Class ListMultipartUploadsRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.s3.model.ListMultipartUploadsRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class ListMultipartUploadsRequest extends AmazonWebServiceRequest implements Serializable
Container for the parameters of the ListMultipartUploads operation.

Required Parameters: BucketName

See Also:
  • Constructor Details

    • ListMultipartUploadsRequest

      public ListMultipartUploadsRequest(String bucketName)
      Constructs a new ListMultipartUploadsRequest to list the multipart uploads from the specified bucket.
      Parameters:
      bucketName - The name of the bucket containing the uploads to list.
  • Method Details

    • getBucketName

      public String getBucketName()
      Returns the name of the bucket containing the uploads to list.
      Returns:
      The name of the bucket containing the uploads to list.
    • setBucketName

      public void setBucketName(String bucketName)
      Sets the name of the bucket containing the multipart uploads to list.
      Parameters:
      bucketName - The name of the bucket containing the uploads to list.
    • withBucketName

      public ListMultipartUploadsRequest withBucketName(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.
      Parameters:
      bucketName - The name of the bucket containing the uploads to list.
      Returns:
      This updated ListMultipartUploadsRequest object.
    • getMaxUploads

      public 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.
      Returns:
      The optional maximum number of uploads to return.
    • setMaxUploads

      public void setMaxUploads(Integer maxUploads)
      Sets the optional maximum number of uploads to return.
      Parameters:
      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.
      Parameters:
      maxUploadsInt - The optional maximum number of uploads to return.
      Returns:
      This updated ListMultipartUploadsRequest object.
    • getKeyMarker

      public 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.

      Returns:
      The optional key marker indicating where in the results to begin listing.
    • setKeyMarker

      public void setKeyMarker(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.

      Parameters:
      keyMarker - The optional key marker indicating where in the results to begin listing.
    • withKeyMarker

      public ListMultipartUploadsRequest withKeyMarker(String keyMarker)
      Sets the KeyMarker property for this request.
      Parameters:
      keyMarker - The value that KeyMarker is set to
      Returns:
      the request with the KeyMarker set
    • getUploadIdMarker

      public 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.

      Returns:
      The optional upload ID marker indicating where in the results to begin listing.
    • setUploadIdMarker

      public void setUploadIdMarker(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.

      Parameters:
      uploadIdMarker - The optional upload ID marker indicating where in the results to begin listing.
    • withUploadIdMarker

      public ListMultipartUploadsRequest withUploadIdMarker(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.

      Parameters:
      uploadIdMarker - The optional upload ID marker indicating where in the results to begin listing.
      Returns:
      This updated ListMultipartUploadsRequest object.
    • getDelimiter

      public 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.
      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.
    • setDelimiter

      public void setDelimiter(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.
      Parameters:
      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(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.
      Parameters:
      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.
      Returns:
      This ListMultipartUploadsRequest, enabling additional method calls to be chained together.
    • getPrefix

      public 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.
      Returns:
      The optional prefix parameter restricting the response to multipart uploads for keys that begin with the specified prefix.
    • setPrefix

      public void setPrefix(String prefix)
      Sets the optional prefix parameter, restricting the response to multipart uploads for keys that begin with the specified prefix.
      Parameters:
      prefix - The optional prefix parameter, restricting the response to multipart uploads for keys that begin with the specified prefix.
    • withPrefix

      public ListMultipartUploadsRequest withPrefix(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.
      Parameters:
      prefix - 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.
    • getEncodingType

      public String getEncodingType()
      Gets the optional encodingType parameter indicating the encoding method to be applied on the response.
      Returns:
      The encoding method to be applied on the response.
    • setEncodingType

      public void setEncodingType(String encodingType)
      Sets the optional encodingType parameter indicating the encoding method to be applied on the response. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
      Parameters:
      encodingType - The encoding method to be applied on the response. Valid values: null (not encoded) or "url".
    • withEncodingType

      public ListMultipartUploadsRequest withEncodingType(String encodingType)
      Sets the optional encodingType parameter indicating the encoding method to be applied on the response. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. Returns this ListMultipartUploadsRequest, enabling additional method calls to be chained together.
      Parameters:
      encodingType - The encoding method to be applied on the response. Valid values: null (not encoded) or "url".