com.obs.services

Class AbstractBucketAdvanceClient

java.lang.Object

com.obs.services.internal.RestConnectionService

com.obs.services.internal.RestStorageService

com.obs.services.internal.service.AbstractRequestConvertor

com.obs.services.internal.service.AclHeaderConvertor

com.obs.services.internal.service.RequestConvertor

com.obs.services.internal.service.ObsBucketBaseService

com.obs.services.internal.service.ObsBucketAdvanceService

com.obs.services.internal.service.ObsObjectBaseService

com.obs.services.internal.service.ObsMultipartObjectService

com.obs.services.internal.service.ObsObjectService

com.obs.services.internal.service.ObsFileService

com.obs.services.internal.service.ObsExtensionService

com.obs.services.internal.ObsService

com.obs.services.AbstractClient

com.obs.services.AbstractDeprecatedBucketClient

com.obs.services.AbstractBucketClient

com.obs.services.AbstractBucketAdvanceClient

All Implemented Interfaces:

IFSClient, IObsClient, Closeable, AutoCloseable

Direct Known Subclasses:

AbstractObjectClient

public abstract class AbstractBucketAdvanceClient
extends AbstractBucketClient

Nested Class Summary

Nested classes/interfaces inherited from class com.obs.services.AbstractClient

AbstractClient.ActionCallbackWithResult<T>

Nested classes/interfaces inherited from class com.obs.services.internal.service.AbstractRequestConvertor

com.obs.services.internal.service.AbstractRequestConvertor.TransResult

Field Summary

Fields inherited from class com.obs.services.internal.RestStorageService

CAN_USE_STANDARD_HTTP_HEADERS

Fields inherited from class com.obs.services.internal.RestConnectionService

apiVersionCache, credentials, httpClient, keyManagerFactory, obsProperties, segmentLock, semaphore, shuttingDown, trustManagerFactory

Constructor Summary

Constructors

Constructor and Description
AbstractBucketAdvanceClient()

Method Summary

Modifier and Type	Method and Description
HeaderResponse	deleteBucketDirectColdAccess(BaseBucketRequest request) Delete the direct reading policy for Archive objects in a bucket.
HeaderResponse	deleteBucketDirectColdAccess(String bucketName) Delete the direct reading policy for Archive objects in a bucket.
HeaderResponse	deleteBucketEncryption(BaseBucketRequest request) Delete bucket encryption configuration.
HeaderResponse	deleteBucketEncryption(String bucketName) Delete bucket encryption configuration.
HeaderResponse	deleteBucketLifecycle(BaseBucketRequest request) Delete the bucket lifecycle rules from a bucket.
HeaderResponse	deleteBucketLifecycle(String bucketName) Delete the bucket lifecycle rules from a bucket.
HeaderResponse	deleteBucketPolicy(BaseBucketRequest request) Delete bucket policies.
HeaderResponse	deleteBucketPolicy(String bucketName) Delete bucket policies.
HeaderResponse	deleteBucketReplication(BaseBucketRequest request) Delete the bucket cross-region replication configuration.
HeaderResponse	deleteBucketReplication(String bucketName) Delete the bucket cross-region replication configuration.
HeaderResponse	deleteBucketTagging(BaseBucketRequest request) Delete bucket tags.
HeaderResponse	deleteBucketTagging(String bucketName) Delete bucket tags.
HeaderResponse	deleteBucketWebsite(BaseBucketRequest request) Delete the website hosting configuration of a bucket.
HeaderResponse	deleteBucketWebsite(String bucketName) Delete the website hosting configuration of a bucket.
BucketDirectColdAccess	getBucketDirectColdAccess(BaseBucketRequest request) Obtain the direct reading policy for Archive objects in a bucket.
BucketDirectColdAccess	getBucketDirectColdAccess(String bucketName) Obtain the direct reading policy for Archive objects in a bucket.
BucketEncryption	getBucketEncryption(BaseBucketRequest request) Obtain bucket encryption configuration.
BucketEncryption	getBucketEncryption(String bucketName) Obtain bucket encryption configuration.
GetBucketFSStatusResult	getBucketFSStatus(GetBucketFSStatusRequest request) Check whether the file gateway feature is enabled for the bucket.
LifecycleConfiguration	getBucketLifecycle(BaseBucketRequest request) Obtain the bucket lifecycle rules.
LifecycleConfiguration	getBucketLifecycle(String bucketName) Obtain the bucket lifecycle rules.
BucketNotificationConfiguration	getBucketNotification(BaseBucketRequest request) Obtain the notification configuration of a bucket.
BucketNotificationConfiguration	getBucketNotification(String bucketName) Obtain the notification configuration of a bucket.
String	getBucketPolicy(BaseBucketRequest request) Obtain a bucket policy.
String	getBucketPolicy(String bucketName) Obtain bucket policies.
BucketPolicyResponse	getBucketPolicyV2(BaseBucketRequest request) Obtain bucket policies.
BucketPolicyResponse	getBucketPolicyV2(String bucketName) Obtain bucket policies.
ReplicationConfiguration	getBucketReplication(BaseBucketRequest request) Obtain the cross-region replication configuration of a bucket.
ReplicationConfiguration	getBucketReplication(String bucketName) Obtain the cross-region replication configuration of a bucket.
BucketTagInfo	getBucketTagging(BaseBucketRequest request) Obtain bucket tags.
BucketTagInfo	getBucketTagging(String bucketName) Obtain bucket tags.
WebsiteConfiguration	getBucketWebsite(BaseBucketRequest request) Obtain the website hosting settings of a Bucket
WebsiteConfiguration	getBucketWebsite(String bucketName) Obtain the website hosting configuration of a Bucket
HeaderResponse	setBucketDirectColdAccess(SetBucketDirectColdAccessRequest request) Configure the direct reading policy for Archive objects in a bucket.
HeaderResponse	setBucketDirectColdAccess(String bucketName, BucketDirectColdAccess access) Set the direct reading policy for Archive objects in a bucket.
HeaderResponse	setBucketEncryption(SetBucketEncryptionRequest request) Configure bucket encryption.
HeaderResponse	setBucketEncryption(String bucketName, BucketEncryption bucketEncryption) Set bucket encryption.
HeaderResponse	setBucketFSStatus(SetBucketFSStatusRequest request) Specify whether to enable the file gateway feature for the bucket.
HeaderResponse	setBucketLifecycle(SetBucketLifecycleRequest request) Configure lifecycle rules for a bucket.
HeaderResponse	setBucketLifecycle(String bucketName, LifecycleConfiguration lifecycleConfig) Set the bucket lifecycle rules.
HeaderResponse	setBucketNotification(SetBucketNotificationRequest request) Set event notification for a bucket.
HeaderResponse	setBucketNotification(String bucketName, BucketNotificationConfiguration bucketNotificationConfiguration) Configure bucket notification.
HeaderResponse	setBucketPolicy(SetBucketPolicyRequest request) Set bucket policies.
HeaderResponse	setBucketPolicy(String bucketName, String policy) Set bucket policies.
HeaderResponse	setBucketReplication(SetBucketReplicationRequest request) Configure cross-region replication for a bucket.
HeaderResponse	setBucketReplication(String bucketName, ReplicationConfiguration replicationConfiguration) Configure cross-region replication for a bucket.
HeaderResponse	setBucketTagging(SetBucketTaggingRequest request) Set bucket tags.
HeaderResponse	setBucketTagging(String bucketName, BucketTagInfo bucketTagInfo) Set bucket tags.
HeaderResponse	setBucketWebsite(SetBucketWebsiteRequest request) Configure website hosting for a bucket.
HeaderResponse	setBucketWebsite(String bucketName, WebsiteConfiguration websiteConfig) Configure website hosting for a bucket.

Methods inherited from class com.obs.services.AbstractBucketClient

createBucket, createBucket, createBucket, createBucket, deleteBucket, deleteBucket, deleteBucketCors, deleteBucketCors, getBucketAcl, getBucketAcl, getBucketCors, getBucketCors, getBucketLocation, getBucketLocation, getBucketLocationV2, getBucketLogging, getBucketLogging, getBucketMetadata, getBucketQuota, getBucketQuota, getBucketRequestPayment, getBucketRequestPayment, getBucketStorageInfo, getBucketStorageInfo, getBucketStoragePolicy, getBucketStoragePolicy, getBucketVersioning, getBucketVersioning, headBucket, headBucket, listBuckets, listBucketsV2, setBucketAcl, setBucketAcl, setBucketCors, setBucketCors, setBucketLogging, setBucketLogging, setBucketLoggingConfiguration, setBucketQuota, setBucketQuota, setBucketRequestPayment, setBucketRequestPayment, setBucketStoragePolicy, setBucketStoragePolicy, setBucketVersioning, setBucketVersioning

Methods inherited from class com.obs.services.AbstractDeprecatedBucketClient

createBucket, deleteBucketLifecycleConfiguration, deleteBucketReplicationConfiguration, deleteBucketWebsiteConfiguration, getBucketLifecycleConfiguration, getBucketLoggingConfiguration, getBucketReplicationConfiguration, getBucketWebsiteConfiguration, listBuckets, optionsBucket, setBucketAcl, setBucketCors, setBucketLifecycleConfiguration, setBucketLoggingConfiguration, setBucketReplicationConfiguration, setBucketVersioning, setBucketWebsiteConfiguration

Methods inherited from class com.obs.services.AbstractClient

base64Md5, base64Md5, close, createGetTemporarySignature, createGetTemporarySignature, createPostSignature, createPostSignature, createPostSignature, createSignedUrl, createSignedUrl, createTemporarySignature, createV4PostSignature, createV4PostSignature, createV4PostSignature, createV4TemporarySignature, doActionWithResult, init, refresh

Methods inherited from class com.obs.services.internal.ObsService

createPostSignatureResponse, createTemporarySignatureResponse, createV4TemporarySignature, initThreadPool, recordBulkTaskStatus

Methods inherited from class com.obs.services.internal.service.ObsExtensionService

createFetchJobImpl, deleteDisPolicyImpl, deleteExtensionPolicyImpl, deleteReadAheadObjectsImpl, getDisPolicyImpl, putDisPolicyImpl, queryExtensionPolicyImpl, queryFetchJobImpl, queryReadAheadObjectsTaskImpl, readAheadObjectsImpl, setExtensionPolicyImpl

Methods inherited from class com.obs.services.internal.service.ObsFileService

listContentSummaryImpl, renameFileImpl, truncateFileImpl, writeFileImpl

Methods inherited from class com.obs.services.internal.service.ObsObjectService

appendObjectImpl, modifyObjectImpl, renameObjectImpl, restoreObjectImpl, restoreObjectV2Impl, truncateObjectImpl

Methods inherited from class com.obs.services.internal.service.ObsMultipartObjectService

abortMultipartUploadImpl, completeMultipartUploadImpl, copyPartImpl, initiateMultipartUploadImpl, listMultipartUploadsImpl, listPartsImpl, uploadPartImpl

Methods inherited from class com.obs.services.internal.service.ObsObjectBaseService

copyObjectImpl, deleteObjectImpl, deleteObjectsImpl, doesObjectExistImpl, getObjectAclImpl, getObjectImpl, getObjectImpl, getObjectMetadataImpl, getObjectUrl, putObjectImpl, setObjectAclImpl, setObjectMetadataImpl

Methods inherited from class com.obs.services.internal.service.ObsBucketAdvanceService

deleteBucketCorsImpl, deleteBucketDirectColdAccessImpl, deleteBucketEncryptionImpl, deleteBucketLifecycleConfigurationImpl, deleteBucketReplicationConfigurationImpl, deleteBucketTaggingImpl, deleteBucketWebsiteConfigurationImpl, getBucketAclImpl, getBucketCorsImpl, getBucketDirectColdAccessImpl, getBucketEncryptionImpl, getBucketLifecycleConfigurationImpl, getBucketLoggingConfigurationImpl, getBucketNotificationConfigurationImpl, getBucketQuotaImpl, getBucketReplicationConfigurationImpl, getBucketRequestPaymentImpl, getBucketTaggingImpl, getBucketVersioningImpl, getBucketWebsiteConfigurationImpl, setBucketAclImpl, setBucketCorsImpl, setBucketDirectColdAccessImpl, setBucketEncryptionImpl, setBucketLifecycleConfigurationImpl, setBucketLoggingConfigurationImpl, setBucketNotificationImpl, setBucketQuotaImpl, setBucketReplicationConfigurationImpl, setBucketRequestPaymentImpl, setBucketTaggingImpl, setBucketVersioningImpl, setBucketWebsiteConfigurationImpl

Methods inherited from class com.obs.services.internal.service.ObsBucketBaseService

createBucketImpl, deleteBucketImpl, deleteBucketPolicyImpl, getBucketLocationImpl, getBucketMetadataImpl, getBucketPolicyImpl, getBucketStorageInfoImpl, getBucketStoragePolicyImpl, headBucketImpl, listAllBucketsImpl, listObjectsImpl, listVersionsImpl, optionsImpl, setBucketFSStatusImpl, setBucketPolicyImpl, setBucketStorageImpl

Methods inherited from class com.obs.services.internal.service.RequestConvertor

transAppendObjectRequest, transConditionCopyHeaders, transConditionGetObjectHeaders, transCopyObjectRequest, transCopyPartRequest, transCreateBucketRequest, transExtensionPermissions, transGetObjectParams, transGetObjectRequest, transInitiateMultipartUploadRequest, transListContentSummaryRequest, transListObjectsRequest, transListVersionsRequest, transModifyObjectRequest, transPutObjectRequest, transRangeHeader, transRestoreObjectResultToRestoreObjectStatus, transSetObjectMetadataRequest, transSseCHeaders, transSseCSourceHeaders, transSseHeaders, transSseKmsHeaders, transUploadPartRequest, transWriteFileRequest

Methods inherited from class com.obs.services.internal.service.AclHeaderConvertor

getCredential, prepareRESTHeaderAcl, prepareRESTHeaderAclObject, putAclImpl

Methods inherited from class com.obs.services.internal.service.AbstractRequestConvertor

build, build, cleanResponseHeaders, createRequestBody, getApiVersion, getHeaderByMethodName, getOptionInfoResult, getSpecialParamForStorageClass, putHeader, setResponseHeaders, setStatusCode, transRequestPaymentHeaders, transRequestPaymentHeaders, verifyResponseContentType, verifyResponseContentTypeForJson

Methods inherited from class com.obs.services.internal.RestStorageService

addRequestHeadersToConnection, authorizeHttpRequest, convertHeadersToMap, getApiVersionCache, getFileSystemDelimiter, getIConvertor, getIHeaders, getProviderCredentials, getRestHeaderPrefix, getRestMetadataPrefix, getXmlResponseSaxParser, isAuthTypeNegotiation, performRequest, performRequest, performRequest, performRequestWithoutSignature, performRestDelete, performRestDelete, performRestDelete, performRestDelete, performRestForApiVersion, performRestGet, performRestGet, performRestGetForListBuckets, performRestHead, performRestOptions, performRestPost, performRestPost, performRestPut, performRestPut, renameMetadataKeys, retryRequest, setCanUseStandardHTTPHeaders, setProviderCredentials, setUserHeaders

Methods inherited from class com.obs.services.internal.RestConnectionService

addRequestParametersToUrlPath, addRequestParametersToUrlPath, getEndpoint, getHttpPort, getHttpsOnly, getHttpsPort, initHttpClient, isCname, isKeepAlive, isPathStyle, setupConnection, setupConnection, setupConnection, shutdown, shutdownImpl

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.obs.services.IObsClient

abortMultipartUpload, appendObject, completeMultipartUpload, copyObject, copyObject, copyPart, deleteObject, deleteObject, deleteObject, deleteObjects, deleteReadAheadObjects, doesObjectExist, doesObjectExist, downloadFile, getObject, getObject, getObject, getObjectAcl, getObjectAcl, getObjectAcl, getObjectMetadata, getObjectMetadata, getObjectMetadata, initiateMultipartUpload, listMultipartUploads, listObjects, listObjects, listParts, listVersions, listVersions, listVersions, listVersions, modifyObject, modifyObject, modifyObject, putObject, putObject, putObject, putObject, putObject, putObjects, queryReadAheadObjectsTask, readAheadObjects, renameObject, renameObject, restoreObject, restoreObjects, restoreObjectV2, setObjectAcl, setObjectAcl, setObjectAcl, setObjectMetadata, truncateObject, truncateObject, uploadFile, uploadPart, uploadPart, uploadPart

Methods inherited from interface com.obs.services.IFSClient

appendFile, dropFile, dropFolder, getAttribute, listContentSummary, newBucket, newFile, newFolder, readFile, renameFile, renameFolder, truncateFile, writeFile

Constructor Detail

AbstractBucketAdvanceClient

public AbstractBucketAdvanceClient()

Method Detail

getBucketLifecycle

public LifecycleConfiguration getBucketLifecycle(String bucketName)
                                          throws ObsException

Description copied from interface: IObsClient

Obtain the bucket lifecycle rules.

Parameters:

bucketName - Bucket name

Returns:

Bucket lifecycle rules

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getBucketLifecycle

public LifecycleConfiguration getBucketLifecycle(BaseBucketRequest request)
                                          throws ObsException

Description copied from interface: IObsClient

Obtain the bucket lifecycle rules.

Parameters:

request - Request parameters

Returns:

Bucket lifecycle rules

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setBucketLifecycle

public HeaderResponse setBucketLifecycle(String bucketName,
                                         LifecycleConfiguration lifecycleConfig)
                                  throws ObsException

Description copied from interface: IObsClient

Set the bucket lifecycle rules.

Parameters:

bucketName - Bucket name

lifecycleConfig - Bucket lifecycle rules

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setBucketLifecycle

public HeaderResponse setBucketLifecycle(SetBucketLifecycleRequest request)
                                  throws ObsException

Description copied from interface: IObsClient

Configure lifecycle rules for a bucket.

Parameters:

request - Request parameters

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

deleteBucketLifecycle

public HeaderResponse deleteBucketLifecycle(String bucketName)
                                     throws ObsException

Description copied from interface: IObsClient

Delete the bucket lifecycle rules from a bucket.

Parameters:

bucketName - Bucket name

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

deleteBucketLifecycle

public HeaderResponse deleteBucketLifecycle(BaseBucketRequest request)
                                     throws ObsException

Description copied from interface: IObsClient

Delete the bucket lifecycle rules from a bucket.

Parameters:

request - Request parameters

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getBucketPolicy

public String getBucketPolicy(String bucketName)
                       throws ObsException

Description copied from interface: IObsClient

Obtain bucket policies.

Parameters:

bucketName - Bucket name

Returns:

Bucket policy, in the JSON format

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getBucketPolicy

public String getBucketPolicy(BaseBucketRequest request)
                       throws ObsException

Description copied from interface: IObsClient

Obtain a bucket policy.

Parameters:

request - Request parameters

Returns:

Bucket policy, in the JSON format

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getBucketPolicyV2

public BucketPolicyResponse getBucketPolicyV2(String bucketName)
                                       throws ObsException

Description copied from interface: IObsClient

Obtain bucket policies.

Parameters:

bucketName - Bucket name

Returns:

Response to a request for obtaining bucket policies

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getBucketPolicyV2

public BucketPolicyResponse getBucketPolicyV2(BaseBucketRequest request)
                                       throws ObsException

Description copied from interface: IObsClient

Obtain bucket policies.

Parameters:

request - Request parameters

Returns:

Response to a request for obtaining bucket policies

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setBucketPolicy

public HeaderResponse setBucketPolicy(String bucketName,
                                      String policy)
                               throws ObsException

Description copied from interface: IObsClient

Set bucket policies.

Parameters:

bucketName - Bucket name

policy - Bucket policy, in the JSON format

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setBucketPolicy

public HeaderResponse setBucketPolicy(SetBucketPolicyRequest request)
                               throws ObsException

Description copied from interface: IObsClient

Set bucket policies.

Parameters:

request - Request parameters

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

deleteBucketPolicy

public HeaderResponse deleteBucketPolicy(String bucketName)
                                  throws ObsException

Description copied from interface: IObsClient

Delete bucket policies.

Parameters:

bucketName - Bucket name

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

deleteBucketPolicy

public HeaderResponse deleteBucketPolicy(BaseBucketRequest request)
                                  throws ObsException

Description copied from interface: IObsClient

Delete bucket policies.

Parameters:

request - Request parameters

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getBucketWebsite

public WebsiteConfiguration getBucketWebsite(String bucketName)
                                      throws ObsException

Description copied from interface: IObsClient

Obtain the website hosting configuration of a Bucket

Parameters:

bucketName - Bucket name

Returns:

Website hosting configuration of a bucket

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getBucketWebsite

public WebsiteConfiguration getBucketWebsite(BaseBucketRequest request)
                                      throws ObsException

Description copied from interface: IObsClient

Obtain the website hosting settings of a Bucket

Parameters:

request - Request parameters

Returns:

Website hosting configuration of a bucket

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setBucketWebsite

public HeaderResponse setBucketWebsite(String bucketName,
                                       WebsiteConfiguration websiteConfig)
                                throws ObsException

Description copied from interface: IObsClient

Configure website hosting for a bucket.

Parameters:

bucketName - Bucket name

websiteConfig - Website hosting configuration of a bucket

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setBucketWebsite

public HeaderResponse setBucketWebsite(SetBucketWebsiteRequest request)
                                throws ObsException

Description copied from interface: IObsClient

Configure website hosting for a bucket.

Parameters:

request - Request parameters

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

deleteBucketWebsite

public HeaderResponse deleteBucketWebsite(String bucketName)
                                   throws ObsException

Description copied from interface: IObsClient

Delete the website hosting configuration of a bucket.

Parameters:

bucketName - Bucket name

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

deleteBucketWebsite

public HeaderResponse deleteBucketWebsite(BaseBucketRequest request)
                                   throws ObsException

Description copied from interface: IObsClient

Delete the website hosting configuration of a bucket.

Parameters:

request - Request parameters

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getBucketTagging

public BucketTagInfo getBucketTagging(String bucketName)
                               throws ObsException

Description copied from interface: IObsClient

Obtain bucket tags.

Parameters:

bucketName - Bucket name

Returns:

Bucket tag

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getBucketTagging

public BucketTagInfo getBucketTagging(BaseBucketRequest request)
                               throws ObsException

Description copied from interface: IObsClient

Obtain bucket tags.

Parameters:

request - Request parameters

Returns:

Bucket tag

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setBucketTagging

public HeaderResponse setBucketTagging(String bucketName,
                                       BucketTagInfo bucketTagInfo)
                                throws ObsException

