com.tencentcloudapi.ckafka.v20190819.models

Class CreateTopicRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ckafka.v20190819.models.CreateTopicRequest

public class CreateTopicRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateTopicRequest()
CreateTopicRequest(CreateTopicRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
String	getAclRuleName() Get Name of the preset ACL rule.
String	getCleanUpPolicy() Get Log cleanup policy, which is `delete` by default.
Long	getEnableAclRule() Get Preset ACL rule.
Long	getEnableWhiteList() Get IP allowlist switch.
String	getInstanceId() Get Instance ID
String[]	getIpWhiteList() Get IP allowlist list for quota limit, which is required if `enableWhileList` is 1
Long	getMaxMessageBytes() Get Max message size in bytes.
Long	getMinInsyncReplicas() Get Default value: 1
String	getNote() Get Topic remarks string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`)
Long	getPartitionNum() Get Number of partitions, which should be greater than 0
Long	getReplicaNum() Get Number of replicas, which cannot be higher than the number of brokers.
Long	getRetentionBytes() Get Message retention file size in bytes, which is an optional parameter.
Long	getRetentionMs() Get Message retention period in milliseconds, which is optional.
Long	getSegmentMs() Get Segment rolling duration in ms.
Tag[]	getTags() Get Tag list.
String	getTopicName() Get Topic name, which is a string of up to 128 characters.
Long	getUncleanLeaderElectionEnable() Get Whether to allow an unsynced replica to be elected as leader.
void	setAclRuleName(String AclRuleName) Set Name of the preset ACL rule.
void	setCleanUpPolicy(String CleanUpPolicy) Set Log cleanup policy, which is `delete` by default.
void	setEnableAclRule(Long EnableAclRule) Set Preset ACL rule.
void	setEnableWhiteList(Long EnableWhiteList) Set IP allowlist switch.
void	setInstanceId(String InstanceId) Set Instance ID
void	setIpWhiteList(String[] IpWhiteList) Set IP allowlist list for quota limit, which is required if `enableWhileList` is 1
void	setMaxMessageBytes(Long MaxMessageBytes) Set Max message size in bytes.
void	setMinInsyncReplicas(Long MinInsyncReplicas) Set Default value: 1
void	setNote(String Note) Set Topic remarks string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`)
void	setPartitionNum(Long PartitionNum) Set Number of partitions, which should be greater than 0
void	setReplicaNum(Long ReplicaNum) Set Number of replicas, which cannot be higher than the number of brokers.
void	setRetentionBytes(Long RetentionBytes) Set Message retention file size in bytes, which is an optional parameter.
void	setRetentionMs(Long RetentionMs) Set Message retention period in milliseconds, which is optional.
void	setSegmentMs(Long SegmentMs) Set Segment rolling duration in ms.
void	setTags(Tag[] Tags) Set Tag list.
void	setTopicName(String TopicName) Set Topic name, which is a string of up to 128 characters.
void	setUncleanLeaderElectionEnable(Long UncleanLeaderElectionEnable) Set Whether to allow an unsynced replica to be elected as leader.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreateTopicRequest

public CreateTopicRequest()

CreateTopicRequest

