CreateTopicRequest (tencentcloud-sdk-java 3.1.594 API)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAclRuleName()` Get 预设ACL规则的名称
`String`	`getCleanUpPolicy()` Get 清理日志策略，日志清理模式，默认为"delete"。"delete"：日志按保存时间删除，"compact"：日志按 key 压缩，"compact, delete"：日志按 key 压缩且会按保存时间删除。
`Long`	`getEnableAclRule()` Get 预设ACL规则, 1:打开 0:关闭，默认不打开
`Long`	`getEnableWhiteList()` Get ip白名单开关, 1:打开 0:关闭，默认不打开
`String`	`getInstanceId()` Get 实例Id
`String[]`	`getIpWhiteList()` Get Ip白名单列表，配额限制，enableWhileList=1时必选
`Long`	`getMaxMessageBytes()` Get 主题消息最大值，单位为 Byte，最小值1024Byte(即1KB)，最大值为8388608Byte（即8MB）。
`Long`	`getMinInsyncReplicas()` Get 默认为1
`String`	`getNote()` Get 主题备注，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
`Long`	`getPartitionNum()` Get Partition个数，大于0
`Long`	`getReplicaNum()` Get 副本个数，不能多于 broker 数，最大为3
`Long`	`getRetentionBytes()` Get 可选, 保留文件大小.
`Long`	`getRetentionMs()` Get 可选参数。消息保留时间，单位ms，当前最小值为60000ms
`Long`	`getSegmentMs()` Get Segment分片滚动的时长，单位ms，当前最小为3600000ms
`Tag[]`	`getTags()` Get 标签列表
`String`	`getTopicName()` Get 主题名称，是一个不超过 128 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
`Long`	`getUncleanLeaderElectionEnable()` Get 是否允许未同步的副本选为leader，false:不允许，true:允许，默认不允许
`void`	`setAclRuleName(String AclRuleName)` Set 预设ACL规则的名称
`void`	`setCleanUpPolicy(String CleanUpPolicy)` Set 清理日志策略，日志清理模式，默认为"delete"。"delete"：日志按保存时间删除，"compact"：日志按 key 压缩，"compact, delete"：日志按 key 压缩且会按保存时间删除。
`void`	`setEnableAclRule(Long EnableAclRule)` Set 预设ACL规则, 1:打开 0:关闭，默认不打开
`void`	`setEnableWhiteList(Long EnableWhiteList)` Set ip白名单开关, 1:打开 0:关闭，默认不打开
`void`	`setInstanceId(String InstanceId)` Set 实例Id
`void`	`setIpWhiteList(String[] IpWhiteList)` Set Ip白名单列表，配额限制，enableWhileList=1时必选
`void`	`setMaxMessageBytes(Long MaxMessageBytes)` Set 主题消息最大值，单位为 Byte，最小值1024Byte(即1KB)，最大值为8388608Byte（即8MB）。
`void`	`setMinInsyncReplicas(Long MinInsyncReplicas)` Set 默认为1
`void`	`setNote(String Note)` Set 主题备注，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
`void`	`setPartitionNum(Long PartitionNum)` Set Partition个数，大于0
`void`	`setReplicaNum(Long ReplicaNum)` Set 副本个数，不能多于 broker 数，最大为3
`void`	`setRetentionBytes(Long RetentionBytes)` Set 可选, 保留文件大小.
`void`	`setRetentionMs(Long RetentionMs)` Set 可选参数。消息保留时间，单位ms，当前最小值为60000ms
`void`	`setSegmentMs(Long SegmentMs)` Set Segment分片滚动的时长，单位ms，当前最小为3600000ms
`void`	`setTags(Tag[] Tags)` Set 标签列表
`void`	`setTopicName(String TopicName)` Set 主题名称，是一个不超过 128 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
`void`	`setUncleanLeaderElectionEnable(Long UncleanLeaderElectionEnable)` Set 是否允许未同步的副本选为leader，false:不允许，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
  - 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 实例Id
    
    Returns:
    
    InstanceId 实例Id
  - setInstanceId
```
public void setInstanceId(String InstanceId)
```
    Set 实例Id
    
    Parameters:
    
    InstanceId - 实例Id
  - getTopicName
```
public String getTopicName()
```
    Get 主题名称，是一个不超过 128 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
    
    Returns:
    
    TopicName 主题名称，是一个不超过 128 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
  - setTopicName
```
public void setTopicName(String TopicName)
```
    Set 主题名称，是一个不超过 128 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
    
    Parameters:
    
    TopicName - 主题名称，是一个不超过 128 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
  - getPartitionNum
```
public Long getPartitionNum()
```
    Get Partition个数，大于0
    
    Returns:
    
    PartitionNum Partition个数，大于0
  - setPartitionNum
```
public void setPartitionNum(Long PartitionNum)
```
    Set Partition个数，大于0
    
    Parameters:
    
    PartitionNum - Partition个数，大于0
  - getReplicaNum
```
public Long getReplicaNum()
```
    Get 副本个数，不能多于 broker 数，最大为3
    
    Returns:
    
    ReplicaNum 副本个数，不能多于 broker 数，最大为3
  - setReplicaNum
```
public void setReplicaNum(Long ReplicaNum)
```
    Set 副本个数，不能多于 broker 数，最大为3
    
    Parameters:
    
    ReplicaNum - 副本个数，不能多于 broker 数，最大为3
  - getEnableWhiteList
```
public Long getEnableWhiteList()
```
    Get ip白名单开关, 1:打开 0:关闭，默认不打开
    
    Returns:
    
    EnableWhiteList ip白名单开关, 1:打开 0:关闭，默认不打开
  - setEnableWhiteList
```
public void setEnableWhiteList(Long EnableWhiteList)
```
    Set ip白名单开关, 1:打开 0:关闭，默认不打开
    
    Parameters:
    
    EnableWhiteList - ip白名单开关, 1:打开 0:关闭，默认不打开
  - getIpWhiteList
```
public String[] getIpWhiteList()
```
    Get Ip白名单列表，配额限制，enableWhileList=1时必选
    
    Returns:
    
    IpWhiteList Ip白名单列表，配额限制，enableWhileList=1时必选
  - setIpWhiteList
```
public void setIpWhiteList(String[] IpWhiteList)
```
    Set Ip白名单列表，配额限制，enableWhileList=1时必选
    
    Parameters:
    
    IpWhiteList - Ip白名单列表，配额限制，enableWhileList=1时必选
  - getCleanUpPolicy
```
public String getCleanUpPolicy()
```
    Get 清理日志策略，日志清理模式，默认为"delete"。"delete"：日志按保存时间删除，"compact"：日志按 key 压缩，"compact, delete"：日志按 key 压缩且会按保存时间删除。
    
    Returns:
    
    CleanUpPolicy 清理日志策略，日志清理模式，默认为"delete"。"delete"：日志按保存时间删除，"compact"：日志按 key 压缩，"compact, delete"：日志按 key 压缩且会按保存时间删除。
  - setCleanUpPolicy
```
public void setCleanUpPolicy(String CleanUpPolicy)
```
    Set 清理日志策略，日志清理模式，默认为"delete"。"delete"：日志按保存时间删除，"compact"：日志按 key 压缩，"compact, delete"：日志按 key 压缩且会按保存时间删除。
    
    Parameters:
    
    CleanUpPolicy - 清理日志策略，日志清理模式，默认为"delete"。"delete"：日志按保存时间删除，"compact"：日志按 key 压缩，"compact, delete"：日志按 key 压缩且会按保存时间删除。
  - getNote
```
public String getNote()
```
    Get 主题备注，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
    
    Returns:
    
    Note 主题备注，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
  - setNote
```
public void setNote(String Note)
```
    Set 主题备注，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
    
    Parameters:
    
    Note - 主题备注，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
  - getMinInsyncReplicas
```
public Long getMinInsyncReplicas()
```
    Get 默认为1
    
    Returns:
    
    MinInsyncReplicas 默认为1
  - setMinInsyncReplicas
```
public void setMinInsyncReplicas(Long MinInsyncReplicas)
```
    Set 默认为1
    
    Parameters:
    
    MinInsyncReplicas - 默认为1
  - getUncleanLeaderElectionEnable
```
public Long getUncleanLeaderElectionEnable()
```
    Get 是否允许未同步的副本选为leader，false:不允许，true:允许，默认不允许
    
    Returns:
    
    UncleanLeaderElectionEnable 是否允许未同步的副本选为leader，false:不允许，true:允许，默认不允许
  - setUncleanLeaderElectionEnable
```
public void setUncleanLeaderElectionEnable(Long UncleanLeaderElectionEnable)
```
    Set 是否允许未同步的副本选为leader，false:不允许，true:允许，默认不允许
    
    Parameters:
    
    UncleanLeaderElectionEnable - 是否允许未同步的副本选为leader，false:不允许，true:允许，默认不允许
  - getRetentionMs
```
public Long getRetentionMs()
```
    Get 可选参数。消息保留时间，单位ms，当前最小值为60000ms
    
    Returns:
    
    RetentionMs 可选参数。消息保留时间，单位ms，当前最小值为60000ms
  - setRetentionMs
```
public void setRetentionMs(Long RetentionMs)
```
    Set 可选参数。消息保留时间，单位ms，当前最小值为60000ms
    
    Parameters:
    
    RetentionMs - 可选参数。消息保留时间，单位ms，当前最小值为60000ms
  - getSegmentMs
```
public Long getSegmentMs()
```
    Get Segment分片滚动的时长，单位ms，当前最小为3600000ms
    
    Returns:
    
    SegmentMs Segment分片滚动的时长，单位ms，当前最小为3600000ms
  - setSegmentMs
```
public void setSegmentMs(Long SegmentMs)
```
    Set Segment分片滚动的时长，单位ms，当前最小为3600000ms
    
    Parameters:
    
    SegmentMs - Segment分片滚动的时长，单位ms，当前最小为3600000ms
  - getMaxMessageBytes
```
public Long getMaxMessageBytes()
```
    Get 主题消息最大值，单位为 Byte，最小值1024Byte(即1KB)，最大值为8388608Byte（即8MB）。
    
    Returns:
    
    MaxMessageBytes 主题消息最大值，单位为 Byte，最小值1024Byte(即1KB)，最大值为8388608Byte（即8MB）。
  - setMaxMessageBytes
```
public void setMaxMessageBytes(Long MaxMessageBytes)
```
    Set 主题消息最大值，单位为 Byte，最小值1024Byte(即1KB)，最大值为8388608Byte（即8MB）。
    
    Parameters:
    
    MaxMessageBytes - 主题消息最大值，单位为 Byte，最小值1024Byte(即1KB)，最大值为8388608Byte（即8MB）。
  - getEnableAclRule
```
public Long getEnableAclRule()
```
    Get 预设ACL规则, 1:打开 0:关闭，默认不打开
    
    Returns:
    
    EnableAclRule 预设ACL规则, 1:打开 0:关闭，默认不打开
  - setEnableAclRule
```
public void setEnableAclRule(Long EnableAclRule)
```
    Set 预设ACL规则, 1:打开 0:关闭，默认不打开
    
    Parameters:
    
    EnableAclRule - 预设ACL规则, 1:打开 0:关闭，默认不打开
  - getAclRuleName
```
public String getAclRuleName()
```
    Get 预设ACL规则的名称
    
    Returns:
    
    AclRuleName 预设ACL规则的名称
  - setAclRuleName
```
public void setAclRuleName(String AclRuleName)
```
    Set 预设ACL规则的名称
    
    Parameters:
    
    AclRuleName - 预设ACL规则的名称
  - getRetentionBytes
```
public Long getRetentionBytes()
```
    Get 可选, 保留文件大小. 默认为-1,单位bytes, 当前最小值为1048576B
    
    Returns:
    
    RetentionBytes 可选, 保留文件大小. 默认为-1,单位bytes, 当前最小值为1048576B
  - setRetentionBytes
```
public void setRetentionBytes(Long RetentionBytes)
```
    Set 可选, 保留文件大小. 默认为-1,单位bytes, 当前最小值为1048576B
    
    Parameters:
    
    RetentionBytes - 可选, 保留文件大小. 默认为-1,单位bytes, 当前最小值为1048576B
  - getTags
```
public Tag[] getTags()
```
    Get 标签列表
    
    Returns:
    
    Tags 标签列表
  - setTags
```
public void setTags(Tag[] Tags)
```
    Set 标签列表
    
    Parameters:
    
    Tags - 标签列表
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel

Class CreateTopicRequest

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

CreateTopicRequest

CreateTopicRequest

Method Detail

getInstanceId

setInstanceId

getTopicName

setTopicName

getPartitionNum

setPartitionNum

getReplicaNum

setReplicaNum

getEnableWhiteList

setEnableWhiteList

getIpWhiteList

setIpWhiteList

getCleanUpPolicy

setCleanUpPolicy

getNote

setNote

getMinInsyncReplicas

setMinInsyncReplicas

getUncleanLeaderElectionEnable

setUncleanLeaderElectionEnable

getRetentionMs

setRetentionMs

getSegmentMs

setSegmentMs

getMaxMessageBytes

setMaxMessageBytes

getEnableAclRule

setEnableAclRule

getAclRuleName

setAclRuleName

getRetentionBytes

setRetentionBytes

getTags

setTags

toMap