com.tencentcloudapi.ckafka.v20190819.models

Class EsParam

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ckafka.v20190819.models.EsParam

public class EsParam
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
EsParam()
EsParam(EsParam 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	getContentKey() Get 非json格式数据的自定义key
String	getDatabasePrimaryKey() Get 转储到ES的消息为Database的binlog时，如果需要同步数据库操作，即增删改的操作到ES时填写数据库表主键
String	getDateField() Get 消息要映射为 es 索引中 @timestamp 的字段，如果当前配置为空，则使用消息的时间戳进行映射
String	getDateFormat() Get Es自定义日期后缀
String	getDocumentIdField() Get 转储到Es中的文档ID取值字段名
DropCls	getDropCls() Get 当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效
FailureParam	getDropDlq() Get 死信队列
Boolean	getDropInvalidJsonMessage() Get Es是否抛弃非json格式的消息
Boolean	getDropInvalidMessage() Get Es是否抛弃解析失败的消息
String	getIndex() Get Es自定义index名称
String	getIndexType() Get Es自定义index名称的类型，STRING，JSONPATH，默认为STRING
String	getPassword() Get Es密码
Long	getPort() Get Es的连接port
EsRecordMapping[]	getRecordMappingList() Get 使用数据订阅格式导入 es 时，消息与 es 索引字段映射关系。不填默认为默认字段匹配
String	getRecordMappingMode() Get 用来区分当前索引映射，属于新建索引还是存量索引。"EXIST_MAPPING"：从存量索引中选择；"NEW_MAPPING"：新建索引
String	getResource() Get Es实例资源Id
Boolean	getSelfBuilt() Get 是否为自建集群
String	getServiceVip() Get 实例vip
String	getUniqVpcId() Get 实例的vpcId
String	getUserName() Get Es用户名
void	setContentKey(String ContentKey) Set 非json格式数据的自定义key
void	setDatabasePrimaryKey(String DatabasePrimaryKey) Set 转储到ES的消息为Database的binlog时，如果需要同步数据库操作，即增删改的操作到ES时填写数据库表主键
void	setDateField(String DateField) Set 消息要映射为 es 索引中 @timestamp 的字段，如果当前配置为空，则使用消息的时间戳进行映射
void	setDateFormat(String DateFormat) Set Es自定义日期后缀
void	setDocumentIdField(String DocumentIdField) Set 转储到Es中的文档ID取值字段名
void	setDropCls(DropCls DropCls) Set 当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效
void	setDropDlq(FailureParam DropDlq) Set 死信队列
void	setDropInvalidJsonMessage(Boolean DropInvalidJsonMessage) Set Es是否抛弃非json格式的消息
void	setDropInvalidMessage(Boolean DropInvalidMessage) Set Es是否抛弃解析失败的消息
void	setIndex(String Index) Set Es自定义index名称
void	setIndexType(String IndexType) Set Es自定义index名称的类型，STRING，JSONPATH，默认为STRING
void	setPassword(String Password) Set Es密码
void	setPort(Long Port) Set Es的连接port
void	setRecordMappingList(EsRecordMapping[] RecordMappingList) Set 使用数据订阅格式导入 es 时，消息与 es 索引字段映射关系。不填默认为默认字段匹配
void	setRecordMappingMode(String RecordMappingMode) Set 用来区分当前索引映射，属于新建索引还是存量索引。"EXIST_MAPPING"：从存量索引中选择；"NEW_MAPPING"：新建索引
void	setResource(String Resource) Set Es实例资源Id
void	setSelfBuilt(Boolean SelfBuilt) Set 是否为自建集群
void	setServiceVip(String ServiceVip) Set 实例vip
void	setUniqVpcId(String UniqVpcId) Set 实例的vpcId
void	setUserName(String UserName) Set Es用户名
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

EsParam

public EsParam()

EsParam

public EsParam(EsParam 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

getResource

public String getResource()

Get Es实例资源Id

Returns:

Resource Es实例资源Id

setResource

public void setResource(String Resource)

Set Es实例资源Id

Parameters:

Resource - Es实例资源Id

getPort

public Long getPort()

Get Es的连接port

Returns:

Port Es的连接port

setPort

public void setPort(Long Port)

Set Es的连接port

Parameters:

Port - Es的连接port

getUserName

public String getUserName()

Get Es用户名

Returns:

UserName Es用户名

setUserName

public void setUserName(String UserName)

Set Es用户名

Parameters:

UserName - Es用户名

getPassword

public String getPassword()

Get Es密码

Returns:

Password Es密码

setPassword

public void setPassword(String Password)

Set Es密码

Parameters:

Password - Es密码

getSelfBuilt

public Boolean getSelfBuilt()

Get 是否为自建集群

Returns:

SelfBuilt 是否为自建集群

setSelfBuilt

public void setSelfBuilt(Boolean SelfBuilt)

Set 是否为自建集群

Parameters:

SelfBuilt - 是否为自建集群

getServiceVip

public String getServiceVip()

Get 实例vip

Returns:

ServiceVip 实例vip

setServiceVip

public void setServiceVip(String ServiceVip)

Set 实例vip

Parameters:

ServiceVip - 实例vip

getUniqVpcId

public String getUniqVpcId()

Get 实例的vpcId

Returns:

UniqVpcId 实例的vpcId

setUniqVpcId

public void setUniqVpcId(String UniqVpcId)

Set 实例的vpcId

Parameters:

UniqVpcId - 实例的vpcId

getDropInvalidMessage

public Boolean getDropInvalidMessage()

Get Es是否抛弃解析失败的消息

Returns:

DropInvalidMessage Es是否抛弃解析失败的消息

setDropInvalidMessage

public void setDropInvalidMessage(Boolean DropInvalidMessage)

Set Es是否抛弃解析失败的消息

Parameters:

DropInvalidMessage - Es是否抛弃解析失败的消息

getIndex

public String getIndex()

Get Es自定义index名称

Returns:

Index Es自定义index名称

setIndex

public void setIndex(String Index)

Set Es自定义index名称

Parameters:

Index - Es自定义index名称

getDateFormat

public String getDateFormat()

Get Es自定义日期后缀

Returns:

DateFormat Es自定义日期后缀

setDateFormat

public void setDateFormat(String DateFormat)

Set Es自定义日期后缀

Parameters:

DateFormat - Es自定义日期后缀

getContentKey

public String getContentKey()

Get 非json格式数据的自定义key

Returns:

ContentKey 非json格式数据的自定义key

setContentKey

public void setContentKey(String ContentKey)

Set 非json格式数据的自定义key

Parameters:

ContentKey - 非json格式数据的自定义key

getDropInvalidJsonMessage

public Boolean getDropInvalidJsonMessage()

Get Es是否抛弃非json格式的消息

Returns:

DropInvalidJsonMessage Es是否抛弃非json格式的消息

setDropInvalidJsonMessage

public void setDropInvalidJsonMessage(Boolean DropInvalidJsonMessage)

Set Es是否抛弃非json格式的消息

Parameters:

DropInvalidJsonMessage - Es是否抛弃非json格式的消息

getDocumentIdField

public String getDocumentIdField()

Get 转储到Es中的文档ID取值字段名

Returns:

DocumentIdField 转储到Es中的文档ID取值字段名

setDocumentIdField

public void setDocumentIdField(String DocumentIdField)

Set 转储到Es中的文档ID取值字段名

Parameters:

DocumentIdField - 转储到Es中的文档ID取值字段名

getIndexType

public String getIndexType()

Get Es自定义index名称的类型，STRING，JSONPATH，默认为STRING

Returns:

IndexType Es自定义index名称的类型，STRING，JSONPATH，默认为STRING

setIndexType

public void setIndexType(String IndexType)

Set Es自定义index名称的类型，STRING，JSONPATH，默认为STRING

Parameters:

IndexType - Es自定义index名称的类型，STRING，JSONPATH，默认为STRING

getDropCls

public DropCls getDropCls()

Get 当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

Returns:

DropCls 当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

setDropCls

public void setDropCls(DropCls DropCls)

Set 当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

Parameters:

DropCls - 当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

getDatabasePrimaryKey

public String getDatabasePrimaryKey()

Get 转储到ES的消息为Database的binlog时，如果需要同步数据库操作，即增删改的操作到ES时填写数据库表主键

Returns:

DatabasePrimaryKey 转储到ES的消息为Database的binlog时，如果需要同步数据库操作，即增删改的操作到ES时填写数据库表主键

setDatabasePrimaryKey

public void setDatabasePrimaryKey(String DatabasePrimaryKey)

Set 转储到ES的消息为Database的binlog时，如果需要同步数据库操作，即增删改的操作到ES时填写数据库表主键

Parameters:

DatabasePrimaryKey - 转储到ES的消息为Database的binlog时，如果需要同步数据库操作，即增删改的操作到ES时填写数据库表主键

getDropDlq

public FailureParam getDropDlq()

Get 死信队列

Returns:

DropDlq 死信队列

setDropDlq

public void setDropDlq(FailureParam DropDlq)

Set 死信队列

Parameters:

DropDlq - 死信队列

getRecordMappingList

public EsRecordMapping[] getRecordMappingList()

Get 使用数据订阅格式导入 es 时，消息与 es 索引字段映射关系。不填默认为默认字段匹配

Returns:

RecordMappingList 使用数据订阅格式导入 es 时，消息与 es 索引字段映射关系。不填默认为默认字段匹配

setRecordMappingList

public void setRecordMappingList(EsRecordMapping[] RecordMappingList)

Set 使用数据订阅格式导入 es 时，消息与 es 索引字段映射关系。不填默认为默认字段匹配

Parameters:

RecordMappingList - 使用数据订阅格式导入 es 时，消息与 es 索引字段映射关系。不填默认为默认字段匹配

getDateField

public String getDateField()

Get 消息要映射为 es 索引中 @timestamp 的字段，如果当前配置为空，则使用消息的时间戳进行映射

Returns:

DateField 消息要映射为 es 索引中 @timestamp 的字段，如果当前配置为空，则使用消息的时间戳进行映射

setDateField

public void setDateField(String DateField)

Set 消息要映射为 es 索引中 @timestamp 的字段，如果当前配置为空，则使用消息的时间戳进行映射

Parameters:

DateField - 消息要映射为 es 索引中 @timestamp 的字段，如果当前配置为空，则使用消息的时间戳进行映射

getRecordMappingMode

public String getRecordMappingMode()

Get 用来区分当前索引映射，属于新建索引还是存量索引。"EXIST_MAPPING"：从存量索引中选择；"NEW_MAPPING"：新建索引

Returns:

RecordMappingMode 用来区分当前索引映射，属于新建索引还是存量索引。"EXIST_MAPPING"：从存量索引中选择；"NEW_MAPPING"：新建索引

setRecordMappingMode

public void setRecordMappingMode(String RecordMappingMode)

Set 用来区分当前索引映射，属于新建索引还是存量索引。"EXIST_MAPPING"：从存量索引中选择；"NEW_MAPPING"：新建索引

Parameters:

RecordMappingMode - 用来区分当前索引映射，属于新建索引还是存量索引。"EXIST_MAPPING"：从存量索引中选择；"NEW_MAPPING"：新建索引

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.