ObsClient (OBS SDK for Java 3.19.7 API)

java.lang.Object
- com.obs.services.internal.RestStorageService
- - com.obs.services.internal.ObsService
  - - com.obs.services.ObsClient

All Implemented Interfaces:

IFSClient, IObsClient, Closeable, AutoCloseable

Direct Known Subclasses:

OefClient, SecretFlexibleObsClient
```
public class ObsClient
extends com.obs.services.internal.ObsService
implements Closeable, IObsClient, IFSClient
```
ObsClient

Field Summary
- Fields inherited from class com.obs.services.internal.RestStorageService
  apiVersionCache, credentials, httpClient, keyManagerFactory, obsProperties, segmentLock, semaphore, shuttingDown, trustManagerFactory

Constructor Summary

Constructors
Constructor and Description
`ObsClient(IObsCredentialsProvider provider, ObsConfiguration config)`
`ObsClient(IObsCredentialsProvider provider, String endPoint)`
`ObsClient(ObsConfiguration config)` Constructor
`ObsClient(String endPoint)` Constructor
`ObsClient(String accessKey, String secretKey, ObsConfiguration config)` Constructor
`ObsClient(String accessKey, String secretKey, String endPoint)` Constructor
`ObsClient(String accessKey, String secretKey, String securityToken, ObsConfiguration config)` Constructor
`ObsClient(String accessKey, String secretKey, String securityToken, String endPoint)` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`HeaderResponse`	`abortMultipartUpload(AbortMultipartUploadRequest request)` Abort a multipart upload.
`ObsFSFile`	`appendFile(WriteFileRequest request)` Append data to a file.
`AppendObjectResult`	`appendObject(AppendObjectRequest request)` Perform an appendable upload.
`String`	`base64Md5(InputStream is)`
`String`	`base64Md5(InputStream is, long length, long offset)`
`void`	`close()` Close ObsClient and release connection resources.
`CompleteMultipartUploadResult`	`completeMultipartUpload(CompleteMultipartUploadRequest request)` Combine parts.
`CopyObjectResult`	`copyObject(CopyObjectRequest request)` Copy an object.
`CopyObjectResult`	`copyObject(String sourceBucketName, String sourceObjectKey, String destBucketName, String destObjectKey)` Copy an object.
`CopyPartResult`	`copyPart(CopyPartRequest request)` Copy a part.
`ObsBucket`	`createBucket(CreateBucketRequest request)` Create a bucket.
`ObsBucket`	`createBucket(ObsBucket bucket)` Create a bucket.
`ObsBucket`	`createBucket(S3Bucket bucket)` Deprecated.
`ObsBucket`	`createBucket(String bucketName)` Create a bucket.
`ObsBucket`	`createBucket(String bucketName, String location)` Create a bucket.
`TemporarySignatureResponse`	`createGetTemporarySignature(String bucketName, String objectKey, String prefix, Date expiryDate, Map<String,String> headers, Map<String,Object> queryParams)` Generate temporary authorization parameters for GET requests based on the object name prefix and validity period.
`TemporarySignatureResponse`	`createGetTemporarySignature(String bucketName, String objectKey, String prefix, long expires, Map<String,String> headers, Map<String,Object> queryParams)` Generate temporary authorization parameters for GET requests based on the object name prefix and validity period.
`PostSignatureResponse`	`createPostSignature(long expires, String bucketName, String objectKey)` Generate parameters for browser-based authorized access.
`PostSignatureResponse`	`createPostSignature(PostSignatureRequest request)` Generate parameters for browser-based authorized access.
`PostSignatureResponse`	`createPostSignature(String acl, String contentType, long expires, String bucketName, String objectKey)` Generate parameters for browser-based authorized access.
`String`	`createSignedUrl(HttpMethodEnum method, String bucketName, String objectKey, SpecialParamEnum specialParam, Date expiryTime, Map<String,String> headers, Map<String,Object> queryParams)` Deprecated.
`String`	`createSignedUrl(HttpMethodEnum method, String bucketName, String objectKey, SpecialParamEnum specialParam, long expires, Map<String,String> headers, Map<String,Object> queryParams)` Deprecated.
`TemporarySignatureResponse`	`createTemporarySignature(TemporarySignatureRequest request)` Generate temporarily authorized access parameters.
`V4PostSignatureResponse`	`createV4PostSignature(long expires, String bucketName, String objectKey)` Deprecated.
`V4PostSignatureResponse`	`createV4PostSignature(String acl, String contentType, long expires, String bucketName, String objectKey)` Deprecated.
`V4PostSignatureResponse`	`createV4PostSignature(V4PostSignatureRequest request)` Deprecated.
`V4TemporarySignatureResponse`	`createV4TemporarySignature(V4TemporarySignatureRequest request)` Deprecated.
`HeaderResponse`	`deleteBucket(String bucketName)` Delete a bucket.
`HeaderResponse`	`deleteBucketCors(String bucketName)` Delete the bucket CORS rules.
`HeaderResponse`	`deleteBucketDirectColdAccess(String bucketName)` Delete the direct reading policy for Archive objects in a bucket.
`HeaderResponse`	`deleteBucketEncryption(String bucketName)` Delete bucket encryption configuration.
`HeaderResponse`	`deleteBucketLifecycle(String bucketName)` Delete the bucket lifecycle rules from a bucket.
`HeaderResponse`	`deleteBucketLifecycleConfiguration(String bucketName)` Deprecated.
`HeaderResponse`	`deleteBucketPolicy(String bucketName)` Delete bucket policies.
`HeaderResponse`	`deleteBucketReplication(String bucketName)` Delete the bucket cross-region replication configuration.
`HeaderResponse`	`deleteBucketReplicationConfiguration(String bucketName)` Deprecated.
`HeaderResponse`	`deleteBucketTagging(String bucketName)` Delete bucket tags.
`HeaderResponse`	`deleteBucketWebsite(String bucketName)` Delete the website hosting configuration of a bucket.
`HeaderResponse`	`deleteBucketWebsiteConfiguration(String bucketName)` Deprecated.
`DeleteObjectResult`	`deleteObject(String bucketName, String objectKey)` Delete an object.
`DeleteObjectResult`	`deleteObject(String bucketName, String objectKey, String versionId)` Delete an object.
`DeleteObjectsResult`	`deleteObjects(DeleteObjectsRequest deleteObjectsRequest)` Delete objects in a batch.
`ReadAheadResult`	`deleteReadAheadObjects(String bucketName, String prefix)` Delete the read-ahead cache.
`boolean`	`doesObjectExist(GetObjectMetadataRequest request)`
`boolean`	`doesObjectExist(String buckeName, String objectKey)`
`DownloadFileResult`	`downloadFile(DownloadFileRequest downloadFileRequest)` Download a file.
`DropFileResult`	`dropFile(DropFileRequest request)` Delete a file.
`TaskProgressStatus`	`dropFolder(DropFolderRequest request)` Delete a folder.
`protected void`	`finalize()`
`ObsFSAttribute`	`getAttribute(GetAttributeRequest request)` Obtain file or folder properties.
`AccessControlList`	`getBucketAcl(String bucketName)` Obtain a bucket ACL.
`BucketCors`	`getBucketCors(String bucketName)` Obtain the bucket CORS rules.
`BucketDirectColdAccess`	`getBucketDirectColdAccess(String bucketName)` Obtain the direct reading policy for Archive objects in a bucket.
`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(String bucketName)` Obtain the bucket lifecycle rules.
`LifecycleConfiguration`	`getBucketLifecycleConfiguration(String bucketName)` Deprecated.
`String`	`getBucketLocation(String bucketName)` Obtain the bucket location.
`BucketLocationResponse`	`getBucketLocationV2(String bucketName)` Obtain the bucket location.
`BucketLoggingConfiguration`	`getBucketLogging(String bucketName)` Obtain the logging settings of a bucket.
`BucketLoggingConfiguration`	`getBucketLoggingConfiguration(String bucketName)` Deprecated.
`BucketMetadataInfoResult`	`getBucketMetadata(BucketMetadataInfoRequest request)` Obtain bucket metadata.
`BucketNotificationConfiguration`	`getBucketNotification(String bucketName)` Obtain the notification configuration of a bucket.
`String`	`getBucketPolicy(String bucketName)` Obtain bucket policies.
`BucketPolicyResponse`	`getBucketPolicyV2(String bucketName)` Obtain bucket policies.
`BucketQuota`	`getBucketQuota(String bucketName)` Obtain the bucket quota.
`ReplicationConfiguration`	`getBucketReplication(String bucketName)` Obtain the cross-region replication configuration of a bucket.
`ReplicationConfiguration`	`getBucketReplicationConfiguration(String bucketName)` Deprecated.
`BucketStorageInfo`	`getBucketStorageInfo(String bucketName)` Obtain bucket storage information.
`BucketStoragePolicyConfiguration`	`getBucketStoragePolicy(String bucketName)` Obtain the bucket storage class.
`BucketTagInfo`	`getBucketTagging(String bucketName)` Obtain bucket tags.
`BucketVersioningConfiguration`	`getBucketVersioning(String bucketName)` Obtain the versioning status for a bucket.
`WebsiteConfiguration`	`getBucketWebsite(String bucketName)` Obtain the website hosting configuration of a Bucket
`WebsiteConfiguration`	`getBucketWebsiteConfiguration(String bucketName)` Deprecated.
`ObsObject`	`getObject(GetObjectRequest request)` Download an object.
`ObsObject`	`getObject(String bucketName, String objectKey)` Download an object.
`ObsObject`	`getObject(String bucketName, String objectKey, String versionId)` Download an object.
`AccessControlList`	`getObjectAcl(String bucketName, String objectKey)` Obtain an object ACL.
`AccessControlList`	`getObjectAcl(String bucketName, String objectKey, String versionId)` Obtain an object ACL.
`ObjectMetadata`	`getObjectMetadata(GetObjectMetadataRequest request)` Obtain object properties.
`ObjectMetadata`	`getObjectMetadata(String bucketName, String objectKey)` Obtain object properties.
`ObjectMetadata`	`getObjectMetadata(String bucketName, String objectKey, String versionId)` Obtain object properties.
`boolean`	`headBucket(String bucketName)` Identify whether a bucket exists.
`InitiateMultipartUploadResult`	`initiateMultipartUpload(InitiateMultipartUploadRequest request)` Initialize a multipart upload.
`List<S3Bucket>`	`listBuckets()` Deprecated.
`List<ObsBucket>`	`listBuckets(ListBucketsRequest request)` Obtain the bucket list.
`ListBucketsResult`	`listBucketsV2(ListBucketsRequest request)` Obtain the bucket list.
`MultipartUploadListing`	`listMultipartUploads(ListMultipartUploadsRequest request)` List incomplete multipart uploads.
`ObjectListing`	`listObjects(ListObjectsRequest request)` List objects in the bucket.
`ObjectListing`	`listObjects(String bucketName)` List objects in the bucket.
`ListPartsResult`	`listParts(ListPartsRequest request)` List uploaded parts.
`ListVersionsResult`	`listVersions(ListVersionsRequest request)` List versioning objects in a bucket.
`ListVersionsResult`	`listVersions(String bucketName)` List versioning objects in a bucket.
`ListVersionsResult`	`listVersions(String bucketName, long maxKeys)` List versioning objects in a bucket.
`ListVersionsResult`	`listVersions(String bucketName, String prefix, String delimiter, String keyMarker, String versionIdMarker, long maxKeys)` List versioning objects in a bucket.
`ListVersionsResult`	`listVersions(String bucketName, String prefix, String delimiter, String keyMarker, String versionIdMarker, long maxKeys, String nextVersionIdMarker)` Deprecated.
`ObsFSBucket`	`newBucket(NewBucketRequest request)` Create a bucket.
`ObsFSFile`	`newFile(NewFileRequest request)` Create a file.
`ObsFSFolder`	`newFolder(NewFolderRequest request)` Create a folder.
`OptionsInfoResult`	`optionsBucket(String bucketName, OptionsInfoRequest optionInfo)` Deprecated.
`OptionsInfoResult`	`optionsObject(String bucketName, String objectKey, OptionsInfoRequest optionInfo)` Deprecated.
`PutObjectResult`	`putObject(PutObjectRequest request)` Upload an object.
`PutObjectResult`	`putObject(String bucketName, String objectKey, File file)` Upload an object.
`PutObjectResult`	`putObject(String bucketName, String objectKey, File file, ObjectMetadata metadata)` Upload an object.
`PutObjectResult`	`putObject(String bucketName, String objectKey, InputStream input)` Upload an object.
`PutObjectResult`	`putObject(String bucketName, String objectKey, InputStream input, ObjectMetadata metadata)` Upload an object.
`UploadProgressStatus`	`putObjects(PutObjectsRequest request)`
`ReadAheadQueryResult`	`queryReadAheadObjectsTask(String bucketName, String taskId)` Query the progress of a read-ahead task.
`ReadAheadResult`	`readAheadObjects(ReadAheadRequest request)` Read ahead objects.
`ReadFileResult`	`readFile(ReadFileRequest request)` Obtain the file content.
`void`	`refresh(String accessKey, String secretKey, String securityToken)` Refresh the temporary access key.
`RenameResult`	`renameFile(RenameRequest request)` Rename a file.
`RenameResult`	`renameFolder(RenameRequest request)` Rename a folder.
`RestoreObjectRequest.RestoreObjectStatus`	`restoreObject(RestoreObjectRequest request)` Deprecated.
`TaskProgressStatus`	`restoreObjects(RestoreObjectsRequest request)` Restore Archive objects in a batch.
`RestoreObjectResult`	`restoreObjectV2(RestoreObjectRequest request)` Restore an Archive object.
`HeaderResponse`	`setBucketAcl(String bucketName, AccessControlList acl)` Set a bucket ACL.
`HeaderResponse`	`setBucketAcl(String bucketName, String cannedACL, AccessControlList acl)` Deprecated.
`HeaderResponse`	`setBucketCors(String bucketName, BucketCors bucketCors)` Configure the bucket CORS.
`HeaderResponse`	`setBucketCors(String bucketName, S3BucketCors s3BucketCors)` Deprecated.
`HeaderResponse`	`setBucketDirectColdAccess(String bucketName, BucketDirectColdAccess access)` Set the direct reading policy for Archive objects in a bucket.
`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(String bucketName, LifecycleConfiguration lifecycleConfig)` Set the bucket lifecycle rules.
`HeaderResponse`	`setBucketLifecycleConfiguration(String bucketName, LifecycleConfiguration lifecycleConfig)` Deprecated.
`HeaderResponse`	`setBucketLogging(String bucketName, BucketLoggingConfiguration loggingConfiguration)` Configure logging for a bucket.
`HeaderResponse`	`setBucketLoggingConfiguration(String bucketName, BucketLoggingConfiguration loggingConfiguration)` Deprecated.
`HeaderResponse`	`setBucketLoggingConfiguration(String bucketName, BucketLoggingConfiguration loggingConfiguration, boolean updateTargetACLifRequired)`
`HeaderResponse`	`setBucketNotification(String bucketName, BucketNotificationConfiguration bucketNotificationConfiguration)` Configure bucket notification.
`HeaderResponse`	`setBucketPolicy(String bucketName, String policy)` Set bucket policies.
`HeaderResponse`	`setBucketQuota(String bucketName, BucketQuota bucketQuota)` Set the bucket quota.
`HeaderResponse`	`setBucketReplication(String bucketName, ReplicationConfiguration replicationConfiguration)` Configure cross-region replication for a bucket.
`HeaderResponse`	`setBucketReplicationConfiguration(String bucketName, ReplicationConfiguration replicationConfiguration)` Deprecated.
`HeaderResponse`	`setBucketStoragePolicy(String bucketName, BucketStoragePolicyConfiguration bucketStorage)` Set the bucket storage class.
`HeaderResponse`	`setBucketTagging(String bucketName, BucketTagInfo bucketTagInfo)` Set bucket tags.
`HeaderResponse`	`setBucketVersioning(String bucketName, BucketVersioningConfiguration versioningConfiguration)` Set the versioning status for a bucket.
`HeaderResponse`	`setBucketVersioning(String bucketName, String status)` Deprecated.
`HeaderResponse`	`setBucketWebsite(String bucketName, WebsiteConfiguration websiteConfig)` Configure website hosting for a bucket.
`HeaderResponse`	`setBucketWebsiteConfiguration(String bucketName, WebsiteConfiguration websiteConfig)` Deprecated.
`HeaderResponse`	`setObjectAcl(String bucketName, String objectKey, AccessControlList acl)` Set an object ACL.
`HeaderResponse`	`setObjectAcl(String bucketName, String objectKey, AccessControlList acl, String versionId)` Set an object ACL.
`HeaderResponse`	`setObjectAcl(String bucketName, String objectKey, String cannedACL, AccessControlList acl, String versionId)` Deprecated.
`ObjectMetadata`	`setObjectMetadata(SetObjectMetadataRequest request)` Set object properties.
`TruncateFileResult`	`truncateFile(TruncateFileRequest request)` Truncate a file.
`CompleteMultipartUploadResult`	`uploadFile(UploadFileRequest uploadFileRequest)` Upload a file.
`UploadPartResult`	`uploadPart(String bucketName, String objectKey, String uploadId, int partNumber, File file)` Upload a part.
`UploadPartResult`	`uploadPart(String bucketName, String objectKey, String uploadId, int partNumber, InputStream input)` Upload a part.
`UploadPartResult`	`uploadPart(UploadPartRequest request)` Upload a part.
`ObsFSFile`	`writeFile(WriteFileRequest request)` Write data to a file.

Methods inherited from class com.obs.services.internal.ObsService
_createPostSignature, _createTemporarySignature, abortMultipartUploadImpl, appendObjectImpl, completeMultipartUploadImpl, copyObjectImpl, copyPartImpl, createBucketImpl, createFetchJobImpl, createRequestBody, createV4TemporarySignature, deleteBucketCorsImpl, deleteBucketDirectColdAccessImpl, deleteBucketEncryptionImpl, deleteBucketImpl, deleteBucketLifecycleConfigurationImpl, deleteBucketPolicyImpl, deleteBucketReplicationConfigurationImpl, deleteBucketTaggingImpl, deleteBucketWebsiteConfigurationImpl, deleteDisPolicyImpl, deleteExtensionPolicyImpl, deleteObjectImpl, deleteObjectsImpl, DeleteReadAheadObjectsImpl, doesObjectExistImpl, getApiVersion, getBucketAclImpl, getBucketCorsImpl, getBucketDirectColdAccessImpl, getBucketEncryptionImpl, getBucketLifecycleConfigurationImpl, getBucketLocationImpl, getBucketLoggingConfigurationImpl, getBucketMetadataImpl, getBucketNotificationConfigurationImpl, getBucketPolicyImpl, getBucketQuotaImpl, getBucketReplicationConfigurationImpl, getBucketStorageInfoImpl, getBucketStoragePolicyImpl, getBucketTaggingImpl, getBucketVersioningImpl, getBucketWebsiteConfigurationImpl, getCredential, getDisPolicyImpl, getObjectAclImpl, getObjectImpl, getObjectImpl, getObjectMetadataImpl, headBucketImpl, initiateMultipartUploadImpl, initThreadPool, listAllBucketsImpl, listMultipartUploadsImpl, listObjectsImpl, listPartsImpl, listVersionsImpl, optionsImpl, putDisPolicyImpl, putObjectImpl, queryExtensionPolicyImpl, queryFetchJobImpl, queryReadAheadObjectsTaskImpl, readAheadObjectsImpl, recordBulkTaskStatus, renameObjectImpl, restoreObjectImpl, restoreObjectV2Impl, setBucketAclImpl, setBucketCorsImpl, setBucketDirectColdAccessImpl, setBucketEncryptionImpl, setBucketFSStatusImpl, setBucketLifecycleConfigurationImpl, setBucketLoggingConfigurationImpl, setBucketNotificationImpl, setBucketPolicyImpl, setBucketQuotaImpl, setBucketReplicationConfigurationImpl, setBucketStorageImpl, setBucketTaggingImpl, setBucketVersioningImpl, setBucketWebsiteConfigurationImpl, setExtensionPolicyImpl, setObjectAclImpl, setObjectMetadataImpl, truncateFileImpl, uploadPartImpl, verifyResponseContentType, verifyResponseContentTypeForJson, writeFileImpl

Methods inherited from class com.obs.services.internal.RestStorageService
addRequestHeadersToConnection, addRequestParametersToUrlPath, addRequestParametersToUrlPath, authorizeHttpRequest, convertHeadersToMap, getApiVersionCache, getEndpoint, getFileSystemDelimiter, getHttpPort, getHttpsOnly, getHttpsPort, getIConvertor, getIHeaders, getProviderCredentials, getRestHeaderPrefix, getRestMetadataPrefix, getXmlResponseSaxParser, initHttpClient, isAuthTypeNegotiation, isCname, isKeepAlive, isPathStyle, performRequest, performRequest, performRequest, performRequestAsync, performRequestAsync, performRequestAsync, performRequesttWithoutSignatureAsync, performRequestWithoutSignature, performRestDelete, performRestDelete, performRestDelete, performRestDelete, performRestForApiVersion, performRestGet, performRestGet, performRestGetForListBuckets, performRestHead, performRestOptions, performRestPost, performRestPost, performRestPut, performRestPut, renameMetadataKeys, retryRequest, setProviderCredentials, setupConnection, setupConnection, setupConnection, shutdown, shutdownImpl, sleepOnInternalError

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ObsClient
```
public ObsClient(String endPoint)
```
    Constructor
    
    Parameters:
    endPoint - OBS endpoint
  - ObsClient
```
public ObsClient(ObsConfiguration config)
```
    Constructor
    
    Parameters:
    config - Configuration parameters of ObsClient
  - ObsClient
```
public ObsClient(String accessKey,
         String secretKey,
         String endPoint)
```
    Constructor
    
    Parameters:
    accessKey - AK in the access key
    secretKey - SK in the access key
    endPoint - OBS endpoint
  - ObsClient
```
public ObsClient(String accessKey,
         String secretKey,
         ObsConfiguration config)
```
    Constructor
    
    Parameters:
    accessKey - AK in the access key
    secretKey - SK in the access key
    config - Configuration parameters of ObsClient
  - ObsClient
```
public ObsClient(String accessKey,
         String secretKey,
         String securityToken,
         String endPoint)
```
    Constructor
    
    Parameters:
    accessKey - AK in the temporary access key
    secretKey - SK in the temporary access key
    securityToken - Security token
    endPoint - OBS endpoint
  - ObsClient
```
public ObsClient(String accessKey,
         String secretKey,
         String securityToken,
         ObsConfiguration config)
```
    Constructor
    
    Parameters:
    accessKey - AK in the temporary access key
    secretKey - SK in the temporary access key
    securityToken - Security token
    config - Configuration parameters of ObsClient
  - ObsClient
```
public ObsClient(IObsCredentialsProvider provider,
         String endPoint)
```
  - ObsClient
```
public ObsClient(IObsCredentialsProvider provider,
         ObsConfiguration config)
```
- Method Detail
  - refresh
```
public void refresh(String accessKey,
           String secretKey,
           String securityToken)
```
    Description copied from interface: IObsClient
    
    Refresh the temporary access key.
    
    Specified by:
    
    refresh in interface IObsClient
    
    Parameters:
    accessKey - AK in the temporary access key
    secretKey - SK in the temporary access key
    securityToken - Security token
  - createSignedUrl
```
@Deprecated
public String createSignedUrl(HttpMethodEnum method,
                                String bucketName,
                                String objectKey,
                                SpecialParamEnum specialParam,
                                Date expiryTime,
                                Map<String,String> headers,
                                Map<String,Object> queryParams)
                       throws ObsException
```
    Deprecated.
    
    Create a temporarily authorized URL.
    
    Parameters:
    method - HTTP request method
    bucketName - Bucket name
    objectKey - Object name
    specialParam - Special operator
    expiryTime - Time when the temporary authentication expires
    headers - Header information
    queryParams - Query parameter information
    
    Returns:
    Temporarily authorized URL
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - createSignedUrl
```
@Deprecated
public String createSignedUrl(HttpMethodEnum method,
                                String bucketName,
                                String objectKey,
                                SpecialParamEnum specialParam,
                                long expires,
                                Map<String,String> headers,
                                Map<String,Object> queryParams)
```
    Deprecated.
    
    Create a temporarily authorized URL.
    
    Parameters:
    method - HTTP request method
    bucketName - Bucket name
    objectKey - Object name
    specialParam - Special operator
    expires - Time when the temporary authentication expires. The unit is second and the default value is 300.
    headers - Header information
    queryParams - Query parameter information
    
    Returns:
    Temporarily authorized URL
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - createV4TemporarySignature
```
@Deprecated
public V4TemporarySignatureResponse createV4TemporarySignature(V4TemporarySignatureRequest request)
```
    Deprecated.
  - createV4PostSignature
```
@Deprecated
public V4PostSignatureResponse createV4PostSignature(String acl,
                                                       String contentType,
                                                       long expires,
                                                       String bucketName,
                                                       String objectKey)
                                              throws ObsException
```
    Deprecated.
    
    Throws:
    
    ObsException
  - createV4PostSignature
```
@Deprecated
public V4PostSignatureResponse createV4PostSignature(long expires,
                                                       String bucketName,
                                                       String objectKey)
                                              throws ObsException
```
    Deprecated.
    
    Throws:
    
    ObsException
  - createV4PostSignature
```
@Deprecated
public V4PostSignatureResponse createV4PostSignature(V4PostSignatureRequest request)
                                              throws ObsException
```
    Deprecated.
    
    Throws:
    
    ObsException
  - createTemporarySignature
```
public TemporarySignatureResponse createTemporarySignature(TemporarySignatureRequest request)
```
    Description copied from interface: IObsClient
    
    Generate temporarily authorized access parameters.
    
    Specified by:
    
    createTemporarySignature in interface IObsClient
    
    Parameters:
    request - Parameters in a request for temporarily authorized access
    
    Returns:
    Response to the request for temporarily authorized access
  - createGetTemporarySignature
```
public TemporarySignatureResponse createGetTemporarySignature(String bucketName,
                                                     String objectKey,
                                                     String prefix,
                                                     Date expiryDate,
                                                     Map<String,String> headers,
                                                     Map<String,Object> queryParams)
```
    Generate temporary authorization parameters for GET requests based on the object name prefix and validity period.
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object name
    prefix - Object name prefix
    expiryDate - Expiration date (ISO 8601 UTC)
    headers - Header information
    queryParams - Query parameter information
    
    Returns:
    Response to the request for temporary access authorization
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - createGetTemporarySignature
```
public TemporarySignatureResponse createGetTemporarySignature(String bucketName,
                                                     String objectKey,
                                                     String prefix,
                                                     long expires,
                                                     Map<String,String> headers,
                                                     Map<String,Object> queryParams)
```
    Generate temporary authorization parameters for GET requests based on the object name prefix and validity period.
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object name
    prefix - Object name prefix
    expires - Validity period (seconds)
    headers - Header information
    queryParams - Query parameter information
    
    Returns:
    Response to the request for temporary access authorization
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - createPostSignature
```
public PostSignatureResponse createPostSignature(String acl,
                                        String contentType,
                                        long expires,
                                        String bucketName,
                                        String objectKey)
                                          throws ObsException
```
    Generate parameters for browser-based authorized access.
    
    Parameters:
    acl - Object ACL
    contentType - MIME type of the object
    expires - Validity period (in seconds)
    bucketName - Bucket name
    objectKey - Object name
    
    Returns:
    Response to the V4 browser-based authorized access
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - createPostSignature
```
public PostSignatureResponse createPostSignature(long expires,
                                        String bucketName,
                                        String objectKey)
                                          throws ObsException
```
    Generate parameters for browser-based authorized access.
    
    Parameters:
    expires - Validity period (in seconds)
    bucketName - Bucket name
    objectKey - Object name
    
    Returns:
    Response to the V4 browser-based authorized access
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - createPostSignature
```
public PostSignatureResponse createPostSignature(PostSignatureRequest request)
                                          throws ObsException
```
    Description copied from interface: IObsClient
    
    Generate parameters for browser-based authorized access.
    
    Specified by:
    
    createPostSignature in interface IObsClient
    
    Parameters:
    request - Request parameters for V4 browser-based authorized access
    
    Returns:
    Response to the V4 browser-based authorized access
    
    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)
                       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".
    Specified by:
    
    createBucket in interface IObsClient
    
    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".
    Specified by:
    
    createBucket in interface IObsClient
    
    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".
    Specified by:
    
    createBucket in interface IObsClient
    
    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".
    Specified by:
    
    createBucket in interface IObsClient
    
    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
  - createBucket
```
@Deprecated
public ObsBucket createBucket(S3Bucket bucket)
                       throws ObsException
```
    Deprecated.
    
    Throws:
    
    ObsException
  - listBuckets
```
@Deprecated
public List<S3Bucket> listBuckets()
                           throws ObsException
```
    Deprecated.
    
    Throws:
    
    ObsException
  - listBuckets
```
public List<ObsBucket> listBuckets(ListBucketsRequest request)
                            throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the bucket list.
    
    Specified by:
    
    listBuckets in interface IObsClient
    
    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.
    
    Specified by:
    
    listBucketsV2 in interface IObsClient
    
    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
  - deleteBucket
```
public HeaderResponse deleteBucket(String bucketName)
                            throws ObsException
```
    Description copied from interface: IObsClient
    
    Delete a bucket.
    
    Specified by:
    
    deleteBucket in interface IObsClient
    
    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
  - listObjects
```
public ObjectListing listObjects(ListObjectsRequest request)
                          throws ObsException
```
    Description copied from interface: IObsClient
    
    List objects in the bucket.
    
    Specified by:
    
    listObjects in interface IObsClient
    
    Parameters:
    request - Request parameters for listing objects in a bucket
    
    Returns:
    Response to the request for listing objects in the bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - listObjects
```
public ObjectListing listObjects(String bucketName)
                          throws ObsException
```
    Description copied from interface: IObsClient
    
    List objects in the bucket.
    
    Specified by:
    
    listObjects in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    
    Returns:
    Response to the request for listing objects in the bucket
    
    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.
    
    Specified by:
    
    headBucket in interface IObsClient
    
    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
  - listVersions
```
@Deprecated
public ListVersionsResult listVersions(String bucketName,
                                         String prefix,
                                         String delimiter,
                                         String keyMarker,
                                         String versionIdMarker,
                                         long maxKeys,
                                         String nextVersionIdMarker)
                                throws ObsException
```
    Deprecated.
    
    List versioning objects in a bucket.
    
    Parameters:
    bucketName - Bucket name
    prefix - Object name prefix used for listing versioning objects
    delimiter - Character for grouping object names
    keyMarker - Start position for listing versioning objects (sorted by object name)
    versionIdMarker - Start position for listing versioning objects (sorted by version ID)
    maxKeys - Maximum number of versioning objects to be listed
    nextVersionIdMarker - Deprecated field
    
    Returns:
    Response to the request for listing versioning objects in the bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - listVersions
```
public ListVersionsResult listVersions(ListVersionsRequest request)
                                throws ObsException
```
    Description copied from interface: IObsClient
    
    List versioning objects in a bucket.
    
    Specified by:
    
    listVersions in interface IObsClient
    
    Parameters:
    request - Request parameters for listing versioning objects in the bucket
    
    Returns:
    Response to the request for listing versioning objects in the bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - listVersions
```
public ListVersionsResult listVersions(String bucketName)
                                throws ObsException
```
    Description copied from interface: IObsClient
    
    List versioning objects in a bucket.
    
    Specified by:
    
    listVersions in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    
    Returns:
    Response to the request for listing versioning objects in the bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - listVersions
```
public ListVersionsResult listVersions(String bucketName,
                              long maxKeys)
                                throws ObsException
```
    Description copied from interface: IObsClient
    
    List versioning objects in a bucket.
    
    Specified by:
    
    listVersions in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    maxKeys - Maximum number of versioning objects to be listed
    
    Returns:
    Response to the request for listing versioning objects in the bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - listVersions
```
public ListVersionsResult listVersions(String bucketName,
                              String prefix,
                              String delimiter,
                              String keyMarker,
                              String versionIdMarker,
                              long maxKeys)
                                throws ObsException
```
    Description copied from interface: IObsClient
    
    List versioning objects in a bucket.
    
    Specified by:
    
    listVersions in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    prefix - Object name prefix used for listing versioning objects
    delimiter - Character for grouping object names
    keyMarker - Start position for listing versioning objects (sorted by object name)
    versionIdMarker - Start position for listing versioning objects (sorted by version ID)
    maxKeys - Maximum number of versioning objects to be listed
    
    Returns:
    Response to the request for listing versioning objects in the bucket
    
    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.
    
    Specified by:
    
    getBucketMetadata in interface IObsClient
    
    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.
    
    Specified by:
    
    getBucketAcl in interface IObsClient
    
    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
  - setBucketAcl
```
@Deprecated
public HeaderResponse setBucketAcl(String bucketName,
                                     String cannedACL,
                                     AccessControlList acl)
                            throws ObsException
```
    Deprecated.
    
    Set a bucket ACL.
    
    Parameters:
    bucketName - Bucket name
    cannedACL - Pre-defined access control policy
    acl - ACL ("acl" and "cannedACL" cannot be used together.)
    
    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(String bucketName,
                          AccessControlList acl)
                            throws ObsException
```
    Description copied from interface: IObsClient
    
    Set a bucket ACL.
    
    Specified by:
    
    setBucketAcl in interface IObsClient
    
    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
  - getBucketLocation
```
public String getBucketLocation(String bucketName)
                         throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the bucket location.
    
    Specified by:
    
    getBucketLocation in interface IObsClient
    
    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
  - getBucketLocationV2
```
public BucketLocationResponse getBucketLocationV2(String bucketName)
                                           throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the bucket location.
    
    Specified by:
    
    getBucketLocationV2 in interface IObsClient
    
    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.
    
    Specified by:
    
    getBucketStorageInfo in interface IObsClient
    
    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
  - getBucketQuota
```
public BucketQuota getBucketQuota(String bucketName)
                           throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the bucket quota.
    
    Specified by:
    
    getBucketQuota in interface IObsClient
    
    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
  - setBucketQuota
```
public HeaderResponse setBucketQuota(String bucketName,
                            BucketQuota bucketQuota)
                              throws ObsException
```
    Description copied from interface: IObsClient
    
    Set the bucket quota.
    
    Specified by:
    
    setBucketQuota in interface IObsClient
    
    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
  - getBucketStoragePolicy
```
public BucketStoragePolicyConfiguration getBucketStoragePolicy(String bucketName)
                                                        throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the bucket storage class.
    
    Specified by:
    
    getBucketStoragePolicy in interface IObsClient
    
    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
  - setBucketStoragePolicy
```
public HeaderResponse setBucketStoragePolicy(String bucketName,
                                    BucketStoragePolicyConfiguration bucketStorage)
                                      throws ObsException
```
    Description copied from interface: IObsClient
    
    Set the bucket storage class.
    
    Specified by:
    
    setBucketStoragePolicy in interface IObsClient
    
    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
  - setBucketCors
```
public HeaderResponse setBucketCors(String bucketName,
                           BucketCors bucketCors)
                             throws ObsException
```
    Description copied from interface: IObsClient
    
    Configure the bucket CORS.
    
    Specified by:
    
    setBucketCors in interface IObsClient
    
    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
```
@Deprecated
public HeaderResponse setBucketCors(String bucketName,
                                      S3BucketCors s3BucketCors)
                             throws ObsException
```
    Deprecated.
    
    Throws:
    
    ObsException
  - getBucketCors
```
public BucketCors getBucketCors(String bucketName)
                         throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the bucket CORS rules.
    
    Specified by:
    
    getBucketCors in interface IObsClient
    
    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
  - deleteBucketCors
```
public HeaderResponse deleteBucketCors(String bucketName)
                                throws ObsException
```
    Description copied from interface: IObsClient
    
    Delete the bucket CORS rules.
    
    Specified by:
    
    deleteBucketCors in interface IObsClient
    
    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
  - optionsBucket
```
@Deprecated
public OptionsInfoResult optionsBucket(String bucketName,
                                         OptionsInfoRequest optionInfo)
                                throws ObsException
```
    Deprecated.
    
    Pre-request a bucket.
    
    Parameters:
    bucketName - Bucket name
    optionInfo - Parameters in a bucket preflight request
    
    Returns:
    Response to the bucket preflight request
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - optionsObject
```
@Deprecated
public OptionsInfoResult optionsObject(String bucketName,
                                         String objectKey,
                                         OptionsInfoRequest optionInfo)
                                throws ObsException
```
    Deprecated.
    
    Perform a preflight on a bucket.
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object name
    optionInfo - Parameters in an object preflight request
    
    Returns:
    Response to the object preflight request
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketLoggingConfiguration
```
@Deprecated
public BucketLoggingConfiguration getBucketLoggingConfiguration(String bucketName)
                                                         throws ObsException
```
    Deprecated.
    
    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(String bucketName)
                                            throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the logging settings of a bucket.
    
    Specified by:
    
    getBucketLogging in interface IObsClient
    
    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
  - setBucketLoggingConfiguration
```
public HeaderResponse setBucketLoggingConfiguration(String bucketName,
                                           BucketLoggingConfiguration loggingConfiguration,
                                           boolean updateTargetACLifRequired)
                                             throws ObsException
```
    Specified by:
    
    setBucketLoggingConfiguration in interface IObsClient
    
    Throws:
    
    ObsException
  - setBucketLoggingConfiguration
```
@Deprecated
public HeaderResponse setBucketLoggingConfiguration(String bucketName,
                                                      BucketLoggingConfiguration loggingConfiguration)
                                             throws ObsException
```
    Deprecated.
    
    Throws:
    
    ObsException
  - setBucketLogging
```
public HeaderResponse setBucketLogging(String bucketName,
                              BucketLoggingConfiguration loggingConfiguration)
                                throws ObsException
```
    Description copied from interface: IObsClient
    
    Configure logging for a bucket.
    
    Specified by:
    
    setBucketLogging in interface IObsClient
    
    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
  - setBucketVersioning
```
@Deprecated
public HeaderResponse setBucketVersioning(String bucketName,
                                            String status)
                                   throws ObsException
```
    Deprecated.
    
    Throws:
    
    ObsException
  - setBucketVersioning
```
public HeaderResponse setBucketVersioning(String bucketName,
                                 BucketVersioningConfiguration versioningConfiguration)
                                   throws ObsException
```
    Description copied from interface: IObsClient
    
    Set the versioning status for a bucket.
    
    Specified by:
    
    setBucketVersioning in interface IObsClient
    
    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
  - getBucketVersioning
```
public BucketVersioningConfiguration getBucketVersioning(String bucketName)
                                                  throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the versioning status for a bucket.
    
    Specified by:
    
    getBucketVersioning in interface IObsClient
    
    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
  - getBucketLifecycleConfiguration
```
@Deprecated
public LifecycleConfiguration getBucketLifecycleConfiguration(String bucketName)
                                                       throws ObsException
```
    Deprecated.
    
    Throws:
    
    ObsException
  - getBucketLifecycle
```
public LifecycleConfiguration getBucketLifecycle(String bucketName)
                                          throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the bucket lifecycle rules.
    
    Specified by:
    
    getBucketLifecycle in interface IObsClient
    
    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
  - setBucketLifecycleConfiguration
```
@Deprecated
public HeaderResponse setBucketLifecycleConfiguration(String bucketName,
                                                        LifecycleConfiguration lifecycleConfig)
                                               throws ObsException
```
    Deprecated.
    
    Throws:
    
    ObsException
  - setBucketLifecycle
```
public HeaderResponse setBucketLifecycle(String bucketName,
                                LifecycleConfiguration lifecycleConfig)
                                  throws ObsException
```
    Description copied from interface: IObsClient
    
    Set the bucket lifecycle rules.
    
    Specified by:
    
    setBucketLifecycle in interface IObsClient
    
    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
  - deleteBucketLifecycleConfiguration
```
@Deprecated
public HeaderResponse deleteBucketLifecycleConfiguration(String bucketName)
                                                  throws ObsException
```
    Deprecated.
    
    Throws:
    
    ObsException
  - deleteBucketLifecycle
```
public HeaderResponse deleteBucketLifecycle(String bucketName)
                                     throws ObsException
```
    Description copied from interface: IObsClient
    
    Delete the bucket lifecycle rules from a bucket.
    
    Specified by:
    
    deleteBucketLifecycle in interface IObsClient
    
    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
  - getBucketPolicy
```
public String getBucketPolicy(String bucketName)
                       throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain bucket policies.
    
    Specified by:
    
    getBucketPolicy in interface IObsClient
    
    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
  - getBucketPolicyV2
```
public BucketPolicyResponse getBucketPolicyV2(String bucketName)
                                       throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain bucket policies.
    
    Specified by:
    
    getBucketPolicyV2 in interface IObsClient
    
    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
  - setBucketPolicy
```
public HeaderResponse setBucketPolicy(String bucketName,
                             String policy)
                               throws ObsException
```
    Description copied from interface: IObsClient
    
    Set bucket policies.
    
    Specified by:
    
    setBucketPolicy in interface IObsClient
    
    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
  - deleteBucketPolicy
```
public HeaderResponse deleteBucketPolicy(String bucketName)
                                  throws ObsException
```
    Description copied from interface: IObsClient
    
    Delete bucket policies.
    
    Specified by:
    
    deleteBucketPolicy in interface IObsClient
    
    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
  - getBucketWebsiteConfiguration
```
@Deprecated
public WebsiteConfiguration getBucketWebsiteConfiguration(String bucketName)
                                                   throws ObsException
```
    Deprecated.
    
    Throws:
    
    ObsException
  - getBucketWebsite
```
public WebsiteConfiguration getBucketWebsite(String bucketName)
                                      throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the website hosting configuration of a Bucket
    
    Specified by:
    
    getBucketWebsite in interface IObsClient
    
    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
  - setBucketWebsiteConfiguration
```
@Deprecated
public HeaderResponse setBucketWebsiteConfiguration(String bucketName,
                                                      WebsiteConfiguration websiteConfig)
                                             throws ObsException
```
    Deprecated.
    
    Throws:
    
    ObsException
  - setBucketWebsite
```
public HeaderResponse setBucketWebsite(String bucketName,
                              WebsiteConfiguration websiteConfig)
                                throws ObsException
```
    Description copied from interface: IObsClient
    
    Configure website hosting for a bucket.
    
    Specified by:
    
    setBucketWebsite in interface IObsClient
    
    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
  - deleteBucketWebsiteConfiguration
```
@Deprecated
public HeaderResponse deleteBucketWebsiteConfiguration(String bucketName)
                                                throws ObsException
```
    Deprecated.
    
    Throws:
    
    ObsException
  - deleteBucketWebsite
```
public HeaderResponse deleteBucketWebsite(String bucketName)
                                   throws ObsException
```
    Description copied from interface: IObsClient
    
    Delete the website hosting configuration of a bucket.
    
    Specified by:
    
    deleteBucketWebsite in interface IObsClient
    
    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
  - getBucketTagging
```
public BucketTagInfo getBucketTagging(String bucketName)
                               throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain bucket tags.
    
    Specified by:
    
    getBucketTagging in interface IObsClient
    
    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
  - setBucketTagging
```
public HeaderResponse setBucketTagging(String bucketName,
                              BucketTagInfo bucketTagInfo)
                                throws ObsException
```
    Description copied from interface: IObsClient
    
    Set bucket tags.
    
    Specified by:
    
    setBucketTagging in interface IObsClient
    
    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
  - deleteBucketTagging
```
public HeaderResponse deleteBucketTagging(String bucketName)
                                   throws ObsException
```
    Description copied from interface: IObsClient
    
    Delete bucket tags.
    
    Specified by:
    
    deleteBucketTagging in interface IObsClient
    
    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
  - getBucketEncryption
```
public BucketEncryption getBucketEncryption(String bucketName)
                                     throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain bucket encryption configuration.
    
    Specified by:
    
    getBucketEncryption in interface IObsClient
    
    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
  - setBucketEncryption
```
public HeaderResponse setBucketEncryption(String bucketName,
                                 BucketEncryption bucketEncryption)
                                   throws ObsException
```
    Description copied from interface: IObsClient
    
    Set bucket encryption.
    
    Specified by:
    
    setBucketEncryption in interface IObsClient
    
    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
  - deleteBucketEncryption
```
public HeaderResponse deleteBucketEncryption(String bucketName)
                                      throws ObsException
```
    Description copied from interface: IObsClient
    
    Delete bucket encryption configuration.
    
    Specified by:
    
    deleteBucketEncryption in interface IObsClient
    
    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
  - setBucketReplicationConfiguration
```
@Deprecated
public HeaderResponse setBucketReplicationConfiguration(String bucketName,
                                                          ReplicationConfiguration replicationConfiguration)
                                                 throws ObsException
```
    Deprecated.
    
    Throws:
    
    ObsException
  - setBucketReplication
```
public HeaderResponse setBucketReplication(String bucketName,
                                  ReplicationConfiguration replicationConfiguration)
                                    throws ObsException
```
    Description copied from interface: IObsClient
    
    Configure cross-region replication for a bucket.
    
    Specified by:
    
    setBucketReplication in interface IObsClient
    
    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
  - getBucketReplicationConfiguration
```
@Deprecated
public ReplicationConfiguration getBucketReplicationConfiguration(String bucketName)
                                                           throws ObsException
```
    Deprecated.
    
    Throws:
    
    ObsException
  - getBucketReplication
```
public ReplicationConfiguration getBucketReplication(String bucketName)
                                              throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the cross-region replication configuration of a bucket.
    
    Specified by:
    
    getBucketReplication in interface IObsClient
    
    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
  - deleteBucketReplicationConfiguration
```
@Deprecated
public HeaderResponse deleteBucketReplicationConfiguration(String bucketName)
                                                    throws ObsException
```
    Deprecated.
    
    Throws:
    
    ObsException
  - deleteBucketReplication
```
public HeaderResponse deleteBucketReplication(String bucketName)
                                       throws ObsException
```
    Description copied from interface: IObsClient
    
    Delete the bucket cross-region replication configuration.
    
    Specified by:
    
    deleteBucketReplication in interface IObsClient
    
    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
  - getBucketNotification
```
public BucketNotificationConfiguration getBucketNotification(String bucketName)
                                                      throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain the notification configuration of a bucket.
    
    Specified by:
    
    getBucketNotification in interface IObsClient
    
    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
  - setBucketNotification
```
public HeaderResponse setBucketNotification(String bucketName,
                                   BucketNotificationConfiguration bucketNotificationConfiguration)
                                     throws ObsException
```
    Description copied from interface: IObsClient
    
    Configure bucket notification.
    
    Specified by:
    
    setBucketNotification in interface IObsClient
    
    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
  - putObject
```
public PutObjectResult putObject(String bucketName,
                        String objectKey,
                        InputStream input,
                        ObjectMetadata metadata)
                          throws ObsException
```
    Description copied from interface: IObsClient
    
    Upload an object.
    
    Specified by:
    
    putObject in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object name
    input - Data stream to be uploaded
    metadata - Object properties
    
    Returns:
    Response to an object upload request
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - putObject
```
public PutObjectResult putObject(String bucketName,
                        String objectKey,
                        InputStream input)
                          throws ObsException
```
    Description copied from interface: IObsClient
    
    Upload an object.
    
    Specified by:
    
    putObject in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object name
    input - Data stream to be uploaded
    
    Returns:
    Response to an object upload request
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - putObject
```
public PutObjectResult putObject(PutObjectRequest request)
                          throws ObsException
```
    Description copied from interface: IObsClient
    
    Upload an object.
    
    Specified by:
    
    putObject in interface IObsClient
    
    Parameters:
    request - Parameters in an object upload request
    
    Returns:
    Response to an object upload request
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - putObject
```
public PutObjectResult putObject(String bucketName,
                        String objectKey,
                        File file)
                          throws ObsException
```
    Description copied from interface: IObsClient
    
    Upload an object.
    
    Specified by:
    
    putObject in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object name
    file - File to be uploaded
    
    Returns:
    Response to an object upload request
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - putObject
```
public PutObjectResult putObject(String bucketName,
                        String objectKey,
                        File file,
                        ObjectMetadata metadata)
                          throws ObsException
```
    Description copied from interface: IObsClient
    
    Upload an object.
    
    Specified by:
    
    putObject in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object name
    file - File to be uploaded
    metadata - Object properties
    
    Returns:
    Response to an object upload request
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - appendObject
```
public AppendObjectResult appendObject(AppendObjectRequest request)
                                throws ObsException
```
    Description copied from interface: IObsClient
    
    Perform an appendable upload.
    
    Specified by:
    
    appendObject in interface IObsClient
    
    Parameters:
    request - Parameters in an appendable upload request
    
    Returns:
    Response to the appendable upload request
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - uploadFile
```
public CompleteMultipartUploadResult uploadFile(UploadFileRequest uploadFileRequest)
                                         throws ObsException
```
    Description copied from interface: IObsClient
    
    Upload a file. The resumable upload mode is supported.
    
    Specified by:
    
    uploadFile in interface IObsClient
    
    Parameters:
    uploadFileRequest - Parameters in a file upload request
    
    Returns:
    Result of part combination
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - downloadFile
```
public DownloadFileResult downloadFile(DownloadFileRequest downloadFileRequest)
                                throws ObsException
```
    Description copied from interface: IObsClient
    
    Download a file. The resumable download mode is supported.
    
    Specified by:
    
    downloadFile in interface IObsClient
    
    Parameters:
    downloadFileRequest - Parameters in a request for downloading a file
    
    Returns:
    File download result
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getObject
```
public ObsObject getObject(GetObjectRequest request)
                    throws ObsException
```
    Description copied from interface: IObsClient
    
    Download an object.
    
    Specified by:
    
    getObject in interface IObsClient
    
    Parameters:
    request - Parameters in an object download request
    
    Returns:
    Object information, including the object data stream
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getObject
```
public ObsObject getObject(String bucketName,
                  String objectKey,
                  String versionId)
                    throws ObsException
```
    Description copied from interface: IObsClient
    
    Download an object.
    
    Specified by:
    
    getObject in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object name
    versionId - Object version ID
    
    Returns:
    Object information, including the object data stream
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getObject
```
public ObsObject getObject(String bucketName,
                  String objectKey)
                    throws ObsException
```
    Description copied from interface: IObsClient
    
    Download an object.
    
    Specified by:
    
    getObject in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object name
    
    Returns:
    Object information, including the object data stream
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getObjectMetadata
```
public ObjectMetadata getObjectMetadata(GetObjectMetadataRequest request)
                                 throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain object properties.
    
    Specified by:
    
    getObjectMetadata in interface IObsClient
    
    Parameters:
    request - Parameters in a request for obtaining the properties of an object
    
    Returns:
    Object properties
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setObjectMetadata
```
public ObjectMetadata setObjectMetadata(SetObjectMetadataRequest request)
                                 throws ObsException
```
    Description copied from interface: IObsClient
    
    Set object properties.
    
    Specified by:
    
    setObjectMetadata in interface IObsClient
    
    Parameters:
    request - Parameters in the request for obtaining object properties
    
    Returns:
    Object properties
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getObjectMetadata
```
public ObjectMetadata getObjectMetadata(String bucketName,
                               String objectKey,
                               String versionId)
                                 throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain object properties.
    
    Specified by:
    
    getObjectMetadata in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object name
    versionId - Object version ID
    
    Returns:
    Object properties
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getObjectMetadata
```
public ObjectMetadata getObjectMetadata(String bucketName,
                               String objectKey)
                                 throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain object properties.
    
    Specified by:
    
    getObjectMetadata in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object name
    
    Returns:
    Object properties
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - restoreObject
```
@Deprecated
public RestoreObjectRequest.RestoreObjectStatus restoreObject(RestoreObjectRequest request)
                                                       throws ObsException
```
    Deprecated.
    
    Description copied from interface: IObsClient
    
    Restore an Archive object.
    
    Specified by:
    
    restoreObject in interface IObsClient
    
    Parameters:
    request - Parameters in a request for restoring an Archive object
    
    Returns:
    Status of the to-be-restored Archive object
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - restoreObjectV2
```
public RestoreObjectResult restoreObjectV2(RestoreObjectRequest request)
                                    throws ObsException
```
    Description copied from interface: IObsClient
    
    Restore an Archive object.
    
    Specified by:
    
    restoreObjectV2 in interface IObsClient
    
    Parameters:
    request - Request parameters for restoring an Archive object
    
    Returns:
    Result of restoring the Archive object
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - restoreObjects
```
public TaskProgressStatus restoreObjects(RestoreObjectsRequest request)
                                  throws ObsException
```
    Description copied from interface: IObsClient
    
    Restore Archive objects in a batch.
    
    Specified by:
    
    restoreObjects in interface IObsClient
    
    Parameters:
    request - Request parameters for restoring Archive objects in a batch
    
    Returns:
    Batch task execution status
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - putObjects
```
public UploadProgressStatus putObjects(PutObjectsRequest request)
                                throws ObsException
```
    Specified by:
    
    putObjects in interface IObsClient
    
    Throws:
    
    ObsException
  - dropFolder
```
public TaskProgressStatus dropFolder(DropFolderRequest request)
                              throws ObsException
```
    Description copied from interface: IFSClient
    
    Delete a folder.
    
    Specified by:
    
    dropFolder in interface IFSClient
    
    Parameters:
    request - Request parameters for deleting a folder
    
    Returns:
    Batch task execution status
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - deleteObject
```
public DeleteObjectResult deleteObject(String bucketName,
                              String objectKey,
                              String versionId)
                                throws ObsException
```
    Description copied from interface: IObsClient
    
    Delete an object.
    
    Specified by:
    
    deleteObject in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object name
    versionId - Object version ID
    
    Returns:
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - deleteObject
```
public DeleteObjectResult deleteObject(String bucketName,
                              String objectKey)
                                throws ObsException
```
    Description copied from interface: IObsClient
    
    Delete an object.
    
    Specified by:
    
    deleteObject in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object 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
  - deleteObjects
```
public DeleteObjectsResult deleteObjects(DeleteObjectsRequest deleteObjectsRequest)
                                  throws ObsException
```
    Description copied from interface: IObsClient
    
    Delete objects in a batch.
    
    Specified by:
    
    deleteObjects in interface IObsClient
    
    Parameters:
    deleteObjectsRequest - Parameters in an object batch deletion request
    
    Returns:
    Result of the object batch deletion request
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getObjectAcl
```
public AccessControlList getObjectAcl(String bucketName,
                             String objectKey,
                             String versionId)
                               throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain an object ACL.
    
    Specified by:
    
    getObjectAcl in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object name
    versionId - Object version ID
    
    Returns:
    Object ACL
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getObjectAcl
```
public AccessControlList getObjectAcl(String bucketName,
                             String objectKey)
                               throws ObsException
```
    Description copied from interface: IObsClient
    
    Obtain an object ACL.
    
    Specified by:
    
    getObjectAcl in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object name
    
    Returns:
    Object ACL
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setObjectAcl
```
@Deprecated
public HeaderResponse setObjectAcl(String bucketName,
                                     String objectKey,
                                     String cannedACL,
                                     AccessControlList acl,
                                     String versionId)
                            throws ObsException
```
    Deprecated.
    
    Set an object ACL.
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object name
    cannedACL - Pre-defined access control policy
    acl - ACL ("acl" and "cannedACL" cannot be used together.)
    versionId - Object version ID
    
    Returns:
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setObjectAcl
```
public HeaderResponse setObjectAcl(String bucketName,
                          String objectKey,
                          AccessControlList acl,
                          String versionId)
                            throws ObsException
```
    Description copied from interface: IObsClient
    
    Set an object ACL.
    
    Specified by:
    
    setObjectAcl in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object name
    acl - ACL
    versionId - Object version ID
    
    Returns:
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setObjectAcl
```
public HeaderResponse setObjectAcl(String bucketName,
                          String objectKey,
                          AccessControlList acl)
                            throws ObsException
```
    Description copied from interface: IObsClient
    
    Set an object ACL.
    
    Specified by:
    
    setObjectAcl in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object 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
  - copyObject