Description copied from interface: IObsClient

Set bucket tags.

Parameters:

bucketName - Bucket name

bucketTagInfo - Bucket tags

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setBucketTagging

public HeaderResponse setBucketTagging(SetBucketTaggingRequest request)
                                throws ObsException

Description copied from interface: IObsClient

Set bucket tags.

Parameters:

request - Request parameters

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

deleteBucketTagging

public HeaderResponse deleteBucketTagging(String bucketName)
                                   throws ObsException

Description copied from interface: IObsClient

Delete bucket tags.

Parameters:

bucketName - Bucket name

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

deleteBucketTagging

public HeaderResponse deleteBucketTagging(BaseBucketRequest request)
                                   throws ObsException

Description copied from interface: IObsClient

Delete bucket tags.

Parameters:

request - Request parameters

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getBucketEncryption

public BucketEncryption getBucketEncryption(String bucketName)
                                     throws ObsException

Description copied from interface: IObsClient

Obtain bucket encryption configuration.

Parameters:

bucketName - Bucket name

Returns:

Bucket encryption configuration

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getBucketEncryption

public BucketEncryption getBucketEncryption(BaseBucketRequest request)
                                     throws ObsException

Description copied from interface: IObsClient

Obtain bucket encryption configuration.

Parameters:

request - Request parameters

Returns:

Bucket encryption configuration

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setBucketEncryption

public HeaderResponse setBucketEncryption(String bucketName,
                                          BucketEncryption bucketEncryption)
                                   throws ObsException

Description copied from interface: IObsClient

Set bucket encryption.

Parameters:

bucketName - Bucket name

bucketEncryption - Bucket encryption configuration

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setBucketEncryption

public HeaderResponse setBucketEncryption(SetBucketEncryptionRequest request)
                                   throws ObsException

Description copied from interface: IObsClient

Configure bucket encryption.

Parameters:

request - Request parameters

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

deleteBucketEncryption

public HeaderResponse deleteBucketEncryption(String bucketName)
                                      throws ObsException

Description copied from interface: IObsClient

Delete bucket encryption configuration.

Parameters:

bucketName - Bucket name

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

deleteBucketEncryption

public HeaderResponse deleteBucketEncryption(BaseBucketRequest request)
                                      throws ObsException

Description copied from interface: IObsClient

Delete bucket encryption configuration.

Parameters:

request - Request parameters

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setBucketReplication

public HeaderResponse setBucketReplication(String bucketName,
                                           ReplicationConfiguration replicationConfiguration)
                                    throws ObsException

Description copied from interface: IObsClient

Configure cross-region replication for a bucket.

Parameters:

bucketName - Bucket name

replicationConfiguration - Cross-region replication configuration

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setBucketReplication

public HeaderResponse setBucketReplication(SetBucketReplicationRequest request)
                                    throws ObsException

Description copied from interface: IObsClient

Configure cross-region replication for a bucket.

Parameters:

request - Request parameters

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getBucketReplication

public ReplicationConfiguration getBucketReplication(String bucketName)
                                              throws ObsException

Description copied from interface: IObsClient

Obtain the cross-region replication configuration of a bucket.

Parameters:

bucketName - Bucket name

Returns:

Cross-region replication configuration

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getBucketReplication

public ReplicationConfiguration getBucketReplication(BaseBucketRequest request)
                                              throws ObsException

Description copied from interface: IObsClient

Obtain the cross-region replication configuration of a bucket.

Parameters:

request - Request parameters

Returns:

Cross-region replication configuration

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

deleteBucketReplication

public HeaderResponse deleteBucketReplication(String bucketName)
                                       throws ObsException

Description copied from interface: IObsClient

Delete the bucket cross-region replication configuration.

Parameters:

bucketName - Bucket name

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

deleteBucketReplication

public HeaderResponse deleteBucketReplication(BaseBucketRequest request)
                                       throws ObsException

