TopicProps
Properties for defining a Topic
.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-kafka-topic
Initializer
import com.aliyun.ros.cdk.kafka.TopicProps;
TopicProps.builder()
.instanceId(java.lang.String)
.instanceId(IResolvable)
.remark(java.lang.String)
.remark(IResolvable)
.topic(java.lang.String)
.topic(IResolvable)
// .compactTopic(java.lang.Boolean)
// .compactTopic(IResolvable)
// .config(IResolvable)
// .config(java.util.Map<java.lang.String, java.lang.Object>)
// .localTopic(java.lang.Boolean)
// .localTopic(IResolvable)
// .minInsyncReplicas(java.lang.Number)
// .minInsyncReplicas(IResolvable)
// .partitionNum(java.lang.Number)
// .partitionNum(IResolvable)
// .replicationFactor(java.lang.Number)
// .replicationFactor(IResolvable)
// .tags(java.util.List<TagsProperty>)
.build();
Properties
Name | Type | Description |
---|---|---|
instanceId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property instanceId: The ID of the Message Queue for Apache Kafka instance where the topic is located. |
remark |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property remark: The description of the topic. |
topic |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property topic: The name of the topic. |
compactTopic |
java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable |
Property compactTopic: The log cleanup policy for the topic. |
config |
com.aliyun.ros.cdk.core.IResolvable OR java.util.Map |
Property config: Supplementary configuration. |
localTopic |
java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable |
Property localTopic: The storage engine of the topic. |
minInsyncReplicas |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property minInsyncReplicas: The minimum number of ISR sync replicas. |
partitionNum |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property partitionNum: The number of partitions in the topic. |
replicationFactor |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property replicationFactor: The number of copies of the topic. |
tags |
java.util.List<TagsProperty> |
Property tags: Tags to attach to instance. |
instanceId
Required
public java.lang.Object getInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property instanceId: The ID of the Message Queue for Apache Kafka instance where the topic is located.
You can call the GetInstanceList operation to query instances.
remark
Required
public java.lang.Object getRemark();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property remark: The description of the topic.
The value of this parameter must meet the following requirements: The value can only contain letters, digits, hyphens (-), and underscores (_). The value must be 3 to 64 characters in length.
topic
Required
public java.lang.Object getTopic();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property topic: The name of the topic.
The value of this parameter must meet the following requirements: The name can only contain letters, digits, hyphens (-), and underscores (_). The name must be 3 to 64 characters in length, and will be automatically truncated if it contains more characters. The name cannot be modified after being created.
compactTopic
Optional
public java.lang.Object getCompactTopic();
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property compactTopic: The log cleanup policy for the topic.
This parameter is available when the Local Storage mode is specified for the topic. Valid values: false: uses the default log cleanup policy. true: uses the Apache Kafka log compaction policy.
config
Optional
public java.lang.Object getConfig();
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map
Property config: Supplementary configuration.
Currently supports Key as replications. Indicates the number of Topic copies, the value type is Integer, and the value limit is 1~3. This parameter can only be specified if the LocalTopic value is true. NOTE If replications is specified in this parameter, the specified ReplicationFactor parameter no longer takes effect.
localTopic
Optional
public java.lang.Object getLocalTopic();
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property localTopic: The storage engine of the topic.
Valid values: false: the Cloud Storage mode. true: the Local Storage mode.
minInsyncReplicas
Optional
public java.lang.Object getMinInsyncReplicas();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property minInsyncReplicas: The minimum number of ISR sync replicas.
This parameter can only be specified if the LocalTopic value is true. The value must be less than the number of Topic copies. The number of synchronous replicas is limited to 1~3.
partitionNum
Optional
public java.lang.Object getPartitionNum();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property partitionNum: The number of partitions in the topic.
Valid values: 1 to 48 We recommend that you set the number of partitions to a multiple of 6 to reduce the risk of data skew.Note:For special requirements,submit a ticket.
replicationFactor
Optional
public java.lang.Object getReplicationFactor();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property replicationFactor: The number of copies of the topic.
This parameter can only be specified if the LocalTopic value is true. The number of copies is limited to 1~3. Note When the number of replicas is 1, there is a risk of data loss. Please set it carefully.
tags
Optional
public java.util.List<TagsProperty> getTags();
- Type: java.util.List<TagsProperty>
Property tags: Tags to attach to instance.
Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.