public CreateTopicRequest(CreateTopicRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getInstanceId

public String getInstanceId()

Get Instance ID

Returns:

InstanceId Instance ID

setInstanceId

public void setInstanceId(String InstanceId)

Set Instance ID

Parameters:

InstanceId - Instance ID

getTopicName

public String getTopicName()

Get Topic name, which is a string of up to 128 characters. It can contain letters, digits, and hyphens (-) and must start with a letter.

Returns:

TopicName Topic name, which is a string of up to 128 characters. It can contain letters, digits, and hyphens (-) and must start with a letter.

setTopicName

public void setTopicName(String TopicName)

Set Topic name, which is a string of up to 128 characters. It can contain letters, digits, and hyphens (-) and must start with a letter.

Parameters:

TopicName - Topic name, which is a string of up to 128 characters. It can contain letters, digits, and hyphens (-) and must start with a letter.

getPartitionNum

public Long getPartitionNum()

Get Number of partitions, which should be greater than 0

Returns:

PartitionNum Number of partitions, which should be greater than 0

setPartitionNum

public void setPartitionNum(Long PartitionNum)

Set Number of partitions, which should be greater than 0

Parameters:

PartitionNum - Number of partitions, which should be greater than 0

getReplicaNum

public Long getReplicaNum()

Get Number of replicas, which cannot be higher than the number of brokers. Maximum value: 3

Returns:

ReplicaNum Number of replicas, which cannot be higher than the number of brokers. Maximum value: 3

setReplicaNum

public void setReplicaNum(Long ReplicaNum)

Set Number of replicas, which cannot be higher than the number of brokers. Maximum value: 3

Parameters:

ReplicaNum - Number of replicas, which cannot be higher than the number of brokers. Maximum value: 3

getEnableWhiteList

public Long getEnableWhiteList()

Get IP allowlist switch. 1: enabled, 0: disabled. Default value: 0

Returns:

EnableWhiteList IP allowlist switch. 1: enabled, 0: disabled. Default value: 0

setEnableWhiteList

public void setEnableWhiteList(Long EnableWhiteList)

Set IP allowlist switch. 1: enabled, 0: disabled. Default value: 0

Parameters:

EnableWhiteList - IP allowlist switch. 1: enabled, 0: disabled. Default value: 0

getIpWhiteList

public String[] getIpWhiteList()

Get IP allowlist list for quota limit, which is required if `enableWhileList` is 1

Returns:

IpWhiteList IP allowlist list for quota limit, which is required if `enableWhileList` is 1

setIpWhiteList

public void setIpWhiteList(String[] IpWhiteList)

Set IP allowlist list for quota limit, which is required if `enableWhileList` is 1

Parameters:

IpWhiteList - IP allowlist list for quota limit, which is required if `enableWhileList` is 1

getCleanUpPolicy

public String getCleanUpPolicy()

Get Log cleanup policy, which is `delete` by default. `delete`: logs will be deleted by save time; `compact`: logs will be compressed by key; `compact, delete`: logs will be compressed by key and deleted by save time.

Returns:

CleanUpPolicy Log cleanup policy, which is `delete` by default. `delete`: logs will be deleted by save time; `compact`: logs will be compressed by key; `compact, delete`: logs will be compressed by key and deleted by save time.

setCleanUpPolicy

public void setCleanUpPolicy(String CleanUpPolicy)

Set Log cleanup policy, which is `delete` by default. `delete`: logs will be deleted by save time; `compact`: logs will be compressed by key; `compact, delete`: logs will be compressed by key and deleted by save time.

Parameters:

CleanUpPolicy - Log cleanup policy, which is `delete` by default. `delete`: logs will be deleted by save time; `compact`: logs will be compressed by key; `compact, delete`: logs will be compressed by key and deleted by save time.

getNote

public String getNote()

Get Topic remarks string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`)

Returns:

Note Topic remarks string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`)

setNote

public void setNote(String Note)

