Package com.tencentcloudapi.teo.v20220901.models

Class RulesProperties

    • Constructor Summary

      Constructors 
      Constructor Description
      RulesProperties()  
      RulesProperties​(RulesProperties 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
      RuleChoicePropertiesItem[] getChoiceProperties()
      Get 该参数对应的关联配置参数，属于调用接口的必填参数。 注意：如果可选参数无特殊新增参数则该数组为空数组。
      String[] getChoicesValue()
      Get 参数值的可选值。 注意：若参数值为用户自定义则该数组为空数组。
      RuleExtraParameter getExtraParameter()
      Get 为 NULL：无特殊参数，RuleAction 选择 NormalAction； 注意：此字段可能返回 null，表示取不到有效值。
      Boolean getIsAllowEmpty()
      Get 是否允许为空。
      Boolean getIsMultiple()
      Get 参数值是否支持多选或者填写多个。
      Long getMax()
      Get 数值参数的最大值，非数值参数或 Min 和 Max 值都为 0 则此项无意义。
      Long getMin()
      Get 数值参数的最小值，非数值参数或 Min 和 Max 值都为 0 则此项无意义。
      String getName()
      Get 值为参数名称。
      String getType()
      Get 参数值类型。 CHOICE：参数值只能在 ChoicesValue 中选择； TOGGLE：参数值为开关类型，可在 ChoicesValue 中选择； OBJECT：参数值为对象类型，ChoiceProperties 为改对象类型关联的属性； CUSTOM_NUM：参数值用户自定义，整型类型； CUSTOM_STRING：参数值用户自定义，字符串类型。注意：当参数类型为 OBJECT 类型时，请注意参考 [示例2 参数为 OBJECT 类型的创建](https://tcloud4api.woa.com/document/product/1657/79382?!preview&!document=1)
      void setChoiceProperties​(RuleChoicePropertiesItem[] ChoiceProperties)
      Set 该参数对应的关联配置参数，属于调用接口的必填参数。 注意：如果可选参数无特殊新增参数则该数组为空数组。
      void setChoicesValue​(String[] ChoicesValue)
      Set 参数值的可选值。 注意：若参数值为用户自定义则该数组为空数组。
      void setExtraParameter​(RuleExtraParameter ExtraParameter)
      Set 为 NULL：无特殊参数，RuleAction 选择 NormalAction； 注意：此字段可能返回 null，表示取不到有效值。
      void setIsAllowEmpty​(Boolean IsAllowEmpty)
      Set 是否允许为空。
      void setIsMultiple​(Boolean IsMultiple)
      Set 参数值是否支持多选或者填写多个。
      void setMax​(Long Max)
      Set 数值参数的最大值，非数值参数或 Min 和 Max 值都为 0 则此项无意义。
      void setMin​(Long Min)
      Set 数值参数的最小值，非数值参数或 Min 和 Max 值都为 0 则此项无意义。
      void setName​(String Name)
      Set 值为参数名称。
      void setType​(String Type)
      Set 参数值类型。 CHOICE：参数值只能在 ChoicesValue 中选择； TOGGLE：参数值为开关类型，可在 ChoicesValue 中选择； OBJECT：参数值为对象类型，ChoiceProperties 为改对象类型关联的属性； CUSTOM_NUM：参数值用户自定义，整型类型； CUSTOM_STRING：参数值用户自定义，字符串类型。注意：当参数类型为 OBJECT 类型时，请注意参考 [示例2 参数为 OBJECT 类型的创建](https://tcloud4api.woa.com/document/product/1657/79382?!preview&!document=1)
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • Constructor Detail

      • RulesProperties

        public RulesProperties()

      • RulesProperties

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

      • getName

        public String getName()
        Get 值为参数名称。
        Returns:
        Name 值为参数名称。

      • setName

        public void setName​(String Name)
        Set 值为参数名称。
        Parameters:
        Name - 值为参数名称。

      • getMin

        public Long getMin()
        Get 数值参数的最小值，非数值参数或 Min 和 Max 值都为 0 则此项无意义。
        Returns:
        Min 数值参数的最小值，非数值参数或 Min 和 Max 值都为 0 则此项无意义。

      • setMin

        public void setMin​(Long Min)
        Set 数值参数的最小值，非数值参数或 Min 和 Max 值都为 0 则此项无意义。
        Parameters:
        Min - 数值参数的最小值，非数值参数或 Min 和 Max 值都为 0 则此项无意义。

      • getChoicesValue

        public String[] getChoicesValue()
        Get 参数值的可选值。 注意：若参数值为用户自定义则该数组为空数组。
        Returns:
        ChoicesValue 参数值的可选值。 注意：若参数值为用户自定义则该数组为空数组。

      • setChoicesValue

        public void setChoicesValue​(String[] ChoicesValue)
        Set 参数值的可选值。 注意：若参数值为用户自定义则该数组为空数组。
        Parameters:
        ChoicesValue - 参数值的可选值。 注意：若参数值为用户自定义则该数组为空数组。

      • getType

        public String getType()
        Get 参数值类型。
      • CHOICE：参数值只能在 ChoicesValue 中选择；
      • TOGGLE：参数值为开关类型，可在 ChoicesValue 中选择；
      • OBJECT：参数值为对象类型，ChoiceProperties 为改对象类型关联的属性；
      • CUSTOM_NUM：参数值用户自定义，整型类型；
      • CUSTOM_STRING：参数值用户自定义，字符串类型。
        • 注意：当参数类型为 OBJECT 类型时，请注意参考 [示例2 参数为 OBJECT 类型的创建](https://tcloud4api.woa.com/document/product/1657/79382?!preview&!document=1)
Returns:
Type 参数值类型。
  • CHOICE：参数值只能在 ChoicesValue 中选择；
  • TOGGLE：参数值为开关类型，可在 ChoicesValue 中选择；
  • OBJECT：参数值为对象类型，ChoiceProperties 为改对象类型关联的属性；
  • CUSTOM_NUM：参数值用户自定义，整型类型；
  • CUSTOM_STRING：参数值用户自定义，字符串类型。
    • 注意：当参数类型为 OBJECT 类型时，请注意参考 [示例2 参数为 OBJECT 类型的创建](https://tcloud4api.woa.com/document/product/1657/79382?!preview&!document=1)
    Parameters:
    Type - 参数值类型。
  • CHOICE：参数值只能在 ChoicesValue 中选择；
  • TOGGLE：参数值为开关类型，可在 ChoicesValue 中选择；
  • OBJECT：参数值为对象类型，ChoiceProperties 为改对象类型关联的属性；
  • CUSTOM_NUM：参数值用户自定义，整型类型；
  • CUSTOM_STRING：参数值用户自定义，字符串类型。
    • 注意：当参数类型为 OBJECT 类型时，请注意参考 [示例2 参数为 OBJECT 类型的创建](https://tcloud4api.woa.com/document/product/1657/79382?!preview&!document=1)