Package com.tencentcloudapi.gaap.v20180529.models

Class DescribeProxiesRequest

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Filter[] getFilters()
      Get 过滤条件。 每次请求的Filters的上限为10，Filter.Values的上限为5。参数不支持同时指定InstanceIds和Filters。 ProjectId - String - 是否必填：否 -（过滤条件）按照项目ID过滤。 AccessRegion - String - 是否必填：否 - （过滤条件）按照接入地域过滤。 RealServerRegion - String - 是否必填：否 - （过滤条件）按照源站地域过滤。 GroupId - String - 是否必填：否 - （过滤条件）按照通道组ID过滤。 IPAddressVersion - String - 是否必填：否 - （过滤条件）按照IP版本过滤。 PackageType - String - 是否必填：否 - （过滤条件）按照通道套餐类型过滤。
      Long getIndependent()
      Get 当该字段为1时，仅拉取非通道组的通道， 当该字段为0时，仅拉取通道组的通道， 不存在该字段时，拉取所有通道，包括独立通道和通道组通道。
      String[] getInstanceIds()
      Get （旧参数，请切换到ProxyIds）按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。
      Long getLimit()
      Get 返回数量，默认为20，最大值为100。
      Long getOffset()
      Get 偏移量，默认为0。
      String getOrder()
      Get 输出通道列表的排列顺序。取值范围： asc：升序排列； desc：降序排列。 默认为降序。
      String getOrderField()
      Get 通道列表排序的依据字段。取值范围： create_time：依据通道的创建时间排序； proxy_id：依据通道的ID排序； bandwidth：依据通道带宽上限排序； concurrent_connections：依据通道并发排序； 默认按通道创建时间排序。
      String[] getProxyIds()
      Get （新参数，替代InstanceIds）按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。
      TagPair[] getTagSet()
      Get 标签列表，当存在该字段时，拉取对应标签下的资源列表。 最多支持5个标签，当存在两个或两个以上的标签时，满足其中任意一个标签时，通道会被拉取出来。
      void setFilters​(Filter[] Filters)
      Set 过滤条件。 每次请求的Filters的上限为10，Filter.Values的上限为5。参数不支持同时指定InstanceIds和Filters。 ProjectId - String - 是否必填：否 -（过滤条件）按照项目ID过滤。 AccessRegion - String - 是否必填：否 - （过滤条件）按照接入地域过滤。 RealServerRegion - String - 是否必填：否 - （过滤条件）按照源站地域过滤。 GroupId - String - 是否必填：否 - （过滤条件）按照通道组ID过滤。 IPAddressVersion - String - 是否必填：否 - （过滤条件）按照IP版本过滤。 PackageType - String - 是否必填：否 - （过滤条件）按照通道套餐类型过滤。
      void setIndependent​(Long Independent)
      Set 当该字段为1时，仅拉取非通道组的通道， 当该字段为0时，仅拉取通道组的通道， 不存在该字段时，拉取所有通道，包括独立通道和通道组通道。
      void setInstanceIds​(String[] InstanceIds)
      Set （旧参数，请切换到ProxyIds）按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。
      void setLimit​(Long Limit)
      Set 返回数量，默认为20，最大值为100。
      void setOffset​(Long Offset)
      Set 偏移量，默认为0。
      void setOrder​(String Order)
      Set 输出通道列表的排列顺序。取值范围： asc：升序排列； desc：降序排列。 默认为降序。
      void setOrderField​(String OrderField)
      Set 通道列表排序的依据字段。取值范围： create_time：依据通道的创建时间排序； proxy_id：依据通道的ID排序； bandwidth：依据通道带宽上限排序； concurrent_connections：依据通道并发排序； 默认按通道创建时间排序。
      void setProxyIds​(String[] ProxyIds)
      Set （新参数，替代InstanceIds）按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。
      void setTagSet​(TagPair[] TagSet)
      Set 标签列表，当存在该字段时，拉取对应标签下的资源列表。 最多支持5个标签，当存在两个或两个以上的标签时，满足其中任意一个标签时，通道会被拉取出来。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • Constructor Detail

      • DescribeProxiesRequest

        public DescribeProxiesRequest()

      • DescribeProxiesRequest

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

      • getInstanceIds

        public String[] getInstanceIds()
        Get （旧参数，请切换到ProxyIds）按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。
        Returns:
        InstanceIds （旧参数，请切换到ProxyIds）按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。

      • setInstanceIds

        public void setInstanceIds​(String[] InstanceIds)
        Set （旧参数，请切换到ProxyIds）按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。
        Parameters:
        InstanceIds - （旧参数，请切换到ProxyIds）按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。

      • getOffset

        public Long getOffset()
        Get 偏移量，默认为0。
        Returns:
        Offset 偏移量，默认为0。

      • setOffset

        public void setOffset​(Long Offset)
        Set 偏移量，默认为0。
        Parameters:
        Offset - 偏移量，默认为0。

      • getLimit

        public Long getLimit()
        Get 返回数量，默认为20，最大值为100。
        Returns:
        Limit 返回数量，默认为20，最大值为100。

      • setLimit

        public void setLimit​(Long Limit)
        Set 返回数量，默认为20，最大值为100。
        Parameters:
        Limit - 返回数量，默认为20，最大值为100。

      • getFilters

        public Filter[] getFilters()
        Get 过滤条件。 每次请求的Filters的上限为10，Filter.Values的上限为5。参数不支持同时指定InstanceIds和Filters。 ProjectId - String - 是否必填：否 -（过滤条件）按照项目ID过滤。 AccessRegion - String - 是否必填：否 - （过滤条件）按照接入地域过滤。 RealServerRegion - String - 是否必填：否 - （过滤条件）按照源站地域过滤。 GroupId - String - 是否必填：否 - （过滤条件）按照通道组ID过滤。 IPAddressVersion - String - 是否必填：否 - （过滤条件）按照IP版本过滤。 PackageType - String - 是否必填：否 - （过滤条件）按照通道套餐类型过滤。
        Returns:
        Filters 过滤条件。 每次请求的Filters的上限为10，Filter.Values的上限为5。参数不支持同时指定InstanceIds和Filters。 ProjectId - String - 是否必填：否 -（过滤条件）按照项目ID过滤。 AccessRegion - String - 是否必填：否 - （过滤条件）按照接入地域过滤。 RealServerRegion - String - 是否必填：否 - （过滤条件）按照源站地域过滤。 GroupId - String - 是否必填：否 - （过滤条件）按照通道组ID过滤。 IPAddressVersion - String - 是否必填：否 - （过滤条件）按照IP版本过滤。 PackageType - String - 是否必填：否 - （过滤条件）按照通道套餐类型过滤。

      • setFilters

        public void setFilters​(Filter[] Filters)
        Set 过滤条件。 每次请求的Filters的上限为10，Filter.Values的上限为5。参数不支持同时指定InstanceIds和Filters。 ProjectId - String - 是否必填：否 -（过滤条件）按照项目ID过滤。 AccessRegion - String - 是否必填：否 - （过滤条件）按照接入地域过滤。 RealServerRegion - String - 是否必填：否 - （过滤条件）按照源站地域过滤。 GroupId - String - 是否必填：否 - （过滤条件）按照通道组ID过滤。 IPAddressVersion - String - 是否必填：否 - （过滤条件）按照IP版本过滤。 PackageType - String - 是否必填：否 - （过滤条件）按照通道套餐类型过滤。
        Parameters:
        Filters - 过滤条件。 每次请求的Filters的上限为10，Filter.Values的上限为5。参数不支持同时指定InstanceIds和Filters。 ProjectId - String - 是否必填：否 -（过滤条件）按照项目ID过滤。 AccessRegion - String - 是否必填：否 - （过滤条件）按照接入地域过滤。 RealServerRegion - String - 是否必填：否 - （过滤条件）按照源站地域过滤。 GroupId - String - 是否必填：否 - （过滤条件）按照通道组ID过滤。 IPAddressVersion - String - 是否必填：否 - （过滤条件）按照IP版本过滤。 PackageType - String - 是否必填：否 - （过滤条件）按照通道套餐类型过滤。

      • getProxyIds

        public String[] getProxyIds()
        Get （新参数，替代InstanceIds）按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。
        Returns:
        ProxyIds （新参数，替代InstanceIds）按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。

      • setProxyIds

        public void setProxyIds​(String[] ProxyIds)
        Set （新参数，替代InstanceIds）按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。
        Parameters:
        ProxyIds - （新参数，替代InstanceIds）按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。

      • getTagSet

        public TagPair[] getTagSet()
        Get 标签列表，当存在该字段时，拉取对应标签下的资源列表。 最多支持5个标签，当存在两个或两个以上的标签时，满足其中任意一个标签时，通道会被拉取出来。
        Returns:
        TagSet 标签列表，当存在该字段时，拉取对应标签下的资源列表。 最多支持5个标签，当存在两个或两个以上的标签时，满足其中任意一个标签时，通道会被拉取出来。

      • setTagSet

        public void setTagSet​(TagPair[] TagSet)
        Set 标签列表，当存在该字段时，拉取对应标签下的资源列表。 最多支持5个标签，当存在两个或两个以上的标签时，满足其中任意一个标签时，通道会被拉取出来。
        Parameters:
        TagSet - 标签列表，当存在该字段时，拉取对应标签下的资源列表。 最多支持5个标签，当存在两个或两个以上的标签时，满足其中任意一个标签时，通道会被拉取出来。

      • getIndependent

        public Long getIndependent()
        Get 当该字段为1时，仅拉取非通道组的通道， 当该字段为0时，仅拉取通道组的通道， 不存在该字段时，拉取所有通道，包括独立通道和通道组通道。
        Returns:
        Independent 当该字段为1时，仅拉取非通道组的通道， 当该字段为0时，仅拉取通道组的通道， 不存在该字段时，拉取所有通道，包括独立通道和通道组通道。

      • setIndependent

        public void setIndependent​(Long Independent)
        Set 当该字段为1时，仅拉取非通道组的通道， 当该字段为0时，仅拉取通道组的通道， 不存在该字段时，拉取所有通道，包括独立通道和通道组通道。
        Parameters:
        Independent - 当该字段为1时，仅拉取非通道组的通道， 当该字段为0时，仅拉取通道组的通道， 不存在该字段时，拉取所有通道，包括独立通道和通道组通道。

      • getOrder

        public String getOrder()
        Get 输出通道列表的排列顺序。取值范围： asc：升序排列； desc：降序排列。 默认为降序。
        Returns:
        Order 输出通道列表的排列顺序。取值范围： asc：升序排列； desc：降序排列。 默认为降序。

      • setOrder

        public void setOrder​(String Order)
        Set 输出通道列表的排列顺序。取值范围： asc：升序排列； desc：降序排列。 默认为降序。
        Parameters:
        Order - 输出通道列表的排列顺序。取值范围： asc：升序排列； desc：降序排列。 默认为降序。

      • getOrderField

        public String getOrderField()
        Get 通道列表排序的依据字段。取值范围： create_time：依据通道的创建时间排序； proxy_id：依据通道的ID排序； bandwidth：依据通道带宽上限排序； concurrent_connections：依据通道并发排序； 默认按通道创建时间排序。
        Returns:
        OrderField 通道列表排序的依据字段。取值范围： create_time：依据通道的创建时间排序； proxy_id：依据通道的ID排序； bandwidth：依据通道带宽上限排序； concurrent_connections：依据通道并发排序； 默认按通道创建时间排序。

      • setOrderField

        public void setOrderField​(String OrderField)
        Set 通道列表排序的依据字段。取值范围： create_time：依据通道的创建时间排序； proxy_id：依据通道的ID排序； bandwidth：依据通道带宽上限排序； concurrent_connections：依据通道并发排序； 默认按通道创建时间排序。
        Parameters:
        OrderField - 通道列表排序的依据字段。取值范围： create_time：依据通道的创建时间排序； proxy_id：依据通道的ID排序； bandwidth：依据通道带宽上限排序； concurrent_connections：依据通道并发排序； 默认按通道创建时间排序。