AbstractBucketClient (OBS SDK for Java 3.21.12 API)

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

All Implemented Interfaces:

IFSClient, IObsBucketExtendClient, IObsClient, Closeable, AutoCloseable

Direct Known Subclasses:

AbstractBucketAdvanceClient
```
public abstract class AbstractBucketClient
extends AbstractDeprecatedBucketClient
```

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
  credentials, httpClient, keyManagerFactory, obsProperties, semaphore, shuttingDown, trustManagerFactory

Constructor Summary

Constructors
Constructor and Description

AbstractBucketClient()

Constructors
Constructor and Description
`AbstractBucketClient()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ObsBucket`	`createBucket(CreateBucketRequest request)` Create a bucket.
`ObsBucket`	`createBucket(ObsBucket bucket)` Create a bucket.
`ObsBucket`	`createBucket(String bucketName)` Create a bucket.
`ObsBucket`	`createBucket(String bucketName, String location)` Create a bucket.
`HeaderResponse`	`deleteBucket(BaseBucketRequest request)` Delete a bucket.
`HeaderResponse`	`deleteBucket(String bucketName)` Delete a bucket.
`HeaderResponse`	`deleteBucketCors(BaseBucketRequest request)` Delete the bucket CORS rules.
`HeaderResponse`	`deleteBucketCors(String bucketName)` Delete the bucket CORS rules.
`HeaderResponse`	`deleteBucketCustomDomain(DeleteBucketCustomDomainRequest request)` Deleting the Custom Domain Name of a Bucket
`HeaderResponse`	`deleteBucketCustomDomain(String bucketName, String domainName)` Deleting the Custom Domain Name of a Bucket
`AccessControlList`	`getBucketAcl(BaseBucketRequest request)` Obtain a bucket ACL.
`AccessControlList`	`getBucketAcl(String bucketName)` Obtain a bucket ACL.
`BucketCors`	`getBucketCors(BaseBucketRequest request)` Obtain the bucket CORS rules.
`BucketCors`	`getBucketCors(String bucketName)` Obtain the bucket CORS rules.
`BucketCustomDomainInfo`	`getBucketCustomDomain(GetBucketCustomDomainRequest request)` Obtaining the Custom Domain Name of a Bucket
`BucketCustomDomainInfo`	`getBucketCustomDomain(String bucketName)` Obtaining the Custom Domain Name of a Bucket
`BucketLocationResponse`	`getBucketLocation(BaseBucketRequest request)` Obtain the bucket location.
`String`	`getBucketLocation(String bucketName)` Obtain the bucket location.
`BucketLocationResponse`	`getBucketLocationV2(String bucketName)` Obtain the bucket location.
`BucketLoggingConfiguration`	`getBucketLogging(BaseBucketRequest request)` Obtain the logging settings of a bucket.
`BucketLoggingConfiguration`	`getBucketLogging(String bucketName)` Obtain the logging settings of a bucket.
`BucketMetadataInfoResult`	`getBucketMetadata(BucketMetadataInfoRequest request)` Obtain bucket metadata.
`BucketQuota`	`getBucketQuota(BaseBucketRequest request)` Obtain the bucket quota.
`BucketQuota`	`getBucketQuota(String bucketName)` Obtain the bucket quota.
`RequestPaymentConfiguration`	`getBucketRequestPayment(BaseBucketRequest request)` Obtain the requester-pays status of a bucket.
`RequestPaymentConfiguration`	`getBucketRequestPayment(String bucketName)` Obtain the status of the requester-pays function of a bucket.
`BucketStorageInfo`	`getBucketStorageInfo(BaseBucketRequest request)` Obtain bucket storage information.
`BucketStorageInfo`	`getBucketStorageInfo(String bucketName)` Obtain bucket storage information.
`BucketStoragePolicyConfiguration`	`getBucketStoragePolicy(BaseBucketRequest request)` Obtain the bucket storage class.
`BucketStoragePolicyConfiguration`	`getBucketStoragePolicy(String bucketName)` Obtain the bucket storage class.
`BucketVersioningConfiguration`	`getBucketVersioning(BaseBucketRequest request)` Obtain the versioning status for a bucket.
`BucketVersioningConfiguration`	`getBucketVersioning(String bucketName)` Obtain the versioning status for a bucket.
`boolean`	`headBucket(BaseBucketRequest request)` Identify whether a bucket exists.
`boolean`	`headBucket(String bucketName)` Identify whether a bucket exists.
`List<ObsBucket>`	`listBuckets(ListBucketsRequest request)` Obtain the bucket list.
`ListBucketsResult`	`listBucketsV2(ListBucketsRequest request)` Obtain the bucket list.
`HeaderResponse`	`setBucketAcl(SetBucketAclRequest request)` Set a bucket ACL.
`HeaderResponse`	`setBucketAcl(String bucketName, AccessControlList acl)` Set a bucket ACL.
`HeaderResponse`	`setBucketCors(SetBucketCorsRequest request)` Configure the bucket CORS.
`HeaderResponse`	`setBucketCors(String bucketName, BucketCors bucketCors)` Configure the bucket CORS.
`HeaderResponse`	`setBucketCustomDomain(SetBucketCustomDomainRequest request)` Configuring a Custom Domain Name for a Bucket
`HeaderResponse`	`setBucketCustomDomain(String bucketName, String domainName)` Configuring a Custom Domain Name for a Bucket
`HeaderResponse`	`setBucketLogging(SetBucketLoggingRequest request)` Configure logging for a bucket.
`HeaderResponse`	`setBucketLogging(String bucketName, BucketLoggingConfiguration loggingConfiguration)` Configure logging for a bucket.
`HeaderResponse`	`setBucketLoggingConfiguration(String bucketName, BucketLoggingConfiguration loggingConfiguration, boolean updateTargetACLifRequired)`
`HeaderResponse`	`setBucketQuota(SetBucketQuotaRequest request)` Set the bucket quota.
`HeaderResponse`	`setBucketQuota(String bucketName, BucketQuota bucketQuota)` Set the bucket quota.
`HeaderResponse`	`setBucketRequestPayment(SetBucketRequestPaymentRequest request)` Configure the requester-pays function for a bucket.
`HeaderResponse`	`setBucketRequestPayment(String bucketName, RequestPaymentEnum payer)` Configure the requester-pays function for a bucket.
`HeaderResponse`	`setBucketStoragePolicy(SetBucketStoragePolicyRequest request)` Set the bucket storage class.
`HeaderResponse`	`setBucketStoragePolicy(String bucketName, BucketStoragePolicyConfiguration bucketStorage)` Set the bucket storage class.
`HeaderResponse`	`setBucketVersioning(SetBucketVersioningRequest request)` Set the versioning status for a bucket.
`HeaderResponse`	`setBucketVersioning(String bucketName, BucketVersioningConfiguration versioningConfiguration)` Set the versioning status for a bucket.

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, deleteExtensionPolicyImpl, deleteReadAheadObjectsImpl, 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, deleteBucketCustomDomainImpl, deleteBucketDirectColdAccessImpl, deleteBucketEncryptionImpl, deleteBucketLifecycleConfigurationImpl, deleteBucketReplicationConfigurationImpl, deleteBucketTaggingImpl, deleteBucketWebsiteConfigurationImpl, getBucketAclImpl, getBucketCorsImpl, getBucketCustomDomainImpl, getBucketDirectColdAccessImpl, getBucketEncryptionImpl, getBucketLifecycleConfigurationImpl, getBucketLoggingConfigurationImpl, getBucketNotificationConfigurationImpl, getBucketQuotaImpl, getBucketReplicationConfigurationImpl, getBucketRequestPaymentImpl, getBucketTaggingImpl, getBucketWebsiteConfigurationImpl, setBucketAclImpl, setBucketCorsImpl, setBucketCustomDomainImpl, 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, getBucketVersioningImpl, 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, createRequestBody, getApiVersion, getHeaderByMethodName, getOptionInfoResult, getSpecialParamForStorageClass, putCleanedKeyAndValues, putHeader, setHeadersAndStatus, setHeadersAndStatus, transObjectRequest, transObjectRequestWithResult, transRequest, transRequestPaymentHeaders, transRequestPaymentHeaders, transRequestWithResult, verifyResponseContentType, verifyResponseContentTypeForJson

