KafkaParam (tencentcloud-sdk-java 3.1.1355 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.ckafka.v20190819.models.KafkaParam

public class KafkaParam
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  header, skipSign

Constructor Summary

Constructors
Constructor and Description
`KafkaParam()`
`KafkaParam(KafkaParam 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`	`getCompressionType()` Get 写入Topic时是否进行压缩，不开启填"none"，开启的话，填写"open"。
`String`	`getConnectorSyncType()` Get 数据同步专用参数, 正常数据处理可为空, 实例级别同步: 仅同步元数据填写"META_SYNC_INSTANCE_TYPE", 同步元数据及全部topic内消息的填写"META_AND_DATA_SYNC_INSTANCE_TYPE"; topic级别同步: 选中的源和目标topic中的消息(需要目标实例也包含该topic)填写"DATA_SYNC_TYPE"
`Boolean`	`getEnableToleration()` Get 启用容错实例/开启死信队列注意：此字段可能返回 null，表示取不到有效值。
`Boolean`	`getKeepPartition()` Get 数据同步专用参数, 当通过时,希望下游的消息写入分区与上游的一致,则填true,但下游分区小于上游时,会报错; 不需要一致则为false, 默认为false
`Long`	`getMsgMultiple()` Get 源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用)
`String`	`getOffsetType()` Get Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp 注意：此字段可能返回 null，表示取不到有效值。
`Long`	`getPartitionNum()` Get Topic的分区数注意：此字段可能返回 null，表示取不到有效值。
`Long`	`getQpsLimit()` Get Qps 限制
`String`	`getResource()` Get ckafka集群实例Id
`String`	`getResourceName()` Get 实例资源名称注意：此字段可能返回 null，表示取不到有效值。
`Boolean`	`getSelfBuilt()` Get 是否为自建集群
`Long`	`getStartTime()` Get Offset类型为timestamp时必传，传时间戳，精确到秒注意：此字段可能返回 null，表示取不到有效值。
`TableMapping[]`	`getTableMappings()` Get Table到Topic的路由，「分发到多个topic」开关打开时必传注意：此字段可能返回 null，表示取不到有效值。
`String`	`getTopic()` Get 主题名，多个以“,”分隔
`String`	`getTopicId()` Get 主题Id 注意：此字段可能返回 null，表示取不到有效值。
`String`	`getTopicRegularExpression()` Get 正则匹配Topic列表
`Boolean`	`getUseAutoCreateTopic()` Get 使用的Topic是否需要自动创建（目前只支持SOURCE流入任务，如果不使用分发到多个topic，需要在Topic字段填写需要自动创建的topic名）
`Boolean`	`getUseTableMapping()` Get 「分发到多个topic」开关，默认为false
`Long`	`getZoneId()` Get 可用区注意：此字段可能返回 null，表示取不到有效值。
`void`	`setCompressionType(String CompressionType)` Set 写入Topic时是否进行压缩，不开启填"none"，开启的话，填写"open"。
`void`	`setConnectorSyncType(String ConnectorSyncType)` Set 数据同步专用参数, 正常数据处理可为空, 实例级别同步: 仅同步元数据填写"META_SYNC_INSTANCE_TYPE", 同步元数据及全部topic内消息的填写"META_AND_DATA_SYNC_INSTANCE_TYPE"; topic级别同步: 选中的源和目标topic中的消息(需要目标实例也包含该topic)填写"DATA_SYNC_TYPE"
`void`	`setEnableToleration(Boolean EnableToleration)` Set 启用容错实例/开启死信队列注意：此字段可能返回 null，表示取不到有效值。
`void`	`setKeepPartition(Boolean KeepPartition)` Set 数据同步专用参数, 当通过时,希望下游的消息写入分区与上游的一致,则填true,但下游分区小于上游时,会报错; 不需要一致则为false, 默认为false
`void`	`setMsgMultiple(Long MsgMultiple)` Set 源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用)
`void`	`setOffsetType(String OffsetType)` Set Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp 注意：此字段可能返回 null，表示取不到有效值。
`void`	`setPartitionNum(Long PartitionNum)` Set Topic的分区数注意：此字段可能返回 null，表示取不到有效值。
`void`	`setQpsLimit(Long QpsLimit)` Set Qps 限制
`void`	`setResource(String Resource)` Set ckafka集群实例Id
`void`	`setResourceName(String ResourceName)` Set 实例资源名称注意：此字段可能返回 null，表示取不到有效值。
`void`	`setSelfBuilt(Boolean SelfBuilt)` Set 是否为自建集群
`void`	`setStartTime(Long StartTime)` Set Offset类型为timestamp时必传，传时间戳，精确到秒注意：此字段可能返回 null，表示取不到有效值。
`void`	`setTableMappings(TableMapping[] TableMappings)` Set Table到Topic的路由，「分发到多个topic」开关打开时必传注意：此字段可能返回 null，表示取不到有效值。
`void`	`setTopic(String Topic)` Set 主题名，多个以“,”分隔
`void`	`setTopicId(String TopicId)` Set 主题Id 注意：此字段可能返回 null，表示取不到有效值。
`void`	`setTopicRegularExpression(String TopicRegularExpression)` Set 正则匹配Topic列表
`void`	`setUseAutoCreateTopic(Boolean UseAutoCreateTopic)` Set 使用的Topic是否需要自动创建（目前只支持SOURCE流入任务，如果不使用分发到多个topic，需要在Topic字段填写需要自动创建的topic名）
`void`	`setUseTableMapping(Boolean UseTableMapping)` Set 「分发到多个topic」开关，默认为false
`void`	`setZoneId(Long ZoneId)` Set 可用区注意：此字段可能返回 null，表示取不到有效值。
`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, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - KafkaParam
```
public KafkaParam()
```
  - KafkaParam
```
public KafkaParam(KafkaParam 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
  - getSelfBuilt
```
public Boolean getSelfBuilt()
```
    Get 是否为自建集群
    
    Returns:
    
    SelfBuilt 是否为自建集群
  - setSelfBuilt
```
public void setSelfBuilt(Boolean SelfBuilt)
```
    Set 是否为自建集群
    
    Parameters:
    
    SelfBuilt - 是否为自建集群
  - getResource
```
public String getResource()
```
    Get ckafka集群实例Id
    
    Returns:
    
    Resource ckafka集群实例Id
  - setResource
```
public void setResource(String Resource)
```
    Set ckafka集群实例Id
    
    Parameters:
    
    Resource - ckafka集群实例Id
  - getTopic
```
public String getTopic()
```
    Get 主题名，多个以“,”分隔
    
    Returns:
    
    Topic 主题名，多个以“,”分隔
  - setTopic
```
public void setTopic(String Topic)
```
    Set 主题名，多个以“,”分隔
    
    Parameters:
    
    Topic - 主题名，多个以“,”分隔
  - getOffsetType
```
public String getOffsetType()
```
    Get Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp 注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    OffsetType Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp 注意：此字段可能返回 null，表示取不到有效值。
  - setOffsetType
```
public void setOffsetType(String OffsetType)
```
    Set Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp 注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    OffsetType - Offset类型，最开始位置earliest，最新位置latest，时间点位置timestamp 注意：此字段可能返回 null，表示取不到有效值。
  - getStartTime
```
public Long getStartTime()
```
    Get Offset类型为timestamp时必传，传时间戳，精确到秒注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    StartTime Offset类型为timestamp时必传，传时间戳，精确到秒注意：此字段可能返回 null，表示取不到有效值。
  - setStartTime
```
public void setStartTime(Long StartTime)
```
    Set Offset类型为timestamp时必传，传时间戳，精确到秒注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    StartTime - Offset类型为timestamp时必传，传时间戳，精确到秒注意：此字段可能返回 null，表示取不到有效值。
  - getResourceName
```
public String getResourceName()
```
    Get 实例资源名称注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    ResourceName 实例资源名称注意：此字段可能返回 null，表示取不到有效值。
  - setResourceName
```
public void setResourceName(String ResourceName)
```
    Set 实例资源名称注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    ResourceName - 实例资源名称注意：此字段可能返回 null，表示取不到有效值。
  - getZoneId
```
public Long getZoneId()
```
    Get 可用区注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    ZoneId 可用区注意：此字段可能返回 null，表示取不到有效值。
  - setZoneId
```
public void setZoneId(Long ZoneId)
```
    Set 可用区注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    ZoneId - 可用区注意：此字段可能返回 null，表示取不到有效值。
  - getTopicId
```
public String getTopicId()
```
    Get 主题Id 注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    TopicId 主题Id 注意：此字段可能返回 null，表示取不到有效值。
  - setTopicId
```
public void setTopicId(String TopicId)
```
    Set 主题Id 注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    TopicId - 主题Id 注意：此字段可能返回 null，表示取不到有效值。
  - getPartitionNum
```
public Long getPartitionNum()
```
    Get Topic的分区数注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    PartitionNum Topic的分区数注意：此字段可能返回 null，表示取不到有效值。
  - setPartitionNum
```
public void setPartitionNum(Long PartitionNum)
```
    Set Topic的分区数注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    PartitionNum - Topic的分区数注意：此字段可能返回 null，表示取不到有效值。
  - getEnableToleration
```
public Boolean getEnableToleration()
```
    Get 启用容错实例/开启死信队列注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    EnableToleration 启用容错实例/开启死信队列注意：此字段可能返回 null，表示取不到有效值。
  - setEnableToleration
```
public void setEnableToleration(Boolean EnableToleration)
```
    Set 启用容错实例/开启死信队列注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    EnableToleration - 启用容错实例/开启死信队列注意：此字段可能返回 null，表示取不到有效值。
  - getQpsLimit
```
public Long getQpsLimit()
```
    Get Qps 限制
    
    Returns:
    
    QpsLimit Qps 限制
  - setQpsLimit
```
public void setQpsLimit(Long QpsLimit)
```
    Set Qps 限制
    
    Parameters:
    
    QpsLimit - Qps 限制
  - getTableMappings
```
public TableMapping[] getTableMappings()
```
    Get Table到Topic的路由，「分发到多个topic」开关打开时必传注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    TableMappings Table到Topic的路由，「分发到多个topic」开关打开时必传注意：此字段可能返回 null，表示取不到有效值。
  - setTableMappings
```
public void setTableMappings(TableMapping[] TableMappings)
```
    Set Table到Topic的路由，「分发到多个topic」开关打开时必传注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    TableMappings - Table到Topic的路由，「分发到多个topic」开关打开时必传注意：此字段可能返回 null，表示取不到有效值。
  - getUseTableMapping
```
public Boolean getUseTableMapping()
```
    Get 「分发到多个topic」开关，默认为false
    
    Returns:
    
    UseTableMapping 「分发到多个topic」开关，默认为false
  - setUseTableMapping
```
public void setUseTableMapping(Boolean UseTableMapping)
```
    Set 「分发到多个topic」开关，默认为false
    
    Parameters:
    
    UseTableMapping - 「分发到多个topic」开关，默认为false
  - getUseAutoCreateTopic
```
public Boolean getUseAutoCreateTopic()
```
    Get 使用的Topic是否需要自动创建（目前只支持SOURCE流入任务，如果不使用分发到多个topic，需要在Topic字段填写需要自动创建的topic名）
    
    Returns:
    
    UseAutoCreateTopic 使用的Topic是否需要自动创建（目前只支持SOURCE流入任务，如果不使用分发到多个topic，需要在Topic字段填写需要自动创建的topic名）
  - setUseAutoCreateTopic
```
public void setUseAutoCreateTopic(Boolean UseAutoCreateTopic)
```
    Set 使用的Topic是否需要自动创建（目前只支持SOURCE流入任务，如果不使用分发到多个topic，需要在Topic字段填写需要自动创建的topic名）
    
    Parameters:
    
    UseAutoCreateTopic - 使用的Topic是否需要自动创建（目前只支持SOURCE流入任务，如果不使用分发到多个topic，需要在Topic字段填写需要自动创建的topic名）
  - getCompressionType
```
public String getCompressionType()
```
    Get 写入Topic时是否进行压缩，不开启填"none"，开启的话，填写"open"。
    
    Returns:
    
    CompressionType 写入Topic时是否进行压缩，不开启填"none"，开启的话，填写"open"。
  - setCompressionType
```
public void setCompressionType(String CompressionType)
```
    Set 写入Topic时是否进行压缩，不开启填"none"，开启的话，填写"open"。
    
    Parameters:
    
    CompressionType - 写入Topic时是否进行压缩，不开启填"none"，开启的话，填写"open"。
  - getMsgMultiple
```
public Long getMsgMultiple()
```
    Get 源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用)
    
    Returns:
    
    MsgMultiple 源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用)
  - setMsgMultiple