Description copied from interface: IObsClient

Delete the bucket cross-region replication configuration.

Parameters:

request - Request parameters

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getBucketNotification

public BucketNotificationConfiguration getBucketNotification(String bucketName)
                                                      throws ObsException

Description copied from interface: IObsClient

Obtain the notification configuration of a bucket.

Parameters:

bucketName - Bucket name

Returns:

Bucket notification configuration

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getBucketNotification

public BucketNotificationConfiguration getBucketNotification(BaseBucketRequest request)
                                                      throws ObsException

Description copied from interface: IObsClient

Obtain the notification configuration of a bucket.

Parameters:

request - Request parameters

Returns:

Bucket notification configuration

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setBucketNotification

public HeaderResponse setBucketNotification(String bucketName,
                                            BucketNotificationConfiguration bucketNotificationConfiguration)
                                     throws ObsException

Description copied from interface: IObsClient

Configure bucket notification.

Parameters:

bucketName - Bucket name

bucketNotificationConfiguration - Bucket notification configuration

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setBucketNotification

public HeaderResponse setBucketNotification(SetBucketNotificationRequest request)
                                     throws ObsException

Description copied from interface: IObsClient

Set event notification for a bucket.

Parameters:

request - Request parameters

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setBucketFSStatus

public HeaderResponse setBucketFSStatus(SetBucketFSStatusRequest request)
                                 throws ObsException

Description copied from interface: IFSClient

Specify whether to enable the file gateway feature for the bucket.

Parameters:

request - Request parameters for specifying whether to enable the file gateway feature for the bucket

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getBucketFSStatus

public GetBucketFSStatusResult getBucketFSStatus(GetBucketFSStatusRequest request)
                                          throws ObsException

Description copied from interface: IFSClient

Check whether the file gateway feature is enabled for the bucket.

Parameters:

request - Request parameters for checking whether the file gateway feature is enabled for the bucket

Returns:

Response to the check of whether the file gateway feature is enabled for the bucket

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setBucketDirectColdAccess

public HeaderResponse setBucketDirectColdAccess(String bucketName,
                                                BucketDirectColdAccess access)
                                         throws ObsException

Description copied from interface: IObsClient

Set the direct reading policy for Archive objects in a bucket.

Parameters:

bucketName - Bucket name

access - Direct reading policy

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

setBucketDirectColdAccess

public HeaderResponse setBucketDirectColdAccess(SetBucketDirectColdAccessRequest request)
                                         throws ObsException

Description copied from interface: IObsClient

Configure the direct reading policy for Archive objects in a bucket.

Parameters:

request - Request parameters

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getBucketDirectColdAccess

public BucketDirectColdAccess getBucketDirectColdAccess(String bucketName)
                                                 throws ObsException

Description copied from interface: IObsClient

Obtain the direct reading policy for Archive objects in a bucket.

Parameters:

bucketName - Bucket name

Returns:

Direct reading policy for Archive objects of a bucket

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

getBucketDirectColdAccess

public BucketDirectColdAccess getBucketDirectColdAccess(BaseBucketRequest request)
                                                 throws ObsException

Description copied from interface: IObsClient

Obtain the direct reading policy for Archive objects in a bucket.

Parameters:

request - Request parameters

Returns:

Direct reading policy for Archive objects in a bucket

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

deleteBucketDirectColdAccess

public HeaderResponse deleteBucketDirectColdAccess(String bucketName)
                                            throws ObsException

Description copied from interface: IObsClient

Delete the direct reading policy for Archive objects in a bucket.

Parameters:

bucketName - Bucket name

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

deleteBucketDirectColdAccess

public HeaderResponse deleteBucketDirectColdAccess(BaseBucketRequest request)
                                            throws ObsException

Description copied from interface: IObsClient

Delete the direct reading policy for Archive objects in a bucket.

Parameters:

request - Request parameters

Returns:

Common response headers

Throws:

ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails