Class DescribeModuleRequest

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Filter[] getFilters()
      Get 过滤条件。 module-name - string - 是否必填:否 - (过滤条件)按照模块名称过滤。 module-id - string - 是否必填:否 - (过滤条件)按照模块ID过滤。 image-id String 是否必填:否 (过滤条件)按照镜像ID过滤。 instance-family String 是否必填:否 (过滤条件)按照机型family过滤。 security-group-id - string 是否必填:否 - (过滤条件)按照模块绑定的安全组id过滤。 每次请求的Filters的上限为10,Filter.Values的上限为5。
      Long getLimit()
      Get 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
      Long getOffset()
      Get 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
      String getOrderByField()
      Get 指定排序字段。目前支持的可选值如下 instance-num 按实例数量排序。 node-num 按节点数量排序。 timestamp 按实例创建时间排序。 如果不传,默认按实例创建时间排序
      Long getOrderDirection()
      Get 指定排序是降序还是升序。0表示降序; 1表示升序。如果不传默认为降序
      void setFilters​(Filter[] Filters)
      Set 过滤条件。 module-name - string - 是否必填:否 - (过滤条件)按照模块名称过滤。 module-id - string - 是否必填:否 - (过滤条件)按照模块ID过滤。 image-id String 是否必填:否 (过滤条件)按照镜像ID过滤。 instance-family String 是否必填:否 (过滤条件)按照机型family过滤。 security-group-id - string 是否必填:否 - (过滤条件)按照模块绑定的安全组id过滤。 每次请求的Filters的上限为10,Filter.Values的上限为5。
      void setLimit​(Long Limit)
      Set 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
      void setOffset​(Long Offset)
      Set 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
      void setOrderByField​(String OrderByField)
      Set 指定排序字段。目前支持的可选值如下 instance-num 按实例数量排序。 node-num 按节点数量排序。 timestamp 按实例创建时间排序。 如果不传,默认按实例创建时间排序
      void setOrderDirection​(Long OrderDirection)
      Set 指定排序是降序还是升序。0表示降序; 1表示升序。如果不传默认为降序
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.
    • Constructor Detail

      • DescribeModuleRequest

        public DescribeModuleRequest()
      • DescribeModuleRequest

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

      • getFilters

        public Filter[] getFilters()
        Get 过滤条件。 module-name - string - 是否必填:否 - (过滤条件)按照模块名称过滤。 module-id - string - 是否必填:否 - (过滤条件)按照模块ID过滤。 image-id String 是否必填:否 (过滤条件)按照镜像ID过滤。 instance-family String 是否必填:否 (过滤条件)按照机型family过滤。 security-group-id - string 是否必填:否 - (过滤条件)按照模块绑定的安全组id过滤。 每次请求的Filters的上限为10,Filter.Values的上限为5。
        Returns:
        Filters 过滤条件。 module-name - string - 是否必填:否 - (过滤条件)按照模块名称过滤。 module-id - string - 是否必填:否 - (过滤条件)按照模块ID过滤。 image-id String 是否必填:否 (过滤条件)按照镜像ID过滤。 instance-family String 是否必填:否 (过滤条件)按照机型family过滤。 security-group-id - string 是否必填:否 - (过滤条件)按照模块绑定的安全组id过滤。 每次请求的Filters的上限为10,Filter.Values的上限为5。
      • setFilters

        public void setFilters​(Filter[] Filters)
        Set 过滤条件。 module-name - string - 是否必填:否 - (过滤条件)按照模块名称过滤。 module-id - string - 是否必填:否 - (过滤条件)按照模块ID过滤。 image-id String 是否必填:否 (过滤条件)按照镜像ID过滤。 instance-family String 是否必填:否 (过滤条件)按照机型family过滤。 security-group-id - string 是否必填:否 - (过滤条件)按照模块绑定的安全组id过滤。 每次请求的Filters的上限为10,Filter.Values的上限为5。
        Parameters:
        Filters - 过滤条件。 module-name - string - 是否必填:否 - (过滤条件)按照模块名称过滤。 module-id - string - 是否必填:否 - (过滤条件)按照模块ID过滤。 image-id String 是否必填:否 (过滤条件)按照镜像ID过滤。 instance-family String 是否必填:否 (过滤条件)按照机型family过滤。 security-group-id - string 是否必填:否 - (过滤条件)按照模块绑定的安全组id过滤。 每次请求的Filters的上限为10,Filter.Values的上限为5。
      • getOffset

        public Long getOffset()
        Get 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
        Returns:
        Offset 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
      • setOffset

        public void setOffset​(Long Offset)
        Set 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
        Parameters:
        Offset - 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
      • getLimit

        public Long getLimit()
        Get 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
        Returns:
        Limit 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
      • setLimit

        public void setLimit​(Long Limit)
        Set 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
        Parameters:
        Limit - 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
      • getOrderByField

        public String getOrderByField()
        Get 指定排序字段。目前支持的可选值如下 instance-num 按实例数量排序。 node-num 按节点数量排序。 timestamp 按实例创建时间排序。 如果不传,默认按实例创建时间排序
        Returns:
        OrderByField 指定排序字段。目前支持的可选值如下 instance-num 按实例数量排序。 node-num 按节点数量排序。 timestamp 按实例创建时间排序。 如果不传,默认按实例创建时间排序
      • setOrderByField

        public void setOrderByField​(String OrderByField)
        Set 指定排序字段。目前支持的可选值如下 instance-num 按实例数量排序。 node-num 按节点数量排序。 timestamp 按实例创建时间排序。 如果不传,默认按实例创建时间排序
        Parameters:
        OrderByField - 指定排序字段。目前支持的可选值如下 instance-num 按实例数量排序。 node-num 按节点数量排序。 timestamp 按实例创建时间排序。 如果不传,默认按实例创建时间排序
      • getOrderDirection

        public Long getOrderDirection()
        Get 指定排序是降序还是升序。0表示降序; 1表示升序。如果不传默认为降序
        Returns:
        OrderDirection 指定排序是降序还是升序。0表示降序; 1表示升序。如果不传默认为降序
      • setOrderDirection

        public void setOrderDirection​(Long OrderDirection)
        Set 指定排序是降序还是升序。0表示降序; 1表示升序。如果不传默认为降序
        Parameters:
        OrderDirection - 指定排序是降序还是升序。0表示降序; 1表示升序。如果不传默认为降序