```
public void setMsgMultiple(Long MsgMultiple)
```
    Set 源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用)
    
    Parameters:
    
    MsgMultiple - 源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用)
  - getConnectorSyncType
```
public String getConnectorSyncType()
```
    Get 数据同步专用参数, 正常数据处理可为空, 实例级别同步: 仅同步元数据填写"META_SYNC_INSTANCE_TYPE", 同步元数据及全部topic内消息的填写"META_AND_DATA_SYNC_INSTANCE_TYPE"; topic级别同步: 选中的源和目标topic中的消息(需要目标实例也包含该topic)填写"DATA_SYNC_TYPE"
    
    Returns:
    
    ConnectorSyncType 数据同步专用参数, 正常数据处理可为空, 实例级别同步: 仅同步元数据填写"META_SYNC_INSTANCE_TYPE", 同步元数据及全部topic内消息的填写"META_AND_DATA_SYNC_INSTANCE_TYPE"; topic级别同步: 选中的源和目标topic中的消息(需要目标实例也包含该topic)填写"DATA_SYNC_TYPE"
  - setConnectorSyncType
```
public void setConnectorSyncType(String ConnectorSyncType)
```
    Set 数据同步专用参数, 正常数据处理可为空, 实例级别同步: 仅同步元数据填写"META_SYNC_INSTANCE_TYPE", 同步元数据及全部topic内消息的填写"META_AND_DATA_SYNC_INSTANCE_TYPE"; topic级别同步: 选中的源和目标topic中的消息(需要目标实例也包含该topic)填写"DATA_SYNC_TYPE"
    
    Parameters:
    
    ConnectorSyncType - 数据同步专用参数, 正常数据处理可为空, 实例级别同步: 仅同步元数据填写"META_SYNC_INSTANCE_TYPE", 同步元数据及全部topic内消息的填写"META_AND_DATA_SYNC_INSTANCE_TYPE"; topic级别同步: 选中的源和目标topic中的消息(需要目标实例也包含该topic)填写"DATA_SYNC_TYPE"
  - getKeepPartition
