Class QueueConfig

    • Constructor Summary

      Constructors 
      Constructor Description
      QueueConfig()  
      QueueConfig​(QueueConfig 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 Description
      DataDisk[] getDataDisks()
      Get 节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
      Long getDesiredIdleNodeCapacity()
      Get 队列中期望的空闲节点数量(包含弹性节点和静态节点)。默认值:0。队列中,处于空闲状态的节点小于此值,集群会扩容弹性节点;处于空闲状态的节点大于此值,集群会缩容弹性节点。
      Boolean getEnableAutoExpansion()
      Get 是否开启自动扩容。
      Boolean getEnableAutoShrink()
      Get 是否开启自动缩容。
      ExpansionNodeConfig[] getExpansionNodeConfigs()
      Get 扩容节点配置信息。
      String getImageId()
      Get 指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID,格式形如`img-xxx`。目前仅支持公有镜和特定自定义镜像。
      InternetAccessible getInternetAccessible()
      Get 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
      Long getMaxNodesPerCycle()
      Get 每轮扩容最大节点个数。默认值:100。取值范围:1~100。
      Long getMaxSize()
      Get 队列中弹性节点数量最大值。默认值:10。取值范围:0~200。
      Long getMinSize()
      Get 队列中弹性节点数量最小值。默认值:0。取值范围:0~200。
      String getQueueName()
      Get 队列名称。
      Long getScaleOutNodeThreshold()
      Get 比例扩容阈值。默认值:0。取值范围:0~200。 当作业负载需要扩容节点数量大于此值,当前扩容轮次按照ScaleOutRatio配置的比例进行扩容。当作业负载需要扩容节点数量小于此值,当前扩容轮次扩容当前作业负载所需数量的节点。 此参数配合ScaleOutRatio参数进行使用,用于比例扩容场景下,在作业负载所需节点数量较小时,加快收敛速度。
      Long getScaleOutRatio()
      Get 扩容比例。默认值:100。取值范围:1~100。 如果扩容比例为50,那么每轮只会扩容当前作业负载所需的50%数量的节点。
      Long getScaleUpMemRatio()
      Get 扩容过程中,作业的内存在匹配实例机型时增大比例(不会影响作业提交的内存大小,只影响匹配计算过程)。
      针对场景:由于实例机型的总内存会大于实例内部的可用内存,16GB内存规格的实例,实例操作系统内的可用内存只有约14.9GB内存。假设此时提交一个需要15GB内存的作业, - 当ScaleUpMemRatio=0时,会匹配到16GB内存规格的实例,但是由于操作系统内的可用内存为14.9GB小于作业所需的15GB,扩容出来的实例作业无法运行起来。 - 当ScaleUpMemRatio=10时,匹配实例规格会按照15*(1+10%)=16.5GB来进行实例规格匹配,则不会匹配到16GB的实例,而是更大内存规格的实例来保证作业能够被运行起来。
      SystemDisk getSystemDisk()
      Get 节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
      void setDataDisks​(DataDisk[] DataDisks)
      Set 节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
      void setDesiredIdleNodeCapacity​(Long DesiredIdleNodeCapacity)
      Set 队列中期望的空闲节点数量(包含弹性节点和静态节点)。默认值:0。队列中,处于空闲状态的节点小于此值,集群会扩容弹性节点;处于空闲状态的节点大于此值,集群会缩容弹性节点。
      void setEnableAutoExpansion​(Boolean EnableAutoExpansion)
      Set 是否开启自动扩容。
      void setEnableAutoShrink​(Boolean EnableAutoShrink)
      Set 是否开启自动缩容。
      void setExpansionNodeConfigs​(ExpansionNodeConfig[] ExpansionNodeConfigs)
      Set 扩容节点配置信息。
      void setImageId​(String ImageId)
      Set 指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID,格式形如`img-xxx`。目前仅支持公有镜和特定自定义镜像。
      void setInternetAccessible​(InternetAccessible InternetAccessible)
      Set 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
      void setMaxNodesPerCycle​(Long MaxNodesPerCycle)
      Set 每轮扩容最大节点个数。默认值:100。取值范围:1~100。
      void setMaxSize​(Long MaxSize)
      Set 队列中弹性节点数量最大值。默认值:10。取值范围:0~200。
      void setMinSize​(Long MinSize)
      Set 队列中弹性节点数量最小值。默认值:0。取值范围:0~200。
      void setQueueName​(String QueueName)
      Set 队列名称。
      void setScaleOutNodeThreshold​(Long ScaleOutNodeThreshold)
      Set 比例扩容阈值。默认值:0。取值范围:0~200。 当作业负载需要扩容节点数量大于此值,当前扩容轮次按照ScaleOutRatio配置的比例进行扩容。当作业负载需要扩容节点数量小于此值,当前扩容轮次扩容当前作业负载所需数量的节点。 此参数配合ScaleOutRatio参数进行使用,用于比例扩容场景下,在作业负载所需节点数量较小时,加快收敛速度。
      void setScaleOutRatio​(Long ScaleOutRatio)
      Set 扩容比例。默认值:100。取值范围:1~100。 如果扩容比例为50,那么每轮只会扩容当前作业负载所需的50%数量的节点。
      void setScaleUpMemRatio​(Long ScaleUpMemRatio)
      Set 扩容过程中,作业的内存在匹配实例机型时增大比例(不会影响作业提交的内存大小,只影响匹配计算过程)。
      针对场景:由于实例机型的总内存会大于实例内部的可用内存,16GB内存规格的实例,实例操作系统内的可用内存只有约14.9GB内存。假设此时提交一个需要15GB内存的作业, - 当ScaleUpMemRatio=0时,会匹配到16GB内存规格的实例,但是由于操作系统内的可用内存为14.9GB小于作业所需的15GB,扩容出来的实例作业无法运行起来。 - 当ScaleUpMemRatio=10时,匹配实例规格会按照15*(1+10%)=16.5GB来进行实例规格匹配,则不会匹配到16GB的实例,而是更大内存规格的实例来保证作业能够被运行起来。
      void setSystemDisk​(SystemDisk SystemDisk)
      Set 节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.
    • Constructor Detail

      • QueueConfig

        public QueueConfig()
      • QueueConfig

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

      • getQueueName

        public String getQueueName()
        Get 队列名称。
        Returns:
        QueueName 队列名称。
      • setQueueName

        public void setQueueName​(String QueueName)
        Set 队列名称。
        Parameters:
        QueueName - 队列名称。
      • getMinSize

        public Long getMinSize()
        Get 队列中弹性节点数量最小值。默认值:0。取值范围:0~200。
        Returns:
        MinSize 队列中弹性节点数量最小值。默认值:0。取值范围:0~200。
      • setMinSize

        public void setMinSize​(Long MinSize)
        Set 队列中弹性节点数量最小值。默认值:0。取值范围:0~200。
        Parameters:
        MinSize - 队列中弹性节点数量最小值。默认值:0。取值范围:0~200。
      • getMaxSize

        public Long getMaxSize()
        Get 队列中弹性节点数量最大值。默认值:10。取值范围:0~200。
        Returns:
        MaxSize 队列中弹性节点数量最大值。默认值:10。取值范围:0~200。
      • setMaxSize

        public void setMaxSize​(Long MaxSize)
        Set 队列中弹性节点数量最大值。默认值:10。取值范围:0~200。
        Parameters:
        MaxSize - 队列中弹性节点数量最大值。默认值:10。取值范围:0~200。
      • getEnableAutoExpansion

        public Boolean getEnableAutoExpansion()
        Get 是否开启自动扩容。
        Returns:
        EnableAutoExpansion 是否开启自动扩容。
      • setEnableAutoExpansion

        public void setEnableAutoExpansion​(Boolean EnableAutoExpansion)
        Set 是否开启自动扩容。
        Parameters:
        EnableAutoExpansion - 是否开启自动扩容。
      • getEnableAutoShrink

        public Boolean getEnableAutoShrink()
        Get 是否开启自动缩容。
        Returns:
        EnableAutoShrink 是否开启自动缩容。
      • setEnableAutoShrink

        public void setEnableAutoShrink​(Boolean EnableAutoShrink)
        Set 是否开启自动缩容。
        Parameters:
        EnableAutoShrink - 是否开启自动缩容。
      • getImageId

        public String getImageId()
        Get 指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID,格式形如`img-xxx`。目前仅支持公有镜和特定自定义镜像。
        Returns:
        ImageId 指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID,格式形如`img-xxx`。目前仅支持公有镜和特定自定义镜像。
      • setImageId

        public void setImageId​(String ImageId)
        Set 指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID,格式形如`img-xxx`。目前仅支持公有镜和特定自定义镜像。
        Parameters:
        ImageId - 指定有效的[镜像](https://cloud.tencent.com/document/product/213/4940)ID,格式形如`img-xxx`。目前仅支持公有镜和特定自定义镜像。
      • getSystemDisk

        public SystemDisk getSystemDisk()
        Get 节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
        Returns:
        SystemDisk 节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
      • setSystemDisk

        public void setSystemDisk​(SystemDisk SystemDisk)
        Set 节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
        Parameters:
        SystemDisk - 节点系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
      • getDataDisks

        public DataDisk[] getDataDisks()
        Get 节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
        Returns:
        DataDisks 节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
      • setDataDisks

        public void setDataDisks​(DataDisk[] DataDisks)
        Set 节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
        Parameters:
        DataDisks - 节点数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
      • getInternetAccessible

        public InternetAccessible getInternetAccessible()
        Get 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
        Returns:
        InternetAccessible 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
      • setInternetAccessible

        public void setInternetAccessible​(InternetAccessible InternetAccessible)
        Set 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
        Parameters:
        InternetAccessible - 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
      • getExpansionNodeConfigs

        public ExpansionNodeConfig[] getExpansionNodeConfigs()
        Get 扩容节点配置信息。
        Returns:
        ExpansionNodeConfigs 扩容节点配置信息。
      • setExpansionNodeConfigs

        public void setExpansionNodeConfigs​(ExpansionNodeConfig[] ExpansionNodeConfigs)
        Set 扩容节点配置信息。
        Parameters:
        ExpansionNodeConfigs - 扩容节点配置信息。
      • getDesiredIdleNodeCapacity

        public Long getDesiredIdleNodeCapacity()
        Get 队列中期望的空闲节点数量(包含弹性节点和静态节点)。默认值:0。队列中,处于空闲状态的节点小于此值,集群会扩容弹性节点;处于空闲状态的节点大于此值,集群会缩容弹性节点。
        Returns:
        DesiredIdleNodeCapacity 队列中期望的空闲节点数量(包含弹性节点和静态节点)。默认值:0。队列中,处于空闲状态的节点小于此值,集群会扩容弹性节点;处于空闲状态的节点大于此值,集群会缩容弹性节点。
      • setDesiredIdleNodeCapacity

        public void setDesiredIdleNodeCapacity​(Long DesiredIdleNodeCapacity)
        Set 队列中期望的空闲节点数量(包含弹性节点和静态节点)。默认值:0。队列中,处于空闲状态的节点小于此值,集群会扩容弹性节点;处于空闲状态的节点大于此值,集群会缩容弹性节点。
        Parameters:
        DesiredIdleNodeCapacity - 队列中期望的空闲节点数量(包含弹性节点和静态节点)。默认值:0。队列中,处于空闲状态的节点小于此值,集群会扩容弹性节点;处于空闲状态的节点大于此值,集群会缩容弹性节点。
      • getScaleOutRatio

        public Long getScaleOutRatio()
        Get 扩容比例。默认值:100。取值范围:1~100。 如果扩容比例为50,那么每轮只会扩容当前作业负载所需的50%数量的节点。
        Returns:
        ScaleOutRatio 扩容比例。默认值:100。取值范围:1~100。 如果扩容比例为50,那么每轮只会扩容当前作业负载所需的50%数量的节点。
      • setScaleOutRatio

        public void setScaleOutRatio​(Long ScaleOutRatio)
        Set 扩容比例。默认值:100。取值范围:1~100。 如果扩容比例为50,那么每轮只会扩容当前作业负载所需的50%数量的节点。
        Parameters:
        ScaleOutRatio - 扩容比例。默认值:100。取值范围:1~100。 如果扩容比例为50,那么每轮只会扩容当前作业负载所需的50%数量的节点。
      • getScaleOutNodeThreshold

        public Long getScaleOutNodeThreshold()
        Get 比例扩容阈值。默认值:0。取值范围:0~200。 当作业负载需要扩容节点数量大于此值,当前扩容轮次按照ScaleOutRatio配置的比例进行扩容。当作业负载需要扩容节点数量小于此值,当前扩容轮次扩容当前作业负载所需数量的节点。 此参数配合ScaleOutRatio参数进行使用,用于比例扩容场景下,在作业负载所需节点数量较小时,加快收敛速度。
        Returns:
        ScaleOutNodeThreshold 比例扩容阈值。默认值:0。取值范围:0~200。 当作业负载需要扩容节点数量大于此值,当前扩容轮次按照ScaleOutRatio配置的比例进行扩容。当作业负载需要扩容节点数量小于此值,当前扩容轮次扩容当前作业负载所需数量的节点。 此参数配合ScaleOutRatio参数进行使用,用于比例扩容场景下,在作业负载所需节点数量较小时,加快收敛速度。
      • setScaleOutNodeThreshold

        public void setScaleOutNodeThreshold​(Long ScaleOutNodeThreshold)
        Set 比例扩容阈值。默认值:0。取值范围:0~200。 当作业负载需要扩容节点数量大于此值,当前扩容轮次按照ScaleOutRatio配置的比例进行扩容。当作业负载需要扩容节点数量小于此值,当前扩容轮次扩容当前作业负载所需数量的节点。 此参数配合ScaleOutRatio参数进行使用,用于比例扩容场景下,在作业负载所需节点数量较小时,加快收敛速度。
        Parameters:
        ScaleOutNodeThreshold - 比例扩容阈值。默认值:0。取值范围:0~200。 当作业负载需要扩容节点数量大于此值,当前扩容轮次按照ScaleOutRatio配置的比例进行扩容。当作业负载需要扩容节点数量小于此值,当前扩容轮次扩容当前作业负载所需数量的节点。 此参数配合ScaleOutRatio参数进行使用,用于比例扩容场景下,在作业负载所需节点数量较小时,加快收敛速度。
      • getMaxNodesPerCycle

        public Long getMaxNodesPerCycle()
        Get 每轮扩容最大节点个数。默认值:100。取值范围:1~100。
        Returns:
        MaxNodesPerCycle 每轮扩容最大节点个数。默认值:100。取值范围:1~100。
      • setMaxNodesPerCycle

        public void setMaxNodesPerCycle​(Long MaxNodesPerCycle)
        Set 每轮扩容最大节点个数。默认值:100。取值范围:1~100。
        Parameters:
        MaxNodesPerCycle - 每轮扩容最大节点个数。默认值:100。取值范围:1~100。
      • getScaleUpMemRatio

        public Long getScaleUpMemRatio()
        Get 扩容过程中,作业的内存在匹配实例机型时增大比例(不会影响作业提交的内存大小,只影响匹配计算过程)。
        针对场景:由于实例机型的总内存会大于实例内部的可用内存,16GB内存规格的实例,实例操作系统内的可用内存只有约14.9GB内存。假设此时提交一个需要15GB内存的作业, - 当ScaleUpMemRatio=0时,会匹配到16GB内存规格的实例,但是由于操作系统内的可用内存为14.9GB小于作业所需的15GB,扩容出来的实例作业无法运行起来。 - 当ScaleUpMemRatio=10时,匹配实例规格会按照15*(1+10%)=16.5GB来进行实例规格匹配,则不会匹配到16GB的实例,而是更大内存规格的实例来保证作业能够被运行起来。
        Returns:
        ScaleUpMemRatio 扩容过程中,作业的内存在匹配实例机型时增大比例(不会影响作业提交的内存大小,只影响匹配计算过程)。
        针对场景:由于实例机型的总内存会大于实例内部的可用内存,16GB内存规格的实例,实例操作系统内的可用内存只有约14.9GB内存。假设此时提交一个需要15GB内存的作业, - 当ScaleUpMemRatio=0时,会匹配到16GB内存规格的实例,但是由于操作系统内的可用内存为14.9GB小于作业所需的15GB,扩容出来的实例作业无法运行起来。 - 当ScaleUpMemRatio=10时,匹配实例规格会按照15*(1+10%)=16.5GB来进行实例规格匹配,则不会匹配到16GB的实例,而是更大内存规格的实例来保证作业能够被运行起来。
      • setScaleUpMemRatio

        public void setScaleUpMemRatio​(Long ScaleUpMemRatio)
        Set 扩容过程中,作业的内存在匹配实例机型时增大比例(不会影响作业提交的内存大小,只影响匹配计算过程)。
        针对场景:由于实例机型的总内存会大于实例内部的可用内存,16GB内存规格的实例,实例操作系统内的可用内存只有约14.9GB内存。假设此时提交一个需要15GB内存的作业, - 当ScaleUpMemRatio=0时,会匹配到16GB内存规格的实例,但是由于操作系统内的可用内存为14.9GB小于作业所需的15GB,扩容出来的实例作业无法运行起来。 - 当ScaleUpMemRatio=10时,匹配实例规格会按照15*(1+10%)=16.5GB来进行实例规格匹配,则不会匹配到16GB的实例,而是更大内存规格的实例来保证作业能够被运行起来。
        Parameters:
        ScaleUpMemRatio - 扩容过程中,作业的内存在匹配实例机型时增大比例(不会影响作业提交的内存大小,只影响匹配计算过程)。
        针对场景:由于实例机型的总内存会大于实例内部的可用内存,16GB内存规格的实例,实例操作系统内的可用内存只有约14.9GB内存。假设此时提交一个需要15GB内存的作业, - 当ScaleUpMemRatio=0时,会匹配到16GB内存规格的实例,但是由于操作系统内的可用内存为14.9GB小于作业所需的15GB,扩容出来的实例作业无法运行起来。 - 当ScaleUpMemRatio=10时,匹配实例规格会按照15*(1+10%)=16.5GB来进行实例规格匹配,则不会匹配到16GB的实例,而是更大内存规格的实例来保证作业能够被运行起来。