com.tencentcloudapi.ckafka.v20190819.models

Class KafkaParam

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

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

Returns:

Resource 实例资源

setResource

public void setResource(String Resource)

Set 实例资源

Parameters:

Resource - 实例资源

getTopic

public String getTopic()

Get Topic名称，多个以“,”分隔

Returns:

Topic Topic名称，多个以“,”分隔

setTopic

public void setTopic(String Topic)

Set Topic名称，多个以“,”分隔

Parameters:

Topic - 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 Zone ID 注意：此字段可能返回 null，表示取不到有效值。

Returns:

ZoneId Zone ID 注意：此字段可能返回 null，表示取不到有效值。

setZoneId

public void setZoneId(Long ZoneId)

Set Zone ID 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

ZoneId - Zone ID 注意：此字段可能返回 null，表示取不到有效值。

getTopicId

public String getTopicId()

Get Topic的Id 注意：此字段可能返回 null，表示取不到有效值。

Returns:

TopicId Topic的Id 注意：此字段可能返回 null，表示取不到有效值。

setTopicId

public void setTopicId(String TopicId)

Set Topic的Id 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

TopicId - Topic的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 限制 注意：此字段可能返回 null，表示取不到有效值。

Returns:

QpsLimit Qps 限制 注意：此字段可能返回 null，表示取不到有效值。

setQpsLimit

public void setQpsLimit(Long QpsLimit)

Set Qps 限制 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

QpsLimit - Qps 限制 注意：此字段可能返回 null，表示取不到有效值。

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 注意：此字段可能返回 null，表示取不到有效值。

Returns:

UseTableMapping 「分发到多个topic」开关，默认为false 注意：此字段可能返回 null，表示取不到有效值。

setUseTableMapping

public void setUseTableMapping(Boolean UseTableMapping)

Set 「分发到多个topic」开关，默认为false 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

UseTableMapping - 「分发到多个topic」开关，默认为false 注意：此字段可能返回 null，表示取不到有效值。

getUseAutoCreateTopic

public Boolean getUseAutoCreateTopic()

Get 使用的Topic是否需要自动创建（目前只支持SOURCE流入任务，如果不使用分发到多个topic，需要在Topic字段填写需要自动创建的topic名） 注意：此字段可能返回 null，表示取不到有效值。

Returns:

UseAutoCreateTopic 使用的Topic是否需要自动创建（目前只支持SOURCE流入任务，如果不使用分发到多个topic，需要在Topic字段填写需要自动创建的topic名） 注意：此字段可能返回 null，表示取不到有效值。

setUseAutoCreateTopic

public void setUseAutoCreateTopic(Boolean UseAutoCreateTopic)

Set 使用的Topic是否需要自动创建（目前只支持SOURCE流入任务，如果不使用分发到多个topic，需要在Topic字段填写需要自动创建的topic名） 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

UseAutoCreateTopic - 使用的Topic是否需要自动创建（目前只支持SOURCE流入任务，如果不使用分发到多个topic，需要在Topic字段填写需要自动创建的topic名） 注意：此字段可能返回 null，表示取不到有效值。

getCompressionType

public String getCompressionType()

Get 写入Topic时是否进行压缩，不开启填"none"，开启的话，填写"open"。 注意：此字段可能返回 null，表示取不到有效值。

Returns:

CompressionType 写入Topic时是否进行压缩，不开启填"none"，开启的话，填写"open"。 注意：此字段可能返回 null，表示取不到有效值。

setCompressionType

public void setCompressionType(String CompressionType)

Set 写入Topic时是否进行压缩，不开启填"none"，开启的话，填写"open"。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

CompressionType - 写入Topic时是否进行压缩，不开启填"none"，开启的话，填写"open"。 注意：此字段可能返回 null，表示取不到有效值。

getMsgMultiple

public Long getMsgMultiple()

Get 源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用) 注意：此字段可能返回 null，表示取不到有效值。

Returns:

MsgMultiple 源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用) 注意：此字段可能返回 null，表示取不到有效值。

setMsgMultiple

public void setMsgMultiple(Long MsgMultiple)

Set 源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用) 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

MsgMultiple - 源topic消息1条扩增成msgMultiple条写入目标topic(该参数目前只有ckafka流入ckafka适用) 注意：此字段可能返回 null，表示取不到有效值。

getConnectorSyncType

public String getConnectorSyncType()

Get 数据同步专用参数, 正常数据处理可为空, 实例级别同步: 仅同步元数据填写"META_SYNC_INSTANCE_TYPE", 同步元数据及全部topic内消息的填写"META_AND_DATA_SYNC_INSTANCE_TYPE"; topic级别同步: 选中的源和目标topic中的消息(需要目标实例也包含该topic)填写"DATA_SYNC_TYPE" 注意：此字段可能返回 null，表示取不到有效值。

Returns:

ConnectorSyncType 数据同步专用参数, 正常数据处理可为空, 实例级别同步: 仅同步元数据填写"META_SYNC_INSTANCE_TYPE", 同步元数据及全部topic内消息的填写"META_AND_DATA_SYNC_INSTANCE_TYPE"; topic级别同步: 选中的源和目标topic中的消息(需要目标实例也包含该topic)填写"DATA_SYNC_TYPE" 注意：此字段可能返回 null，表示取不到有效值。

setConnectorSyncType

public void setConnectorSyncType(String ConnectorSyncType)

Set 数据同步专用参数, 正常数据处理可为空, 实例级别同步: 仅同步元数据填写"META_SYNC_INSTANCE_TYPE", 同步元数据及全部topic内消息的填写"META_AND_DATA_SYNC_INSTANCE_TYPE"; topic级别同步: 选中的源和目标topic中的消息(需要目标实例也包含该topic)填写"DATA_SYNC_TYPE" 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

ConnectorSyncType - 数据同步专用参数, 正常数据处理可为空, 实例级别同步: 仅同步元数据填写"META_SYNC_INSTANCE_TYPE", 同步元数据及全部topic内消息的填写"META_AND_DATA_SYNC_INSTANCE_TYPE"; topic级别同步: 选中的源和目标topic中的消息(需要目标实例也包含该topic)填写"DATA_SYNC_TYPE" 注意：此字段可能返回 null，表示取不到有效值。

getKeepPartition

public Boolean getKeepPartition()

Get 数据同步专用参数, 当通过时,希望下游的消息写入分区与上游的一致,则填true,但下游分区小于上游时,会报错; 不需要一致则为false, 默认为false 注意：此字段可能返回 null，表示取不到有效值。

Returns:

KeepPartition 数据同步专用参数, 当通过时,希望下游的消息写入分区与上游的一致,则填true,但下游分区小于上游时,会报错; 不需要一致则为false, 默认为false 注意：此字段可能返回 null，表示取不到有效值。

setKeepPartition

public void setKeepPartition(Boolean KeepPartition)

Set 数据同步专用参数, 当通过时,希望下游的消息写入分区与上游的一致,则填true,但下游分区小于上游时,会报错; 不需要一致则为false, 默认为false 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

KeepPartition - 数据同步专用参数, 当通过时,希望下游的消息写入分区与上游的一致,则填true,但下游分区小于上游时,会报错; 不需要一致则为false, 默认为false 注意：此字段可能返回 null，表示取不到有效值。

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel