com.qcloud.cos.model

类 PutInstructionFileRequest

java.lang.Object

com.qcloud.cos.internal.CosServiceRequest

com.qcloud.cos.model.PutInstructionFileRequest

所有已实现的接口:

EncryptionMaterialsFactory, ReadLimitInfo, MaterialsDescriptionProvider, Cloneable

public class PutInstructionFileRequest
extends CosServiceRequest
implements MaterialsDescriptionProvider, EncryptionMaterialsFactory

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

构造器概要

构造器

构造器和说明
PutInstructionFileRequest(COSObjectId cosObjectId, EncryptionMaterials encryptionMaterials, String suffix)
PutInstructionFileRequest(COSObjectId cosObjectId, Map<String,String> matDesc, String suffix)

方法概要

限定符和类型	方法和说明
PutObjectRequest	createPutObjectRequest(COSObject cosObject) 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.
COSObjectId	getCOSObjectId() Returns the COS object id for which the new instruction file will be created.
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.
String	getStorageClass() Gets the optional COS 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 COS storage class to use when storing the new object.
void	setStorageClass(String storageClass) Sets the optional COS 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 COS storage class to use when storing the new object.
PutInstructionFileRequest	withStorageClass(String storageClass) Sets the optional COS storage class to use when storing the new object.

从类继承的方法 com.qcloud.cos.internal.CosServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getCosCredentials, getCustomQueryParameters, getCustomRequestHeaders, getFixedEndpointAddr, getGeneralProgressListener, getReadLimit, getRequestClientOptions, putCustomQueryParameter, putCustomRequestHeader, setCosCredentials, setFixedEndpointAddr, setGeneralProgressListener, withGeneralProgressListener

从类继承的方法 java.lang.Object

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

构造器详细资料

PutInstructionFileRequest

public PutInstructionFileRequest(COSObjectId cosObjectId,
                                 Map<String,String> matDesc,
                                 String suffix)

参数:

COSObjectId - id of the corresponding cos object.

matDesc - material description of the instruction file

suffix - suffix of the instruction file to be put

PutInstructionFileRequest

public PutInstructionFileRequest(COSObjectId cosObjectId,
                                 EncryptionMaterials encryptionMaterials,
                                 String suffix)

参数:

cosObjectId - id of the corresponding cos object.

encryptionMaterials - encryption materials to be used for the instruction file

suffix - suffix of the instruction file to be put

方法详细资料

getCOSObjectId

public COSObjectId getCOSObjectId()

Returns the COS 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.

指定者:

getMaterialsDescription 在接口中 MaterialsDescriptionProvider

返回:

materials description.

getEncryptionMaterials

public EncryptionMaterials getEncryptionMaterials()

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

指定者:

getEncryptionMaterials 在接口中 EncryptionMaterialsFactory

返回:

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.

返回:

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

另请参阅:

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.

参数:

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

另请参阅:

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.

参数:

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

返回:

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

另请参阅:

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.

参数:

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.

参数:

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.

参数:

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.

参数:

redirectLocation - The redirect location for the new object.

getStorageClass

public String getStorageClass()

Gets the optional COS 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 COS storage classes, see the StorageClass enumeration.

返回:

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

另请参阅:

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

setStorageClass

public void setStorageClass(String storageClass)

Sets the optional COS 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 COS storage classes and available values, see the StorageClass enumeration.

参数:

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

另请参阅:

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

withStorageClass

public PutInstructionFileRequest withStorageClass(String storageClass)

Sets the optional COS 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 COS storage classes and available values, see the StorageClass enumeration.

参数:

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

返回:

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

另请参阅:

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

setStorageClass

public void setStorageClass(StorageClass storageClass)

Sets the optional COS 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 COS storage classes and available values, see the StorageClass enumeration.

参数:

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

另请参阅:

getStorageClass(), setStorageClass(String)

withStorageClass

public PutInstructionFileRequest withStorageClass(StorageClass storageClass)

Sets the optional COS 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 COS storage classes and available values, see the StorageClass enumeration.

参数:

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

返回:

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

另请参阅:

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

createPutObjectRequest

public PutObjectRequest createPutObjectRequest(COSObject cosObject)

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