Package com.amazonaws.services.s3.model
Class EncryptedInitiateMultipartUploadRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.s3.model.InitiateMultipartUploadRequest
-
- com.amazonaws.services.s3.model.EncryptedInitiateMultipartUploadRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,MaterialsDescriptionProvider
,SSEAwsKeyManagementParamsProvider
,SSECustomerKeyProvider
,Serializable
,Cloneable
public class EncryptedInitiateMultipartUploadRequest extends InitiateMultipartUploadRequest implements MaterialsDescriptionProvider, Serializable
This class is an extension ofInitiateMultipartUploadRequest
to allow additional crypto related attributes to be specified.In particular, this includes the options to
- specify encryption material description on a per-request basis;
- specify whether a new set of encryption material is to be created for the upload or not;
EncryptedInitiateMultipartUploadRequest
is only recognized byAmazonS3EncryptionClient
.If
EncryptedInitiateMultipartUploadRequest
is used against the non-encryptingAmazonS3Client
, these additional attributes will be ignored.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.services.s3.model.InitiateMultipartUploadRequest
objectMetadata
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description EncryptedInitiateMultipartUploadRequest(String bucketName, String key)
EncryptedInitiateMultipartUploadRequest(String bucketName, String key, ObjectMetadata objectMetadata)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<String,String>
getMaterialsDescription()
Returns an unmodifiable view of the MaterialsDescription which the caller can use to load EncryptionMaterials from anyEncryptionMaterialsAccessor
boolean
isCreateEncryptionMaterial()
Returns true if a new set of encryption material is to be created; false otherwise.void
setCreateEncryptionMaterial(boolean createEncryptionMaterial)
void
setMaterialsDescription(Map<String,String> materialsDescription)
sets the materials description for the encryption materials to be used with the current Multi Part Upload Request.EncryptedInitiateMultipartUploadRequest
withCreateEncryptionMaterial(boolean createEncryptionMaterial)
EncryptedInitiateMultipartUploadRequest
withMaterialsDescription(Map<String,String> materialsDescription)
sets the materials description for the encryption materials to be used with the current Multi Part Upload Request.-
Methods inherited from class com.amazonaws.services.s3.model.InitiateMultipartUploadRequest
getAccessControlList, getBucketName, getCannedACL, getKey, getObjectMetadata, getRedirectLocation, getSSEAwsKeyManagementParams, getSSECustomerKey, getStorageClass, isRequesterPays, setAccessControlList, setBucketName, setCannedACL, setKey, setObjectMetadata, setRedirectLocation, setRequesterPays, setSSEAwsKeyManagementParams, setSSECustomerKey, setStorageClass, withAccessControlList, withBucketName, withCannedACL, withKey, withObjectMetadata, withRedirectLocation, withRequesterPays, withSSEAwsKeyManagementParams, withSSECustomerKey, withStorageClass, withStorageClass
-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Constructor Detail
-
EncryptedInitiateMultipartUploadRequest
public EncryptedInitiateMultipartUploadRequest(String bucketName, String key)
-
EncryptedInitiateMultipartUploadRequest
public EncryptedInitiateMultipartUploadRequest(String bucketName, String key, ObjectMetadata objectMetadata)
-
-
Method Detail
-
getMaterialsDescription
public Map<String,String> getMaterialsDescription()
Description copied from interface:MaterialsDescriptionProvider
Returns an unmodifiable view of the MaterialsDescription which the caller can use to load EncryptionMaterials from anyEncryptionMaterialsAccessor
- Specified by:
getMaterialsDescription
in interfaceMaterialsDescriptionProvider
- Returns:
- materials description.
-
setMaterialsDescription
public void setMaterialsDescription(Map<String,String> materialsDescription)
sets the materials description for the encryption materials to be used with the current Multi Part Upload Request.- Parameters:
materialsDescription
- the materialsDescription to set
-
withMaterialsDescription
public EncryptedInitiateMultipartUploadRequest withMaterialsDescription(Map<String,String> materialsDescription)
sets the materials description for the encryption materials to be used with the current Multi Part Upload Request.- Parameters:
materialsDescription
- the materialsDescription to set
-
isCreateEncryptionMaterial
public boolean isCreateEncryptionMaterial()
Returns true if a new set of encryption material is to be created; false otherwise. Default is true.
-
setCreateEncryptionMaterial
public void setCreateEncryptionMaterial(boolean createEncryptionMaterial)
- Parameters:
createEncryptionMaterial
- true if a new set of encryption material is to be created; false otherwise.
-
withCreateEncryptionMaterial
public EncryptedInitiateMultipartUploadRequest withCreateEncryptionMaterial(boolean createEncryptionMaterial)
- Parameters:
createEncryptionMaterial
- true if a new set of encryption material is to be created; false otherwise.
-
-