```
public Boolean getKeepPartition()
```
    Get 数据同步专用参数, 当通过时,希望下游的消息写入分区与上游的一致,则填true,但下游分区小于上游时,会报错; 不需要一致则为false, 默认为false
    
    Returns:
    
    KeepPartition 数据同步专用参数, 当通过时,希望下游的消息写入分区与上游的一致,则填true,但下游分区小于上游时,会报错; 不需要一致则为false, 默认为false
  - setKeepPartition
```
public void setKeepPartition(Boolean KeepPartition)
```
    Set 数据同步专用参数, 当通过时,希望下游的消息写入分区与上游的一致,则填true,但下游分区小于上游时,会报错; 不需要一致则为false, 默认为false
    
    Parameters:
    
    KeepPartition - 数据同步专用参数, 当通过时,希望下游的消息写入分区与上游的一致,则填true,但下游分区小于上游时,会报错; 不需要一致则为false, 默认为false
  - getTopicRegularExpression
```
public String getTopicRegularExpression()
```
    Get 正则匹配Topic列表
    
    Returns:
    
    TopicRegularExpression 正则匹配Topic列表
  - setTopicRegularExpression
```
public void setTopicRegularExpression(String TopicRegularExpression)
```
    Set 正则匹配Topic列表
    
    Parameters:
    
    TopicRegularExpression - 正则匹配Topic列表
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel
    
    Parameters:
    
    map - The map to populate with the model's parameters.
    
    prefix - A string prefix for the keys.

Class KafkaParam

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

KafkaParam

KafkaParam

Method Detail

getSelfBuilt

setSelfBuilt

getResource

setResource

getTopic

setTopic

getOffsetType

setOffsetType

getStartTime

setStartTime

getResourceName

setResourceName

getZoneId

setZoneId

getTopicId

setTopicId

getPartitionNum

setPartitionNum

getEnableToleration

setEnableToleration

getQpsLimit

setQpsLimit

getTableMappings

setTableMappings

getUseTableMapping

setUseTableMapping

getUseAutoCreateTopic

setUseAutoCreateTopic

getCompressionType

setCompressionType

getMsgMultiple

setMsgMultiple

getConnectorSyncType

setConnectorSyncType

getKeepPartition

setKeepPartition

getTopicRegularExpression

setTopicRegularExpression

toMap