com.amazonaws.services.s3.model

## クラス ListMultipartUploadsRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.s3.model.ListMultipartUploadsRequest

-     public class ListMultipartUploadsRequest
      extends AmazonWebServiceRequest

  Container for the parameters of the ListMultipartUploads operation.

  Required Parameters: BucketName

  関連項目:
    `AmazonS3.listMultipartUploads(ListMultipartUploadsRequest)`

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `ListMultipartUploadsRequest(java.lang.String bucketName)` Constructs a new ListMultipartUploadsRequest to list the multipart uploads from the specified bucket.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `java.lang.String` | `getBucketName()` Returns the name of the bucket containing the uploads to list.
    `java.lang.String` | `getDelimiter()` Returns the optional delimiter parameter that causes multipart uploads for keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the `MultipartUploadListing.getCommonPrefixes()` list.
    `java.lang.String` | `getKeyMarker()` Returns the optional key marker indicating where in the results to begin listing.
    `java.lang.Integer` | `getMaxUploads()` Returns the optional maximum number of uploads to return, or null if no maximum number of uploads has been set for this request.
    `java.lang.String` | `getPrefix()` Returns the optional prefix parameter that restricts the response to multipart uploads for keys that begin with the specified prefix.
    `java.lang.String` | `getUploadIdMarker()` Returns the optional upload ID marker indicating where in the results to begin listing.
    `void` | `setBucketName(java.lang.String bucketName)` Sets the name of the bucket containing the multipart uploads to list.
    `void` | `setDelimiter(java.lang.String delimiter)` Sets the optional delimiter parameter that causes multipart uploads for keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the `MultipartUploadListing.getCommonPrefixes()` list.
    `void` | `setKeyMarker(java.lang.String keyMarker)` Sets the optional key marker indicating where in the results to begin listing.
    `void` | `setMaxUploads(java.lang.Integer maxUploads)` Sets the optional maximum number of uploads to return.
    `void` | `setPrefix(java.lang.String prefix)` Sets the optional prefix parameter, restricting the response to multipart uploads for keys that begin with the specified prefix.
    `void` | `setUploadIdMarker(java.lang.String uploadIdMarker)` Sets the optional upload ID marker indicating where in the results to begin listing.
    `ListMultipartUploadsRequest` | `withBucketName(java.lang.String bucketName)` Sets The name of the bucket containing the uploads to list, and returns this updated ListMultipartUploadsRequest object so that additional method calls can be chained together.
    `ListMultipartUploadsRequest` | `withDelimiter(java.lang.String delimiter)` Sets the optional delimiter parameter that causes multipart uploads for keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the `MultipartUploadListing.getCommonPrefixes()` list.
    `ListMultipartUploadsRequest` | `withKeyMarker(java.lang.String keyMarker)` Sets the KeyMarker property for this request.
    `ListMultipartUploadsRequest` | `withMaxUploads(int maxUploadsInt)` Sets the optional maximum number of uploads to return and returns this updated ListMultipartUploadsRequest object so that additional method calls can be chained together.
    `ListMultipartUploadsRequest` | `withPrefix(java.lang.String prefix)` Sets the optional prefix parameter restricting the response to multipart uploads for keys that begin with the specified prefix.
    `ListMultipartUploadsRequest` | `withUploadIdMarker(java.lang.String uploadIdMarker)` Sets the optional upload ID marker indicating where in the results to begin listing and returns this updated ListMultipartUploadsRequest object so that additional methods can be chained together.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

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