Set Topic remarks string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`)

Parameters:

Note - Topic remarks string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (`-`)

getMinInsyncReplicas

public Long getMinInsyncReplicas()

Get Default value: 1

Returns:

MinInsyncReplicas Default value: 1

setMinInsyncReplicas

public void setMinInsyncReplicas(Long MinInsyncReplicas)

Set Default value: 1

Parameters:

MinInsyncReplicas - Default value: 1

getUncleanLeaderElectionEnable

public Long getUncleanLeaderElectionEnable()

Get Whether to allow an unsynced replica to be elected as leader. false: no, true: yes. Default value: false

Returns:

UncleanLeaderElectionEnable Whether to allow an unsynced replica to be elected as leader. false: no, true: yes. Default value: false

setUncleanLeaderElectionEnable

public void setUncleanLeaderElectionEnable(Long UncleanLeaderElectionEnable)

Set Whether to allow an unsynced replica to be elected as leader. false: no, true: yes. Default value: false

Parameters:

UncleanLeaderElectionEnable - Whether to allow an unsynced replica to be elected as leader. false: no, true: yes. Default value: false

getRetentionMs

public Long getRetentionMs()

Get Message retention period in milliseconds, which is optional. Min value: 60,000 ms.

Returns:

RetentionMs Message retention period in milliseconds, which is optional. Min value: 60,000 ms.

setRetentionMs

public void setRetentionMs(Long RetentionMs)

Set Message retention period in milliseconds, which is optional. Min value: 60,000 ms.

Parameters:

RetentionMs - Message retention period in milliseconds, which is optional. Min value: 60,000 ms.

getSegmentMs

public Long getSegmentMs()

Get Segment rolling duration in ms. The current minimum value is 3,600,000 ms

Returns:

SegmentMs Segment rolling duration in ms. The current minimum value is 3,600,000 ms

setSegmentMs

public void setSegmentMs(Long SegmentMs)

Set Segment rolling duration in ms. The current minimum value is 3,600,000 ms

Parameters:

SegmentMs - Segment rolling duration in ms. The current minimum value is 3,600,000 ms

getMaxMessageBytes

public Long getMaxMessageBytes()

Get Max message size in bytes. Value range: 1,024 bytes (1 KB) to 8,388,608 bytes (8 MB).

Returns:

MaxMessageBytes Max message size in bytes. Value range: 1,024 bytes (1 KB) to 8,388,608 bytes (8 MB).

setMaxMessageBytes

public void setMaxMessageBytes(Long MaxMessageBytes)

Set Max message size in bytes. Value range: 1,024 bytes (1 KB) to 8,388,608 bytes (8 MB).

Parameters:

MaxMessageBytes - Max message size in bytes. Value range: 1,024 bytes (1 KB) to 8,388,608 bytes (8 MB).

getEnableAclRule

public Long getEnableAclRule()

Get Preset ACL rule. `1`: enable, `0`: disable. Default value: `0`.

Returns:

EnableAclRule Preset ACL rule. `1`: enable, `0`: disable. Default value: `0`.

setEnableAclRule

public void setEnableAclRule(Long EnableAclRule)

Set Preset ACL rule. `1`: enable, `0`: disable. Default value: `0`.

Parameters:

EnableAclRule - Preset ACL rule. `1`: enable, `0`: disable. Default value: `0`.

getAclRuleName

public String getAclRuleName()

Get Name of the preset ACL rule.

Returns:

AclRuleName Name of the preset ACL rule.

setAclRuleName

public void setAclRuleName(String AclRuleName)

Set Name of the preset ACL rule.

Parameters:

AclRuleName - Name of the preset ACL rule.

getRetentionBytes

public Long getRetentionBytes()

Get Message retention file size in bytes, which is an optional parameter. Default value: -1. Currently, the min value that can be entered is 1,048,576 B.

Returns:

RetentionBytes Message retention file size in bytes, which is an optional parameter. Default value: -1. Currently, the min value that can be entered is 1,048,576 B.

setRetentionBytes

public void setRetentionBytes(Long RetentionBytes)

Set Message retention file size in bytes, which is an optional parameter. Default value: -1. Currently, the min value that can be entered is 1,048,576 B.

Parameters:

RetentionBytes - Message retention file size in bytes, which is an optional parameter. Default value: -1. Currently, the min value that can be entered is 1,048,576 B.

getTags

public Tag[] getTags()

Get Tag list.

Returns:

Tags Tag list.

setTags

public void setTags(Tag[] Tags)

Set Tag list.

Parameters:

Tags - Tag list.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel