com.qcloud.cos

接口 COS

所有超级接口:

COSDirectSpi

所有已知子接口:

COSEncryption

所有已知实现类:

COSClient, COSEncryptionClient

public interface COS
extends COSDirectSpi

方法概要

限定符和类型	方法和说明
void	abortMultipartUpload(AbortMultipartUploadRequest request) Aborts a multipart upload.
CompleteMultipartUploadResult	completeMultipartUpload(CompleteMultipartUploadRequest request) Completes a multipart upload by assembling previously uploaded parts.
CopyObjectResult	copyObject(CopyObjectRequest copyObjectRequest) Copy a source object to a new destination in COS.
CopyObjectResult	copyObject(String sourceBucketName, String sourceKey, String destinationBucketName, String destinationKey) Copy a source object to a new destination in COS.
CopyPartResult	copyPart(CopyPartRequest copyPartRequest) Copies a source object to a part of a multipart upload.
Bucket	createBucket(CreateBucketRequest createBucketRequest) Creates a new bucket in the region which is set in ClientConfig Every object stored in is contained within a bucket.
Bucket	createBucket(String bucketName) Creates a new bucket in the region which is set in ClientConfig Every object stored in is contained within a bucket.
void	deleteBucket(DeleteBucketRequest deleteBucketRequest) Deletes the specified bucket.
void	deleteBucket(String bucketName) Deletes the specified bucket.
void	deleteBucketCrossOriginConfiguration(DeleteBucketCrossOriginConfigurationRequest deleteBucketCrossOriginConfigurationRequest) Delete the cross origin configuration for the specified bucket.
void	deleteBucketCrossOriginConfiguration(String bucketName) Delete the cross origin configuration for the specified bucket.
void	deleteBucketLifecycleConfiguration(DeleteBucketLifecycleConfigurationRequest deleteBucketLifecycleConfigurationRequest) Removes the lifecycle configuration for the bucket specified.
void	deleteBucketLifecycleConfiguration(String bucketName) Removes the lifecycle configuration for the bucket specified.
void	deleteBucketPolicy(DeleteBucketPolicyRequest deleteBucketPolicyRequest) Deletes the policy associated with the specified bucket.
void	deleteBucketPolicy(String bucketName) Deletes the policy associated with the specified bucket.
void	deleteBucketReplicationConfiguration(DeleteBucketReplicationConfigurationRequest deleteBucketReplicationConfigurationRequest) Deletes the replication configuration for the given QCloud bucket.
void	deleteBucketReplicationConfiguration(String bucketName) Deletes the replication configuration for the given QCloud bucket.
void	deleteObject(DeleteObjectRequest deleteObjectRequest) Deletes the specified object in the specified bucket.
void	deleteObject(String bucketName, String key) Deletes the specified object in the specified bucket.
DeleteObjectsResult	deleteObjects(DeleteObjectsRequest deleteObjectsRequest) Deletes multiple objects in a single bucket from COS.
void	deleteVersion(DeleteVersionRequest deleteVersionRequest) Deletes a specific version of the specified object in the specified bucket.
void	deleteVersion(String bucketName, String key, String versionId) Deletes a specific version of the specified object in the specified bucket.
boolean	doesBucketExist(String bucketName) Checks if the specified bucket exists. use this method to determine if a specified bucket name already exists, and therefore can't be used to create a new bucket.
boolean	doesObjectExist(String bucketName, String objectName)
URL	generatePresignedUrl(GeneratePresignedUrlRequest generatePresignedUrlRequest) Returns a pre-signed URL for accessing COS resource. you can specify the expiration time.
URL	generatePresignedUrl(String bucketName, String key, Date expiration) Returns a pre-signed URL for accessing COS resource. you can specify the expiration time.
URL	generatePresignedUrl(String bucketName, String key, Date expiration, HttpMethodName method) Returns a pre-signed URL for accessing COS resource. you can specify the expiration time.
AccessControlList	getBucketAcl(GetBucketAclRequest getBucketAclRequest) Gets the AccessControlList (ACL) for the specified bucket.
AccessControlList	getBucketAcl(String bucketName) Gets the AccessControlList (ACL) for the specified bucket.
BucketCrossOriginConfiguration	getBucketCrossOriginConfiguration(GetBucketCrossOriginConfigurationRequest getBucketCrossOriginConfigurationRequest) Gets the cross origin configuration for the specified bucket, or null if no configuration has been established.
BucketCrossOriginConfiguration	getBucketCrossOriginConfiguration(String bucketName) Gets the cross origin configuration for the specified bucket, or null if no configuration has been established.
BucketLifecycleConfiguration	getBucketLifecycleConfiguration(GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest) Gets the lifecycle configuration for the specified bucket, or null if the specified bucket does not exist or if no configuration has been established.
BucketLifecycleConfiguration	getBucketLifecycleConfiguration(String bucketName) Gets the lifecycle configuration for the specified bucket, or null if the specified bucket does not exist or if no configuration has been established.
String	getBucketLocation(GetBucketLocationRequest getBucketLocationRequest) Gets the geographical region where stores the specified bucket.
String	getBucketLocation(String bucketName) Gets the geographical region where stores the specified bucket.
BucketPolicy	getBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest) Gets the policy for the specified bucket.
BucketPolicy	getBucketPolicy(String bucketName) Gets the policy for the specified bucket.
BucketReplicationConfiguration	getBucketReplicationConfiguration(GetBucketReplicationConfigurationRequest getBucketReplicationConfigurationRequest) Retrieves the replication configuration for the given QCloud bucket.
BucketReplicationConfiguration	getBucketReplicationConfiguration(String bucketName) Retrieves the replication configuration for the given QCloud bucket.
BucketVersioningConfiguration	getBucketVersioningConfiguration(GetBucketVersioningConfigurationRequest getBucketVersioningConfigurationRequest) Returns the versioning configuration for the specified bucket.
BucketVersioningConfiguration	getBucketVersioningConfiguration(String bucketName) Returns the versioning configuration for the specified bucket.
ClientConfig	getClientConfig() return the client config. client config include the region info, default expired sign time, etc.
COSObject	getObject(GetObjectRequest getObjectRequest) Gets the object stored in under the specified bucket and key.
ObjectMetadata	getObject(GetObjectRequest getObjectRequest, File destinationFile) Gets the object metadata for the object stored in under the specified bucket and key, and saves the object contents to the specified file.
COSObject	getObject(String bucketName, String key) Gets the object stored in under the specified bucket and key.
AccessControlList	getObjectAcl(GetObjectAclRequest getObjectAclRequest) Gets the AccessControlList (ACL) for the specified object in Qcloud COS.
AccessControlList	getObjectAcl(String bucketName, String key) Gets the AccessControlList (ACL) for the specified object in Qcloud COS.
ObjectMetadata	getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest) Gets the metadata for the specified object without actually fetching the object itself.
ObjectMetadata	getObjectMetadata(String bucketName, String key) Gets the metadata for the specified object without actually fetching the object itself.
HeadBucketResult	headBucket(HeadBucketRequest headBucketRequest) Performs a head bucket operation on the requested bucket name.
InitiateMultipartUploadResult	initiateMultipartUpload(InitiateMultipartUploadRequest request) Initiates a multipart upload and returns an InitiateMultipartUploadResult which contains an upload ID.
List<Bucket>	listBuckets() Returns a list of all buckets that the authenticated sender of the request owns.
List<Bucket>	listBuckets(ListBucketsRequest listBucketsRequest) Returns a list of all buckets that the authenticated sender of the request owns.
MultipartUploadListing	listMultipartUploads(ListMultipartUploadsRequest request) Lists in-progress multipart uploads.
ObjectListing	listNextBatchOfObjects(ListNextBatchOfObjectsRequest listNextBatchOfObjectsRequest) Provides an easy way to continue a truncated object listing and retrieve the next page of results.
ObjectListing	listNextBatchOfObjects(ObjectListing previousObjectListing) Provides an easy way to continue a truncated object listing and retrieve the next page of results.
VersionListing	listNextBatchOfVersions(ListNextBatchOfVersionsRequest listNextBatchOfVersionsRequest) Provides an easy way to continue a truncated VersionListing and retrieve the next page of results.
VersionListing	listNextBatchOfVersions(VersionListing previousVersionListing) Provides an easy way to continue a truncated VersionListing and retrieve the next page of results.
ObjectListing	listObjects(ListObjectsRequest listObjectsRequest) Returns a list of summary information about the objects in the specified bucket.
ObjectListing	listObjects(String bucketName) Returns a list of summary information about the objects in the specified buckets.
ObjectListing	listObjects(String bucketName, String prefix) Returns a list of summary information about the objects in the specified bucket.
PartListing	listParts(ListPartsRequest request) Lists the parts that have been uploaded for a specific multipart upload.
VersionListing	listVersions(ListVersionsRequest listVersionsRequest) Returns a list of summary information about the versions in the specified bucket.
VersionListing	listVersions(String bucketName, String prefix) Returns a list of summary information about the versions in the specified bucket.
VersionListing	listVersions(String bucketName, String prefix, String keyMarker, String versionIdMarker, String delimiter, Integer maxResults) Returns a list of summary information about the versions in the specified bucket.
PutObjectResult	putObject(PutObjectRequest putObjectRequest) Uploads a new object to the specified bucket.
PutObjectResult	putObject(String bucketName, String key, File file) Uploads the specified file to under the specified bucket and key name.
PutObjectResult	putObject(String bucketName, String key, InputStream input, ObjectMetadata metadata) Uploads the specified file to under the specified bucket and key name.
PutObjectResult	putObject(String bucketName, String key, String content) upload string content to a cos object. content will be encoded to bytes with UTF-8 encoding
void	restoreObject(RestoreObjectRequest request) Restore an object, which was transitioned to CAS from COS when it was expired, into COS again.
void	restoreObject(String bucketName, String key, int expirationInDays) Restore an object, which was transitioned to CAS from COS when it was expired, into COS again.
void	setBucketAcl(SetBucketAclRequest setBucketAclRequest) Sets the AccessControlList for the specified bucket.
void	setBucketAcl(String bucketName, AccessControlList acl) Sets the AccessControlList for the specified bucket.
void	setBucketAcl(String bucketName, CannedAccessControlList acl) Sets the CannedAccessControlList for the specified bucket.
void	setBucketCrossOriginConfiguration(SetBucketCrossOriginConfigurationRequest setBucketCrossOriginConfigurationRequest) Sets the cross origin configuration for the specified bucket.
void	setBucketCrossOriginConfiguration(String bucketName, BucketCrossOriginConfiguration bucketCrossOriginConfiguration) Sets the cross origin configuration for the specified bucket.
void	setBucketLifecycleConfiguration(SetBucketLifecycleConfigurationRequest setBucketLifecycleConfigurationRequest) Sets the lifecycle configuration for the specified bucket.
void	setBucketLifecycleConfiguration(String bucketName, BucketLifecycleConfiguration bucketLifecycleConfiguration) Sets the lifecycle configuration for the specified bucket.
void	setBucketPolicy(SetBucketPolicyRequest setBucketPolicyRequest) Sets the policy associated with the specified bucket.
void	setBucketPolicy(String bucketName, String policyText) Sets the policy associated with the specified bucket.
void	setBucketReplicationConfiguration(SetBucketReplicationConfigurationRequest setBucketReplicationConfigurationRequest) Sets a replication configuration for the QCloud bucket.
void	setBucketReplicationConfiguration(String bucketName, BucketReplicationConfiguration configuration) Sets a replication configuration for a bucket.
void	setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest setBucketVersioningConfigurationRequest) Sets the versioning configuration for the specified bucket.
void	setObjectAcl(SetObjectAclRequest setObjectAclRequest) Sets the AccessControlList for the specified object.
void	setObjectAcl(String bucketName, String key, AccessControlList acl) Sets the CannedAccessControlList for the specified object.
void	setObjectAcl(String bucketName, String key, CannedAccessControlList acl) Sets the CannedAccessControlList for the specified object.
void	updateObjectMetaData(String bucketName, String key, ObjectMetadata objectMetadata) update the object meta.
UploadPartResult	uploadPart(UploadPartRequest uploadPartRequest) Uploads a part in a multipart upload.

方法详细资料

getClientConfig

ClientConfig getClientConfig()

return the client config. client config include the region info, default expired sign time, etc.

返回:

ClientConfig.

putObject

PutObjectResult putObject(PutObjectRequest putObjectRequest)
                   throws CosClientException,
                          CosServiceException

Uploads a new object to the specified bucket. The PutObjectRequest contains all the details of the request, including the bucket to upload to, the key the object will be uploaded under, and the file or input stream containing the data to upload.

never stores partial objects; if during this call an exception wasn't thrown, the entire object was stored.

Depending on whether a file or input stream is being uploaded, this method has slightly different behavior.

When uploading a file:

• The client automatically computes a checksum of the file. uses checksums to validate the data in each file.
• Using the file extension, attempts to determine the correct content type and content disposition to use for the object.

When uploading directly from an input stream:

• Be careful to set the correct content type in the metadata object before directly sending a stream. Unlike file uploads, content types from input streams cannot be automatically determined. If the caller doesn't explicitly set the content type, it will not be set in .
• Content length must be specified before data can be uploaded to . Qcloud COS explicitly requires that the content length be sent in the request headers before it will accept any of the data. If the caller doesn't provide the length, the library must buffer the contents of the input stream in order to calculate it.

The specified bucket must already exist and the caller must have Permission#Write permission to the bucket to upload an object.

指定者:

putObject 在接口中 COSDirectSpi

参数:

putObjectRequest - The request object containing all the parameters to upload a new object to .

返回:

A PutObjectResult object containing the information returned by for the newly created object.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

putObject(String, String, File), putObject(String, String, InputStream, ObjectMetadata)

putObject

PutObjectResult putObject(String bucketName,
                          String key,
                          File file)
                   throws CosClientException,
                          CosServiceException

Uploads the specified file to under the specified bucket and key name.

never stores partial objects; if during this call an exception wasn't thrown, the entire object was stored.

The client automatically computes a checksum of the file. uses checksums to validate the data in each file.

Using the file extension, attempts to determine the correct content type and content disposition to use for the object.

The specified bucket must already exist and the caller must have Permission#Write permission to the bucket to upload an object.

参数:

bucketName - The name of an existing bucket, to which you have Permission#Write permission.

key - The key under which to store the specified file.

file - The file containing the data to be uploaded to .

返回:

A PutObjectResult object containing the information returned by for the newly created object.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

putObject(PutObjectRequest), putObject(String, String, InputStream, ObjectMetadata)

putObject

PutObjectResult putObject(String bucketName,
                          String key,
                          InputStream input,
                          ObjectMetadata metadata)
                   throws CosClientException,
                          CosServiceException

Uploads the specified file to under the specified bucket and key name.

never stores partial objects; if during this call an exception wasn't thrown, the entire object was stored.

When uploading directly from an input stream:

• Be careful to set the correct content type in the metadata object before directly sending a stream. Unlike file uploads, content types from input streams cannot be automatically determined. If the caller doesn't explicitly set the content type, it will not be set in .
• Content length must be specified before data can be uploaded to . Qcloud COS explicitly requires that the content length be sent in the request headers before it will accept any of the data. If the caller doesn't provide the length, the library must buffer the contents of the input stream in order to calculate it.

The specified bucket must already exist and the caller must have Permission#Write permission to the bucket to upload an object.

参数:

bucketName - The name of an existing bucket, to which you have Permission#Write permission.

key - The key under which to store the specified file.

input - The input stream containing the data to be uploaded to .

metadata - Additional metadata instructing how to handle the uploaded data (e.g. custom user metadata, hooks for specifying content type, etc.).

返回:

A PutObjectResult object containing the information returned by for the newly created object.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

putObject(PutObjectRequest), putObject(String, String, File)

putObject

PutObjectResult putObject(String bucketName,
                          String key,
                          String content)
                   throws CosClientException,
                          CosServiceException

upload string content to a cos object. content will be encoded to bytes with UTF-8 encoding

参数:

bucketName - The name of an existing bucket, to which you have Permission#Write permission.

key - The key under which to store the specified file.

content - the object content, content will be encoded to bytes with UTF-8 encoding.

返回:

A PutObjectResult object containing the information returned by for the newly created object.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

putObject(PutObjectRequest), putObject(String, String, File)

getObject

COSObject getObject(String bucketName,
                    String key)
             throws CosClientException,
                    CosServiceException

Gets the object stored in under the specified bucket and key.

Be extremely careful when using this method; the returned COS object contains a direct stream of data from the HTTP connection. The underlying HTTP connection cannot be closed until the user finishes reading the data and closes the stream. Therefore:

• Use the data from the input stream in object as soon as possible
• Close the input stream in object as soon as possible

If these rules are not followed, the client can run out of resources by allocating too many open, but unused, HTTP connections.

To get an object from , the caller must have Permission#Read access to the object.

If the object fetched is publicly readable, it can also read it by pasting its URL into a browser.

For more advanced options (such as downloading only a range of an object's content, or placing constraints on when the object should be downloaded) callers can use getObject(GetObjectRequest).

参数:

bucketName - The name of the bucket containing the desired object.

key - The key under which the desired object is stored.

返回:

The object stored in in the specified bucket and key.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

getObject(GetObjectRequest), getObject(GetObjectRequest, File)

getObject

COSObject getObject(GetObjectRequest getObjectRequest)
             throws CosClientException,
                    CosServiceException

Gets the object stored in under the specified bucket and key. Returns null if the specified constraints weren't met.

Be extremely careful when using this method; the returned COS object contains a direct stream of data from the HTTP connection. The underlying HTTP connection cannot be closed until the user finishes reading the data and closes the stream. Therefore:

• Use the data from the input stream in object as soon as possible,
• Close the input stream in object as soon as possible.

If callers do not follow those rules, then the client can run out of resources if allocating too many open, but unused, HTTP connections.

To get an object from , the caller must have Permission#Read access to the object.

If the object fetched is publicly readable, it can also read it by pasting its URL into a browser.

When specifying constraints in the request object, the client needs to be prepared to handle this method returning null if the provided constraints aren't met when Qcloud COS receives the request.

If the advanced options provided in GetObjectRequest aren't needed, use the simpler getObject(String bucketName, String key) method.

指定者:

getObject 在接口中 COSDirectSpi

参数:

getObjectRequest - The request object containing all the options on how to download the object.

返回:

The object stored in in the specified bucket and key. Returns null if constraints were specified but not met.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

getObject(String, String), getObject(GetObjectRequest, File)

getObject

ObjectMetadata getObject(GetObjectRequest getObjectRequest,
                         File destinationFile)
                  throws CosClientException,
                         CosServiceException

Gets the object metadata for the object stored in under the specified bucket and key, and saves the object contents to the specified file. Returns null if the specified constraints weren't met.

Instead of using getObject(GetObjectRequest), use this method to ensure that the underlying HTTP stream resources are automatically closed as soon as possible. The clients handles immediate storage of the object contents to the specified file.

To get an object from , the caller must have Permission#Read access to the object.

If the object fetched is publicly readable, it can also read it by pasting its URL into a browser.

When specifying constraints in the request object, the client needs to be prepared to handle this method returning null if the provided constraints aren't met when Qcloud COS receives the request.

指定者:

getObject 在接口中 COSDirectSpi

参数:

getObjectRequest - The request object containing all the options on how to download the object content.

destinationFile - Indicates the file (which might already exist) where to save the object content being downloading from .

返回:

All COS object metadata for the specified object. Returns null if constraints were specified but not met.

抛出:

CosClientException - If any errors are encountered in the client while making the request, handling the response, or writing the incoming data from COS to the specified destination file.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

getObject(String, String), getObject(GetObjectRequest)

doesObjectExist

boolean doesObjectExist(String bucketName,
                        String objectName)
                 throws CosClientException,
                        CosServiceException

参数:

bucketName - Name of bucket that presumably contains object

objectName - Name of object that has to be checked

返回:

true if exist. otherwise false;

抛出:

CosClientException - If any errors are encountered in the client while making the request, handling the response, or writing the incoming data from COS to the specified destination file.

CosServiceException - If any errors occurred in while processing the request.

getObjectMetadata

ObjectMetadata getObjectMetadata(String bucketName,
                                 String key)
                          throws CosClientException,
                                 CosServiceException

Gets the metadata for the specified object without actually fetching the object itself. This is useful in obtaining only the object metadata, and avoids wasting bandwidth on fetching the object data.

The object metadata contains information such as content type, content disposition, etc., as well as custom user metadata that can be associated with an object in .

参数:

bucketName - bucket name

key - cos path

返回:

All COS object metadata for the specified object.

抛出:

CosClientException - If any errors are encountered on the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

getObjectMetadata

ObjectMetadata getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest)
                          throws CosClientException,
                                 CosServiceException

Gets the metadata for the specified object without actually fetching the object itself. This is useful in obtaining only the object metadata, and avoids wasting bandwidth on fetching the object data.

The object metadata contains information such as content type, content disposition, etc., as well as custom user metadata that can be associated with an object in .

参数:

getObjectMetadataRequest - The request object specifying the bucket, key and optional version ID of the object whose metadata is being retrieved.

返回:

All COS object metadata for the specified object.

抛出:

CosClientException - If any errors are encountered on the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

getObjectMetadata(String, String)

deleteObject

void deleteObject(String bucketName,
                  String key)
           throws CosClientException,
                  CosServiceException

Deletes the specified object in the specified bucket. Once deleted, the object can only be restored if versioning was enabled when the object was deleted.

If attempting to delete an object that does not exist, will return a success message instead of an error message.

参数:

bucketName - bucket name

key - cos path

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

deleteObject

void deleteObject(DeleteObjectRequest deleteObjectRequest)
           throws CosClientException,
                  CosServiceException

Deletes the specified object in the specified bucket. Once deleted, the object can only be restored if versioning was enabled when the object was deleted.

If attempting to delete an object that does not exist, will return a success message instead of an error message.

参数:

deleteObjectRequest - The request object containing all options for deleting an Qcloud COS object.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

COSClient.deleteObject(String, String)

deleteVersion

void deleteVersion(String bucketName,
                   String key,
                   String versionId)
            throws CosClientException,
                   CosServiceException

Deletes a specific version of the specified object in the specified bucket. Once deleted, there is no method to restore or undelete an object version. This is the only way to permanently delete object versions that are protected by versioning.

Deleting an object version is permanent and irreversible. It is a privileged operation that only the owner of the bucket containing the version can perform.

Users can only delete a version of an object if versioning is enabled for the bucket. For more information about enabling versioning for a bucket, see setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest).

If attempting to delete an object that does not exist, COS will return a success message instead of an error message.

参数:

bucketName - The name of the COS bucket containing the object to delete.

key - The key of the object to delete.

versionId - The version of the object to delete.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

deleteVersion

void deleteVersion(DeleteVersionRequest deleteVersionRequest)
            throws CosClientException,
                   CosServiceException

Deletes a specific version of the specified object in the specified bucket. Once deleted, there is no method to restore or undelete an object version. This is the only way to permanently delete object versions that are protected by versioning.

Deleting an object version is permanent and irreversible. It is a privileged operation that only the owner of the bucket containing the version can perform.

Users can only delete a version of an object if versioning is enabled for the bucket. For more information about enabling versioning for a bucket, see setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest).

If attempting to delete an object that does not exist, COS will return a success message instead of an error message.

参数:

deleteVersionRequest - The request object containing all options for deleting a specific version of an COS object.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

deleteObjects

DeleteObjectsResult deleteObjects(DeleteObjectsRequest deleteObjectsRequest)
                           throws MultiObjectDeleteException,
                                  CosClientException,
                                  CosServiceException

Deletes multiple objects in a single bucket from COS.

In some cases, some objects will be successfully deleted, while some attempts will cause an error. If any object in the request cannot be deleted, this method throws a MultiObjectDeleteException with details of the error.

参数:

deleteObjectsRequest - The request object containing all options for deleting multiple objects.

抛出:

MultiObjectDeleteException - if one or more of the objects couldn't be deleted.

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

createBucket

Bucket createBucket(String bucketName)
             throws CosClientException,
                    CosServiceException

Creates a new bucket in the region which is set in ClientConfig

Every object stored in is contained within a bucket. Appid and Bucket partition the namespace of objects stored in at the top level. Within a bucket, any name can be used for objects.

There are no limits to the number of objects that can be stored in a bucket. Performance does not vary based on the number of buckets used. Store all objects within a single bucket or organize them across several buckets.

Buckets cannot be nested; buckets cannot be created within other buckets.

Do not make bucket create or delete calls in the high availability code path of an application. Create or delete buckets in a separate initialization or setup routine that runs less often.

To create a bucket, authenticate with an account that has a valid Qcloud Access Key ID and is registered with . Anonymous requests are never allowed to create buckets.

参数:

bucketName - The name of the bucket to be created

返回:

The newly created bucket.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

createBucket

Bucket createBucket(CreateBucketRequest createBucketRequest)
             throws CosClientException,
                    CosServiceException

Creates a new bucket in the region which is set in ClientConfig

Every object stored in is contained within a bucket. Appid and Bucket partition the namespace of objects stored in at the top level. Within a bucket, any name can be used for objects.

There are no limits to the number of objects that can be stored in a bucket. Performance does not vary based on the number of buckets used. Store all objects within a single bucket or organize them across several buckets.

Buckets cannot be nested; buckets cannot be created within other buckets.

Do not make bucket create or delete calls in the high availability code path of an application. Create or delete buckets in a separate initialization or setup routine that runs less often.

To create a bucket, authenticate with an account that has a valid Qcloud Access Key ID and is registered with . Anonymous requests are never allowed to create buckets.

参数:

createBucketRequest - The request object containing all options for creating an Qcloud COS bucket.

返回:

The newly created bucket.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

deleteBucket

void deleteBucket(String bucketName)
           throws CosClientException,
                  CosServiceException

Deletes the specified bucket. All objects (and all object versions, if versioning was ever enabled) in the bucket must be deleted before the bucket itself can be deleted.

Only the owner of a bucket can delete it, regardless of the bucket's access control policy (ACL).

参数:

bucketName - The name of the bucket to be deleted

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

deleteBucket

void deleteBucket(DeleteBucketRequest deleteBucketRequest)
           throws CosClientException,
                  CosServiceException

Deletes the specified bucket. All objects (and all object versions, if versioning was ever enabled) in the bucket must be deleted before the bucket itself can be deleted.

Only the owner of a bucket can delete it, regardless of the bucket's access control policy (ACL).

参数:

deleteBucketRequest - The request object containing all options for deleting an Qcloud COS bucket.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

deleteBucket(String)

doesBucketExist

boolean doesBucketExist(String bucketName)
                 throws CosClientException,
                        CosServiceException

Checks if the specified bucket exists. use this method to determine if a specified bucket name already exists, and therefore can't be used to create a new bucket.

Internally this uses the getBucketAcl(String) operation to determine whether the bucket exists.

参数:

bucketName - The name of the bucket to check.

返回:

The value true if the specified bucket exists ; the value false if there is no bucket with that name.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

headBucket

HeadBucketResult headBucket(HeadBucketRequest headBucketRequest)
                     throws CosClientException,
                            CosServiceException

Performs a head bucket operation on the requested bucket name. This operation is useful to determine if a bucket exists and you have permission to access it.

参数:

headBucketRequest - The request containing the bucket name.

返回:

This method returns a HeadBucketResult if the bucket exists and you have permission to access it. Otherwise, the method will throw an CosServiceException with status code '404 Not Found' if the bucket does not exist, '403 Forbidden' if the user does not have access to the bucket

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

listBuckets

List<Bucket> listBuckets()
                  throws CosClientException,
                         CosServiceException

Returns a list of all buckets that the authenticated sender of the request owns.

返回:

A list of all of the buckets owned by the authenticated sender of the request.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

listBuckets

List<Bucket> listBuckets(ListBucketsRequest listBucketsRequest)
                  throws CosClientException,
                         CosServiceException

Returns a list of all buckets that the authenticated sender of the request owns.

参数:

listBucketsRequest - The request containing all of the options related to the listing of buckets.

返回:

A list of all of the buckets owned by the authenticated sender of the request.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

getBucketLocation

String getBucketLocation(String bucketName)
                  throws CosClientException,
                         CosServiceException

Gets the geographical region where stores the specified bucket.

To view the location constraint of a bucket, the user must be the bucket owner.

参数:

bucketName - The name of the bucket to get location

返回:

The location of the specified bucket.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

getBucketLocation

String getBucketLocation(GetBucketLocationRequest getBucketLocationRequest)
                  throws CosClientException,
                         CosServiceException

Gets the geographical region where stores the specified bucket.

To view the location constraint of a bucket, the user must be the bucket owner.

参数:

getBucketLocationRequest - The request object containing the name of the bucket to look up. This must be a bucket the user owns.

返回:

The location of the specified bucket.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

initiateMultipartUpload

InitiateMultipartUploadResult initiateMultipartUpload(InitiateMultipartUploadRequest request)
                                               throws CosClientException,
                                                      CosServiceException

Initiates a multipart upload and returns an InitiateMultipartUploadResult which contains an upload ID. This upload ID associates all the parts in the specific upload and is used in each of your subsequent uploadPart(UploadPartRequest) requests. You also include this upload ID in the final request to either complete, or abort the multipart upload request.

Note: After you initiate a multipart upload and upload one or more parts, you must either complete or abort the multipart upload in order to stop getting charged for storage of the uploaded parts. Once you complete or abort the multipart upload will release the stored parts and stop charging you for their storage.

指定者:

initiateMultipartUpload 在接口中 COSDirectSpi

参数:

request - The InitiateMultipartUploadRequest object that specifies all the parameters of this operation.

返回:

An InitiateMultipartUploadResult from .

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

uploadPart

UploadPartResult uploadPart(UploadPartRequest uploadPartRequest)
                     throws CosClientException,
                            CosServiceException

Uploads a part in a multipart upload. You must initiate a multipart upload before you can upload any part.

Your UploadPart request must include an upload ID and a part number. The upload ID is the ID returned by in response to your Initiate Multipart Upload request. Part number can be any number between 1 and 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being uploaded. If you upload a new part using the same part number that was specified in uploading a previous part, the previously uploaded part is overwritten.

To ensure data is not corrupted traversing the network, specify the Content-MD5 header in the Upload Part request. checks the part data against the provided MD5 value. If they do not match, returns an error.

When you upload a part, the returned UploadPartResult contains an ETag property. You should record this ETag property value and the part number. After uploading all parts, you must send a CompleteMultipartUpload request. At that time constructs a complete object by concatenating all the parts you uploaded, in ascending order based on the part numbers. The CompleteMultipartUpload request requires you to send all the part numbers and the corresponding ETag values.

Note: After you initiate a multipart upload and upload one or more parts, you must either complete or abort the multipart upload in order to stop getting charged for storage of the uploaded parts. Once you complete or abort the multipart upload will release the stored parts and stop charging you for their storage.

指定者:

uploadPart 在接口中 COSDirectSpi

参数:

request - The UploadPartRequest object that specifies all the parameters of this operation.

返回:

An UploadPartResult from containing the part number and ETag of the new part.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

listParts

PartListing listParts(ListPartsRequest request)
               throws CosClientException,
                      CosServiceException

Lists the parts that have been uploaded for a specific multipart upload.

This method must include the upload ID, returned by the initiateMultipartUpload(InitiateMultipartUploadRequest) operation. This request returns a maximum of 1000 uploaded parts by default. You can restrict the number of parts returned by specifying the MaxParts property on the ListPartsRequest. If your multipart upload consists of more parts than allowed in the ListParts response, the response returns a IsTruncated field with value true, and a NextPartNumberMarker property. In subsequent ListParts request you can include the PartNumberMarker property and set its value to the NextPartNumberMarker property value from the previous response.

参数:

request - The ListPartsRequest object that specifies all the parameters of this operation.

返回:

Returns a PartListing from .

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

abortMultipartUpload

void abortMultipartUpload(AbortMultipartUploadRequest request)
                   throws CosClientException,
                          CosServiceException

Aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed.

指定者:

abortMultipartUpload 在接口中 COSDirectSpi

参数:

request - The AbortMultipartUploadRequest object that specifies all the parameters of this operation.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

completeMultipartUpload

CompleteMultipartUploadResult completeMultipartUpload(CompleteMultipartUploadRequest request)
                                               throws CosClientException,
                                                      CosServiceException

Completes a multipart upload by assembling previously uploaded parts.

You first upload all parts using the uploadPart(UploadPartRequest) method. After successfully uploading all individual parts of an upload, you call this operation to complete the upload. Upon receiving this request, concatenates all the parts in ascending order by part number to create a new object. In the CompleteMultipartUpload request, you must provide the parts list. For each part in the list, you provide the part number and the ETag header value, returned after that part was uploaded.

Processing of a CompleteMultipartUpload request may take several minutes to complete.

指定者:

completeMultipartUpload 在接口中 COSDirectSpi

参数:

request - The CompleteMultipartUploadRequest object that specifies all the parameters of this operation.

返回:

A CompleteMultipartUploadResult from COS containing the ETag for the new object composed of the individual parts.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

listMultipartUploads

MultipartUploadListing listMultipartUploads(ListMultipartUploadsRequest request)
                                     throws CosClientException,
                                            CosServiceException

Lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated, using the InitiateMultipartUpload request, but has not yet been completed or aborted.

This operation returns at most 1,000 multipart uploads in the response by default. The number of multipart uploads can be further limited using the MaxUploads property on the request parameter. If there are additional multipart uploads that satisfy the list criteria, the response will contain an IsTruncated property with the value set to true. To list the additional multipart uploads use the KeyMarker and UploadIdMarker properties on the request parameters.

参数:

request - The ListMultipartUploadsRequest object that specifies all the parameters of this operation.

返回:

A MultipartUploadListing from .

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

listObjects

ObjectListing listObjects(String bucketName)
                   throws CosClientException,
                          CosServiceException

Returns a list of summary information about the objects in the specified buckets. List results are always returned in lexicographic (alphabetical) order.

Because buckets can contain a virtually unlimited number of keys, the complete results of a list query can be extremely large. To manage large result sets, uses pagination to split them into multiple responses. Always check the ObjectListing.isTruncated() method to see if the returned listing is complete or if additional calls are needed to get more results. Alternatively, use the listNextBatchOfObjects(ObjectListing) method as an easy way to get the next page of object listings.

The total number of keys in a bucket doesn't substantially affect list performance.

参数:

bucketName - The name of the bucket to list.

返回:

A listing of the objects in the specified bucket, along with any other associated information, such as common prefixes (if a delimiter was specified), the original request parameters, etc.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

listObjects(String, String), listObjects(ListObjectsRequest)

listObjects

ObjectListing listObjects(String bucketName,
                          String prefix)
                   throws CosClientException,
                          CosServiceException

Returns a list of summary information about the objects in the specified bucket. Depending on request parameters, additional information is returned, such as common prefixes if a delimiter was specified. List results are always returned in lexicographic (alphabetical) order.

Because buckets can contain a virtually unlimited number of keys, the complete results of a list query can be extremely large. To manage large result sets, uses pagination to split them into multiple responses. Always check the ObjectListing.isTruncated() method to see if the returned listing is complete or if additional calls are needed to get more results. Alternatively, use the listNextBatchOfObjects(ObjectListing) method as an easy way to get the next page of object listings.

For example, consider a bucket that contains the following keys:

• "foo/bar/baz"
• "foo/bar/bash"
• "foo/bar/bang"
• "foo/boo"

If calling listObjects with a prefix value of "foo/" and a delimiter value of "/" on this bucket, an ObjectListing is returned that contains one key ("foo/boo") and one entry in the common prefixes list ("foo/bar/"). To see deeper into the virtual hierarchy, make another call to listObjects setting the prefix parameter to any interesting common prefix to list the individual keys under that prefix.

The total number of keys in a bucket doesn't substantially affect list performance.

参数:

bucketName - The name of the bucket to list.

prefix - An optional parameter restricting the response to keys beginning with the specified prefix. Use prefixes to separate a bucket into different sets of keys, similar to how a file system organizes files into directories.

返回:

A listing of the objects in the specified bucket, along with any other associated information, such as common prefixes (if a delimiter was specified), the original request parameters, etc.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

listObjects(String), listObjects(ListObjectsRequest)

listObjects

ObjectListing listObjects(ListObjectsRequest listObjectsRequest)
                   throws CosClientException,
                          CosServiceException

Returns a list of summary information about the objects in the specified bucket. Depending on the request parameters, additional information is returned, such as common prefixes if a delimiter was specified. List results are always returned in lexicographic (alphabetical) order.

