Package com.tencentcloudapi.ckafka.v20190819.models

Class CreateInstancePostRequest

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Long getBandWidth()
      Get 实例内网峰值带宽。单位 MB/s。标准版需传入当前实例规格所对应的峰值带宽。注意如果创建的实例为专业版实例，峰值带宽，分区数等参数配置需要满足专业版的计费规格。
      Long getClusterId()
      Get 创建实例时可以选择集群Id, 该入参表示集群Id。不指定实例所在集群则不传入该参数
      Long getDiskSize()
      Get 实例硬盘大小，需要满足当前实例的计费规格
      String getDiskType()
      Get 专业版实例磁盘类型，标准版实例不需要填写。"CLOUD_SSD"：SSD云硬盘；"CLOUD_BASIC"：高性能云硬盘。不传默认值为 "CLOUD_BASIC"
      String getInstanceName()
      Get 实例名称，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
      Long getInstanceNum()
      Get 购买实例数量。非必填，默认值为 1。当传入该参数时，会创建多个 instanceName 加后缀区分的实例
      Long getInstanceType()
      Get 国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格，国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 1 即可。国际站标准版实例：入门型(general)]填写1；[标准型(standard)]填写2；[进阶型(advanced)]填写3；[容量型(capacity)]填写4；[高阶型1(specialized-1)]填写5；[高阶型2(specialized-2)]填写6；[高阶型3(specialized-3)]填写7；[高阶型4(specialized-4)]填写8。
      String getKafkaVersion()
      Get 实例版本。目前支持 "0.10.2","1.1.1","2.4.1","2.4.2","2.8.1"。"2.4.1" 与 "2.4.2" 属于同一个版本，传任意一个均可。
      Long getMsgRetentionTime()
      Get 实例日志的默认最长保留时间，单位分钟。不传入该参数时默认为 1440 分钟（1天），最大30天。当 topic 显式设置消息保留时间时，以 topic 保留时间为准
      Boolean getMultiZoneFlag()
      Get 当前实例是否为多可用区实例。
      Long getPartition()
      Get 实例最大分区数量，需要满足当前实例的计费规格
      Long getPublicNetworkMonthly()
      Get 公网带宽大小，单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽，此处传 0；总共需要 6Mbps 公网带宽，此处传 3。需要保证传入参数为 3 的整数倍
      String getSpecificationsType()
      Get 实例类型。"standard"：标准版，"profession"：专业版
      String getSubnetId()
      Get 子网id。创建实例默认接入点所在的子网对应的子网 id
      Long getTopicNum()
      Get 实例最大 topic 数量，需要满足当前实例的计费规格
      String getVpcId()
      Get 创建的实例默认接入点所在的 vpc 对应 vpcId。目前不支持创建基础网络实例，因此该参数必填
      Long getZoneId()
      Get 实例所在的可用区。当创建多可用区实例时，该参数为创建的默认接入点所在子网的可用区 id
      Long[] getZoneIds()
      Get 当实例为多可用区实例时，多可用区 id 列表。注意参数 ZoneId 对应的多可用区需要包含在该参数数组中
      void setBandWidth​(Long BandWidth)
      Set 实例内网峰值带宽。单位 MB/s。标准版需传入当前实例规格所对应的峰值带宽。注意如果创建的实例为专业版实例，峰值带宽，分区数等参数配置需要满足专业版的计费规格。
      void setClusterId​(Long ClusterId)
      Set 创建实例时可以选择集群Id, 该入参表示集群Id。不指定实例所在集群则不传入该参数
      void setDiskSize​(Long DiskSize)
      Set 实例硬盘大小，需要满足当前实例的计费规格
      void setDiskType​(String DiskType)
      Set 专业版实例磁盘类型，标准版实例不需要填写。"CLOUD_SSD"：SSD云硬盘；"CLOUD_BASIC"：高性能云硬盘。不传默认值为 "CLOUD_BASIC"
      void setInstanceName​(String InstanceName)
      Set 实例名称，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
      void setInstanceNum​(Long InstanceNum)
      Set 购买实例数量。非必填，默认值为 1。当传入该参数时，会创建多个 instanceName 加后缀区分的实例
      void setInstanceType​(Long InstanceType)
      Set 国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格，国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 1 即可。国际站标准版实例：入门型(general)]填写1；[标准型(standard)]填写2；[进阶型(advanced)]填写3；[容量型(capacity)]填写4；[高阶型1(specialized-1)]填写5；[高阶型2(specialized-2)]填写6；[高阶型3(specialized-3)]填写7；[高阶型4(specialized-4)]填写8。
      void setKafkaVersion​(String KafkaVersion)
      Set 实例版本。目前支持 "0.10.2","1.1.1","2.4.1","2.4.2","2.8.1"。"2.4.1" 与 "2.4.2" 属于同一个版本，传任意一个均可。
      void setMsgRetentionTime​(Long MsgRetentionTime)
      Set 实例日志的默认最长保留时间，单位分钟。不传入该参数时默认为 1440 分钟（1天），最大30天。当 topic 显式设置消息保留时间时，以 topic 保留时间为准
      void setMultiZoneFlag​(Boolean MultiZoneFlag)
      Set 当前实例是否为多可用区实例。
      void setPartition​(Long Partition)
      Set 实例最大分区数量，需要满足当前实例的计费规格
      void setPublicNetworkMonthly​(Long PublicNetworkMonthly)
      Set 公网带宽大小，单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽，此处传 0；总共需要 6Mbps 公网带宽，此处传 3。需要保证传入参数为 3 的整数倍
      void setSpecificationsType​(String SpecificationsType)
      Set 实例类型。"standard"：标准版，"profession"：专业版
      void setSubnetId​(String SubnetId)
      Set 子网id。创建实例默认接入点所在的子网对应的子网 id
      void setTopicNum​(Long TopicNum)
      Set 实例最大 topic 数量，需要满足当前实例的计费规格
      void setVpcId​(String VpcId)
      Set 创建的实例默认接入点所在的 vpc 对应 vpcId。目前不支持创建基础网络实例，因此该参数必填
      void setZoneId​(Long ZoneId)
      Set 实例所在的可用区。当创建多可用区实例时，该参数为创建的默认接入点所在子网的可用区 id
      void setZoneIds​(Long[] ZoneIds)
      Set 当实例为多可用区实例时，多可用区 id 列表。注意参数 ZoneId 对应的多可用区需要包含在该参数数组中
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • Constructor Detail

      • CreateInstancePostRequest

        public CreateInstancePostRequest()

      • CreateInstancePostRequest

        public CreateInstancePostRequest​(CreateInstancePostRequest 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

      • getInstanceName

        public String getInstanceName()
        Get 实例名称，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
        Returns:
        InstanceName 实例名称，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)

      • setInstanceName

        public void setInstanceName​(String InstanceName)
        Set 实例名称，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
        Parameters:
        InstanceName - 实例名称，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)

      • getBandWidth

        public Long getBandWidth()
        Get 实例内网峰值带宽。单位 MB/s。标准版需传入当前实例规格所对应的峰值带宽。注意如果创建的实例为专业版实例，峰值带宽，分区数等参数配置需要满足专业版的计费规格。
        Returns:
        BandWidth 实例内网峰值带宽。单位 MB/s。标准版需传入当前实例规格所对应的峰值带宽。注意如果创建的实例为专业版实例，峰值带宽，分区数等参数配置需要满足专业版的计费规格。

      • setBandWidth

        public void setBandWidth​(Long BandWidth)
        Set 实例内网峰值带宽。单位 MB/s。标准版需传入当前实例规格所对应的峰值带宽。注意如果创建的实例为专业版实例，峰值带宽，分区数等参数配置需要满足专业版的计费规格。
        Parameters:
        BandWidth - 实例内网峰值带宽。单位 MB/s。标准版需传入当前实例规格所对应的峰值带宽。注意如果创建的实例为专业版实例，峰值带宽，分区数等参数配置需要满足专业版的计费规格。

      • getVpcId

        public String getVpcId()
        Get 创建的实例默认接入点所在的 vpc 对应 vpcId。目前不支持创建基础网络实例，因此该参数必填
        Returns:
        VpcId 创建的实例默认接入点所在的 vpc 对应 vpcId。目前不支持创建基础网络实例，因此该参数必填

      • setVpcId

        public void setVpcId​(String VpcId)
        Set 创建的实例默认接入点所在的 vpc 对应 vpcId。目前不支持创建基础网络实例，因此该参数必填
        Parameters:
        VpcId - 创建的实例默认接入点所在的 vpc 对应 vpcId。目前不支持创建基础网络实例，因此该参数必填

      • getSubnetId

        public String getSubnetId()
        Get 子网id。创建实例默认接入点所在的子网对应的子网 id
        Returns:
        SubnetId 子网id。创建实例默认接入点所在的子网对应的子网 id

      • setSubnetId

        public void setSubnetId​(String SubnetId)
        Set 子网id。创建实例默认接入点所在的子网对应的子网 id
        Parameters:
        SubnetId - 子网id。创建实例默认接入点所在的子网对应的子网 id

      • getInstanceType

        public Long getInstanceType()
        Get 国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格，国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 1 即可。国际站标准版实例：入门型(general)]填写1；[标准型(standard)]填写2；[进阶型(advanced)]填写3；[容量型(capacity)]填写4；[高阶型1(specialized-1)]填写5；[高阶型2(specialized-2)]填写6；[高阶型3(specialized-3)]填写7；[高阶型4(specialized-4)]填写8。
        Returns:
        InstanceType 国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格，国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 1 即可。国际站标准版实例：入门型(general)]填写1；[标准型(standard)]填写2；[进阶型(advanced)]填写3；[容量型(capacity)]填写4；[高阶型1(specialized-1)]填写5；[高阶型2(specialized-2)]填写6；[高阶型3(specialized-3)]填写7；[高阶型4(specialized-4)]填写8。

      • setInstanceType

        public void setInstanceType​(Long InstanceType)
        Set 国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格，国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 1 即可。国际站标准版实例：入门型(general)]填写1；[标准型(standard)]填写2；[进阶型(advanced)]填写3；[容量型(capacity)]填写4；[高阶型1(specialized-1)]填写5；[高阶型2(specialized-2)]填写6；[高阶型3(specialized-3)]填写7；[高阶型4(specialized-4)]填写8。
        Parameters:
        InstanceType - 国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格，国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 1 即可。国际站标准版实例：入门型(general)]填写1；[标准型(standard)]填写2；[进阶型(advanced)]填写3；[容量型(capacity)]填写4；[高阶型1(specialized-1)]填写5；[高阶型2(specialized-2)]填写6；[高阶型3(specialized-3)]填写7；[高阶型4(specialized-4)]填写8。

      • getMsgRetentionTime

        public Long getMsgRetentionTime()
        Get 实例日志的默认最长保留时间，单位分钟。不传入该参数时默认为 1440 分钟（1天），最大30天。当 topic 显式设置消息保留时间时，以 topic 保留时间为准
        Returns:
        MsgRetentionTime 实例日志的默认最长保留时间，单位分钟。不传入该参数时默认为 1440 分钟（1天），最大30天。当 topic 显式设置消息保留时间时，以 topic 保留时间为准

      • setMsgRetentionTime

        public void setMsgRetentionTime​(Long MsgRetentionTime)
        Set 实例日志的默认最长保留时间，单位分钟。不传入该参数时默认为 1440 分钟（1天），最大30天。当 topic 显式设置消息保留时间时，以 topic 保留时间为准
        Parameters:
        MsgRetentionTime - 实例日志的默认最长保留时间，单位分钟。不传入该参数时默认为 1440 分钟（1天），最大30天。当 topic 显式设置消息保留时间时，以 topic 保留时间为准

      • getClusterId

        public Long getClusterId()
        Get 创建实例时可以选择集群Id, 该入参表示集群Id。不指定实例所在集群则不传入该参数
        Returns:
        ClusterId 创建实例时可以选择集群Id, 该入参表示集群Id。不指定实例所在集群则不传入该参数

      • setClusterId

        public void setClusterId​(Long ClusterId)
        Set 创建实例时可以选择集群Id, 该入参表示集群Id。不指定实例所在集群则不传入该参数
        Parameters:
        ClusterId - 创建实例时可以选择集群Id, 该入参表示集群Id。不指定实例所在集群则不传入该参数

      • getKafkaVersion

        public String getKafkaVersion()
        Get 实例版本。目前支持 "0.10.2","1.1.1","2.4.1","2.4.2","2.8.1"。"2.4.1" 与 "2.4.2" 属于同一个版本，传任意一个均可。
        Returns:
        KafkaVersion 实例版本。目前支持 "0.10.2","1.1.1","2.4.1","2.4.2","2.8.1"。"2.4.1" 与 "2.4.2" 属于同一个版本，传任意一个均可。

      • setKafkaVersion

        public void setKafkaVersion​(String KafkaVersion)
        Set 实例版本。目前支持 "0.10.2","1.1.1","2.4.1","2.4.2","2.8.1"。"2.4.1" 与 "2.4.2" 属于同一个版本，传任意一个均可。
        Parameters:
        KafkaVersion - 实例版本。目前支持 "0.10.2","1.1.1","2.4.1","2.4.2","2.8.1"。"2.4.1" 与 "2.4.2" 属于同一个版本，传任意一个均可。

      • getSpecificationsType

        public String getSpecificationsType()
        Get 实例类型。"standard"：标准版，"profession"：专业版
        Returns:
        SpecificationsType 实例类型。"standard"：标准版，"profession"：专业版

      • setSpecificationsType

        public void setSpecificationsType​(String SpecificationsType)
        Set 实例类型。"standard"：标准版，"profession"：专业版
        Parameters:
        SpecificationsType - 实例类型。"standard"：标准版，"profession"：专业版

      • getDiskType

        public String getDiskType()
        Get 专业版实例磁盘类型，标准版实例不需要填写。"CLOUD_SSD"：SSD云硬盘；"CLOUD_BASIC"：高性能云硬盘。不传默认值为 "CLOUD_BASIC"
        Returns:
        DiskType 专业版实例磁盘类型，标准版实例不需要填写。"CLOUD_SSD"：SSD云硬盘；"CLOUD_BASIC"：高性能云硬盘。不传默认值为 "CLOUD_BASIC"

      • setDiskType

        public void setDiskType​(String DiskType)
        Set 专业版实例磁盘类型，标准版实例不需要填写。"CLOUD_SSD"：SSD云硬盘；"CLOUD_BASIC"：高性能云硬盘。不传默认值为 "CLOUD_BASIC"
        Parameters:
        DiskType - 专业版实例磁盘类型，标准版实例不需要填写。"CLOUD_SSD"：SSD云硬盘；"CLOUD_BASIC"：高性能云硬盘。不传默认值为 "CLOUD_BASIC"

      • getDiskSize

        public Long getDiskSize()
        Get 实例硬盘大小，需要满足当前实例的计费规格
        Returns:
        DiskSize 实例硬盘大小，需要满足当前实例的计费规格

      • setDiskSize

        public void setDiskSize​(Long DiskSize)
        Set 实例硬盘大小，需要满足当前实例的计费规格
        Parameters:
        DiskSize - 实例硬盘大小，需要满足当前实例的计费规格

      • getPartition

        public Long getPartition()
        Get 实例最大分区数量，需要满足当前实例的计费规格
        Returns:
        Partition 实例最大分区数量，需要满足当前实例的计费规格

      • setPartition

        public void setPartition​(Long Partition)
        Set 实例最大分区数量，需要满足当前实例的计费规格
        Parameters:
        Partition - 实例最大分区数量，需要满足当前实例的计费规格

      • getTopicNum

        public Long getTopicNum()
        Get 实例最大 topic 数量，需要满足当前实例的计费规格
        Returns:
        TopicNum 实例最大 topic 数量，需要满足当前实例的计费规格

      • setTopicNum

        public void setTopicNum​(Long TopicNum)
        Set 实例最大 topic 数量，需要满足当前实例的计费规格
        Parameters:
        TopicNum - 实例最大 topic 数量，需要满足当前实例的计费规格

      • getZoneId

        public Long getZoneId()
        Get 实例所在的可用区。当创建多可用区实例时，该参数为创建的默认接入点所在子网的可用区 id
        Returns:
        ZoneId 实例所在的可用区。当创建多可用区实例时，该参数为创建的默认接入点所在子网的可用区 id

      • setZoneId

        public void setZoneId​(Long ZoneId)
        Set 实例所在的可用区。当创建多可用区实例时，该参数为创建的默认接入点所在子网的可用区 id
        Parameters:
        ZoneId - 实例所在的可用区。当创建多可用区实例时，该参数为创建的默认接入点所在子网的可用区 id

      • getMultiZoneFlag

        public Boolean getMultiZoneFlag()
        Get 当前实例是否为多可用区实例。
        Returns:
        MultiZoneFlag 当前实例是否为多可用区实例。

      • setMultiZoneFlag

        public void setMultiZoneFlag​(Boolean MultiZoneFlag)
        Set 当前实例是否为多可用区实例。
        Parameters:
        MultiZoneFlag - 当前实例是否为多可用区实例。

      • getZoneIds

        public Long[] getZoneIds()
        Get 当实例为多可用区实例时，多可用区 id 列表。注意参数 ZoneId 对应的多可用区需要包含在该参数数组中
        Returns:
        ZoneIds 当实例为多可用区实例时，多可用区 id 列表。注意参数 ZoneId 对应的多可用区需要包含在该参数数组中

      • setZoneIds

        public void setZoneIds​(Long[] ZoneIds)
        Set 当实例为多可用区实例时，多可用区 id 列表。注意参数 ZoneId 对应的多可用区需要包含在该参数数组中
        Parameters:
        ZoneIds - 当实例为多可用区实例时，多可用区 id 列表。注意参数 ZoneId 对应的多可用区需要包含在该参数数组中

      • getInstanceNum

        public Long getInstanceNum()
        Get 购买实例数量。非必填，默认值为 1。当传入该参数时，会创建多个 instanceName 加后缀区分的实例
        Returns:
        InstanceNum 购买实例数量。非必填，默认值为 1。当传入该参数时，会创建多个 instanceName 加后缀区分的实例

      • setInstanceNum

        public void setInstanceNum​(Long InstanceNum)
        Set 购买实例数量。非必填，默认值为 1。当传入该参数时，会创建多个 instanceName 加后缀区分的实例
        Parameters:
        InstanceNum - 购买实例数量。非必填，默认值为 1。当传入该参数时，会创建多个 instanceName 加后缀区分的实例

      • getPublicNetworkMonthly

        public Long getPublicNetworkMonthly()
        Get 公网带宽大小，单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽，此处传 0；总共需要 6Mbps 公网带宽，此处传 3。需要保证传入参数为 3 的整数倍
        Returns:
        PublicNetworkMonthly 公网带宽大小，单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽，此处传 0；总共需要 6Mbps 公网带宽，此处传 3。需要保证传入参数为 3 的整数倍

      • setPublicNetworkMonthly

        public void setPublicNetworkMonthly​(Long PublicNetworkMonthly)
        Set 公网带宽大小，单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽，此处传 0；总共需要 6Mbps 公网带宽，此处传 3。需要保证传入参数为 3 的整数倍
        Parameters:
        PublicNetworkMonthly - 公网带宽大小，单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽，此处传 0；总共需要 6Mbps 公网带宽，此处传 3。需要保证传入参数为 3 的整数倍