com.amazonaws.services.s3.model

Class PutInstructionFileRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.s3.model.PutInstructionFileRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, EncryptionMaterialsFactory, MaterialsDescriptionProvider, Cloneable

public final class PutInstructionFileRequest
extends AmazonWebServiceRequest
implements MaterialsDescriptionProvider, EncryptionMaterialsFactory

Used to create a new instruction file, typically used to share an encrypted S3 object with partners via re-encrypting the CEK of the specified S3 object with a partner-specific public key.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutInstructionFileRequest(S3ObjectId s3ObjectId, EncryptionMaterials encryptionMaterials, String suffix)
PutInstructionFileRequest(S3ObjectId s3ObjectId, Map<String,String> matDesc, String suffix)

Method Summary

Modifier and Type	Method and Description
PutObjectRequest	createPutObjectRequest(S3Object s3Object) Creates and returns a PutObjectRequest for the instruction file with the specified suffix.
AccessControlList	getAccessControlList() Returns the optional access control list for the new object.
CannedAccessControlList	getCannedAcl() Gets the optional pre-configured access control policy to use for the new object.
EncryptionMaterials	getEncryptionMaterials() Returns the encryption materials if specified; or null if not.
Map<String,String>	getMaterialsDescription() Returns the material description for the new instruction file.
String	getRedirectLocation() Gets the optional redirect location for the new object.
S3ObjectId	getS3ObjectId() Returns the S3 object id for which the new instruction file will be created.
String	getStorageClass() Gets the optional Amazon S3 storage class to use when storing the new object.
String	getSuffix() Returns the suffix for the new instruction file.
void	setAccessControlList(AccessControlList accessControlList) Sets the optional access control list for the new object.
void	setCannedAcl(CannedAccessControlList cannedAcl) Sets the optional pre-configured access control policy to use for the new object.
void	setRedirectLocation(String redirectLocation) Sets the optional redirect location for the new object.
void	setStorageClass(StorageClass storageClass) Sets the optional Amazon S3 storage class to use when storing the new object.
void	setStorageClass(String storageClass) Sets the optional Amazon S3 storage class to use when storing the new object.
PutInstructionFileRequest	withAccessControlList(AccessControlList accessControlList) Sets the optional access control list for the new object.
PutInstructionFileRequest	withCannedAcl(CannedAccessControlList cannedAcl) Sets the optional pre-configured access control policy to use for the new object.
PutInstructionFileRequest	withRedirectLocation(String redirectLocation) Sets the optional redirect location for the new object.Returns this PutObjectRequest, enabling additional method calls to be chained together.
PutInstructionFileRequest	withStorageClass(StorageClass storageClass) Sets the optional Amazon S3 storage class to use when storing the new object.
PutInstructionFileRequest	withStorageClass(String storageClass) Sets the optional Amazon S3 storage class to use when storing the new object.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PutInstructionFileRequest

public PutInstructionFileRequest(S3ObjectId s3ObjectId,
                                 Map<String,String> matDesc,
                                 String suffix)

Parameters:

s3ObjectId - id of the corresponding s3 object.

matDesc - material description of the instruction file

suffix - suffix of the instruction file to be put

PutInstructionFileRequest

public PutInstructionFileRequest(S3ObjectId s3ObjectId,
                                 EncryptionMaterials encryptionMaterials,
                                 String suffix)

Parameters:

s3ObjectId - id of the corresponding s3 object.

encryptionMaterials - encryption materials to be used for the instruction file

suffix - suffix of the instruction file to be put

Method Detail

getS3ObjectId

public S3ObjectId getS3ObjectId()

Returns the S3 object id for which the new instruction file will be created. This is not the instruction file id.

getMaterialsDescription

public Map<String,String> getMaterialsDescription()

Returns the material description for the new instruction file.

Specified by:

getMaterialsDescription in interface MaterialsDescriptionProvider

Returns:

materials description.

getEncryptionMaterials

public EncryptionMaterials getEncryptionMaterials()

Returns the encryption materials if specified; or null if not.

Specified by:

getEncryptionMaterials in interface EncryptionMaterialsFactory

Returns:

EncryptionMaterials which the caller can use to encrypt or decrypt data.

getSuffix

public String getSuffix()

Returns the suffix for the new instruction file.

getCannedAcl

public CannedAccessControlList getCannedAcl()

Gets the optional pre-configured access control policy to use for the new object.

Returns:

The optional pre-configured access control policy to use for the new object.

See Also:

AbstractPutObjectRequest.setCannedAcl(CannedAccessControlList), PutObjectRequest.withCannedAcl(CannedAccessControlList)

setCannedAcl

public void setCannedAcl(CannedAccessControlList cannedAcl)

Sets the optional pre-configured access control policy to use for the new object.

Parameters:

cannedAcl - The optional pre-configured access control policy to use for the new object.

See Also:

AbstractPutObjectRequest.getCannedAcl(), PutObjectRequest.withCannedAcl(CannedAccessControlList)

withCannedAcl

public PutInstructionFileRequest withCannedAcl(CannedAccessControlList cannedAcl)

Sets the optional pre-configured access control policy to use for the new object. Returns this PutObjectRequest, enabling additional method calls to be chained together.

Parameters:

cannedAcl - The optional pre-configured access control policy to use for the new object.

Returns:

This PutObjectRequest, enabling additional method calls to be chained together.

See Also:

AbstractPutObjectRequest.getCannedAcl(), AbstractPutObjectRequest.setCannedAcl(CannedAccessControlList)

getAccessControlList

public AccessControlList getAccessControlList()

Returns the optional access control list for the new object. If specified, cannedAcl will be ignored.

setAccessControlList

public void setAccessControlList(AccessControlList accessControlList)

Sets the optional access control list for the new object. If specified, cannedAcl will be ignored.

Parameters:

accessControlList - The access control list for the new object.

withAccessControlList

public PutInstructionFileRequest withAccessControlList(AccessControlList accessControlList)

Sets the optional access control list for the new object. If specified, cannedAcl will be ignored. Returns this PutObjectRequest, enabling additional method calls to be chained together.

Parameters:

accessControlList - The access control list for the new object.

getRedirectLocation

public String getRedirectLocation()

Gets the optional redirect location for the new object.

setRedirectLocation

public void setRedirectLocation(String redirectLocation)

Sets the optional redirect location for the new object.

Parameters:

redirectLocation - The redirect location for the new object.

withRedirectLocation

public PutInstructionFileRequest withRedirectLocation(String redirectLocation)

Sets the optional redirect location for the new object.Returns this PutObjectRequest, enabling additional method calls to be chained together.

Parameters:

redirectLocation - The redirect location for the new object.

getStorageClass

public String getStorageClass()

Gets the optional Amazon S3 storage class to use when storing the new object. If not specified, the default standard storage class is used when storing the object.

For more information on available Amazon S3 storage classes, see the StorageClass enumeration.

Returns:

The Amazon S3 storage class to use when storing the newly copied object.

See Also:

setStorageClass(String), setStorageClass(StorageClass), withStorageClass(StorageClass), withStorageClass(String)

setStorageClass

public void setStorageClass(String storageClass)

Sets the optional Amazon S3 storage class to use when storing the new object. If not specified, the default standard storage class will be used when storing the new object.

For more information on Amazon S3 storage classes and available values, see the StorageClass enumeration.

Parameters:

storageClass - The storage class to use when storing the new object.

See Also:

getStorageClass(), setStorageClass(String), withStorageClass(StorageClass), withStorageClass(String)

withStorageClass

public PutInstructionFileRequest withStorageClass(String storageClass)

Sets the optional Amazon S3 storage class to use when storing the new object. Returns this PutObjectRequest, enabling additional method calls to be chained together. If not specified, the default standard storage class will be used when storing the object.

For more information on Amazon S3 storage classes and available values, see the StorageClass enumeration.

Parameters:

storageClass - The storage class to use when storing the new object.

Returns:

This PutObjectRequest, enabling additional method calls to be chained together.

See Also:

getStorageClass(), setStorageClass(StorageClass), setStorageClass(String), withStorageClass(StorageClass)

setStorageClass

public void setStorageClass(StorageClass storageClass)

Sets the optional Amazon S3 storage class to use when storing the new object. If not specified, the default standard storage class will be used when storing the object.

For more information on Amazon S3 storage classes and available values, see the StorageClass enumeration.

Parameters:

storageClass - The storage class to use when storing the new object.

See Also:

getStorageClass(), setStorageClass(String)

withStorageClass

public PutInstructionFileRequest withStorageClass(StorageClass storageClass)

Sets the optional Amazon S3 storage class to use when storing the new object. Returns this PutObjectRequest, enabling additional method calls to be chained together. If not specified, the default standard storage class will be used when storing the object.

For more information on Amazon S3 storage classes and available values, see the StorageClass enumeration.

Parameters:

storageClass - The storage class to use when storing the new object.

Returns:

This PutObjectRequest, enabling additional method calls to be chained together.

See Also:

getStorageClass(), setStorageClass(StorageClass), setStorageClass(String), withStorageClass(String)

createPutObjectRequest

public PutObjectRequest createPutObjectRequest(S3Object s3Object)

Creates and returns a PutObjectRequest for the instruction file with the specified suffix.