Because buckets can contain a virtually unlimited number of keys, the complete results of a list query can be extremely large. To manage large result sets, uses pagination to split them into multiple responses. Always check the ObjectListing.isTruncated() method to see if the returned listing is complete or if additional calls are needed to get more results. Alternatively, use the listNextBatchOfObjects(ObjectListing) method as an easy way to get the next page of object listings.

Calling ListObjectsRequest.setDelimiter(String) sets the delimiter, allowing groups of keys that share the delimiter-terminated prefix to be included in the returned listing. This allows applications to organize and browse their keys hierarchically, similar to how a file system organizes files into directories. These common prefixes can be retrieved through the ObjectListing.getCommonPrefixes() method.

For example, consider a bucket that contains the following keys:

• "foo/bar/baz"
• "foo/bar/bash"
• "foo/bar/bang"
• "foo/boo"

If calling listObjects with a prefix value of "foo/" and a delimiter value of "/" on this bucket, an ObjectListing is returned that contains one key ("foo/boo") and one entry in the common prefixes list ("foo/bar/"). To see deeper into the virtual hierarchy, make another call to listObjects setting the prefix parameter to any interesting common prefix to list the individual keys under that prefix.

The total number of keys in a bucket doesn't substantially affect list performance.

参数:

listObjectsRequest - The request object containing all options for listing the objects in a specified bucket.

返回:

A listing of the objects in the specified bucket, along with any other associated information, such as common prefixes (if a delimiter was specified), the original request parameters, etc.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

listObjects(String), listObjects(String, String)

listNextBatchOfObjects

ObjectListing listNextBatchOfObjects(ObjectListing previousObjectListing)
                              throws CosClientException,
                                     CosServiceException

Provides an easy way to continue a truncated object listing and retrieve the next page of results.

To continue the object listing and retrieve the next page of results, call the initial ObjectListing from one of the listObjects methods. If truncated (indicated when ObjectListing.isTruncated() returns true), pass the ObjectListing back into this method in order to retrieve the next page of results. Continue using this method to retrieve more results until the returned ObjectListing indicates that it is not truncated.

参数:

previousObjectListing - The previous truncated ObjectListing. If a non-truncated ObjectListing is passed in, an empty ObjectListing is returned without ever contacting .

返回:

The next set of ObjectListing results, beginning immediately after the last result in the specified previous ObjectListing.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

listObjects(String), listObjects(String, String), listObjects(ListObjectsRequest), listNextBatchOfObjects(ListNextBatchOfObjectsRequest)

listNextBatchOfObjects

ObjectListing listNextBatchOfObjects(ListNextBatchOfObjectsRequest listNextBatchOfObjectsRequest)
                              throws CosClientException,
                                     CosServiceException

Provides an easy way to continue a truncated object listing and retrieve the next page of results.

To continue the object listing and retrieve the next page of results, call the initial ObjectListing from one of the listObjects methods. If truncated (indicated when ObjectListing.isTruncated() returns true), pass the ObjectListing back into this method in order to retrieve the next page of results. Continue using this method to retrieve more results until the returned ObjectListing indicates that it is not truncated.

参数:

listNextBatchOfObjectsRequest - The request object for listing next batch of objects using the previous truncated ObjectListing. If a non-truncated ObjectListing is passed in by the request object, an empty ObjectListing is returned without ever contacting .

返回:

The next set of ObjectListing results, beginning immediately after the last result in the specified previous ObjectListing.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

listObjects(String), listObjects(String, String), listObjects(ListObjectsRequest), listNextBatchOfObjects(ObjectListing)

listVersions

VersionListing listVersions(String bucketName,
                            String prefix)
                     throws CosClientException,
                            CosServiceException

Returns a list of summary information about the versions in the specified bucket.

The returned version summaries are ordered first by key and then by version. Keys are sorted lexicographically (alphabetically) while versions are sorted from most recent to least recent. Both versions with data and delete markers are included in the results.

Because buckets can contain a virtually unlimited number of versions, the complete results of a list query can be extremely large. To manage large result sets, COS uses pagination to split them into multiple responses. Always check the VersionListing.isTruncated() method to determine if the returned listing is complete or if additional calls are needed to get more results. Callers are encouraged to use listNextBatchOfVersions(VersionListing) as an easy way to get the next page of results.

For more information about enabling versioning for a bucket, see setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest).

参数:

bucketName - The name of the COS bucket whose versions are to be listed.

prefix - An optional parameter restricting the response to keys beginning with the specified prefix. Use prefixes to separate a bucket into different sets of keys, similar to how a file system organizes files into directories.

返回:

A listing of the versions in the specified bucket, along with any other associated information and original request parameters.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

listVersions(ListVersionsRequest), listVersions(String, String, String, String, String, Integer)

listVersions

VersionListing listVersions(String bucketName,
                            String prefix,
                            String keyMarker,
                            String versionIdMarker,
                            String delimiter,
                            Integer maxResults)
                     throws CosClientException,
                            CosServiceException

Returns a list of summary information about the versions in the specified bucket.

The returned version summaries are ordered first by key and then by version. Keys are sorted lexicographically (alphabetically) while versions are sorted from most recent to least recent. Both versions with data and delete markers are included in the results.

Because buckets can contain a virtually unlimited number of versions, the complete results of a list query can be extremely large. To manage large result sets, COS uses pagination to split them into multiple responses. Always check the VersionListing.isTruncated() method to determine if the returned listing is complete or if additional calls are needed to get more results. Callers are encouraged to use listNextBatchOfVersions(VersionListing) as an easy way to get the next page of results.

For more information about enabling versioning for a bucket, see setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest).

参数:

bucketName - The name of the QCloud COS bucket whose versions are to be listed.

prefix - An optional parameter restricting the response to keys that begin with the specified prefix. Use prefixes to separate a bucket into different sets of keys, similar to how a file system organizes files into directories.

keyMarker - Optional parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results. Results are always ordered first lexicographically (i.e. alphabetically) and then from most recent version to least recent version. If a keyMarker is used without a versionIdMarker, results begin immediately after that key's last version. When a keyMarker is used with a versionIdMarker, results begin immediately after the version with the specified key and version ID.

This enables pagination; to get the next page of results use the next key marker and next version ID marker (from VersionListing.getNextKeyMarker() and VersionListing.getNextVersionIdMarker()) as the markers for the next request to list versions, or use the convenience method listNextBatchOfVersions(VersionListing)

versionIdMarker - Optional parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results. Results are always ordered first lexicographically (i.e. alphabetically) and then from most recent version to least recent version. A keyMarker must be specified when specifying a versionIdMarker. Results begin immediately after the version with the specified key and version ID.

This enables pagination; to get the next page of results use the next key marker and next version ID marker (from VersionListing.getNextKeyMarker() and VersionListing.getNextVersionIdMarker()) as the markers for the next request to list versions, or use the convenience method listNextBatchOfVersions(VersionListing)

delimiter - Optional parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the VersionListing.getCommonPrefixes() list. These rolled-up keys are not returned elsewhere in the response. The most commonly used delimiter is "/", which simulates a hierarchical organization similar to a file system directory structure.

maxResults - Optional parameter indicating the maximum number of results to include in the response. QCloud COS might return fewer than this, but will not return more. Even if maxKeys is not specified, QCloud COS will limit the number of results in the response.

返回:

A listing of the versions in the specified bucket, along with any other associated information and original request parameters.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

listVersions(ListVersionsRequest), listVersions(String, String)

listVersions

VersionListing listVersions(ListVersionsRequest listVersionsRequest)
                     throws CosClientException,
                            CosServiceException

Returns a list of summary information about the versions in the specified bucket.

The returned version summaries are ordered first by key and then by version. Keys are sorted lexicographically (alphabetically) while versions are sorted from most recent to least recent. Both versions with data and delete markers are included in the results.

Because buckets can contain a virtually unlimited number of versions, the complete results of a list query can be extremely large. To manage large result sets, COS uses pagination to split them into multiple responses. Always check the VersionListing.isTruncated() method to determine if the returned listing is complete or if additional calls are needed to get more results. Callers are encouraged to use listNextBatchOfVersions(VersionListing) as an easy way to get the next page of results.

For more information about enabling versioning for a bucket, see setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest).

参数:

listVersionsRequest - The request object containing all options for listing the versions in a specified bucket.

返回:

A listing of the versions in the specified bucket, along with any other associated information and original request parameters.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

listVersions(String, String, String, String, String, Integer), listVersions(String, String)

listNextBatchOfVersions

VersionListing listNextBatchOfVersions(VersionListing previousVersionListing)
                                throws CosClientException,
                                       CosServiceException

Provides an easy way to continue a truncated VersionListing and retrieve the next page of results.

Obtain the initial VersionListing from one of the listVersions methods. If the result is truncated (indicated when VersionListing.isTruncated() returns true), pass the VersionListing back into this method in order to retrieve the next page of results. From there, continue using this method to retrieve more results until the returned VersionListing indicates that it is not truncated.

For more information about enabling versioning for a bucket, see setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest).

参数:

previousVersionListing - The previous truncated VersionListing. If a non-truncated VersionListing is passed in, an empty VersionListing is returned without ever contacting COS.

返回:

The next set of VersionListing results, beginning immediately after the last result in the specified previous VersionListing.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

listVersions(String, String), listVersions(ListVersionsRequest), listVersions(String, String, String, String, String, Integer), listNextBatchOfVersions(ListNextBatchOfVersionsRequest)

