com.tencentcloudapi.ckafka.v20190819.models

Class ModifyTopicAttributesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ckafka.v20190819.models.ModifyTopicAttributesRequest

public class ModifyTopicAttributesRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
ModifyTopicAttributesRequest()
ModifyTopicAttributesRequest(ModifyTopicAttributesRequest 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 Message deletion policy.
Long	getEnableAclRule() Get Preset ACL rule.
Long	getEnableWhiteList() Get IP allowlist switch.
String	getInstanceId() Get Instance ID.
String[]	getIpWhiteList() Get IP allowlist, which is required if the value of `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	getQuotaConsumerByteRate() Get Consumption throttling in MB/sec.
Long	getQuotaProducerByteRate() Get Production throttling in MB/sec.
Long	getReplicaNum() Get The number of topic replicas.
Long	getRetentionBytes() Get Message retention file size in bytes, which is an optional parameter.
Long	getRetentionMs() Get Message retention period in ms.
Long	getSegmentMs() Get Segment rolling duration in ms.
Tag[]	getTags() Get Tag list.
String	getTopicName() Get Topic name.
Long	getUncleanLeaderElectionEnable() Get 0: false, 1: true.
void	setAclRuleName(String AclRuleName) Set Name of the preset ACL rule.
void	setCleanUpPolicy(String CleanUpPolicy) Set Message deletion policy.
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, which is required if the value of `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	setQuotaConsumerByteRate(Long QuotaConsumerByteRate) Set Consumption throttling in MB/sec.
void	setQuotaProducerByteRate(Long QuotaProducerByteRate) Set Production throttling in MB/sec.
void	setReplicaNum(Long ReplicaNum) Set The number of topic replicas.
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 ms.
void	setSegmentMs(Long SegmentMs) Set Segment rolling duration in ms.
void	setTags(Tag[] Tags) Set Tag list.
void	setTopicName(String TopicName) Set Topic name.
void	setUncleanLeaderElectionEnable(Long UncleanLeaderElectionEnable) Set 0: false, 1: true.
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

ModifyTopicAttributesRequest

public ModifyTopicAttributesRequest()

ModifyTopicAttributesRequest

public ModifyTopicAttributesRequest(ModifyTopicAttributesRequest 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.

Returns:

TopicName Topic name.

setTopicName

public void setTopicName(String TopicName)

Set Topic name.

Parameters:

TopicName - Topic name.

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 (`-`).

getEnableWhiteList

public Long getEnableWhiteList()

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

Returns:

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

setEnableWhiteList

public void setEnableWhiteList(Long EnableWhiteList)

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

Parameters:

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

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 0: false, 1: true. Default value: 0.

Returns:

UncleanLeaderElectionEnable 0: false, 1: true. Default value: 0.

setUncleanLeaderElectionEnable

public void setUncleanLeaderElectionEnable(Long UncleanLeaderElectionEnable)

Set 0: false, 1: true. Default value: 0.

Parameters:

UncleanLeaderElectionEnable - 0: false, 1: true. Default value: 0.

getRetentionMs

public Long getRetentionMs()

Get Message retention period in ms. The current minimum value is 60,000 ms.

Returns:

RetentionMs Message retention period in ms. The current minimum value is 60,000 ms.

setRetentionMs

public void setRetentionMs(Long RetentionMs)

Set Message retention period in ms. The current minimum value is 60,000 ms.

Parameters:

RetentionMs - Message retention period in ms. The current minimum value is 60,000 ms.

getSegmentMs

public Long getSegmentMs()

Get Segment rolling duration in ms. The current minimum value is 86,400,000 ms.

Returns:

SegmentMs Segment rolling duration in ms. The current minimum value is 86,400,000 ms.

setSegmentMs

public void setSegmentMs(Long SegmentMs)

Set Segment rolling duration in ms. The current minimum value is 86,400,000 ms.

Parameters:

SegmentMs - Segment rolling duration in ms. The current minimum value is 86,400,000 ms.

getMaxMessageBytes

public Long getMaxMessageBytes()

Get Max message size in bytes. Max value: 8,388,608 bytes (8 MB).

Returns:

MaxMessageBytes Max message size in bytes. Max value: 8,388,608 bytes (8 MB).

setMaxMessageBytes

public void setMaxMessageBytes(Long MaxMessageBytes)

Set Max message size in bytes. Max value: 8,388,608 bytes (8 MB).

Parameters:

MaxMessageBytes - Max message size in bytes. Max value: 8,388,608 bytes (8 MB).

getCleanUpPolicy

public String getCleanUpPolicy()

Get Message deletion policy. Valid values: delete, compact

Returns:

CleanUpPolicy Message deletion policy. Valid values: delete, compact

setCleanUpPolicy

public void setCleanUpPolicy(String CleanUpPolicy)

Set Message deletion policy. Valid values: delete, compact

Parameters:

CleanUpPolicy - Message deletion policy. Valid values: delete, compact

getIpWhiteList

public String[] getIpWhiteList()

Get IP allowlist, which is required if the value of `enableWhileList` is 1.

Returns:

IpWhiteList IP allowlist, which is required if the value of `enableWhileList` is 1.

setIpWhiteList

public void setIpWhiteList(String[] IpWhiteList)

Set IP allowlist, which is required if the value of `enableWhileList` is 1.

Parameters:

IpWhiteList - IP allowlist, which is required if the value of `enableWhileList` is 1.

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.

getQuotaProducerByteRate

public Long getQuotaProducerByteRate()

Get Production throttling in MB/sec.

Returns:

QuotaProducerByteRate Production throttling in MB/sec.

setQuotaProducerByteRate

public void setQuotaProducerByteRate(Long QuotaProducerByteRate)

Set Production throttling in MB/sec.

Parameters:

QuotaProducerByteRate - Production throttling in MB/sec.

getQuotaConsumerByteRate

public Long getQuotaConsumerByteRate()

Get Consumption throttling in MB/sec.

Returns:

QuotaConsumerByteRate Consumption throttling in MB/sec.

setQuotaConsumerByteRate

public void setQuotaConsumerByteRate(Long QuotaConsumerByteRate)

Set Consumption throttling in MB/sec.

Parameters:

QuotaConsumerByteRate - Consumption throttling in MB/sec.

getReplicaNum

public Long getReplicaNum()

Get The number of topic replicas.

Returns:

ReplicaNum The number of topic replicas.

setReplicaNum

public void setReplicaNum(Long ReplicaNum)

Set The number of topic replicas.

Parameters:

ReplicaNum - The number of topic replicas.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel