Class: TencentCloud::Dts::V20211206::ConfigureSubscribeJobRequest

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20211206/models.rb

Overview

ConfigureSubscribeJob请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(subscribeid = nil, subscribemode = nil, accesstype = nil, endpoints = nil, kafkaconfig = nil, subscribeobjects = nil, protocol = nil, pipelineinfo = nil, extraattr = nil, consumervpcid = nil, consumersubnetid = nil) ⇒ ConfigureSubscribeJobRequest

Returns a new instance of ConfigureSubscribeJobRequest.



645
646
647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/v20211206/models.rb', line 645

def initialize(subscribeid=nil, subscribemode=nil, accesstype=nil, endpoints=nil, kafkaconfig=nil, subscribeobjects=nil, protocol=nil, pipelineinfo=nil, extraattr=nil, consumervpcid=nil, consumersubnetid=nil)
  @SubscribeId = subscribeid
  @SubscribeMode = subscribemode
  @AccessType = accesstype
  @Endpoints = endpoints
  @KafkaConfig = kafkaconfig
  @SubscribeObjects = subscribeobjects
  @Protocol = protocol
  @PipelineInfo = pipelineinfo
  @ExtraAttr = extraattr
  @ConsumerVpcId = consumervpcid
  @ConsumerSubnetId = consumersubnetid
end

Instance Attribute Details

#AccessType ⇒ Object

mysql选填参数：ProcessXA-是否处理XA事务，填true处理，不填或填其他值不处理。 mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream，不填也是默认changeStream。 其他业务暂没有可选参数。

Parameters:

  • SubscribeId: —

    数据订阅实例的 ID，可通过DescribeSyncJobs接口获取。

  • SubscribeMode: —

    数据订阅的类型，当 DatabaseType 不为 mongodb 时，枚举值为：all-全实例更新；dml-数据更新；ddl-结构更新；dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时，枚举值为 all-全实例更新；database-订阅单库；collection-订阅单集合

  • AccessType: —

    源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints: —

    数据库节点信息

  • KafkaConfig: —

    Kafka配置

  • SubscribeObjects: —

    订阅的数据库表信息，当 SubscribeMode 不为 all和ddl 时，SubscribeObjects 为必选参数

  • Protocol: —

    订阅数据格式，如：protobuf、json、avro。注意具体可选值依赖当前链路支持能力，数据格式详情参考官网的消费demo文档

  • PipelineInfo: —

    mongo选填参数：输出聚合设置。

  • ExtraAttr: —

    为业务添加的额外信息。参数名作key，参数值作value。

  • ConsumerVpcId: —

    vpc id

  • ConsumerSubnetId: —

    subnet id



643
644
645
 
# File 'lib/v20211206/models.rb', line 643

def AccessType
  @AccessType
end

#ConsumerSubnetId ⇒ Object

mysql选填参数：ProcessXA-是否处理XA事务，填true处理，不填或填其他值不处理。 mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream，不填也是默认changeStream。 其他业务暂没有可选参数。

Parameters:

  • SubscribeId: —

    数据订阅实例的 ID，可通过DescribeSyncJobs接口获取。

  • SubscribeMode: —

    数据订阅的类型，当 DatabaseType 不为 mongodb 时，枚举值为：all-全实例更新；dml-数据更新；ddl-结构更新；dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时，枚举值为 all-全实例更新；database-订阅单库；collection-订阅单集合

  • AccessType: —

    源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints: —

    数据库节点信息

  • KafkaConfig: —

    Kafka配置

  • SubscribeObjects: —

    订阅的数据库表信息，当 SubscribeMode 不为 all和ddl 时，SubscribeObjects 为必选参数

  • Protocol: —

    订阅数据格式，如：protobuf、json、avro。注意具体可选值依赖当前链路支持能力，数据格式详情参考官网的消费demo文档

  • PipelineInfo: —

    mongo选填参数：输出聚合设置。

  • ExtraAttr: —

    为业务添加的额外信息。参数名作key，参数值作value。

  • ConsumerVpcId: —

    vpc id

  • ConsumerSubnetId: —

    subnet id



643
644
645
 
# File 'lib/v20211206/models.rb', line 643

def ConsumerSubnetId
  @ConsumerSubnetId
end

#ConsumerVpcId ⇒ Object

mysql选填参数：ProcessXA-是否处理XA事务，填true处理，不填或填其他值不处理。 mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream，不填也是默认changeStream。 其他业务暂没有可选参数。

Parameters:

  • SubscribeId: —

    数据订阅实例的 ID，可通过DescribeSyncJobs接口获取。

  • SubscribeMode: —

    数据订阅的类型，当 DatabaseType 不为 mongodb 时，枚举值为：all-全实例更新；dml-数据更新；ddl-结构更新；dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时，枚举值为 all-全实例更新；database-订阅单库；collection-订阅单集合

  • AccessType: —

    源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints: —

    数据库节点信息

  • KafkaConfig: —

    Kafka配置

  • SubscribeObjects: —

    订阅的数据库表信息，当 SubscribeMode 不为 all和ddl 时，SubscribeObjects 为必选参数

  • Protocol: —

    订阅数据格式，如：protobuf、json、avro。注意具体可选值依赖当前链路支持能力，数据格式详情参考官网的消费demo文档

  • PipelineInfo: —

    mongo选填参数：输出聚合设置。

  • ExtraAttr: —

    为业务添加的额外信息。参数名作key，参数值作value。

  • ConsumerVpcId: —

    vpc id

  • ConsumerSubnetId: —

    subnet id



643
644
645
 
# File 'lib/v20211206/models.rb', line 643

def ConsumerVpcId
  @ConsumerVpcId
end

#Endpoints ⇒ Object

mysql选填参数：ProcessXA-是否处理XA事务，填true处理，不填或填其他值不处理。 mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream，不填也是默认changeStream。 其他业务暂没有可选参数。

Parameters:

  • SubscribeId: —

    数据订阅实例的 ID，可通过DescribeSyncJobs接口获取。

  • SubscribeMode: —

    数据订阅的类型，当 DatabaseType 不为 mongodb 时，枚举值为：all-全实例更新；dml-数据更新；ddl-结构更新；dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时，枚举值为 all-全实例更新；database-订阅单库；collection-订阅单集合

  • AccessType: —

    源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints: —

    数据库节点信息

  • KafkaConfig: —

    Kafka配置

  • SubscribeObjects: —

    订阅的数据库表信息，当 SubscribeMode 不为 all和ddl 时，SubscribeObjects 为必选参数

  • Protocol: —

    订阅数据格式，如：protobuf、json、avro。注意具体可选值依赖当前链路支持能力，数据格式详情参考官网的消费demo文档

  • PipelineInfo: —

    mongo选填参数：输出聚合设置。

  • ExtraAttr: —

    为业务添加的额外信息。参数名作key，参数值作value。

  • ConsumerVpcId: —

    vpc id

  • ConsumerSubnetId: —

    subnet id



643
644
645
 
# File 'lib/v20211206/models.rb', line 643

def Endpoints
  @Endpoints
end

#ExtraAttr ⇒ Object

mysql选填参数：ProcessXA-是否处理XA事务，填true处理，不填或填其他值不处理。 mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream，不填也是默认changeStream。 其他业务暂没有可选参数。

Parameters:

  • SubscribeId: —

    数据订阅实例的 ID，可通过DescribeSyncJobs接口获取。

  • SubscribeMode: —

    数据订阅的类型，当 DatabaseType 不为 mongodb 时，枚举值为：all-全实例更新；dml-数据更新；ddl-结构更新；dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时，枚举值为 all-全实例更新；database-订阅单库；collection-订阅单集合

  • AccessType: —

    源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints: —

    数据库节点信息

  • KafkaConfig: —

    Kafka配置

  • SubscribeObjects: —

    订阅的数据库表信息，当 SubscribeMode 不为 all和ddl 时，SubscribeObjects 为必选参数

  • Protocol: —

    订阅数据格式，如：protobuf、json、avro。注意具体可选值依赖当前链路支持能力，数据格式详情参考官网的消费demo文档

  • PipelineInfo: —

    mongo选填参数：输出聚合设置。

  • ExtraAttr: —

    为业务添加的额外信息。参数名作key，参数值作value。

  • ConsumerVpcId: —

    vpc id

  • ConsumerSubnetId: —

    subnet id



643
644
645
 
# File 'lib/v20211206/models.rb', line 643

def ExtraAttr
  @ExtraAttr
end

#KafkaConfig ⇒ Object

mysql选填参数：ProcessXA-是否处理XA事务，填true处理，不填或填其他值不处理。 mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream，不填也是默认changeStream。 其他业务暂没有可选参数。

Parameters:

  • SubscribeId: —

    数据订阅实例的 ID，可通过DescribeSyncJobs接口获取。

  • SubscribeMode: —

    数据订阅的类型，当 DatabaseType 不为 mongodb 时，枚举值为：all-全实例更新；dml-数据更新；ddl-结构更新；dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时，枚举值为 all-全实例更新；database-订阅单库；collection-订阅单集合

  • AccessType: —

    源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints: —

    数据库节点信息

  • KafkaConfig: —

    Kafka配置

  • SubscribeObjects: —

    订阅的数据库表信息，当 SubscribeMode 不为 all和ddl 时，SubscribeObjects 为必选参数

  • Protocol: —

    订阅数据格式，如：protobuf、json、avro。注意具体可选值依赖当前链路支持能力，数据格式详情参考官网的消费demo文档

  • PipelineInfo: —

    mongo选填参数：输出聚合设置。

  • ExtraAttr: —

    为业务添加的额外信息。参数名作key，参数值作value。

  • ConsumerVpcId: —

    vpc id

  • ConsumerSubnetId: —

    subnet id



643
644
645
 
# File 'lib/v20211206/models.rb', line 643

def KafkaConfig
  @KafkaConfig
end

#PipelineInfo ⇒ Object

mysql选填参数：ProcessXA-是否处理XA事务，填true处理，不填或填其他值不处理。 mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream，不填也是默认changeStream。 其他业务暂没有可选参数。

Parameters:

  • SubscribeId: —

    数据订阅实例的 ID，可通过DescribeSyncJobs接口获取。

  • SubscribeMode: —

    数据订阅的类型，当 DatabaseType 不为 mongodb 时，枚举值为：all-全实例更新；dml-数据更新；ddl-结构更新；dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时，枚举值为 all-全实例更新；database-订阅单库；collection-订阅单集合

  • AccessType: —

    源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints: —

    数据库节点信息

  • KafkaConfig: —

    Kafka配置

  • SubscribeObjects: —

    订阅的数据库表信息，当 SubscribeMode 不为 all和ddl 时，SubscribeObjects 为必选参数

  • Protocol: —

    订阅数据格式，如：protobuf、json、avro。注意具体可选值依赖当前链路支持能力，数据格式详情参考官网的消费demo文档

  • PipelineInfo: —

    mongo选填参数：输出聚合设置。

  • ExtraAttr: —

    为业务添加的额外信息。参数名作key，参数值作value。

  • ConsumerVpcId: —

    vpc id

  • ConsumerSubnetId: —

    subnet id



643
644
645
 
# File 'lib/v20211206/models.rb', line 643

def PipelineInfo
  @PipelineInfo
end

#Protocol ⇒ Object

mysql选填参数：ProcessXA-是否处理XA事务，填true处理，不填或填其他值不处理。 mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream，不填也是默认changeStream。 其他业务暂没有可选参数。

Parameters:

  • SubscribeId: —

    数据订阅实例的 ID，可通过DescribeSyncJobs接口获取。

  • SubscribeMode: —

    数据订阅的类型，当 DatabaseType 不为 mongodb 时，枚举值为：all-全实例更新；dml-数据更新；ddl-结构更新；dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时，枚举值为 all-全实例更新；database-订阅单库；collection-订阅单集合

  • AccessType: —

    源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints: —

    数据库节点信息

  • KafkaConfig: —

    Kafka配置

  • SubscribeObjects: —

    订阅的数据库表信息，当 SubscribeMode 不为 all和ddl 时，SubscribeObjects 为必选参数

  • Protocol: —

    订阅数据格式，如：protobuf、json、avro。注意具体可选值依赖当前链路支持能力，数据格式详情参考官网的消费demo文档

  • PipelineInfo: —

    mongo选填参数：输出聚合设置。

  • ExtraAttr: —

    为业务添加的额外信息。参数名作key，参数值作value。

  • ConsumerVpcId: —

    vpc id

  • ConsumerSubnetId: —

    subnet id



643
644
645
 
# File 'lib/v20211206/models.rb', line 643

def Protocol
  @Protocol
end

#SubscribeId ⇒ Object

mysql选填参数：ProcessXA-是否处理XA事务，填true处理，不填或填其他值不处理。 mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream，不填也是默认changeStream。 其他业务暂没有可选参数。

Parameters:

  • SubscribeId: —

    数据订阅实例的 ID，可通过DescribeSyncJobs接口获取。

  • SubscribeMode: —

    数据订阅的类型，当 DatabaseType 不为 mongodb 时，枚举值为：all-全实例更新；dml-数据更新；ddl-结构更新；dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时，枚举值为 all-全实例更新；database-订阅单库；collection-订阅单集合

  • AccessType: —

    源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints: —

    数据库节点信息

  • KafkaConfig: —

    Kafka配置

  • SubscribeObjects: —

    订阅的数据库表信息，当 SubscribeMode 不为 all和ddl 时，SubscribeObjects 为必选参数

  • Protocol: —

    订阅数据格式，如：protobuf、json、avro。注意具体可选值依赖当前链路支持能力，数据格式详情参考官网的消费demo文档

  • PipelineInfo: —

    mongo选填参数：输出聚合设置。

  • ExtraAttr: —

    为业务添加的额外信息。参数名作key，参数值作value。

  • ConsumerVpcId: —

    vpc id

  • ConsumerSubnetId: —

    subnet id



643
644
645
 
# File 'lib/v20211206/models.rb', line 643

