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 of
InitiateMultipartUploadRequest
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 by AmazonS3EncryptionClient
.
If EncryptedInitiateMultipartUploadRequest
is used against the
non-encrypting AmazonS3Client
, these additional attributes will be
ignored.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.services.s3.model.InitiateMultipartUploadRequest
objectMetadata
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
ConstructorsConstructorDescriptionEncryptedInitiateMultipartUploadRequest
(String bucketName, String key) EncryptedInitiateMultipartUploadRequest
(String bucketName, String key, ObjectMetadata objectMetadata) -
Method Summary
Modifier and TypeMethodDescriptionReturns an unmodifiable view of the MaterialsDescription which the caller can use to load EncryptionMaterials from anyEncryptionMaterialsAccessor
boolean
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.withCreateEncryptionMaterial
(boolean createEncryptionMaterial) 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 Details
-
EncryptedInitiateMultipartUploadRequest
-
EncryptedInitiateMultipartUploadRequest
public EncryptedInitiateMultipartUploadRequest(String bucketName, String key, ObjectMetadata objectMetadata)
-
-
Method Details
-
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
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.
-