- - ### コンストラクタの詳細

    - #### ListMultipartUploadsRequest

          public ListMultipartUploadsRequest(java.lang.String bucketName)

      Constructs a new ListMultipartUploadsRequest to list the multipart uploads from the specified bucket.
      パラメータ:
        `bucketName` - The name of the bucket containing the uploads to list.

  - ### メソッドの詳細

    - #### getBucketName

          public java.lang.String getBucketName()

      Returns the name of the bucket containing the uploads to list.
      戻り値:
        The name of the bucket containing the uploads to list.

    - #### setBucketName

          public void setBucketName(java.lang.String bucketName)

      Sets the name of the bucket containing the multipart uploads to list.
      パラメータ:
        `bucketName` - The name of the bucket containing the uploads to list.

    - #### withBucketName

          public ListMultipartUploadsRequest withBucketName(java.lang.String bucketName)

      Sets The name of the bucket containing the uploads to list, and returns this updated ListMultipartUploadsRequest object so that additional method calls can be chained together.
      パラメータ:
        `bucketName` - The name of the bucket containing the uploads to list.
      戻り値:
        This updated ListMultipartUploadsRequest object.

    - #### getMaxUploads

          public java.lang.Integer getMaxUploads()

      Returns the optional maximum number of uploads to return, or null if no maximum number of uploads has been set for this request.
      戻り値:
        The optional maximum number of uploads to return.

    - #### setMaxUploads

          public void setMaxUploads(java.lang.Integer maxUploads)

      Sets the optional maximum number of uploads to return.
      パラメータ:
        `maxUploads` - The maximum number of uploads to return.

    - #### withMaxUploads

          public ListMultipartUploadsRequest withMaxUploads(int maxUploadsInt)

      Sets the optional maximum number of uploads to return and returns this updated ListMultipartUploadsRequest object so that additional method calls can be chained together.
      パラメータ:
        `maxUploadsInt` - The optional maximum number of uploads to return.
      戻り値:
        This updated ListMultipartUploadsRequest object.

    - #### getKeyMarker

          public java.lang.String getKeyMarker()

      Returns the optional key marker indicating where in the results to begin listing.

      Together with the upload ID marker, specifies the multipart upload after which listing should begin.

      If the upload ID marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

      If the upload ID marker is specified, any multipart uploads for a key equal to the key-marker may also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified marker.

      戻り値:
        The optional key marker indicating where in the results to begin listing.

    - #### setKeyMarker

          public void setKeyMarker(java.lang.String keyMarker)

      Sets the optional key marker indicating where in the results to begin listing.

      Together with the upload ID marker, specifies the multipart upload after which listing should begin.

      If the upload ID marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

      If the upload ID marker is specified, any multipart uploads for a key equal to the key-marker may also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified marker.

      パラメータ:
        `keyMarker` - The optional key marker indicating where in the results to begin listing.

    - #### withKeyMarker

          public ListMultipartUploadsRequest withKeyMarker(java.lang.String keyMarker)

      Sets the KeyMarker property for this request.
      パラメータ:
        `keyMarker` - The value that KeyMarker is set to
      戻り値:
        the request with the KeyMarker set

    - #### getUploadIdMarker

          public java.lang.String getUploadIdMarker()

      Returns the optional upload ID marker indicating where in the results to begin listing.

      Together with the key marker, specifies the multipart upload after which listing should begin. If no key marker is specified, the upload ID marker is ignored. Otherwise, any multipart uploads for a key equal to the key marker may be included in the list only if they have an upload ID lexicographically greater than the specified marker.

      戻り値:
        The optional upload ID marker indicating where in the results to begin listing.

    - #### setUploadIdMarker

          public void setUploadIdMarker(java.lang.String uploadIdMarker)

      Sets the optional upload ID marker indicating where in the results to begin listing.

      Together with the key marker, specifies the multipart upload after which listing should begin. If no key marker is specified, the upload ID marker is ignored. Otherwise, any multipart uploads for a key equal to the key marker may be included in the list only if they have an upload ID lexicographically greater than the specified marker.

      パラメータ:
        `uploadIdMarker` - The optional upload ID marker indicating where in the results to begin listing.

    - #### withUploadIdMarker

          public ListMultipartUploadsRequest withUploadIdMarker(java.lang.String uploadIdMarker)

      Sets the optional upload ID marker indicating where in the results to begin listing and returns this updated ListMultipartUploadsRequest object so that additional methods can be chained together.

      Together with the key marker, specifies the multipart upload after which listing should begin. If no key marker is specified, the upload ID marker is ignored. Otherwise, any multipart uploads for a key equal to the key marker may be included in the list only if they have an upload ID lexicographically greater than the specified marker.

      パラメータ:
        `uploadIdMarker` - The optional upload ID marker indicating where in the results to begin listing.
      戻り値:
        This updated ListMultipartUploadsRequest object.

    - #### getDelimiter

          public java.lang.String getDelimiter()

      Returns the optional delimiter parameter that causes multipart uploads for keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the `MultipartUploadListing.getCommonPrefixes()` list. These combined keys are not returned elsewhere in the response. The most commonly used delimiter is "/", which simulates a hierarchical organization similar to a file system directory structure.
      戻り値:
        The optional delimiter parameter that causes multipart uploads for keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the `MultipartUploadListing.getCommonPrefixes()` list.

    - #### setDelimiter

          public void setDelimiter(java.lang.String delimiter)

      Sets the optional delimiter parameter that causes multipart uploads for keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the `MultipartUploadListing.getCommonPrefixes()` list.
      パラメータ:
        `delimiter` - The optional delimiter parameter that causes multipart uploads for keys that contain the same string between the prefix and the first occurrence of the delimiter to be combined into a single result element in the `MultipartUploadListing.getCommonPrefixes()` list.

    - #### withDelimiter

          public ListMultipartUploadsRequest withDelimiter(java.lang.String delimiter)

      Sets the optional delimiter parameter that causes multipart uploads for keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the `MultipartUploadListing.getCommonPrefixes()` list. Returns this `ListMultipartUploadsRequest`, enabling additional method calls to be chained together.
      パラメータ:
        `delimiter` - The optional delimiter parameter that causes multipart uploads for keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the `MultipartUploadListing.getCommonPrefixes()` list.
      戻り値:
        This `ListMultipartUploadsRequest`, enabling additional method calls to be chained together.

    - #### getPrefix

          public java.lang.String getPrefix()

      Returns the optional prefix parameter that restricts the response to multipart uploads for keys that begin with the specified prefix. Use prefixes to separate a bucket into different sets of keys, similar to how a file system organizes files into directories.
      戻り値:
        The optional prefix parameter restricting the response to multipart uploads for keys that begin with the specified prefix.

    - #### setPrefix

          public void setPrefix(java.lang.String prefix)

      Sets the optional prefix parameter, restricting the response to multipart uploads for keys that begin with the specified prefix.
      パラメータ:
        `prefix` - The optional prefix parameter, restricting the response to multipart uploads for keys that begin with the specified prefix.

    - #### withPrefix

          public ListMultipartUploadsRequest withPrefix(java.lang.String prefix)

      Sets the optional prefix parameter restricting the response to multipart uploads for keys that begin with the specified prefix. Returns this `ListMultipartUploadsRequest`, enabling additional method calls to be chained together.
      パラメータ:
        `prefix` - The optional prefix parameter restricting the response to multipart uploads for keys that begin with the specified prefix.
      戻り値:
        This `ListMultipartUploadsRequest`, enabling additional method calls to be chained together.