public class DeleteObjectsRequest extends AmazonWebServiceRequest implements Serializable
| Modifier and Type | Class and Description |
|---|---|
static class |
DeleteObjectsRequest.KeyVersion
A key to delete, with an optional version attribute.
|
NOOP| Constructor and Description |
|---|
DeleteObjectsRequest(String bucketName)
Constructs a new
DeleteObjectsRequest, specifying the objects'
bucket name. |
| Modifier and Type | Method and Description |
|---|---|
String |
getBucketName()
Gets the name of the Amazon S3 bucket containing the object(s) to delete.
|
List<DeleteObjectsRequest.KeyVersion> |
getKeys()
Returns the list of keys to delete from this bucket.
|
MultiFactorAuthentication |
getMfa()
Gets the optional Multi-Factor Authentication information included
with this request.
|
boolean |
getQuiet()
Returns the quiet element for this request.
|
void |
setBucketName(String bucketName)
Sets the name of the Amazon S3 bucket containing the object(s) to delete.
|
void |
setKeys(List<DeleteObjectsRequest.KeyVersion> keys)
Sets the list of keys to delete from this bucket, clearing any existing
list of keys.
|
void |
setMfa(MultiFactorAuthentication mfa)
Sets the optional Multi-Factor Authentication information to include with
this request.
|
void |
setQuiet(boolean quiet)
Sets the quiet element for this request.
|
DeleteObjectsRequest |
withBucketName(String bucketName)
Sets the name of the Amazon S3 bucket containing the object(s) to delete
and returns this object, enabling additional method calls to be chained
together.
|
DeleteObjectsRequest |
withKeys(List<DeleteObjectsRequest.KeyVersion> keys)
Sets the list of keys to delete from this bucket, clearing any existing
list of keys.
|
DeleteObjectsRequest |
withKeys(String... keys)
Convenience method to specify a set of keys without versions.
|
DeleteObjectsRequest |
withMfa(MultiFactorAuthentication mfa)
Sets the optional Multi-Factor Authentication information to include with
this request
Returns this, enabling additional method
calls to be chained together.
|
DeleteObjectsRequest |
withQuiet(boolean quiet)
Sets the quiet element for this request.
|
clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic DeleteObjectsRequest(String bucketName)
DeleteObjectsRequest, specifying the objects'
bucket name.bucketName - The name of the Amazon S3 bucket containing the object(s) to
delete.public String getBucketName()
setBucketName(String)public void setBucketName(String bucketName)
bucketName - The name of the Amazon S3 bucket containing the object(s) to
delete.getBucketName()public DeleteObjectsRequest withBucketName(String bucketName)
bucketName - The name of the Amazon S3 bucket containing the object(s) to
delete.DeleteObjectsRequest object, enabling
additional method calls to be chained together.public MultiFactorAuthentication getMfa()
Gets the optional Multi-Factor Authentication information included with this request.
Multi-Factor Authentication is required when deleting an object version from a bucket which has MFADelete enabled in its bucket versioning configuration.
See BucketVersioningConfiguration.setMfaDeleteEnabled(Boolean)
for more information on MFADelete.
public void setMfa(MultiFactorAuthentication mfa)
Sets the optional Multi-Factor Authentication information to include with this request.
Multi-Factor Authentication is required when deleting an object version from a bucket which has MFADelete enabled in its bucket versioning configuration.
See BucketVersioningConfiguration.setMfaDeleteEnabled(Boolean)
for more information on MFADelete.
mfa - The optional Multi-Factor Authentication information to
include with this request.public DeleteObjectsRequest withMfa(MultiFactorAuthentication mfa)
Sets the optional Multi-Factor Authentication information to include with this request Returns this, enabling additional method calls to be chained together.
Multi-Factor Authentication is required when deleting an object version from a bucket which has MFADelete enabled in its bucket versioning configuration
See BucketVersioningConfiguration.setMfaDeleteEnabled(Boolean)
for more information on MFADelete.
mfa - The optional Multi-Factor Authentication information to
include with this request.public void setQuiet(boolean quiet)
public boolean getQuiet()
public DeleteObjectsRequest withQuiet(boolean quiet)
public void setKeys(List<DeleteObjectsRequest.KeyVersion> keys)
keys - The list of keys to delete from this bucketpublic DeleteObjectsRequest withKeys(List<DeleteObjectsRequest.KeyVersion> keys)
keys - The list of keys to delete from this bucketpublic List<DeleteObjectsRequest.KeyVersion> getKeys()
public DeleteObjectsRequest withKeys(String... keys)
withKeys(List)Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.