com.amazonaws.services.s3.model
Class ListMultipartUploadsRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.s3.model.ListMultipartUploadsRequest

public class ListMultipartUploadsRequest
extends AmazonWebServiceRequest

Container for the parameters of the ListMultipartUploads operation.

Required Parameters: BucketName

See Also:
AmazonS3.listMultipartUploads(ListMultipartUploadsRequest)

Constructor Summary
ListMultipartUploadsRequest(String bucketName)
          Constructs a new ListMultipartUploadsRequest to list the multipart uploads from the specified bucket.
 
Method Summary
 String getBucketName()
          Returns the name of the bucket containing the uploads to list.
 String getKeyMarker()
          Returns the optional key marker indicating where in the results to begin listing.
 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.
 String getUploadIdMarker()
          Returns the optional upload ID marker indicating where in the results to begin listing.
 void setBucketName(String bucketName)
          Sets the name of the bucket containing the multipart uploads to list.
 void setKeyMarker(String keyMarker)
          Sets the optional key marker indicating where in the results to begin listing.
 void setMaxUploads(Integer maxUploads)
          Sets the optional maximum number of uploads to return.
 void setUploadIdMarker(String uploadIdMarker)
          Sets the optional upload ID marker indicating where in the results to begin listing.
 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.
 ListMultipartUploadsRequest withKeyMarker(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 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.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getDelegationToken, setDelegationToken
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

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 Detail

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.


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.