com.aliyun.oss.model

## 类 ListBucketsRequest

- java.lang.Object
- - com.aliyun.oss.model.WebServiceRequest
  - - com.aliyun.oss.model.ListBucketsRequest

-     public class ListBucketsRequest
      extends WebServiceRequest

- - ### 字段概要

    字段
    限定符和类型 | 字段和说明
    --- | ---
    `static int` | `MAX_RETURNED_KEYS`

    - ### 从类继承的字段 com.aliyun.oss.model.WebServiceRequest

      `NOOP`

  - ### 构造器概要

    构造器
    构造器和说明
    `ListBucketsRequest()` Constructor.
    `ListBucketsRequest(String prefix, String marker, Integer maxKeys)` Constructor.

  - ### 方法概要

    方法
    限定符和类型 | 方法和说明
    --- | ---
    `String` | `getBid()` Gets the bid.
    `String` | `getMarker()` Gets the marker filter.
    `Integer` | `getMaxKeys()` Gets the max number of buckets to return.
    `String` | `getPrefix()` Gets the prefix filter.
    `String` | `getTagKey()` Gets the tag key.
    `String` | `getTagValue()` Gets the tag value.
    `void` | `setBid(String bid)` Sets the bid。
    `void` | `setMarker(String marker)` Sets the marker filter.
    `void` | `setMaxKeys(Integer maxKeys)` Sets the max number of buckets to return.
    `void` | `setPrefix(String prefix)` Sets the prefix filter.
    `void` | `setTag(String tagKey, String tagValue)` Sets the bucket tag.
    `ListBucketsRequest` | `withMarker(String marker)` Sets the marker filter and return the current ListBucketRequest instance (this).
    `ListBucketsRequest` | `withMaxKeys(Integer maxKeys)` Sets the max number of buckets to return the current ListBucketsRequest instance (this).
    `ListBucketsRequest` | `withPrefix(String prefix)` Sets the prefix filter and return the current ListBucketsRequest instance (this).

    - ### 从类继承的方法 com.aliyun.oss.model.WebServiceRequest

      `addAdditionalHeaderName, addHeader, addParameter, getAdditionalHeaderNames, getHeaders, getParameters, getProgressListener, isLogEnabled, setAdditionalHeaderNames, setHeaders, setLogEnabled, setParameters, setProgressListener, withProgressListener`

    - ### 从类继承的方法 java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### 字段详细资料

    - #### MAX_RETURNED_KEYS

          public static final int MAX_RETURNED_KEYS

      另请参阅:
        常量字段值

  - ### 构造器详细资料

    - #### ListBucketsRequest

          public ListBucketsRequest()

      Constructor.

    - #### ListBucketsRequest

          public ListBucketsRequest(String prefix,
                            String marker,
                            Integer maxKeys)

      Constructor.
      参数:
        `prefix` - Prefix filter, all buckets returned must start with this prefix.
        `marker` - Maker filter, all buckets returned must be greater than the marker.
        `maxKeys` - Max number of buckets to return, by default is 100,

  - ### 方法详细资料

    - #### getPrefix

          public String getPrefix()

      Gets the prefix filter.
      返回:
        The prefix filter.

    - #### setPrefix

          public void setPrefix(String prefix)

      Sets the prefix filter.
      参数:
        `prefix` - The prefix filter.

    - #### withPrefix

          public ListBucketsRequest withPrefix(String prefix)

      Sets the prefix filter and return the current ListBucketsRequest instance (this).
      参数:
        `prefix` - The prefix filter.

    - #### getMarker

          public String getMarker()

      Gets the marker filter.
      返回:
        The marker filter.

    - #### setMarker

          public void setMarker(String marker)

      Sets the marker filter.
      参数:
        `marker` - The marker filter.

    - #### withMarker

          public ListBucketsRequest withMarker(String marker)

      Sets the marker filter and return the current ListBucketRequest instance (this).
      参数:
        `marker` - The marker filter.

    - #### getMaxKeys

          public Integer getMaxKeys()

      Gets the max number of buckets to return. By default it's 100.
      返回:
        The max number of buckets.

    - #### setMaxKeys

          public void setMaxKeys(Integer maxKeys)

      Sets the max number of buckets to return. By default it's 100, the max is 1000.
      参数:
        `maxKeys` - The max number of buckets.

    - #### withMaxKeys

          public ListBucketsRequest withMaxKeys(Integer maxKeys)

      Sets the max number of buckets to return the current ListBucketsRequest instance (this).
      参数:
        `maxKeys` - The max number of buckets.

    - #### setBid

          public void setBid(String bid)

      Sets the bid。
      参数:
        `bid` - bid。

    - #### getBid

          public String getBid()

      Gets the bid.
      返回:
        bid。

    - #### setTag

          public void setTag(String tagKey,
                    String tagValue)

      Sets the bucket tag.

    - #### getTagKey

          public String getTagKey()

      Gets the tag key.
      返回:
        tag key.

    - #### getTagValue

          public String getTagValue()

      Gets the tag value.
      返回:
        tag value.

Copyright © 2020. All Rights Reserved.