Skip to content

ConsumerGroupProps

Properties for defining a ConsumerGroup.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-sls-consumergroup

Initializer

import com.aliyun.ros.cdk.sls.ConsumerGroupProps;
ConsumerGroupProps.builder()
    .consumerGroup(java.lang.String)
    .consumerGroup(IResolvable)
    .logstore(java.lang.String)
    .logstore(IResolvable)
    .order(java.lang.Boolean)
    .order(IResolvable)
    .project(java.lang.String)
    .project(IResolvable)
    .timeout(java.lang.Number)
    .timeout(IResolvable)
    .build();

Properties

Name Type Description
consumerGroup java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property consumerGroup: The name of the consumer group.
logstore java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property logstore: The name of the Logstore.
order java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property order: Specifies whether to consume data in sequence.
project java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property project: The name of the project.
timeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property timeout: The timeout period.

consumerGroupRequired

public java.lang.Object getConsumerGroup();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property consumerGroup: The name of the consumer group.

The name must be unique in a project.


logstoreRequired

public java.lang.Object getLogstore();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property logstore: The name of the Logstore.


orderRequired

public java.lang.Object getOrder();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property order: Specifies whether to consume data in sequence.

Valid values: true In a shard, data is consumed in ascending order based on the value of the *tag*:receive_time**** field. If a shard is split, data in the original shard is consumed first. Then, data in the new shards is consumed at the same time. If shards are merged, data in the original shards is consumed first. Then, data in the new shard is consumed. false Data in all shards is consumed at the same time. If a new shard is generated after a shard is split or after shards are merged, data in the new shard is immediately consumed.


projectRequired

public java.lang.Object getProject();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property project: The name of the project.


timeoutRequired

public java.lang.Object getTimeout();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property timeout: The timeout period.

If the server does not receive heartbeats from a consumer within the timeout period, the server deletes the consumer. Unit: seconds.