Methods inherited from class com.obs.services.internal.RestStorageService
addRequestHeadersToConnection, authorizeHttpRequest, convertHeadersToMap, getFileSystemDelimiter, getIConvertor, getIHeaders, getProviderCredentials, getRestHeaderPrefix, getRestMetadataPrefix, getXmlResponseSaxParser, isAuthTypeNegotiation, performRequest, performRequest, performRequest, performRequest, performRequest, performRequest, performRequestWithoutSignature, performRestDelete, performRestDelete, performRestDelete, performRestForApiVersion, performRestGet, performRestGet, performRestGet, performRestGetForListBuckets, performRestHead, performRestOptions, renameMetadataKeys, renameMetadataKeys, retryRequest, setCanUseStandardHTTPHeaders, setProviderCredentials, setUserHeaders

Methods inherited from class com.obs.services.internal.RestConnectionService
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, deleteBucketDirectColdAccess, deleteBucketDirectColdAccess, deleteBucketEncryption, deleteBucketEncryption, deleteBucketLifecycle, deleteBucketLifecycle, deleteBucketPolicy, deleteBucketPolicy, deleteBucketReplication, deleteBucketReplication, deleteBucketTagging, deleteBucketTagging, deleteBucketWebsite, deleteBucketWebsite, deleteObject, deleteObject, deleteObject, deleteObjects, deleteReadAheadObjects, doesObjectExist, doesObjectExist, downloadFile, getBucketDirectColdAccess, getBucketDirectColdAccess, getBucketEncryption, getBucketEncryption, getBucketLifecycle, getBucketLifecycle, getBucketNotification, getBucketNotification, getBucketPolicy, getBucketPolicy, getBucketPolicyV2, getBucketPolicyV2, getBucketReplication, getBucketReplication, getBucketTagging, getBucketTagging, getBucketWebsite, getBucketWebsite, 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, setBucketDirectColdAccess, setBucketDirectColdAccess, setBucketEncryption, setBucketEncryption, setBucketLifecycle, setBucketLifecycle, setBucketNotification, setBucketNotification, setBucketPolicy, setBucketPolicy, setBucketReplication, setBucketReplication, setBucketTagging, setBucketTagging, setBucketWebsite, setBucketWebsite, setObjectAcl, setObjectAcl, setObjectAcl, setObjectMetadata, truncateObject, truncateObject, uploadFile, uploadPart, uploadPart, uploadPart

Methods inherited from interface com.obs.services.IFSClient
appendFile, dropFile, dropFolder, getAttribute, getBucketFSStatus, listContentSummary, newBucket, newFile, newFolder, readFile, renameFile, renameFolder, setBucketFSStatus, truncateFile, writeFile

- Constructor Detail
  - AbstractBucketClient
```
public AbstractBucketClient()
```
- Method Detail
  - createBucket
```
public ObsBucket createBucket(String bucketName)
                       throws ObsException
```
    Description copied from interface: IObsClient
    Create a bucket.
    
    Bucket naming rules:
    - Contain only lowercase letters, digits, hyphens (-), and periods (.).
    - Must start with a digit or a letter.
    - Contain 3 to 63 characters.
    - Cannot be an IP address.
    - Cannot end with a hyphen (-).
    - Cannot contain two consecutive periods (..).
    - Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, "my-.bucket" and "my.-bucket".
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Bucket information
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - createBucket
```
public ObsBucket createBucket(String bucketName,
                              String location)
                       throws ObsException
```
    Description copied from interface: IObsClient
    Create a bucket.
    Create a bucket of a specific name in the given region.
    Bucket naming rules:
    - Contain only lowercase letters, digits, hyphens (-), and periods (.).
    - Must start with a digit or a letter.
    - Contain 3 to 63 characters.
    - Cannot be an IP address.s
    - Cannot end with a hyphen (-).
    - Cannot contain two consecutive periods (..).
    - Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, "my-.bucket" and "my.-bucket".
    Parameters:
    
    bucketName - Bucket name
    
    location - Bucket location. This parameter is mandatory unless the endpoint belongs to the default region.
    
    Returns:
    
    Bucket information
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - createBucket
```
public ObsBucket createBucket(ObsBucket bucket)
                       throws ObsException
```
    Description copied from interface: IObsClient
    Create a bucket.
    Create a bucket of a specific name in the given region.
    Bucket naming rules:
    - Contain only lowercase letters, digits, hyphens (-), and periods (.).
    - Must start with a digit or a letter.
    - Contain 3 to 63 characters.
    - Cannot be an IP address.
    - Cannot end with a hyphen (-).
    - Cannot contain two consecutive periods (..).
    - Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, "my-.bucket" and "my.-bucket".
    Parameters:
    
    bucket - Bucket information, including the request parameters
    
    Returns:
    
    Bucket information
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - createBucket
```
public ObsBucket createBucket(CreateBucketRequest request)
                       throws ObsException
```
    Description copied from interface: IObsClient
    Create a bucket.
    
    Bucket naming rules:
    - Contain only lowercase letters, digits, hyphens (-), and periods (.).
    - Must start with a digit or a letter.
    - Contain 3 to 63 characters.
    - Cannot be an IP address.
    - Cannot end with a hyphen (-).
    - Cannot contain two consecutive periods (..).
    - Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, "my-.bucket" and "my.-bucket".
    Parameters:
    
    request - Request parameters for creating a bucket
    
    Returns:
    
    Bucket information
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - listBuckets
```
public List<ObsBucket> listBuckets(ListBucketsRequest request)
                            throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the bucket list.
    
    Parameters:
    
    request - Obtain the request parameters for obtaining the bucket list.
    
    Returns:
    
    Bucket list
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - listBucketsV2
```
public ListBucketsResult listBucketsV2(ListBucketsRequest request)
                                throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the bucket list.
    
    Parameters:
    
    request - Obtain the request parameters for obtaining the bucket list.
    
    Returns:
    
    Response to the request for obtaining the bucket list
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - headBucket
```
public boolean headBucket(String bucketName)
                   throws ObsException
```
    Description copied from interface: IObsClient
    
    Identify whether a bucket exists.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Identifier indicating whether the bucket exists
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - headBucket
```
public boolean headBucket(BaseBucketRequest request)
                   throws ObsException
```
    Description copied from interface: IObsClient
    
    Identify whether a bucket exists.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Identifier indicating whether the bucket exists
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - deleteBucket
```
public HeaderResponse deleteBucket(String bucketName)
                            throws ObsException
```
    Description copied from interface: IObsClient
    
    Delete 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
  - deleteBucket