```
public CopyObjectResult copyObject(CopyObjectRequest request)
                            throws ObsException
```
    Description copied from interface: IObsClient
    
    Copy an object.
    
    Specified by:
    
    copyObject in interface IObsClient
    
    Parameters:
    request - Parameters in a request for copying an object
    
    Returns:
    Result of the object copy
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - copyObject
```
public CopyObjectResult copyObject(String sourceBucketName,
                          String sourceObjectKey,
                          String destBucketName,
                          String destObjectKey)
                            throws ObsException
```
    Description copied from interface: IObsClient
    
    Copy an object.
    
    Specified by:
    
    copyObject in interface IObsClient
    
    Parameters:
    sourceBucketName - Source bucket name
    sourceObjectKey - Source object name
    destBucketName - Destination bucket name
    destObjectKey - Destination object name
    
    Returns:
    Result of the object copy
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - initiateMultipartUpload
```
public InitiateMultipartUploadResult initiateMultipartUpload(InitiateMultipartUploadRequest request)
                                                      throws ObsException
```
    Description copied from interface: IObsClient
    
    Initialize a multipart upload.
    
    Specified by:
    
    initiateMultipartUpload in interface IObsClient
    
    Parameters:
    request - Parameters in a request for initializing a multipart upload
    
    Returns:
    Result of the multipart upload
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - abortMultipartUpload
```
public HeaderResponse abortMultipartUpload(AbortMultipartUploadRequest request)
                                    throws ObsException
```
    Description copied from interface: IObsClient
    
    Abort a multipart upload.
    
    Specified by:
    
    abortMultipartUpload in interface IObsClient
    
    Parameters:
    request - Parameters in a request for aborting a multipart upload
    
    Returns:
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - uploadPart
```
public UploadPartResult uploadPart(String bucketName,
                          String objectKey,
                          String uploadId,
                          int partNumber,
                          InputStream input)
                            throws ObsException
```
    Description copied from interface: IObsClient
    
    Upload a part.
    
    Specified by:
    
    uploadPart in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object name
    uploadId - Multipart upload ID
    partNumber - Part number
    input - Data stream to be uploaded
    
    Returns:
    Response to a part upload request
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - uploadPart
```
public UploadPartResult uploadPart(String bucketName,
                          String objectKey,
                          String uploadId,
                          int partNumber,
                          File file)
                            throws ObsException
```
    Description copied from interface: IObsClient
    
    Upload a part.
    
    Specified by:
    
    uploadPart in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    objectKey - Object name
    uploadId - Multipart upload ID
    partNumber - Part number
    file - File to be uploaded
    
    Returns:
    Response to a part upload request
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - uploadPart
```
public UploadPartResult uploadPart(UploadPartRequest request)
                            throws ObsException
```
    Description copied from interface: IObsClient
    
    Upload a part.
    
    Specified by:
    
    uploadPart in interface IObsClient
    
    Parameters:
    request - Parameters in a part upload request
    
    Returns:
    Response to a part upload request
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - copyPart
```
public CopyPartResult copyPart(CopyPartRequest request)
                        throws ObsException
```
    Description copied from interface: IObsClient
    
    Copy a part.
    
    Specified by:
    
    copyPart in interface IObsClient
    
    Parameters:
    request - Parameters in the request for copying a part
    
    Returns:
    Response to a part copy request
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - completeMultipartUpload
```
public CompleteMultipartUploadResult completeMultipartUpload(CompleteMultipartUploadRequest request)
                                                      throws ObsException
```
    Description copied from interface: IObsClient
    
    Combine parts.
    
    Specified by:
    
    completeMultipartUpload in interface IObsClient
    
    Parameters:
    request - Parameters in a request for combining parts
    
    Returns:
    Result of part combination
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - listParts
```
public ListPartsResult listParts(ListPartsRequest request)
                          throws ObsException
```
    Description copied from interface: IObsClient
    
    List uploaded parts.
    
    Specified by:
    
    listParts in interface IObsClient
    
    Parameters:
    request - Parameters in a request for listing uploaded parts
    
    Returns:
    Response to a request for listing uploaded parts
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - listMultipartUploads
```
public MultipartUploadListing listMultipartUploads(ListMultipartUploadsRequest request)
                                            throws ObsException
```
    Description copied from interface: IObsClient
    
    List incomplete multipart uploads.
    
    Specified by:
    
    listMultipartUploads in interface IObsClient
    
    Parameters:
    request - Parameters in a request for listing multipart uploads
    
    Returns:
    List of multipart uploads
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - newBucket
```
public ObsFSBucket newBucket(NewBucketRequest request)
                      throws ObsException
```
    Description copied from interface: IFSClient
    
    Create a bucket.
    
    Specified by:
    
    newBucket in interface IFSClient
    
    Parameters:
    request - Request parameters for creating a bucket
    
    Returns:
    Bucket supporting the file interface
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - newFile
```
public ObsFSFile newFile(NewFileRequest request)
                  throws ObsException
```
    Description copied from interface: IFSClient
    
    Create a file.
    
    Specified by:
    
    newFile in interface IFSClient
    
    Parameters:
    request - Request parameters for creating a file
    
    Returns:
    Files in the bucket that supports the file interface
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - newFolder
```
public ObsFSFolder newFolder(NewFolderRequest request)
                      throws ObsException
```
    Description copied from interface: IFSClient
    
    Create a folder.
    
    Specified by:
    
    newFolder in interface IFSClient
    
    Parameters:
    request - Request parameters for creating a folder
    
    Returns:
    Folders in the bucket that supports the file interface
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getAttribute
```
public ObsFSAttribute getAttribute(GetAttributeRequest request)
                            throws ObsException
```
    Description copied from interface: IFSClient
    
    Obtain file or folder properties.
    
    Specified by:
    
    getAttribute in interface IFSClient
    
    Parameters:
    request - Request parameters for obtaining filer or folder properties
    
    Returns:
    File or folder properties
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - readFile
```
public ReadFileResult readFile(ReadFileRequest request)
                        throws ObsException
```
    Description copied from interface: IFSClient
    
    Obtain the file content.
    
    Specified by:
    
    readFile in interface IFSClient
    
    Parameters:
    request - Request parameters for obtaining the file content
    
    Returns:
    Response to the request for obtaining file content
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - writeFile
```
public ObsFSFile writeFile(WriteFileRequest request)
                    throws ObsException
```
    Description copied from interface: IFSClient
    
    Write data to a file.
    
    Specified by:
    
    writeFile in interface IFSClient
    
    Parameters:
    request - Request parameters for writing data to a file
    
    Returns:
    Files in the bucket that supports the file interface
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - appendFile
```
public ObsFSFile appendFile(WriteFileRequest request)
                     throws ObsException
```
    Description copied from interface: IFSClient
    
    Append data to a file.
    
    Specified by:
    
    appendFile in interface IFSClient
    
    Parameters:
    request - Request parameters for writing data to a file
    
    Returns:
    Files in the bucket that supports the file interface
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - renameFile
```
public RenameResult renameFile(RenameRequest request)
                        throws ObsException
```
    Description copied from interface: IFSClient
    
    Rename a file.
    
    Specified by:
    
    renameFile in interface IFSClient
    
    Parameters:
    request - Request parameters for renaming a file
    
    Returns:
    Response to the request for renaming a file
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - renameFolder
```
public RenameResult renameFolder(RenameRequest request)
                          throws ObsException
```
    Description copied from interface: IFSClient
    
    Rename a folder.
    
    Specified by:
    
    renameFolder in interface IFSClient
    
    Parameters:
    request - Request parameters for renaming a folder
    
    Returns:
    Response to the request for renaming a folder
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - truncateFile
```
public TruncateFileResult truncateFile(TruncateFileRequest request)
                                throws ObsException
```
    Description copied from interface: IFSClient
    
    Truncate a file.
    
    Specified by:
    
    truncateFile in interface IFSClient
    
    Parameters:
    request - Request parameters for truncating a file
    
    Returns:
    Response to the request for truncating a file
    
    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.
    
    Specified by:
    
    setBucketFSStatus in interface IFSClient
    
    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.
    
    Specified by:
    
    getBucketFSStatus in interface IFSClient
    
    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
  - dropFile
```
public DropFileResult dropFile(DropFileRequest request)
                        throws ObsException
```
    Description copied from interface: IFSClient
    
    Delete a file.
    
    Specified by:
    
    dropFile in interface IFSClient
    
    Parameters:
    request - Request parameters for deleting a file
    
    Returns:
    Response to the request for deleting a file
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - readAheadObjects
```
public ReadAheadResult readAheadObjects(ReadAheadRequest request)
                                 throws ObsException
```
    Description copied from interface: IObsClient
    
    Read ahead objects.
    
    Specified by:
    
    readAheadObjects in interface IObsClient
    
    Parameters:
    request - Request parameters for reading ahead objects
    
    Returns:
    Response to the request for reading ahead objects
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - deleteReadAheadObjects
```
public ReadAheadResult deleteReadAheadObjects(String bucketName,
                                     String prefix)
                                       throws ObsException
```
    Description copied from interface: IObsClient
    
    Delete the read-ahead cache.
    
    Specified by:
    
    deleteReadAheadObjects in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    prefix - Name prefix of objects to be read ahead
    
    Returns:
    Response to the request for reading ahead objects
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - queryReadAheadObjectsTask
```
public ReadAheadQueryResult queryReadAheadObjectsTask(String bucketName,
                                             String taskId)
                                               throws ObsException
```
    Description copied from interface: IObsClient
    
    Query the progress of a read-ahead task.
    
    Specified by:
    
    queryReadAheadObjectsTask in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    taskId - ID of the read-ahead task
    
    Returns:
    Response to the request for querying the progress of the read-ahead task
    
    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.
    
    Specified by:
    
    setBucketDirectColdAccess in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    access - Direct reading policy
    
    Returns:
    
    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.
    
    Specified by:
    
    getBucketDirectColdAccess in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    
    Returns:
    
    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.
    
    Specified by:
    
    deleteBucketDirectColdAccess in interface IObsClient
    
    Parameters:
    bucketName - Bucket name
    
    Returns:
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - doesObjectExist
```
public boolean doesObjectExist(String buckeName,
                      String objectKey)
                        throws ObsException
```
    Specified by:
    
    doesObjectExist in interface IObsClient
    
    Throws:
    
    ObsException
  - doesObjectExist
```
public boolean doesObjectExist(GetObjectMetadataRequest request)
                        throws ObsException
```
    Specified by:
    
    doesObjectExist in interface IObsClient
    
    Throws:
    
    ObsException
  - close
```
public void close()
           throws IOException
```
    Description copied from interface: IObsClient
    
    Close ObsClient and release connection resources.
    
    Specified by:
    
    close in interface IFSClient
    
    Specified by:
    
    close in interface IObsClient
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException - ObsClient close exception
  - base64Md5
```
public String base64Md5(InputStream is,
               long length,
               long offset)
                 throws NoSuchAlgorithmException,
                        IOException
```
    Throws:
    
    NoSuchAlgorithmException
    
    IOException
  - base64Md5
```
public String base64Md5(InputStream is)
                 throws NoSuchAlgorithmException,
                        IOException
```
    Throws:
    
    NoSuchAlgorithmException
    
    IOException
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable

Class ObsClient

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

ObsClient

ObsClient

ObsClient

ObsClient

ObsClient

ObsClient

ObsClient

ObsClient

Method Detail

refresh

createSignedUrl

createSignedUrl

createV4TemporarySignature

createV4PostSignature

createV4PostSignature

createV4PostSignature

createTemporarySignature

createGetTemporarySignature

createGetTemporarySignature

createPostSignature

createPostSignature

createPostSignature

createBucket

createBucket

createBucket

createBucket

createBucket

listBuckets

listBuckets

listBucketsV2

deleteBucket

listObjects

listObjects

headBucket

listVersions

listVersions

listVersions

listVersions

listVersions

getBucketMetadata

getBucketAcl

setBucketAcl

setBucketAcl

getBucketLocation

getBucketLocationV2

getBucketStorageInfo

getBucketQuota

setBucketQuota

getBucketStoragePolicy

setBucketStoragePolicy

setBucketCors

setBucketCors

getBucketCors

deleteBucketCors

optionsBucket

optionsObject

getBucketLoggingConfiguration

getBucketLogging

setBucketLoggingConfiguration

setBucketLoggingConfiguration

setBucketLogging

setBucketVersioning

setBucketVersioning

getBucketVersioning

getBucketLifecycleConfiguration

getBucketLifecycle

setBucketLifecycleConfiguration

setBucketLifecycle

deleteBucketLifecycleConfiguration

deleteBucketLifecycle

getBucketPolicy