listNextBatchOfVersions

VersionListing listNextBatchOfVersions(ListNextBatchOfVersionsRequest listNextBatchOfVersionsRequest)
                                throws CosClientException,
                                       CosServiceException

Provides an easy way to continue a truncated VersionListing and retrieve the next page of results.

Obtain the initial VersionListing from one of the listVersions methods. If the result is truncated (indicated when VersionListing.isTruncated() returns true), pass the VersionListing back into this method in order to retrieve the next page of results. From there, continue using this method to retrieve more results until the returned VersionListing indicates that it is not truncated.

For more information about enabling versioning for a bucket, see setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest).

参数:

listNextBatchOfVersionsRequest - The request object for listing next batch of versions using the previous truncated VersionListing. If a non-truncated VersionListing is passed in by the request object, an empty VersionListing is returned without ever contacting COS.

返回:

The next set of VersionListing results, beginning immediately after the last result in the specified previous VersionListing.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

另请参阅:

listVersions(String, String), listVersions(ListVersionsRequest), listVersions(String, String, String, String, String, Integer), listNextBatchOfVersions(VersionListing)

copyObject

CopyObjectResult copyObject(String sourceBucketName,
                            String sourceKey,
                            String destinationBucketName,
                            String destinationKey)
                     throws CosClientException,
                            CosServiceException

Copy a source object to a new destination in COS.

To copy an object, the caller's account must have read access to the source object and write access to the destination bucket. cos support copy a object from a diff account, diff region, diff bucket

参数:

sourceBucketName - The name of the bucket containing the source object to copy.

sourceKey - The key in the source bucket under which the source object is stored.

destinationBucketName - The name of the bucket in which the new object will be created. This can be the same name as the source bucket's.

destinationKey - The key in the destination bucket under which the new object will be created.

返回:

A CopyObjectResult object containing the information returned by about the newly created object, or null if constraints were specified that weren't met when attempted to copy the object.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

copyObject

CopyObjectResult copyObject(CopyObjectRequest copyObjectRequest)
                     throws CosClientException,
                            CosServiceException

Copy a source object to a new destination in COS.

To copy an object, the caller's account must have read access to the source object and write access to the destination bucket. cos support copy a object from a diff account, diff region, diff bucket

参数:

copyObjectRequest - The request object containing all the options for copying an QCloud COS object.

返回:

A CopyObjectResult object containing the information returned by about the newly created object, or null if constraints were specified that weren't met when attempted to copy the object.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

copyPart

CopyPartResult copyPart(CopyPartRequest copyPartRequest)
                 throws CosClientException,
                        CosServiceException

Copies a source object to a part of a multipart upload. To copy an object, the caller's account must have read access to the source object and write access to the destination bucket.

指定者:

copyPart 在接口中 COSDirectSpi

参数:

copyPartRequest - The request object containing all the options for copying an object.

返回:

CopyPartResult containing the information returned by COS about the newly created object, or null if constraints were specified that weren't met when COS attempted to copy the object.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

setBucketLifecycleConfiguration

void setBucketLifecycleConfiguration(String bucketName,
                                     BucketLifecycleConfiguration bucketLifecycleConfiguration)
                              throws CosClientException,
                                     CosServiceException

Sets the lifecycle configuration for the specified bucket.

参数:

bucketName - the bucket name

bucketLifecycleConfiguration - lifecycle config for the bucket

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

setBucketLifecycleConfiguration

void setBucketLifecycleConfiguration(SetBucketLifecycleConfigurationRequest setBucketLifecycleConfigurationRequest)
                              throws CosClientException,
                                     CosServiceException

Sets the lifecycle configuration for the specified bucket.

参数:

setBucketLifecycleConfigurationRequest - The request object containing all options for setting the bucket lifecycle configuration.

抛出:

CosClientException - If any errors are encountered in the client while making the `------+++++++++++++++++++++++++++++++++++++++++++++++++* request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

getBucketLifecycleConfiguration

BucketLifecycleConfiguration getBucketLifecycleConfiguration(String bucketName)
                                                      throws CosClientException,
                                                             CosServiceException

Gets the lifecycle configuration for the specified bucket, or null if the specified bucket does not exist or if no configuration has been established.

参数:

bucketName - the bucket name

返回:

BucketLifecycleConfiguration the bucket lifecycle configuration

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

getBucketLifecycleConfiguration

BucketLifecycleConfiguration getBucketLifecycleConfiguration(GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest)
                                                      throws CosClientException,
                                                             CosServiceException

Gets the lifecycle configuration for the specified bucket, or null if the specified bucket does not exist or if no configuration has been established.

参数:

getBucketLifecycleConfigurationRequest - The request object for retrieving the bucket lifecycle configuration.

返回:

BucketLifecycleConfiguration the bucket lifecycle configuration

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

deleteBucketLifecycleConfiguration

void deleteBucketLifecycleConfiguration(String bucketName)
                                 throws CosClientException,
                                        CosServiceException

Removes the lifecycle configuration for the bucket specified.

参数:

bucketName - the bucket name

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

deleteBucketLifecycleConfiguration

void deleteBucketLifecycleConfiguration(DeleteBucketLifecycleConfigurationRequest deleteBucketLifecycleConfigurationRequest)
                                 throws CosClientException,
                                        CosServiceException

Removes the lifecycle configuration for the bucket specified.

参数:

deleteBucketLifecycleConfigurationRequest - The request object containing all options for removing the bucket lifecycle configuration.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

setBucketVersioningConfiguration

void setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest setBucketVersioningConfigurationRequest)
                               throws CosClientException,
                                      CosServiceException

Sets the versioning configuration for the specified bucket.

A bucket's versioning configuration can be in one of three possible states:

• BucketVersioningConfiguration.OFF
• BucketVersioningConfiguration.ENABLED
• BucketVersioningConfiguration.SUSPENDED

By default, new buckets are in the off state. Once versioning is enabled for a bucket the status can never be reverted to off.

Objects created before versioning was enabled or when versioning is suspended will be given the default null version ID (see Constants#NULL_VERSION_ID). Note that the null version ID is a valid version ID and is not the same as not having a version ID.

The versioning configuration of a bucket has different implications for each operation performed on that bucket or for objects within that bucket. For example, when versioning is enabled a PutObject operation creates a unique object version-id for the object being uploaded. The The PutObject API guarantees that, if versioning is enabled for a bucket at the time of the request, the new object can only be permanently deleted using a DeleteVersion operation. It can never be overwritten. Additionally, the PutObject API guarantees that, if versioning is enabled for a bucket the request, no other object will be overwritten by that request. Refer to the documentation sections for each API for information on how versioning status affects the semantics of that particular API.

参数:

setBucketVersioningConfigurationRequest - The request object containing all options for setting the bucket versioning configuration.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

getBucketVersioningConfiguration

BucketVersioningConfiguration getBucketVersioningConfiguration(String bucketName)
                                                        throws CosClientException,
                                                               CosServiceException

Returns the versioning configuration for the specified bucket.

A bucket's versioning configuration can be in one of three possible states:

• BucketVersioningConfiguration.OFF
• BucketVersioningConfiguration.ENABLED
• BucketVersioningConfiguration.SUSPENDED

By default, new buckets are in the off state. Once versioning is enabled for a bucket the status can never be reverted to off.

The versioning configuration of a bucket has different implications for each operation performed on that bucket or for objects within that bucket. For example, when versioning is enabled a PutObject operation creates a unique object version-id for the object being uploaded. The The PutObject API guarantees that, if versioning is enabled for a bucket at the time of the request, the new object can only be permanently deleted using a DeleteVersion operation. It can never be overwritten. Additionally, the PutObject API guarantees that, if versioning is enabled for a bucket the request, no other object will be overwritten by that request.

参数:

bucketName - the bucket name

返回:

The bucket versioning configuration for the specified bucket.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

getBucketVersioningConfiguration

BucketVersioningConfiguration getBucketVersioningConfiguration(GetBucketVersioningConfigurationRequest getBucketVersioningConfigurationRequest)
                                                        throws CosClientException,
                                                               CosServiceException

Returns the versioning configuration for the specified bucket.

A bucket's versioning configuration can be in one of three possible states:

• BucketVersioningConfiguration.OFF
• BucketVersioningConfiguration.ENABLED
• BucketVersioningConfiguration.SUSPENDED

By default, new buckets are in the off state. Once versioning is enabled for a bucket the status can never be reverted to off.

The versioning configuration of a bucket has different implications for each operation performed on that bucket or for objects within that bucket. For example, when versioning is enabled a PutObject operation creates a unique object version-id for the object being uploaded. The The PutObject API guarantees that, if versioning is enabled for a bucket at the time of the request, the new object can only be permanently deleted using a DeleteVersion operation. It can never be overwritten. Additionally, the PutObject API guarantees that, if versioning is enabled for a bucket the request, no other object will be overwritten by that request.

参数:

getBucketVersioningConfigurationRequest - The request object for retrieving the bucket versioning configuration.

返回:

The bucket versioning configuration for the specified bucket.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

setBucketPolicy

void setBucketPolicy(String bucketName,
                     String policyText)
              throws CosClientException,
                     CosServiceException

Sets the policy associated with the specified bucket. Only the owner of the bucket can set a bucket policy. If a policy already exists for the specified bucket, the new policy replaces the existing policy.

参数:

bucketName - the bucket name

policyText - The policy to apply to the specified bucket.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

setBucketPolicy

void setBucketPolicy(SetBucketPolicyRequest setBucketPolicyRequest)
              throws CosClientException,
                     CosServiceException

Sets the policy associated with the specified bucket. Only the owner of the bucket can set a bucket policy. If a policy already exists for the specified bucket, the new policy replaces the existing policy.

参数:

setBucketPolicyRequest - The request object containing the details of the bucket and policy to update.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

getBucketPolicy

BucketPolicy getBucketPolicy(String bucketName)
                      throws CosClientException,
                             CosServiceException

Gets the policy for the specified bucket. Only the owner of the bucket can retrieve the policy. If no policy has been set for the bucket, then an empty result object with a null policy text field will be returned.

参数:

bucketName - the bucket name

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

getBucketPolicy

BucketPolicy getBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest)
                      throws CosClientException,
                             CosServiceException

Gets the policy for the specified bucket. Only the owner of the bucket can retrieve the policy. If no policy has been set for the bucket, then an empty result object with a null policy text field will be returned.

参数:

getBucketPolicyRequest - get bucket policy request

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

deleteBucketPolicy

void deleteBucketPolicy(String bucketName)
                 throws CosClientException,
                        CosServiceException

Deletes the policy associated with the specified bucket. Only the owner of the bucket can delete the bucket policy.

参数:

bucketName - the bucket name

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

deleteBucketPolicy

void deleteBucketPolicy(DeleteBucketPolicyRequest deleteBucketPolicyRequest)
                 throws CosClientException,
                        CosServiceException

Deletes the policy associated with the specified bucket. Only the owner of the bucket can delete the bucket policy.

参数:

bucketName - the bucket name

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

getObjectAcl

AccessControlList getObjectAcl(String bucketName,
                               String key)
                        throws CosClientException,
                               CosServiceException

Gets the AccessControlList (ACL) for the specified object in Qcloud COS.

Each bucket and object in Qcloud COS has an ACL that defines its access control policy. When a request is made, Qcloud COS authenticates the request using its standard authentication procedure and then checks the ACL to verify the sender was granted access to the bucket or object. If the sender is approved, the request proceeds. Otherwise, Qcloud COS returns an error.

参数:

bucketName - The name of the bucket containing the object whose ACL is being retrieved.

key - The key of the object within the specified bucket whose ACL is being retrieved.

返回:

The AccessControlList for the specified Qcloud COS object.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

getObjectAcl

AccessControlList getObjectAcl(GetObjectAclRequest getObjectAclRequest)
                        throws CosClientException,
                               CosServiceException

Gets the AccessControlList (ACL) for the specified object in Qcloud COS.

Each bucket and object in Qcloud COS has an ACL that defines its access control policy. When a request is made, Qcloud COS authenticates the request using its standard authentication procedure and then checks the ACL to verify the sender was granted access to the bucket or object. If the sender is approved, the request proceeds. Otherwise, Qcloud COS returns an error.

参数:

getObjectAclRequest - the request object containing all the information needed for retrieving the object ACL.

返回:

The AccessControlList for the specified Qcloud COS object.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

setObjectAcl

void setObjectAcl(String bucketName,
                  String key,
                  AccessControlList acl)
           throws CosClientException,
                  CosServiceException

Sets the CannedAccessControlList for the specified object.

Each bucket and object in has an ACL that defines its access control policy. When a request is made, authenticates the request using its standard authentication procedure and then checks the ACL to verify the sender was granted access to the bucket or object. If the sender is approved, the request proceeds. Otherwise, returns an error.

参数:

bucketName - The name of the bucket containing the object whose ACL is being set.

key - The key of the object within the specified bucket whose ACL is being set.

acl - The new AccessControlList for the specified object.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

setObjectAcl

void setObjectAcl(String bucketName,
                  String key,
                  CannedAccessControlList acl)
           throws CosClientException,
                  CosServiceException

Sets the CannedAccessControlList for the specified object.

Each bucket and object in has an ACL that defines its access control policy. When a request is made, authenticates the request using its standard authentication procedure and then checks the ACL to verify the sender was granted access to the bucket or object. If the sender is approved, the request proceeds. Otherwise, returns an error.

参数:

bucketName - The name of the bucket containing the object whose ACL is being set.

key - The key of the object within the specified bucket whose ACL is being set.

acl - The new pre-configured CannedAccessControlList for the specified object.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

setObjectAcl

void setObjectAcl(SetObjectAclRequest setObjectAclRequest)
           throws CosClientException,
                  CosServiceException

Sets the AccessControlList for the specified object.

Each bucket and object in has an ACL that defines its access control policy. When a request is made, authenticates the request using its standard authentication procedure and then checks the ACL to verify the sender was granted access to the bucket or object. If the sender is approved, the request proceeds. Otherwise, returns an error.

参数:

setObjectAclRequest - The request object containing the COS object to modify and the ACL to set.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

setBucketAcl

void setBucketAcl(String bucketName,
                  AccessControlList acl)
           throws CosClientException,
                  CosServiceException

Sets the AccessControlList for the specified bucket.

Each bucket and object in COS has an ACL that defines its access control policy. When a request is made, COS authenticates the request using its standard authentication procedure and then checks the ACL to verify the sender was granted access to the bucket or object. If the sender is approved, the request proceeds. Otherwise, COS returns an error.

When constructing a custom AccessControlList, callers typically retrieve the existing AccessControlList for a bucket .

参数:

bucketName - The name of the bucket whose ACL is being set

acl - The new pre-configured CannedAccessControlList for the specified COS bucket.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

setBucketAcl

void setBucketAcl(String bucketName,
                  CannedAccessControlList acl)
           throws CosClientException,
                  CosServiceException

Sets the CannedAccessControlList for the specified bucket.

Each bucket and object in COS has an ACL that defines its access control policy. When a request is made, COS authenticates the request using its standard authentication procedure and then checks the ACL to verify the sender was granted access to the bucket or object. If the sender is approved, the request proceeds. Otherwise, COS returns an error.

When constructing a custom AccessControlList, callers typically retrieve the existing AccessControlList for a bucket .

参数:

bucketName - The name of the bucket whose ACL is being set

acl - The AccessControlList for the specified COS bucket.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

setBucketAcl

void setBucketAcl(SetBucketAclRequest setBucketAclRequest)
           throws CosClientException,
                  CosServiceException

Sets the AccessControlList for the specified bucket.

Each bucket and object in COS has an ACL that defines its access control policy. When a request is made, COS authenticates the request using its standard authentication procedure and then checks the ACL to verify the sender was granted access to the bucket or object. If the sender is approved, the request proceeds. Otherwise, COS returns an error.

When constructing a custom AccessControlList, callers typically retrieve the existing AccessControlList for a bucket .

参数:

setBucketAclRequest - The request object containing the bucket to modify and the ACL to set.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in while processing the request.

getBucketAcl

AccessControlList getBucketAcl(String bucketName)
                        throws CosClientException,
                               CosServiceException

Gets the AccessControlList (ACL) for the specified bucket.

Each bucket and object in COS has an ACL that defines its access control policy. When a request is made, COS authenticates the request using its standard authentication procedure and then checks the ACL to verify the sender was granted access to the bucket or object. If the sender is approved, the request proceeds. Otherwise, COS returns an error.

参数:

bucketName - The name of the bucket whose ACL is being retrieved.

返回:

The AccessControlList for the specified COS bucket.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in COS while processing the request.

getBucketAcl

AccessControlList getBucketAcl(GetBucketAclRequest getBucketAclRequest)
                        throws CosClientException,
                               CosServiceException

Gets the AccessControlList (ACL) for the specified bucket.

Each bucket and object in COS has an ACL that defines its access control policy. When a request is made, COS authenticates the request using its standard authentication procedure and then checks the ACL to verify the sender was granted access to the bucket or object. If the sender is approved, the request proceeds. Otherwise, COS returns an error.

参数:

getBucketAclRequest - The request containing the name of the bucket whose ACL is being retrieved.

返回:

The AccessControlList for the specified COS bucket.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in COS while processing the request.

getBucketCrossOriginConfiguration

BucketCrossOriginConfiguration getBucketCrossOriginConfiguration(String bucketName)
                                                          throws CosClientException,
                                                                 CosServiceException

Gets the cross origin configuration for the specified bucket, or null if no configuration has been established.

参数:

bucketName - the bucket name

返回:

BucketCrossOriginConfiguration bucket cross origin configuration

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in COS while processing the request.

getBucketCrossOriginConfiguration

BucketCrossOriginConfiguration getBucketCrossOriginConfiguration(GetBucketCrossOriginConfigurationRequest getBucketCrossOriginConfigurationRequest)
                                                          throws CosClientException,
                                                                 CosServiceException

Gets the cross origin configuration for the specified bucket, or null if no configuration has been established.

参数:

getBucketCrossOriginConfigurationRequest - The request object for retrieving the bucket cross origin configuration.

返回:

BucketCrossOriginConfiguration bucket cross origin configuration

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in COS while processing the request.

setBucketCrossOriginConfiguration

void setBucketCrossOriginConfiguration(String bucketName,
                                       BucketCrossOriginConfiguration bucketCrossOriginConfiguration)
                                throws CosClientException,
                                       CosServiceException

Sets the cross origin configuration for the specified bucket.

参数:

bucketName - the bucket name

BucketCrossOriginConfiguration - The bucketCrossOriginConfiguration contains all options for setting the bucket cross origin configuration.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in COS while processing the request.

setBucketCrossOriginConfiguration

void setBucketCrossOriginConfiguration(SetBucketCrossOriginConfigurationRequest setBucketCrossOriginConfigurationRequest)
                                throws CosClientException,
                                       CosServiceException

Sets the cross origin configuration for the specified bucket.

参数:

setBucketCrossOriginConfigurationRequest - The request object containing all options for setting the bucket cross origin configuration.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in COS while processing the request.

deleteBucketCrossOriginConfiguration

void deleteBucketCrossOriginConfiguration(String bucketName)
                                   throws CosClientException,
                                          CosServiceException

Delete the cross origin configuration for the specified bucket.

参数:

bucketName - The bucket name

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in COS while processing the request.

deleteBucketCrossOriginConfiguration

void deleteBucketCrossOriginConfiguration(DeleteBucketCrossOriginConfigurationRequest deleteBucketCrossOriginConfigurationRequest)
                                   throws CosClientException,
                                          CosServiceException

Delete the cross origin configuration for the specified bucket.

参数:

deleteBucketCrossOriginConfigurationRequest - The request object containing all options for deleting the bucket cross origin configuration.

抛出:

CosClientException

CosServiceException

setBucketReplicationConfiguration

void setBucketReplicationConfiguration(String bucketName,
                                       BucketReplicationConfiguration configuration)
                                throws CosClientException,
                                       CosServiceException

Sets a replication configuration for a bucket.

参数:

bucketName - The bucket name for which the replication configuration is set.

configuration - The replication configuration.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in COS while processing the request.

setBucketReplicationConfiguration

void setBucketReplicationConfiguration(SetBucketReplicationConfigurationRequest setBucketReplicationConfigurationRequest)
                                throws CosClientException,
                                       CosServiceException

Sets a replication configuration for the QCloud bucket.

参数:

setBucketReplicationConfigurationRequest - The request object containing all the options for setting a replication configuration for QCloud bucket.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in COS while processing the request.

getBucketReplicationConfiguration

BucketReplicationConfiguration getBucketReplicationConfiguration(String bucketName)
                                                          throws CosClientException,
                                                                 CosServiceException

Retrieves the replication configuration for the given QCloud bucket.

参数:

bucketName - The bucket name for which the replication configuration is to be retrieved.

返回:

the replication configuration of the bucket.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in COS while processing the request.

getBucketReplicationConfiguration

BucketReplicationConfiguration getBucketReplicationConfiguration(GetBucketReplicationConfigurationRequest getBucketReplicationConfigurationRequest)
                                                          throws CosClientException,
                                                                 CosServiceException

Retrieves the replication configuration for the given QCloud bucket.

参数:

getBucketReplicationConfigurationRequest - The request object for retrieving the bucket replication configuration.

返回:

the replication configuration of the bucket.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in COS while processing the request.

deleteBucketReplicationConfiguration

void deleteBucketReplicationConfiguration(String bucketName)
                                   throws CosClientException,
                                          CosServiceException

Deletes the replication configuration for the given QCloud bucket.

参数:

bucketName - The bucket name for which the replication configuration is to be deleted.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in COS while processing the request.

deleteBucketReplicationConfiguration

void deleteBucketReplicationConfiguration(DeleteBucketReplicationConfigurationRequest deleteBucketReplicationConfigurationRequest)
                                   throws CosClientException,
                                          CosServiceException

Deletes the replication configuration for the given QCloud bucket.

参数:

deleteBucketReplicationConfigurationRequest - The request object for delete bucket replication configuration.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in COS while processing the request.

generatePresignedUrl

URL generatePresignedUrl(String bucketName,
                         String key,
                         Date expiration)
                  throws CosClientException

Returns a pre-signed URL for accessing COS resource. you can specify the expiration time. Defaults, if you didn't set the expiration time, the expired time of ClientConfig will be used.

Pre-signed URLs allow clients to form a URL for an COS resource, and then sign it with the current COS security credentials. The pre-signed URL can be shared to other users, allowing access to the resource without providing an account's security credentials.

Pre-signed URLs are useful in many situations where COS security credentials aren't available from the client that needs to make the actual request to COS.

For example, an application may need remote users to upload files to the application owner's COS bucket, but doesn't need to ship the COS security credentials with the application. A pre-signed URL to PUT an object into the owner's bucket can be generated from a remote location with the owner's COS security credentials, then the pre-signed URL can be passed to the end user's application to use.

参数:

bucketName - The name of the bucket containing the desired object.

key - The key in the specified bucket under which the desired object is stored.

expiration - The time at which the returned pre-signed URL will expire.

返回:

A pre-signed URL that can be used to access an COS resource without requiring the user of the URL to know the account's credentials.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

另请参阅:

generatePresignedUrl(String, String, Date), generatePresignedUrl(String, String, Date, HttpMethodName)

generatePresignedUrl

URL generatePresignedUrl(String bucketName,
                         String key,
                         Date expiration,
                         HttpMethodName method)
                  throws CosClientException

Returns a pre-signed URL for accessing COS resource. you can specify the expiration time. Defaults, if you didn't set the expiration time, the expired time of ClientConfig will be used.

Pre-signed URLs allow clients to form a URL for an COS resource, and then sign it with the current COS security credentials. The pre-signed URL can be shared to other users, allowing access to the resource without providing an account's security credentials.

Pre-signed URLs are useful in many situations where COS security credentials aren't available from the client that needs to make the actual request to COS.

For example, an application may need remote users to upload files to the application owner's COS bucket, but doesn't need to ship the COS security credentials with the application. A pre-signed URL to PUT an object into the owner's bucket can be generated from a remote location with the owner's COS security credentials, then the pre-signed URL can be passed to the end user's application to use.

参数:

bucketName - The name of the bucket containing the desired object.

key - The key in the specified bucket under which the desired object is stored.

expiration - The time at which the returned pre-signed URL will expire.

method - The HTTP method verb to use for this URL

返回:

A pre-signed URL that can be used to access an COS resource without requiring the user of the URL to know the account's credentials.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

另请参阅:

generatePresignedUrl(String, String, Date), generatePresignedUrl(String, String, Date, HttpMethodName)

generatePresignedUrl

URL generatePresignedUrl(GeneratePresignedUrlRequest generatePresignedUrlRequest)
                  throws CosClientException

Returns a pre-signed URL for accessing COS resource. you can specify the expiration time. Defaults, if you didn't set the expiration time, the expired time of ClientConfig will be used.

Pre-signed URLs allow clients to form a URL for an COS resource, and then sign it with the current COS security credentials. The pre-signed URL can be shared to other users, allowing access to the resource without providing an account's security credentials.

Pre-signed URLs are useful in many situations where COS security credentials aren't available from the client that needs to make the actual request to COS.

For example, an application may need remote users to upload files to the application owner's COS bucket, but doesn't need to ship the COS security credentials with the application. A pre-signed URL to PUT an object into the owner's bucket can be generated from a remote location with the owner's COS security credentials, then the pre-signed URL can be passed to the end user's application to use.

参数:

generatePresignedUrlRequest - The request object containing all the options for generating a pre-signed URL (bucket name, key, expiration date, etc).

返回:

A pre-signed URL that can be used to access an COS resource without requiring the user of the URL to know the account's credentials.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

另请参阅:

generatePresignedUrl(String, String, Date), COS#generatePresignedUrl(String, String, Date, HttpMethod)

restoreObject

void restoreObject(RestoreObjectRequest request)
            throws CosClientException,
                   CosServiceException

Restore an object, which was transitioned to CAS from COS when it was expired, into COS again. This copy is by nature temporary and is always stored as temporary copy in COS. The customer will be able to set / re-adjust the lifetime of this copy. By re-adjust we mean the customer can call this API to shorten or extend the lifetime of the copy. Note the request will only be accepted when there is no ongoing restore request. One needs to have the new cos:RestoreObject permission to perform this operation.

参数:

request - The request object containing all the options for restoring an COS object.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in COS while processing the request.

restoreObject

void restoreObject(String bucketName,
                   String key,
                   int expirationInDays)
            throws CosClientException,
                   CosServiceException

Restore an object, which was transitioned to CAS from COS when it was expired, into COS again. This copy is by nature temporary and is always stored as temporary copy in COS. The customer will be able to set / re-adjust the lifetime of this copy. By re-adjust we mean the customer can call this API to shorten or extend the lifetime of the copy. Note the request will only be accepted when there is no ongoing restore request. One needs to have the new cos:RestoreObject permission to perform this operation.

参数:

bucketName - The name of an existing bucket.

key - The key under which to store the specified file.

expirationInDays - The number of days after which the object will expire.

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in COS while processing the request.

updateObjectMetaData

void updateObjectMetaData(String bucketName,
                          String key,
                          ObjectMetadata objectMetadata)
                   throws CosClientException,
                          CosServiceException

update the object meta.

参数:

bucketName - The name of an existing bucket.

key - The key under which to store the specified file.

objectMetadata - object new metadata for the specified object

抛出:

CosClientException - If any errors are encountered in the client while making the request or handling the response.

CosServiceException - If any errors occurred in COS while processing the request.