```
public HeaderResponse deleteBucket(BaseBucketRequest request)
                            throws ObsException
```
    Description copied from interface: IObsClient
    
    Delete a bucket.
    
    Parameters:
    
    request - Parameters of a request for deleting 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
  - getBucketMetadata
```
public BucketMetadataInfoResult getBucketMetadata(BucketMetadataInfoRequest request)
                                           throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain bucket metadata.
    
    Parameters:
    
    request - Request parameters for obtaining bucket metadata
    
    Returns:
    
    Response to the request for obtaining bucket metadata
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketAcl
```
public AccessControlList getBucketAcl(String bucketName)
                               throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain a bucket ACL.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Bucket ACL
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketAcl
```
public AccessControlList getBucketAcl(BaseBucketRequest request)
                               throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain a bucket ACL.
    
    Parameters:
    
    request - Request parameters for obtaining the bucket ACL
    
    Returns:
    
    Response to a request for obtaining the bucket ACL
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketAcl
```
public HeaderResponse setBucketAcl(String bucketName,
                                   AccessControlList acl)
                            throws ObsException
```
    Description copied from interface: IObsClient
    
    Set a bucket ACL.
    
    Parameters:
    
    bucketName - Bucket name
    
    acl - ACL
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketAcl
```
public HeaderResponse setBucketAcl(SetBucketAclRequest request)
                            throws ObsException
```
    Description copied from interface: IObsClient
    
    Set a bucket ACL.
    
    Parameters:
    
    request - Request parameters for setting a bucket ACL
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketLocation
```
public String getBucketLocation(String bucketName)
                         throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the bucket location.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Bucket location
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketLocation
```
public BucketLocationResponse getBucketLocation(BaseBucketRequest request)
                                         throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the bucket location.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Response to the request for obtaining the bucket location
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketLocationV2
```
public BucketLocationResponse getBucketLocationV2(String bucketName)
                                           throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the bucket location.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Response to the request for obtaining the bucket location
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketStorageInfo
```
public BucketStorageInfo getBucketStorageInfo(String bucketName)
                                       throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain bucket storage information.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Bcket storage information
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketStorageInfo
```
public BucketStorageInfo getBucketStorageInfo(BaseBucketRequest request)
                                       throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain bucket storage information.
    
    Parameters:
    
    request - Bucket name
    
    Returns:
    
    Bucket storage information
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketQuota
```
public BucketQuota getBucketQuota(String bucketName)
                           throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the bucket quota.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Bucket quota
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketQuota
```
public BucketQuota getBucketQuota(BaseBucketRequest request)
                           throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the bucket quota.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Bucket quota
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketQuota
```
public HeaderResponse setBucketQuota(String bucketName,
                                     BucketQuota bucketQuota)
                              throws ObsException
```
    Description copied from interface: IObsClient
    
    Set the bucket quota.
    
    Parameters:
    
    bucketName - Bucket name
    
    bucketQuota - Bucket quota
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketQuota
```
public HeaderResponse setBucketQuota(SetBucketQuotaRequest request)
                              throws ObsException
```
    Description copied from interface: IObsClient
    
    Set the bucket quota.
    
    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
  - getBucketStoragePolicy
```
public BucketStoragePolicyConfiguration getBucketStoragePolicy(String bucketName)
                                                        throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the bucket storage class.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Bucket storage policy
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketStoragePolicy
```
public BucketStoragePolicyConfiguration getBucketStoragePolicy(BaseBucketRequest request)
                                                        throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the bucket storage class.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Bucket storage policy
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketStoragePolicy
```
public HeaderResponse setBucketStoragePolicy(String bucketName,
                                             BucketStoragePolicyConfiguration bucketStorage)
                                      throws ObsException
```
    Description copied from interface: IObsClient
    
    Set the bucket storage class.
    
    Parameters:
    
    bucketName - Bucket name
    
    bucketStorage - Bucket storage 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
  - setBucketStoragePolicy
```
public HeaderResponse setBucketStoragePolicy(SetBucketStoragePolicyRequest request)
                                      throws ObsException
```
    Description copied from interface: IObsClient
    
    Set the bucket storage class.
    
    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
  - setBucketCors
```
public HeaderResponse setBucketCors(String bucketName,
                                    BucketCors bucketCors)
                             throws ObsException
```
    Description copied from interface: IObsClient
    
    Configure the bucket CORS.
    
    Parameters:
    
    bucketName - Bucket name
    
    bucketCors - CORS 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
  - setBucketCors
```
public HeaderResponse setBucketCors(SetBucketCorsRequest request)
                             throws ObsException
```
    Description copied from interface: IObsClient
    
    Configure the bucket CORS.
    
    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
  - getBucketCors
```
public BucketCors getBucketCors(String bucketName)
                         throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the bucket CORS rules.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Bucket CORS rules
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketCors
```
public BucketCors getBucketCors(BaseBucketRequest request)
                         throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the bucket CORS rules.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Bucket CORS configuration
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - deleteBucketCors
```
public HeaderResponse deleteBucketCors(String bucketName)
                                throws ObsException
```
    Description copied from interface: IObsClient
    
    Delete the bucket CORS rules.
    
    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
  - deleteBucketCors
```
public HeaderResponse deleteBucketCors(BaseBucketRequest request)
                                throws ObsException
```
    Description copied from interface: IObsClient
    
    Delete the bucket CORS rules.
    
    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
  - getBucketLogging
```
public BucketLoggingConfiguration getBucketLogging(String bucketName)
                                            throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the logging settings of a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Logging settings of the bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketLogging
```
public BucketLoggingConfiguration getBucketLogging(BaseBucketRequest request)
                                            throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the logging settings of a bucket.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Logging settings of the bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketLoggingConfiguration
```
public HeaderResponse setBucketLoggingConfiguration(String bucketName,
                                                    BucketLoggingConfiguration loggingConfiguration,
                                                    boolean updateTargetACLifRequired)
                                             throws ObsException
```
    Throws:
    
    ObsException
  - setBucketLogging
```
public HeaderResponse setBucketLogging(String bucketName,
                                       BucketLoggingConfiguration loggingConfiguration)
                                throws ObsException
```
    Description copied from interface: IObsClient
    
    Configure logging for a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    loggingConfiguration - Logging settings
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketLogging
```
public HeaderResponse setBucketLogging(SetBucketLoggingRequest request)
                                throws ObsException
```
    Description copied from interface: IObsClient
    
    Configure logging 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
  - setBucketVersioning
```
public HeaderResponse setBucketVersioning(String bucketName,
                                          BucketVersioningConfiguration versioningConfiguration)
                                   throws ObsException
```
    Description copied from interface: IObsClient
    
    Set the versioning status for a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    versioningConfiguration - Versioning status of 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
  - setBucketVersioning
```
public HeaderResponse setBucketVersioning(SetBucketVersioningRequest request)
                                   throws ObsException
```
    Description copied from interface: IObsClient
    
    Set the versioning status 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
  - getBucketVersioning
```
public BucketVersioningConfiguration getBucketVersioning(String bucketName)
                                                  throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the versioning status for a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Versioning status of the bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketVersioning
```
public BucketVersioningConfiguration getBucketVersioning(BaseBucketRequest request)
                                                  throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the versioning status for a bucket.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Versioning status of the bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketRequestPayment
```
public HeaderResponse setBucketRequestPayment(String bucketName,
                                              RequestPaymentEnum payer)
                                       throws ObsException
```
    Description copied from interface: IObsClient
    
    Configure the requester-pays function for a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    payer - The status of the requester-pays function
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketRequestPayment
```
public HeaderResponse setBucketRequestPayment(SetBucketRequestPaymentRequest request)
                                       throws ObsException
```
    Description copied from interface: IObsClient
    
    Configure the requester-pays function for a bucket.
    
    Parameters:
    
    request - Configuration of the requester-pays function 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
  - getBucketRequestPayment
