Package com.emc.object.s3.request
Class CreateBucketRequest
- java.lang.Object
-
- com.emc.object.ObjectRequest
-
- com.emc.object.s3.request.AbstractBucketRequest
-
- com.emc.object.s3.request.CreateBucketRequest
-
public class CreateBucketRequest extends AbstractBucketRequest
Encapsulates parameters for a create bucket request.
-
-
Constructor Summary
Constructors Constructor Description CreateBucketRequest(java.lang.String bucketName)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AccessControlList
getAcl()
CannedAcl
getCannedAcl()
java.lang.Boolean
getEncryptionEnabled()
java.lang.Boolean
getFileSystemEnabled()
java.util.Map<java.lang.String,java.util.List<java.lang.Object>>
getHeaders()
Override to return request-specific headers based on properties of the request.boolean
getObjectLockEnabled()
java.lang.Long
getRetentionPeriod()
java.lang.Boolean
getStaleReadAllowed()
java.lang.String
getvPoolId()
void
setAcl(AccessControlList acl)
void
setCannedAcl(CannedAcl cannedAcl)
void
setEncryptionEnabled(java.lang.Boolean encryptionEnabled)
Enables transparent server-side encryption (D@RE) on the bucket.void
setFileSystemEnabled(java.lang.Boolean fileSystemEnabled)
Sets whether the bucket can be access via filesystem (i.e.void
setMetadataSearchKeys(java.util.List<MetadataSearchKey> metadataSearchKeys)
Assigns a list of system- and user-metadata keynames that can be used later in bucket searches for the purpose of filtering object lists based querying these keys.void
setObjectLockEnabled(boolean objectLockEnabled)
Sets whether S3 Object Lock will be enabled for the new bucket.void
setRetentionPeriod(java.lang.Long retentionPeriod)
Enables a default retention period that will be applied to all objects created in the bucketvoid
setStaleReadAllowed(java.lang.Boolean staleReadAllowed)
Sets whether stale reads are allowed on the bucketvoid
setvPoolId(java.lang.String vPoolId)
CreateBucketRequest
withAcl(AccessControlList acl)
CreateBucketRequest
withCannedAcl(CannedAcl cannedAcl)
CreateBucketRequest
withEncryptionEnabled(java.lang.Boolean encryptionEnabled)
CreateBucketRequest
withFileSystemEnabled(boolean fileSystemEnabled)
CreateBucketRequest
withMetadataSearchKeys(java.util.List<MetadataSearchKey> metadataSearchKeys)
CreateBucketRequest
withObjectLockEnabled(boolean objectLockEnabled)
CreateBucketRequest
withRetentionPeriod(long retentionPeriod)
CreateBucketRequest
withStaleReadAllowed(boolean staleReadAllowed)
CreateBucketRequest
withVPoolId(java.lang.String vPoolId)
-
Methods inherited from class com.emc.object.s3.request.AbstractBucketRequest
getBucketName, setBucketName
-
Methods inherited from class com.emc.object.ObjectRequest
addCustomHeader, getCustomHeaders, getMethod, getNamespace, getPath, getProperties, getQueryParams, getQueryString, getRawQueryString, getSubresource, property, setNamespace, setPath
-
-
-
-
Method Detail
-
getHeaders
public java.util.Map<java.lang.String,java.util.List<java.lang.Object>> getHeaders()
Description copied from class:ObjectRequest
Override to return request-specific headers based on properties of the request. Always call super() first and modify the result.- Overrides:
getHeaders
in classObjectRequest
-
getCannedAcl
public CannedAcl getCannedAcl()
-
setCannedAcl
public void setCannedAcl(CannedAcl cannedAcl)
-
getAcl
public AccessControlList getAcl()
-
setAcl
public void setAcl(AccessControlList acl)
-
getvPoolId
public java.lang.String getvPoolId()
-
setvPoolId
public void setvPoolId(java.lang.String vPoolId)
-
getFileSystemEnabled
public java.lang.Boolean getFileSystemEnabled()
-
setFileSystemEnabled
public void setFileSystemEnabled(java.lang.Boolean fileSystemEnabled)
Sets whether the bucket can be access via filesystem (i.e. HDFS). This will enable some internal semantics for directories and may affect other features (i.e.TSO support
)
-
getStaleReadAllowed
public java.lang.Boolean getStaleReadAllowed()
-
setStaleReadAllowed
public void setStaleReadAllowed(java.lang.Boolean staleReadAllowed)
Sets whether stale reads are allowed on the bucket
-
getEncryptionEnabled
public java.lang.Boolean getEncryptionEnabled()
-
setEncryptionEnabled
public void setEncryptionEnabled(java.lang.Boolean encryptionEnabled)
Enables transparent server-side encryption (D@RE) on the bucket. This can only be enabled at create time
-
getRetentionPeriod
public java.lang.Long getRetentionPeriod()
-
setRetentionPeriod
public void setRetentionPeriod(java.lang.Long retentionPeriod)
Enables a default retention period that will be applied to all objects created in the bucket- Parameters:
retentionPeriod
- The default number of seconds each object will be in retention after creation
-
setMetadataSearchKeys
public void setMetadataSearchKeys(java.util.List<MetadataSearchKey> metadataSearchKeys)
Assigns a list of system- and user-metadata keynames that can be used later in bucket searches for the purpose of filtering object lists based querying these keys.- Parameters:
metadataSearchKeys
- The set of keys to index.
-
getObjectLockEnabled
public boolean getObjectLockEnabled()
-
setObjectLockEnabled
public void setObjectLockEnabled(boolean objectLockEnabled)
Sets whether S3 Object Lock will be enabled for the new bucket.
-
withCannedAcl
public CreateBucketRequest withCannedAcl(CannedAcl cannedAcl)
-
withAcl
public CreateBucketRequest withAcl(AccessControlList acl)
-
withVPoolId
public CreateBucketRequest withVPoolId(java.lang.String vPoolId)
-
withFileSystemEnabled
public CreateBucketRequest withFileSystemEnabled(boolean fileSystemEnabled)
-
withStaleReadAllowed
public CreateBucketRequest withStaleReadAllowed(boolean staleReadAllowed)
-
withEncryptionEnabled
public CreateBucketRequest withEncryptionEnabled(java.lang.Boolean encryptionEnabled)
-
withRetentionPeriod
public CreateBucketRequest withRetentionPeriod(long retentionPeriod)
-
withMetadataSearchKeys
public CreateBucketRequest withMetadataSearchKeys(java.util.List<MetadataSearchKey> metadataSearchKeys)
-
withObjectLockEnabled
public CreateBucketRequest withObjectLockEnabled(boolean objectLockEnabled)
-
-