com.obs.services.model

## 类 ListObjectsRequest

- java.lang.Object
- - com.obs.services.model.GenericRequest
  - - com.obs.services.model.ListObjectsRequest

-     public class ListObjectsRequest
      extends GenericRequest

  Parameters in a request for listing objects in a bucket

- - ### 构造器概要

    构造器
    构造器和说明
    `ListObjectsRequest()`
    `ListObjectsRequest(String bucketName)` Constructor
    `ListObjectsRequest(String bucketName, int maxKeys)` Constructor
    `ListObjectsRequest(String bucketName, String prefix, String marker, String delimiter, int maxKeys)` Constructor

  - ### 方法概要

    所有方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `String` | `getBucketName()` Obtain the bucket name.
    `String` | `getDelimiter()` Obtain the character used for grouping object names.
    `int` | `getListTimeout()`
    `String` | `getMarker()` Obtain the start position for listing objects.
    `int` | `getMaxKeys()` Obtain the maximum number of objects to be listed.
    `String` | `getPrefix()` Obtain the object name prefix used for filtering objects to be listed.
    `void` | `setBucketName(String bucketName)` Set the bucket name.
    `void` | `setDelimiter(String delimiter)` Set the character used for grouping object names.
    `void` | `setListTimeout(int listTimeout)`
    `void` | `setMarker(String marker)` Set the start position for listing objects.
    `void` | `setMaxKeys(int maxKeys)` Set the maximum number of objects to be listed.
    `void` | `setPrefix(String prefix)` Set the object name prefix used for filtering objects to be listed.
    `String` | `toString()`

    - ### 从类继承的方法 com.obs.services.model.GenericRequest

      `isRequesterPays, setRequesterPays`

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

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

- - ### 构造器详细资料

    - #### ListObjectsRequest

          public ListObjectsRequest()

    - #### ListObjectsRequest

          public ListObjectsRequest(String bucketName)

      Constructor
      参数:
        `bucketName` - Bucket name

    - #### ListObjectsRequest

          public ListObjectsRequest(String bucketName,
                                    int maxKeys)

      Constructor
      参数:
        `bucketName` - Bucket name
        `maxKeys` - Maximum number of objects to be listed

    - #### ListObjectsRequest

          public ListObjectsRequest(String bucketName,
                                    String prefix,
                                    String marker,
                                    String delimiter,
                                    int maxKeys)

      Constructor
      参数:
        `bucketName` - Bucket name
        `prefix` - Object name prefix, used for filtering objects to be listed
        `marker` - Start position for listing objects
        `delimiter` - Character used for grouping object names
        `maxKeys` - Maximum number of objects to be listed

  - ### 方法详细资料

    - #### getBucketName

          public String getBucketName()

      Obtain the bucket name.
      返回:
        Bucket name

    - #### setBucketName

          public void setBucketName(String bucketName)

      Set the bucket name.
      参数:
        `bucketName` - Bucket name

    - #### getPrefix

          public String getPrefix()

      Obtain the object name prefix used for filtering objects to be listed.
      返回:
        Object name prefix

    - #### setPrefix

          public void setPrefix(String prefix)

      Set the object name prefix used for filtering objects to be listed.
      参数:
        `prefix` - Object name prefix

    - #### getMarker

          public String getMarker()

      Obtain the start position for listing objects.
      返回:
        Start position marker

    - #### setMarker

          public void setMarker(String marker)

      Set the start position for listing objects.
      参数:
        `marker` - Start position marker

    - #### getMaxKeys

          public int getMaxKeys()

      Obtain the maximum number of objects to be listed.
      返回:
        Maximum number of objects to be listed

    - #### setMaxKeys

          public void setMaxKeys(int maxKeys)

      Set the maximum number of objects to be listed.
      参数:
        `maxKeys` - Maximum number of objects to be listed

    - #### getDelimiter

          public String getDelimiter()

      Obtain the character used for grouping object names.
      返回:
        Character for grouping object names

    - #### setDelimiter

          public void setDelimiter(String delimiter)

      Set the character used for grouping object names.
      参数:
        `delimiter` - Character for grouping object names

    - #### getListTimeout

          public int getListTimeout()

    - #### setListTimeout

          public void setListTimeout(int listTimeout)

    - #### toString

          public String toString()

      覆盖:
        `toString` 在类中 `GenericRequest`

Copyright © 2021. All rights reserved.