```
public RequestPaymentConfiguration getBucketRequestPayment(String bucketName)
                                                    throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the status of the requester-pays function of a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Configuration of the requester-pays function of the bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketRequestPayment
```
public RequestPaymentConfiguration getBucketRequestPayment(BaseBucketRequest request)
                                                    throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the requester-pays status of a bucket.
    
    Parameters:
    
    request - Basic bucket information
    
    Returns:
    
    Configuration of the requester-pays function of the bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - deleteBucketCustomDomain
```
public HeaderResponse deleteBucketCustomDomain(String bucketName,
                                               String domainName)
                                        throws ObsException
```
    Description copied from interface: IObsBucketExtendClient
    
    Deleting the Custom Domain Name of a Bucket
    
    Parameters:
    
    bucketName - Bucket name
    
    domainName - Custom Domain Name
    
    Returns:
    
    Throws:
    
    ObsException
  - deleteBucketCustomDomain
```
public HeaderResponse deleteBucketCustomDomain(DeleteBucketCustomDomainRequest request)
                                        throws ObsException
```
    Description copied from interface: IObsBucketExtendClient
    
    Deleting the Custom Domain Name of a Bucket
    
    Returns:
    
    Throws:
    
    ObsException
  - getBucketCustomDomain
```
public BucketCustomDomainInfo getBucketCustomDomain(String bucketName)
                                             throws ObsException
```
    Description copied from interface: IObsBucketExtendClient
    
    Obtaining the Custom Domain Name of a Bucket
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Throws:
    
    ObsException
  - getBucketCustomDomain
```
public BucketCustomDomainInfo getBucketCustomDomain(GetBucketCustomDomainRequest request)
                                             throws ObsException
```
    Description copied from interface: IObsBucketExtendClient
    
    Obtaining the Custom Domain Name of a Bucket
    
    Returns:
    
    Throws:
    
    ObsException
  - setBucketCustomDomain
```
public HeaderResponse setBucketCustomDomain(String bucketName,
                                            String domainName)
                                     throws ObsException
```
    Description copied from interface: IObsBucketExtendClient
    
    Configuring a Custom Domain Name for a Bucket
    
    Parameters:
    
    bucketName - Bucket name
    
    domainName - Custom Domain Name
    
    Returns:
    
    Throws:
    
    ObsException
  - setBucketCustomDomain
```
public HeaderResponse setBucketCustomDomain(SetBucketCustomDomainRequest request)
                                     throws ObsException
```
    Description copied from interface: IObsBucketExtendClient
    
    Configuring a Custom Domain Name for a Bucket
    
    Returns:
    
    Throws:
    
    ObsException

Class AbstractBucketClient

Nested Class Summary

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

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

Field Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class com.obs.services.AbstractDeprecatedBucketClient

Methods inherited from class com.obs.services.AbstractClient

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

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

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

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

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

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

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

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

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

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

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.obs.services.IObsClient

Methods inherited from interface com.obs.services.IFSClient

Constructor Detail

AbstractBucketClient

Method Detail

createBucket

createBucket

createBucket

createBucket

listBuckets

listBucketsV2

headBucket

headBucket

deleteBucket

deleteBucket

getBucketMetadata

getBucketAcl

getBucketAcl

setBucketAcl

setBucketAcl

getBucketLocation

getBucketLocation

getBucketLocationV2

getBucketStorageInfo

getBucketStorageInfo

getBucketQuota

getBucketQuota

setBucketQuota

setBucketQuota

getBucketStoragePolicy

getBucketStoragePolicy

setBucketStoragePolicy

setBucketStoragePolicy

setBucketCors

setBucketCors

getBucketCors

getBucketCors

deleteBucketCors

deleteBucketCors

getBucketLogging

getBucketLogging

setBucketLoggingConfiguration

setBucketLogging

setBucketLogging

setBucketVersioning

setBucketVersioning

getBucketVersioning

getBucketVersioning

setBucketRequestPayment

setBucketRequestPayment

getBucketRequestPayment

getBucketRequestPayment

deleteBucketCustomDomain

deleteBucketCustomDomain

getBucketCustomDomain