def SubscribeId
  @SubscribeId
end

#SubscribeMode ⇒ Object

mysql选填参数：ProcessXA-是否处理XA事务，填true处理，不填或填其他值不处理。 mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream，不填也是默认changeStream。 其他业务暂没有可选参数。

Parameters:

  • SubscribeId: —

    数据订阅实例的 ID，可通过DescribeSyncJobs接口获取。

  • SubscribeMode: —

    数据订阅的类型，当 DatabaseType 不为 mongodb 时，枚举值为：all-全实例更新；dml-数据更新；ddl-结构更新；dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时，枚举值为 all-全实例更新；database-订阅单库；collection-订阅单集合

  • AccessType: —

    源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints: —

    数据库节点信息

  • KafkaConfig: —

    Kafka配置

  • SubscribeObjects: —

    订阅的数据库表信息，当 SubscribeMode 不为 all和ddl 时，SubscribeObjects 为必选参数

  • Protocol: —

    订阅数据格式，如：protobuf、json、avro。注意具体可选值依赖当前链路支持能力，数据格式详情参考官网的消费demo文档

  • PipelineInfo: —

    mongo选填参数：输出聚合设置。

  • ExtraAttr: —

    为业务添加的额外信息。参数名作key，参数值作value。

  • ConsumerVpcId: —

    vpc id

  • ConsumerSubnetId: —

    subnet id



643
644
645
 
# File 'lib/v20211206/models.rb', line 643

def SubscribeMode
  @SubscribeMode
end

#SubscribeObjects ⇒ Object

mysql选填参数：ProcessXA-是否处理XA事务，填true处理，不填或填其他值不处理。 mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream，不填也是默认changeStream。 其他业务暂没有可选参数。

Parameters:

  • SubscribeId: —

    数据订阅实例的 ID，可通过DescribeSyncJobs接口获取。

  • SubscribeMode: —

    数据订阅的类型，当 DatabaseType 不为 mongodb 时，枚举值为：all-全实例更新；dml-数据更新；ddl-结构更新；dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时，枚举值为 all-全实例更新；database-订阅单库；collection-订阅单集合

  • AccessType: —

    源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints: —

    数据库节点信息

  • KafkaConfig: —

    Kafka配置

  • SubscribeObjects: —

    订阅的数据库表信息，当 SubscribeMode 不为 all和ddl 时，SubscribeObjects 为必选参数

  • Protocol: —

    订阅数据格式，如：protobuf、json、avro。注意具体可选值依赖当前链路支持能力，数据格式详情参考官网的消费demo文档

  • PipelineInfo: —

    mongo选填参数：输出聚合设置。

  • ExtraAttr: —

    为业务添加的额外信息。参数名作key，参数值作value。

  • ConsumerVpcId: —

    vpc id

  • ConsumerSubnetId: —

    subnet id



643
644
645
 
# File 'lib/v20211206/models.rb', line 643

def SubscribeObjects
  @SubscribeObjects
end

Instance Method Details

#deserialize(params) ⇒ Object 



659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
 
# File 'lib/v20211206/models.rb', line 659

def deserialize(params)
  @SubscribeId = params['SubscribeId']
  @SubscribeMode = params['SubscribeMode']
  @AccessType = params['AccessType']
  unless params['Endpoints'].nil?
    @Endpoints = []
    params['Endpoints'].each do |i|
      endpointitem_tmp = EndpointItem.new
      endpointitem_tmp.deserialize(i)
      @Endpoints << endpointitem_tmp
    end
  end
  unless params['KafkaConfig'].nil?
    @KafkaConfig = SubscribeKafkaConfig.new
    @KafkaConfig.deserialize(params['KafkaConfig'])
  end
  unless params['SubscribeObjects'].nil?
    @SubscribeObjects = []
    params['SubscribeObjects'].each do |i|
      subscribeobject_tmp = SubscribeObject.new
      subscribeobject_tmp.deserialize(i)
      @SubscribeObjects << subscribeobject_tmp
    end
  end
  @Protocol = params['Protocol']
  unless params['PipelineInfo'].nil?
    @PipelineInfo = []
    params['PipelineInfo'].each do |i|
      pipelineinfo_tmp = PipelineInfo.new
      pipelineinfo_tmp.deserialize(i)
      @PipelineInfo << pipelineinfo_tmp
    end
  end
  unless params['ExtraAttr'].nil?
    @ExtraAttr = []
    params['ExtraAttr'].each do |i|
      keyvaluepairoption_tmp = KeyValuePairOption.new
      keyvaluepairoption_tmp.deserialize(i)
      @ExtraAttr << keyvaluepairoption_tmp
    end
  end
  @ConsumerVpcId = params['ConsumerVpcId']
  @ConsumerSubnetId = params['ConsumerSubnetId']
end