IObsClient (OBS SDK for Java 3.21.4 API)

All Known Implementing Classes:

AbstractBatchClient, AbstractBucketAdvanceClient, AbstractBucketClient, AbstractClient, AbstractDeprecatedBucketClient, AbstractFileClient, AbstractMultipartObjectClient, AbstractObjectClient, AbstractPFSClient, ObsClient, OefClient, SecretFlexibleBucketObsClient, SecretFlexibleObsClient
```
public interface IObsClient
```
Basic OBS interface

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`HeaderResponse`	`abortMultipartUpload(AbortMultipartUploadRequest request)` Abort a multipart upload.
`AppendObjectResult`	`appendObject(AppendObjectRequest request)` Perform an appendable upload.
`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(String bucketName)` Create a bucket.
`ObsBucket`	`createBucket(String bucketName, String location)` Create a bucket.
`PostSignatureResponse`	`createPostSignature(PostSignatureRequest request)` Generate parameters for browser-based authorized access.
`TemporarySignatureResponse`	`createTemporarySignature(TemporarySignatureRequest request)` Generate temporarily authorized access parameters.
`HeaderResponse`	`deleteBucket(BaseBucketRequest request)` Delete a bucket.
`HeaderResponse`	`deleteBucket(String bucketName)` Delete a bucket.
`HeaderResponse`	`deleteBucketCors(BaseBucketRequest request)` Delete the bucket CORS rules.
`HeaderResponse`	`deleteBucketCors(String bucketName)` Delete the bucket CORS rules.
`HeaderResponse`	`deleteBucketDirectColdAccess(BaseBucketRequest request)` Delete the direct reading policy for Archive objects in a bucket.
`HeaderResponse`	`deleteBucketDirectColdAccess(String bucketName)` Delete the direct reading policy for Archive objects in a bucket.
`HeaderResponse`	`deleteBucketEncryption(BaseBucketRequest request)` Delete bucket encryption configuration.
`HeaderResponse`	`deleteBucketEncryption(String bucketName)` Delete bucket encryption configuration.
`HeaderResponse`	`deleteBucketLifecycle(BaseBucketRequest request)` Delete the bucket lifecycle rules from a bucket.
`HeaderResponse`	`deleteBucketLifecycle(String bucketName)` Delete the bucket lifecycle rules from a bucket.
`HeaderResponse`	`deleteBucketPolicy(BaseBucketRequest request)` Delete bucket policies.
`HeaderResponse`	`deleteBucketPolicy(String bucketName)` Delete bucket policies.
`HeaderResponse`	`deleteBucketReplication(BaseBucketRequest request)` Delete the bucket cross-region replication configuration.
`HeaderResponse`	`deleteBucketReplication(String bucketName)` Delete the bucket cross-region replication configuration.
`HeaderResponse`	`deleteBucketTagging(BaseBucketRequest request)` Delete bucket tags.
`HeaderResponse`	`deleteBucketTagging(String bucketName)` Delete bucket tags.
`HeaderResponse`	`deleteBucketWebsite(BaseBucketRequest request)` Delete the website hosting configuration of a bucket.
`HeaderResponse`	`deleteBucketWebsite(String bucketName)` Delete the website hosting configuration of a bucket.
`DeleteObjectResult`	`deleteObject(DeleteObjectRequest request)` Delete an object.
`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)` Check whether an object exists.
`boolean`	`doesObjectExist(String buckeName, String objectKey)` Check whether an object exists.
`DownloadFileResult`	`downloadFile(DownloadFileRequest downloadFileRequest)` Download a file.
`AccessControlList`	`getBucketAcl(BaseBucketRequest request)` Obtain a bucket ACL.
`AccessControlList`	`getBucketAcl(String bucketName)` Obtain a bucket ACL.
`BucketCors`	`getBucketCors(BaseBucketRequest request)` Obtain the bucket CORS rules.
`BucketCors`	`getBucketCors(String bucketName)` Obtain the bucket CORS rules.
`BucketDirectColdAccess`	`getBucketDirectColdAccess(BaseBucketRequest request)` Obtain the direct reading policy for Archive objects in a bucket.
`BucketDirectColdAccess`	`getBucketDirectColdAccess(String bucketName)` Obtain the direct reading policy for Archive objects in a bucket.
`BucketEncryption`	`getBucketEncryption(BaseBucketRequest request)` Obtain bucket encryption configuration.
`BucketEncryption`	`getBucketEncryption(String bucketName)` Obtain bucket encryption configuration.
`LifecycleConfiguration`	`getBucketLifecycle(BaseBucketRequest request)` Obtain the bucket lifecycle rules.
`LifecycleConfiguration`	`getBucketLifecycle(String bucketName)` Obtain the bucket lifecycle rules.
`BucketLocationResponse`	`getBucketLocation(BaseBucketRequest request)` Obtain the bucket location.
`String`	`getBucketLocation(String bucketName)` Obtain the bucket location.
`BucketLocationResponse`	`getBucketLocationV2(String bucketName)` Obtain the bucket location.
`BucketLoggingConfiguration`	`getBucketLogging(BaseBucketRequest request)` Obtain the logging settings of a bucket.
`BucketLoggingConfiguration`	`getBucketLogging(String bucketName)` Obtain the logging settings of a bucket.
`BucketMetadataInfoResult`	`getBucketMetadata(BucketMetadataInfoRequest request)` Obtain bucket metadata.
`BucketNotificationConfiguration`	`getBucketNotification(BaseBucketRequest request)` Obtain the notification configuration of a bucket.
`BucketNotificationConfiguration`	`getBucketNotification(String bucketName)` Obtain the notification configuration of a bucket.
`String`	`getBucketPolicy(BaseBucketRequest request)` Obtain a bucket policy.
`String`	`getBucketPolicy(String bucketName)` Obtain bucket policies.
`BucketPolicyResponse`	`getBucketPolicyV2(BaseBucketRequest request)` Obtain bucket policies.
`BucketPolicyResponse`	`getBucketPolicyV2(String bucketName)` Obtain bucket policies.
`BucketQuota`	`getBucketQuota(BaseBucketRequest request)` Obtain the bucket quota.
`BucketQuota`	`getBucketQuota(String bucketName)` Obtain the bucket quota.
`ReplicationConfiguration`	`getBucketReplication(BaseBucketRequest request)` Obtain the cross-region replication configuration of a bucket.
`ReplicationConfiguration`	`getBucketReplication(String bucketName)` Obtain the cross-region replication configuration of a bucket.
`RequestPaymentConfiguration`	`getBucketRequestPayment(BaseBucketRequest request)` Obtain the requester-pays status of a bucket.
`RequestPaymentConfiguration`	`getBucketRequestPayment(String bucketName)` Obtain the status of the requester-pays function of a bucket.
`BucketStorageInfo`	`getBucketStorageInfo(BaseBucketRequest request)` Obtain bucket storage information.
`BucketStorageInfo`	`getBucketStorageInfo(String bucketName)` Obtain bucket storage information.
`BucketStoragePolicyConfiguration`	`getBucketStoragePolicy(BaseBucketRequest request)` Obtain the bucket storage class.
`BucketStoragePolicyConfiguration`	`getBucketStoragePolicy(String bucketName)` Obtain the bucket storage class.
`BucketTagInfo`	`getBucketTagging(BaseBucketRequest request)` Obtain bucket tags.
`BucketTagInfo`	`getBucketTagging(String bucketName)` Obtain bucket tags.
`BucketVersioningConfiguration`	`getBucketVersioning(BaseBucketRequest request)` Obtain the versioning status for a bucket.
`BucketVersioningConfiguration`	`getBucketVersioning(String bucketName)` Obtain the versioning status for a bucket.
`WebsiteConfiguration`	`getBucketWebsite(BaseBucketRequest request)` Obtain the website hosting settings of a Bucket
`WebsiteConfiguration`	`getBucketWebsite(String bucketName)` Obtain the website hosting configuration of a Bucket
`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(GetObjectAclRequest request)` Obtain an object ACL.
`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(BaseBucketRequest request)` Identify whether a bucket exists.
`boolean`	`headBucket(String bucketName)` Identify whether a bucket exists.
`InitiateMultipartUploadResult`	`initiateMultipartUpload(InitiateMultipartUploadRequest request)` Initialize a multipart upload.
`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.
`ModifyObjectResult`	`modifyObject(ModifyObjectRequest request)` Write a file.
`ModifyObjectResult`	`modifyObject(String bucketName, String objectKey, long position, File file)` Write a file.
`ModifyObjectResult`	`modifyObject(String bucketName, String objectKey, long position, InputStream input)` Write a file.
`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)` Upload files in a batch.
`ReadAheadQueryResult`	`queryReadAheadObjectsTask(String bucketName, String taskId)` Query the progress of a read-ahead task.
`ReadAheadResult`	`readAheadObjects(ReadAheadRequest request)` Read ahead objects.
`void`	`refresh(String accessKey, String secretKey, String securityToken)` Refresh the temporary access key.
`RenameObjectResult`	`renameObject(RenameObjectRequest request)` Rename a file or directory.
`RenameObjectResult`	`renameObject(String bucketName, String objectKey, String newObjectKey)` Rename a file or directory.
`RestoreObjectRequest.RestoreObjectStatus`	`restoreObject(RestoreObjectRequest request)` Restore an Archive object.
`TaskProgressStatus`	`restoreObjects(RestoreObjectsRequest request)` Restore Archive objects in a batch.
`RestoreObjectResult`	`restoreObjectV2(RestoreObjectRequest request)` Restore an Archive object.
`HeaderResponse`	`setBucketAcl(SetBucketAclRequest request)` Set a bucket ACL.
`HeaderResponse`	`setBucketAcl(String bucketName, AccessControlList acl)` Set a bucket ACL.
`HeaderResponse`	`setBucketCors(SetBucketCorsRequest request)` Configure the bucket CORS.
`HeaderResponse`	`setBucketCors(String bucketName, BucketCors bucketCors)` Configure the bucket CORS.
`HeaderResponse`	`setBucketDirectColdAccess(SetBucketDirectColdAccessRequest request)` Configure the direct reading policy for Archive objects in a bucket.
`HeaderResponse`	`setBucketDirectColdAccess(String bucketName, BucketDirectColdAccess access)` Set the direct reading policy for Archive objects in a bucket.
`HeaderResponse`	`setBucketEncryption(SetBucketEncryptionRequest request)` Configure bucket encryption.
`HeaderResponse`	`setBucketEncryption(String bucketName, BucketEncryption bucketEncryption)` Set bucket encryption.
`HeaderResponse`	`setBucketLifecycle(SetBucketLifecycleRequest request)` Configure lifecycle rules for a bucket.
`HeaderResponse`	`setBucketLifecycle(String bucketName, LifecycleConfiguration lifecycleConfig)` Set the bucket lifecycle rules.
`HeaderResponse`	`setBucketLogging(SetBucketLoggingRequest request)` Configure logging for a bucket.
`HeaderResponse`	`setBucketLogging(String bucketName, BucketLoggingConfiguration loggingConfiguration)` Configure logging for a bucket.
`HeaderResponse`	`setBucketLoggingConfiguration(String bucketName, BucketLoggingConfiguration loggingConfiguration, boolean updateTargetACLifRequired)`
`HeaderResponse`	`setBucketNotification(SetBucketNotificationRequest request)` Set event notification for a bucket.
`HeaderResponse`	`setBucketNotification(String bucketName, BucketNotificationConfiguration bucketNotificationConfiguration)` Configure bucket notification.
`HeaderResponse`	`setBucketPolicy(SetBucketPolicyRequest request)` Set bucket policies.
`HeaderResponse`	`setBucketPolicy(String bucketName, String policy)` Set bucket policies.
`HeaderResponse`	`setBucketQuota(SetBucketQuotaRequest request)` Set the bucket quota.
`HeaderResponse`	`setBucketQuota(String bucketName, BucketQuota bucketQuota)` Set the bucket quota.
`HeaderResponse`	`setBucketReplication(SetBucketReplicationRequest request)` Configure cross-region replication for a bucket.
`HeaderResponse`	`setBucketReplication(String bucketName, ReplicationConfiguration replicationConfiguration)` Configure cross-region replication for a bucket.
`HeaderResponse`	`setBucketRequestPayment(SetBucketRequestPaymentRequest request)` Configure the requester-pays function for a bucket.
`HeaderResponse`	`setBucketRequestPayment(String bucketName, RequestPaymentEnum payer)` Configure the requester-pays function for a bucket.
`HeaderResponse`	`setBucketStoragePolicy(SetBucketStoragePolicyRequest request)` Set the bucket storage class.
`HeaderResponse`	`setBucketStoragePolicy(String bucketName, BucketStoragePolicyConfiguration bucketStorage)` Set the bucket storage class.
`HeaderResponse`	`setBucketTagging(SetBucketTaggingRequest request)` Set bucket tags.
`HeaderResponse`	`setBucketTagging(String bucketName, BucketTagInfo bucketTagInfo)` Set bucket tags.
`HeaderResponse`	`setBucketVersioning(SetBucketVersioningRequest request)` Set the versioning status for a bucket.
`HeaderResponse`	`setBucketVersioning(String bucketName, BucketVersioningConfiguration versioningConfiguration)` Set the versioning status for a bucket.
`HeaderResponse`	`setBucketWebsite(SetBucketWebsiteRequest request)` Configure website hosting for a bucket.
`HeaderResponse`	`setBucketWebsite(String bucketName, WebsiteConfiguration websiteConfig)` Configure website hosting for a bucket.
`HeaderResponse`	`setObjectAcl(SetObjectAclRequest request)` Set an object ACL.
`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.
`ObjectMetadata`	`setObjectMetadata(SetObjectMetadataRequest request)` Set object properties.
`TruncateObjectResult`	`truncateObject(String bucketName, String objectKey, long newLength)` Truncate a file.
`TruncateObjectResult`	`truncateObject(TruncateObjectRequest 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.

- Method Detail
  - refresh
```
void refresh(String accessKey,
             String secretKey,
             String securityToken)
```
    Refresh the temporary access key.
    
    Parameters:
    
    accessKey - AK in the temporary access key
    
    secretKey - SK in the temporary access key
    
    securityToken - Security token
  - createTemporarySignature
```
TemporarySignatureResponse createTemporarySignature(TemporarySignatureRequest request)
```
    Generate temporarily authorized access parameters.
    
    Parameters:
    
    request - Parameters in a request for temporarily authorized access
    
    Returns:
    
    Response to the request for temporarily authorized access
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - createPostSignature
```
PostSignatureResponse createPostSignature(PostSignatureRequest request)
                                   throws ObsException
```
    Generate parameters for browser-based authorized access.
    
    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
```
ObsBucket createBucket(String bucketName)
                throws ObsException
```
    Create a bucket.
    
    Bucket naming rules:
    - Contain only lowercase letters, digits, hyphens (-), and periods (.).
    - Must start with a digit or a letter.
    - Contain 3 to 63 characters.
    - Cannot be an IP address.
    - Cannot end with a hyphen (-).
    - Cannot contain two consecutive periods (..).
    - Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, "my-.bucket" and "my.-bucket".
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Bucket information
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - createBucket
```
ObsBucket createBucket(String bucketName,
                       String location)
                throws ObsException
```
    Create a bucket.
    Create a bucket of a specific name in the given region.
    Bucket naming rules:
    - Contain only lowercase letters, digits, hyphens (-), and periods (.).
    - Must start with a digit or a letter.
    - Contain 3 to 63 characters.
    - Cannot be an IP address.s
    - Cannot end with a hyphen (-).
    - Cannot contain two consecutive periods (..).
    - Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, "my-.bucket" and "my.-bucket".
    Parameters:
    
    bucketName - Bucket name
    
    location - Bucket location. This parameter is mandatory unless the endpoint belongs to the default region.
    
    Returns:
    
    Bucket information
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - createBucket
```
ObsBucket createBucket(ObsBucket bucket)
                throws ObsException
```
    Create a bucket.
    Create a bucket of a specific name in the given region.
    Bucket naming rules:
    - Contain only lowercase letters, digits, hyphens (-), and periods (.).
    - Must start with a digit or a letter.
    - Contain 3 to 63 characters.
    - Cannot be an IP address.
    - Cannot end with a hyphen (-).
    - Cannot contain two consecutive periods (..).
    - Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, "my-.bucket" and "my.-bucket".
    Parameters:
    
    bucket - Bucket information, including the request parameters
    
    Returns:
    
    Bucket information
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - createBucket
```
ObsBucket createBucket(CreateBucketRequest request)
                throws ObsException
```
    Create a bucket.
    
    Bucket naming rules:
    - Contain only lowercase letters, digits, hyphens (-), and periods (.).
    - Must start with a digit or a letter.
    - Contain 3 to 63 characters.
    - Cannot be an IP address.
    - Cannot end with a hyphen (-).
    - Cannot contain two consecutive periods (..).
    - Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, "my-.bucket" and "my.-bucket".
    Parameters:
    
    request - Request parameters for creating a bucket
    
    Returns:
    
    Bucket information
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - renameObject
```
RenameObjectResult renameObject(String bucketName,
                                String objectKey,
                                String newObjectKey)
                         throws ObsException
```
    Rename a file or directory. Only the parallel file system supports this interface.
    
    Parameters:
    
    bucketName - Bucket name
    
    objectKey - File name or directory name
    
    newObjectKey - Name of the renamed file or directory
    
    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
  - renameObject
```
RenameObjectResult renameObject(RenameObjectRequest request)
                         throws ObsException
```
    Rename a file or directory. Only the parallel file system supports this interface.
    
    Parameters:
    
    request - Parameters of a request 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
    
    Since:
    
    3.20.3
  - truncateObject
```
TruncateObjectResult truncateObject(String bucketName,
                                    String objectKey,
                                    long newLength)
                             throws ObsException
```
    Truncate a file. Only the parallel file system supports this interface.
    
    Parameters:
    
    bucketName - Bucket name
    
    objectKey - File name
    
    newLength - Size of the truncated 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
  - truncateObject
```
TruncateObjectResult truncateObject(TruncateObjectRequest request)
                             throws ObsException
```
    Truncate a file. Only the parallel file system supports this interface.
    
    Parameters:
    
    request - Parameters of a request 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
    
    Since:
    
    3.20.3
  - modifyObject
```
ModifyObjectResult modifyObject(String bucketName,
                                String objectKey,
                                long position,
                                File file)
                         throws ObsException
```
    Write a file. Only the parallel file system supports this interface.
    
    Parameters:
    
    bucketName - Bucket name
    
    objectKey - File name
    
    position - Start position for writing data to a file
    
    file - Local file path
    
    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
  - modifyObject
```
ModifyObjectResult modifyObject(String bucketName,
                                String objectKey,
                                long position,
                                InputStream input)
                         throws ObsException
```
    Write a file. Only the parallel file system supports this interface.
    
    Parameters:
    
    bucketName - Bucket name
    
    objectKey - File name
    
    position - Start position for writing data to a file
    
    input - Data stream to be uploaded
    
    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
  - modifyObject
```
ModifyObjectResult modifyObject(ModifyObjectRequest request)
                         throws ObsException
```
    Write a file. Only the parallel file system supports this interface.
    
    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
  - listBuckets
```
List<ObsBucket> listBuckets(ListBucketsRequest request)
                     throws ObsException
```
    Obtain the bucket list.
    
    Parameters:
    
    request - Obtain the request parameters for obtaining the bucket list.
    
    Returns:
    
    Bucket list
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - listBucketsV2
```
ListBucketsResult listBucketsV2(ListBucketsRequest request)
                         throws ObsException
```
    Obtain the bucket list.
    
    Parameters:
    
    request - Obtain the request parameters for obtaining the bucket list.
    
    Returns:
    
    Response to the request for obtaining the bucket list
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - deleteBucket
```
HeaderResponse deleteBucket(String bucketName)
                     throws ObsException
```
    Delete a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - deleteBucket
```
HeaderResponse deleteBucket(BaseBucketRequest request)
                     throws ObsException
```
    Delete a bucket.
    
    Parameters:
    
    request - Parameters of a request for deleting a bucket
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - listObjects
```
ObjectListing listObjects(ListObjectsRequest request)
                   throws ObsException
```
    List objects in the bucket.
    
    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
```
ObjectListing listObjects(String bucketName)
                   throws ObsException
```
    List objects in the bucket.
    
    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
```
boolean headBucket(String bucketName)
            throws ObsException
```
    Identify whether a bucket exists.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Identifier indicating whether the bucket exists
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - headBucket
```
boolean headBucket(BaseBucketRequest request)
            throws ObsException
```
    Identify whether a bucket exists.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Identifier indicating whether the bucket exists
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - listVersions
```
ListVersionsResult listVersions(ListVersionsRequest request)
                         throws ObsException
```
    List versioning objects in a bucket.
    
    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
```
ListVersionsResult listVersions(String bucketName)
                         throws ObsException
```
    List versioning objects in a bucket.
    
    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
```
ListVersionsResult listVersions(String bucketName,
                                long maxKeys)
                         throws ObsException
```
    List versioning objects in a bucket.
    
    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
```
ListVersionsResult listVersions(String bucketName,
                                String prefix,
                                String delimiter,
                                String keyMarker,
                                String versionIdMarker,
                                long maxKeys)
                         throws ObsException
```
    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
    
    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
```
BucketMetadataInfoResult getBucketMetadata(BucketMetadataInfoRequest request)
                                    throws ObsException
```
    Obtain bucket metadata.
    
    Parameters:
    
    request - Request parameters for obtaining bucket metadata
    
    Returns:
    
    Response to the request for obtaining bucket metadata
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketAcl
```
AccessControlList getBucketAcl(String bucketName)
                        throws ObsException
```
    Obtain a bucket ACL.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Bucket ACL
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketAcl
```
AccessControlList getBucketAcl(BaseBucketRequest request)
                        throws ObsException
```
    Obtain a bucket ACL.
    
    Parameters:
    
    request - Request parameters for obtaining the bucket ACL
    
    Returns:
    
    Response to a request for obtaining the bucket ACL
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - setBucketAcl
```
HeaderResponse setBucketAcl(String bucketName,
                            AccessControlList acl)
                     throws ObsException
```
    Set a bucket ACL.
    
    Parameters:
    
    bucketName - Bucket name
    
    acl - ACL
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketAcl
```
HeaderResponse setBucketAcl(SetBucketAclRequest request)
                     throws ObsException
```
    Set a bucket ACL.
    
    Parameters:
    
    request - Request parameters for setting a bucket ACL
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - getBucketLocation
```
String getBucketLocation(String bucketName)
                  throws ObsException
```
    Obtain the bucket location.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Bucket location
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketLocation
```
BucketLocationResponse getBucketLocation(BaseBucketRequest request)
                                  throws ObsException
```
    Obtain the bucket location.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Response to the request for obtaining the bucket location
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - getBucketLocationV2
```
BucketLocationResponse getBucketLocationV2(String bucketName)
                                    throws ObsException
```
    Obtain the bucket location.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Response to the request for obtaining the bucket location
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketStorageInfo
```
BucketStorageInfo getBucketStorageInfo(String bucketName)
                                throws ObsException
```
    Obtain bucket storage information.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Bcket storage information
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketStorageInfo
```
BucketStorageInfo getBucketStorageInfo(BaseBucketRequest request)
                                throws ObsException
```
    Obtain bucket storage information.
    
    Parameters:
    
    request - Bucket name
    
    Returns:
    
    Bucket storage information
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - getBucketQuota
```
BucketQuota getBucketQuota(String bucketName)
                    throws ObsException
```
    Obtain the bucket quota.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Bucket quota
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketQuota
```
BucketQuota getBucketQuota(BaseBucketRequest request)
                    throws ObsException
```
    Obtain the bucket quota.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Bucket quota
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - setBucketQuota
```
HeaderResponse setBucketQuota(String bucketName,
                              BucketQuota bucketQuota)
                       throws ObsException
```
    Set the bucket quota.
    
    Parameters:
    
    bucketName - Bucket name
    
    bucketQuota - Bucket quota
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketQuota
```
HeaderResponse setBucketQuota(SetBucketQuotaRequest request)
                       throws ObsException
```
    Set the bucket quota.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - getBucketStoragePolicy
```
BucketStoragePolicyConfiguration getBucketStoragePolicy(String bucketName)
                                                 throws ObsException
```
    Obtain the bucket storage class.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Bucket storage policy
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketStoragePolicy
```
BucketStoragePolicyConfiguration getBucketStoragePolicy(BaseBucketRequest request)
                                                 throws ObsException
```
    Obtain the bucket storage class.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Bucket storage policy
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - setBucketStoragePolicy
```
HeaderResponse setBucketStoragePolicy(String bucketName,
                                      BucketStoragePolicyConfiguration bucketStorage)
                               throws ObsException
```
    Set the bucket storage class.
    
    Parameters:
    
    bucketName - Bucket name
    
    bucketStorage - Bucket storage policy
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketStoragePolicy
```
HeaderResponse setBucketStoragePolicy(SetBucketStoragePolicyRequest request)
                               throws ObsException
```
    Set the bucket storage class.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - setBucketCors
```
HeaderResponse setBucketCors(String bucketName,
                             BucketCors bucketCors)
                      throws ObsException
```
    Configure the bucket CORS.
    
    Parameters:
    
    bucketName - Bucket name
    
    bucketCors - CORS rules
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketCors
```
HeaderResponse setBucketCors(SetBucketCorsRequest request)
                      throws ObsException
```
    Configure the bucket CORS.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - getBucketCors
```
BucketCors getBucketCors(String bucketName)
                  throws ObsException
```
    Obtain the bucket CORS rules.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Bucket CORS rules
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketCors
```
BucketCors getBucketCors(BaseBucketRequest request)
                  throws ObsException
```
    Obtain the bucket CORS rules.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Bucket CORS configuration
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - deleteBucketCors
```
HeaderResponse deleteBucketCors(String bucketName)
                         throws ObsException
```
    Delete the bucket CORS rules.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - deleteBucketCors
```
HeaderResponse deleteBucketCors(BaseBucketRequest request)
                         throws ObsException
```
    Delete the bucket CORS rules.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - getBucketLogging
```
BucketLoggingConfiguration getBucketLogging(String bucketName)
                                     throws ObsException
```
    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
```
BucketLoggingConfiguration getBucketLogging(BaseBucketRequest request)
                                     throws ObsException
```
    Obtain the logging settings of a bucket.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Logging settings of the bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - setBucketLoggingConfiguration
```
HeaderResponse setBucketLoggingConfiguration(String bucketName,
                                             BucketLoggingConfiguration loggingConfiguration,
                                             boolean updateTargetACLifRequired)
                                      throws ObsException
```
    Throws:
    
    ObsException
  - setBucketLogging
```
HeaderResponse setBucketLogging(String bucketName,
                                BucketLoggingConfiguration loggingConfiguration)
                         throws ObsException
```
    Configure logging for a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    loggingConfiguration - Logging settings
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketLogging
```
HeaderResponse setBucketLogging(SetBucketLoggingRequest request)
                         throws ObsException
```
    Configure logging for a bucket.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - setBucketVersioning
```
HeaderResponse setBucketVersioning(String bucketName,
                                   BucketVersioningConfiguration versioningConfiguration)
                            throws ObsException
```
    Set the versioning status for a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    versioningConfiguration - Versioning status of the bucket
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketVersioning
```
HeaderResponse setBucketVersioning(SetBucketVersioningRequest request)
                            throws ObsException
```
    Set the versioning status for a bucket.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - getBucketVersioning
```
BucketVersioningConfiguration getBucketVersioning(String bucketName)
                                           throws ObsException
```
    Obtain the versioning status for a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Versioning status of the bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketVersioning
```
BucketVersioningConfiguration getBucketVersioning(BaseBucketRequest request)
                                           throws ObsException
```
    Obtain the versioning status for a bucket.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Versioning status of the bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - setBucketRequestPayment
```
HeaderResponse setBucketRequestPayment(String bucketName,
                                       RequestPaymentEnum payer)
                                throws ObsException
```
    Configure the requester-pays function for a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    payer - The status of the requester-pays function
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketRequestPayment
```
HeaderResponse setBucketRequestPayment(SetBucketRequestPaymentRequest request)
                                throws ObsException
```
    Configure the requester-pays function for a bucket.
    
    Parameters:
    
    request - Configuration of the requester-pays function of a bucket
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - getBucketRequestPayment
```
RequestPaymentConfiguration getBucketRequestPayment(String bucketName)
                                             throws ObsException
```
    Obtain the status of the requester-pays function of a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Configuration of the requester-pays function of the bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - getBucketRequestPayment
```
RequestPaymentConfiguration getBucketRequestPayment(BaseBucketRequest request)
                                             throws ObsException
```
    Obtain the requester-pays status of a bucket.
    
    Parameters:
    
    request - Basic bucket information
    
    Returns:
    
    Configuration of the requester-pays function of the bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - getBucketLifecycle
```
LifecycleConfiguration getBucketLifecycle(String bucketName)
                                   throws ObsException
```
    Obtain the bucket lifecycle rules.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Bucket lifecycle rules
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketLifecycle
```
LifecycleConfiguration getBucketLifecycle(BaseBucketRequest request)
                                   throws ObsException
```
    Obtain the bucket lifecycle rules.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Bucket lifecycle rules
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - setBucketLifecycle
```
HeaderResponse setBucketLifecycle(String bucketName,
                                  LifecycleConfiguration lifecycleConfig)
                           throws ObsException
```
    Set the bucket lifecycle rules.
    
    Parameters:
    
    bucketName - Bucket name
    
    lifecycleConfig - Bucket lifecycle rules
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketLifecycle
```
HeaderResponse setBucketLifecycle(SetBucketLifecycleRequest request)
                           throws ObsException
```
    Configure lifecycle rules for a bucket.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - deleteBucketLifecycle
```
HeaderResponse deleteBucketLifecycle(String bucketName)
                              throws ObsException
```
    Delete the bucket lifecycle rules from a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - deleteBucketLifecycle
```
HeaderResponse deleteBucketLifecycle(BaseBucketRequest request)
                              throws ObsException
```
    Delete the bucket lifecycle rules from a bucket.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - getBucketPolicy
```
String getBucketPolicy(String bucketName)
                throws ObsException
```
    Obtain bucket policies.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Bucket policy, in the JSON format
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketPolicy
```
String getBucketPolicy(BaseBucketRequest request)
                throws ObsException
```
    Obtain a bucket policy.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Bucket policy, in the JSON format
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - getBucketPolicyV2
```
BucketPolicyResponse getBucketPolicyV2(String bucketName)
                                throws ObsException
```
    Obtain bucket policies.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Response to a request for obtaining bucket policies
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketPolicyV2
```
BucketPolicyResponse getBucketPolicyV2(BaseBucketRequest request)
                                throws ObsException
```
    Obtain bucket policies.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Response to a request for obtaining bucket policies
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - setBucketPolicy
```
HeaderResponse setBucketPolicy(String bucketName,
                               String policy)
                        throws ObsException
```
    Set bucket policies.
    
    Parameters:
    
    bucketName - Bucket name
    
    policy - Bucket policy, in the JSON format
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketPolicy
```
HeaderResponse setBucketPolicy(SetBucketPolicyRequest request)
                        throws ObsException
```
    Set bucket policies.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - deleteBucketPolicy
```
HeaderResponse deleteBucketPolicy(String bucketName)
                           throws ObsException
```
    Delete bucket policies.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - deleteBucketPolicy
```
HeaderResponse deleteBucketPolicy(BaseBucketRequest request)
                           throws ObsException
```
    Delete bucket policies.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - getBucketWebsite
```
WebsiteConfiguration getBucketWebsite(String bucketName)
                               throws ObsException
```
    Obtain the website hosting configuration of a Bucket
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Website hosting configuration of a bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketWebsite
```
WebsiteConfiguration getBucketWebsite(BaseBucketRequest request)
                               throws ObsException
```
    Obtain the website hosting settings of a Bucket
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Website hosting configuration of a bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - setBucketWebsite
```
HeaderResponse setBucketWebsite(String bucketName,
                                WebsiteConfiguration websiteConfig)
                         throws ObsException
```
    Configure website hosting for a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    websiteConfig - Website hosting configuration of a bucket
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketWebsite
```
HeaderResponse setBucketWebsite(SetBucketWebsiteRequest request)
                         throws ObsException
```
    Configure website hosting for a bucket.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - deleteBucketWebsite
```
HeaderResponse deleteBucketWebsite(String bucketName)
                            throws ObsException
```
    Delete the website hosting configuration of a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - deleteBucketWebsite
```
HeaderResponse deleteBucketWebsite(BaseBucketRequest request)
                            throws ObsException
```
    Delete the website hosting configuration of a bucket.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - getBucketTagging
```
BucketTagInfo getBucketTagging(String bucketName)
                        throws ObsException
```
    Obtain bucket tags.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Bucket tag
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketTagging
```
BucketTagInfo getBucketTagging(BaseBucketRequest request)
                        throws ObsException
```
    Obtain bucket tags.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Bucket tag
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - setBucketTagging
```
HeaderResponse setBucketTagging(String bucketName,
                                BucketTagInfo bucketTagInfo)
                         throws ObsException
```
    Set bucket tags.
    
    Parameters:
    
    bucketName - Bucket name
    
    bucketTagInfo - Bucket tags
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketTagging
```
HeaderResponse setBucketTagging(SetBucketTaggingRequest request)
                         throws ObsException
```
    Set bucket tags.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - deleteBucketTagging
```
HeaderResponse deleteBucketTagging(String bucketName)
                            throws ObsException
```
    Delete bucket tags.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - deleteBucketTagging
```
HeaderResponse deleteBucketTagging(BaseBucketRequest request)
                            throws ObsException
```
    Delete bucket tags.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - getBucketEncryption
```
BucketEncryption getBucketEncryption(String bucketName)
                              throws ObsException
```
    Obtain bucket encryption configuration.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Bucket encryption configuration
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketEncryption
```
BucketEncryption getBucketEncryption(BaseBucketRequest request)
                              throws ObsException
```
    Obtain bucket encryption configuration.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Bucket encryption configuration
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - setBucketEncryption
```
HeaderResponse setBucketEncryption(String bucketName,
                                   BucketEncryption bucketEncryption)
                            throws ObsException
```
    Set bucket encryption.
    
    Parameters:
    
    bucketName - Bucket name
    
    bucketEncryption - Bucket encryption configuration
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketEncryption
```
HeaderResponse setBucketEncryption(SetBucketEncryptionRequest request)
                            throws ObsException
```
    Configure bucket encryption.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - deleteBucketEncryption
```
HeaderResponse deleteBucketEncryption(String bucketName)
                               throws ObsException
```
    Delete bucket encryption configuration.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - deleteBucketEncryption
```
HeaderResponse deleteBucketEncryption(BaseBucketRequest request)
                               throws ObsException
```
    Delete bucket encryption configuration.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - setBucketReplication
```
HeaderResponse setBucketReplication(String bucketName,
                                    ReplicationConfiguration replicationConfiguration)
                             throws ObsException
```
    Configure cross-region replication for a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    replicationConfiguration - Cross-region replication configuration
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketReplication
```
HeaderResponse setBucketReplication(SetBucketReplicationRequest request)
                             throws ObsException
```
    Configure cross-region replication for a bucket.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - getBucketReplication
```
ReplicationConfiguration getBucketReplication(String bucketName)
                                       throws ObsException
```
    Obtain the cross-region replication configuration of a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Cross-region replication configuration
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketReplication
```
ReplicationConfiguration getBucketReplication(BaseBucketRequest request)
                                       throws ObsException
```
    Obtain the cross-region replication configuration of a bucket.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Cross-region replication configuration
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - deleteBucketReplication
```
HeaderResponse deleteBucketReplication(String bucketName)
                                throws ObsException
```
    Delete the bucket cross-region replication configuration.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - deleteBucketReplication
```
HeaderResponse deleteBucketReplication(BaseBucketRequest request)
                                throws ObsException
```
    Delete the bucket cross-region replication configuration.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - getBucketNotification
```
BucketNotificationConfiguration getBucketNotification(String bucketName)
                                               throws ObsException
```
    Obtain the notification configuration of a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Bucket notification configuration
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketNotification
```
BucketNotificationConfiguration getBucketNotification(BaseBucketRequest request)
                                               throws ObsException
```
    Obtain the notification configuration of a bucket.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Bucket notification configuration
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - setBucketNotification
```
HeaderResponse setBucketNotification(String bucketName,
                                     BucketNotificationConfiguration bucketNotificationConfiguration)
                              throws ObsException
```
    Configure bucket notification.
    
    Parameters:
    
    bucketName - Bucket name
    
    bucketNotificationConfiguration - Bucket notification configuration
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketNotification
```
HeaderResponse setBucketNotification(SetBucketNotificationRequest request)
                              throws ObsException
```
    Set event notification for a bucket.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - putObject
```
PutObjectResult putObject(String bucketName,
                          String objectKey,
                          InputStream input,
                          ObjectMetadata metadata)
                   throws ObsException
```
    Upload an object.
    
    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
```
PutObjectResult putObject(String bucketName,
                          String objectKey,
                          InputStream input)
                   throws ObsException
```
    Upload an object.
    
    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
```
PutObjectResult putObject(PutObjectRequest request)
                   throws ObsException
```
    Upload an object.
    
    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
```
PutObjectResult putObject(String bucketName,
                          String objectKey,
                          File file)
                   throws ObsException
```
    Upload an object.
    
    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
```
PutObjectResult putObject(String bucketName,
                          String objectKey,
                          File file,
                          ObjectMetadata metadata)
                   throws ObsException
```
    Upload an object.
    
    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
```
AppendObjectResult appendObject(AppendObjectRequest request)
                         throws ObsException
```
    Perform an appendable upload.
    
    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
```
CompleteMultipartUploadResult uploadFile(UploadFileRequest uploadFileRequest)
                                  throws ObsException
```
    Upload a file. The resumable upload mode is supported.
    
    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
  - putObjects
```
UploadProgressStatus putObjects(PutObjectsRequest request)
                         throws ObsException
```
    Upload files in a batch.
    
    Parameters:
    
    request - Request parameters for uploading files 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
  - doesObjectExist
```
boolean doesObjectExist(String buckeName,
                        String objectKey)
                 throws ObsException
```
    Check whether an object exists.
    
    Parameters:
    
    buckeName - Bucket name
    
    objectKey - Object name
    
    Returns:
    
    Whether an object exists
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - doesObjectExist
```
boolean doesObjectExist(GetObjectMetadataRequest request)
                 throws ObsException
```
    Check whether an object exists.
    
    Parameters:
    
    request - Request parameters for obtaining the properties of an object
    
    Returns:
    
    Whether an object exists
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - downloadFile
```
DownloadFileResult downloadFile(DownloadFileRequest downloadFileRequest)
                         throws ObsException
```
    Download a file. The resumable download mode is supported.
    
    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
```
ObsObject getObject(GetObjectRequest request)
             throws ObsException
```
    Download an object.
    
    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
```
ObsObject getObject(String bucketName,
                    String objectKey,
                    String versionId)
             throws ObsException
```
    Download an object.
    
    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
```
ObsObject getObject(String bucketName,
                    String objectKey)
             throws ObsException
```
    Download an object.
    
    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
```
ObjectMetadata getObjectMetadata(GetObjectMetadataRequest request)
                          throws ObsException
```
    Obtain object properties.
    
    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
  - getObjectMetadata
```
ObjectMetadata getObjectMetadata(String bucketName,
                                 String objectKey,
                                 String versionId)
                          throws ObsException
```
    Obtain object properties.
    
    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
```
ObjectMetadata getObjectMetadata(String bucketName,
                                 String objectKey)
                          throws ObsException
```
    Obtain object properties.
    
    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
  - setObjectMetadata
```
ObjectMetadata setObjectMetadata(SetObjectMetadataRequest request)
                          throws ObsException
```
    Set object properties.
    
    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
  - restoreObject
```
RestoreObjectRequest.RestoreObjectStatus restoreObject(RestoreObjectRequest request)
                                                throws ObsException
```
    Restore an Archive object.
    
    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
```
RestoreObjectResult restoreObjectV2(RestoreObjectRequest request)
                             throws ObsException
```
    Restore an Archive object.
    
    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
```
TaskProgressStatus restoreObjects(RestoreObjectsRequest request)
                           throws ObsException
```
    Restore Archive objects in a batch.
    
    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
  - deleteObject
```
DeleteObjectResult deleteObject(String bucketName,
                                String objectKey,
                                String versionId)
                         throws ObsException
```
    Delete an object.
    
    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
```
DeleteObjectResult deleteObject(String bucketName,
                                String objectKey)
                         throws ObsException
```
    Delete an object.
    
    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
  - deleteObject
```
DeleteObjectResult deleteObject(DeleteObjectRequest request)
                         throws ObsException
```
    Delete an object.
    
    Parameters:
    
    request - Request parameters for deleting an object
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - deleteObjects
```
DeleteObjectsResult deleteObjects(DeleteObjectsRequest deleteObjectsRequest)
                           throws ObsException
```
    Delete objects in a batch.
    
    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
```
AccessControlList getObjectAcl(String bucketName,
                               String objectKey,
                               String versionId)
                        throws ObsException
```
    Obtain an object ACL.
    
    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
```
AccessControlList getObjectAcl(String bucketName,
                               String objectKey)
                        throws ObsException
```
    Obtain an object ACL.
    
    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
  - getObjectAcl
```
AccessControlList getObjectAcl(GetObjectAclRequest request)
                        throws ObsException
```
    Obtain an object ACL.
    
    Parameters:
    
    request - Request parameters for obtaining an object ACL
    
    Returns:
    
    Object ACL
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - setObjectAcl
```
HeaderResponse setObjectAcl(String bucketName,
                            String objectKey,
                            AccessControlList acl,
                            String versionId)
                     throws ObsException
```
    Set an object ACL.
    
    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
```
HeaderResponse setObjectAcl(String bucketName,
                            String objectKey,
                            AccessControlList acl)
                     throws ObsException
```
    Set an object ACL.
    
    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
  - setObjectAcl
```
HeaderResponse setObjectAcl(SetObjectAclRequest request)
                     throws ObsException
```
    Set an object ACL.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - copyObject
```
CopyObjectResult copyObject(CopyObjectRequest request)
                     throws ObsException
```
    Copy an object.
    
    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
```
CopyObjectResult copyObject(String sourceBucketName,
                            String sourceObjectKey,
                            String destBucketName,
                            String destObjectKey)
                     throws ObsException
```
    Copy an object.
    
    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
```
InitiateMultipartUploadResult initiateMultipartUpload(InitiateMultipartUploadRequest request)
                                               throws ObsException
```
    Initialize a multipart upload.
    
    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
```
HeaderResponse abortMultipartUpload(AbortMultipartUploadRequest request)
                             throws ObsException
```
    Abort a multipart upload.
    
    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
```
UploadPartResult uploadPart(String bucketName,
                            String objectKey,
                            String uploadId,
                            int partNumber,
                            InputStream input)
                     throws ObsException
```
    Upload a part.
    
    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
```
UploadPartResult uploadPart(String bucketName,
                            String objectKey,
                            String uploadId,
                            int partNumber,
                            File file)
                     throws ObsException
```
    Upload a part.
    
    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
```
UploadPartResult uploadPart(UploadPartRequest request)
                     throws ObsException
```
    Upload a part.
    
    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
```
CopyPartResult copyPart(CopyPartRequest request)
                 throws ObsException
```
    Copy a part.
    
    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
```
CompleteMultipartUploadResult completeMultipartUpload(CompleteMultipartUploadRequest request)
                                               throws ObsException
```
    Combine parts.
    
    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
```
ListPartsResult listParts(ListPartsRequest request)
                   throws ObsException
```
    List uploaded parts.
    
    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
```
MultipartUploadListing listMultipartUploads(ListMultipartUploadsRequest request)
                                     throws ObsException
```
    List incomplete multipart uploads.
    
    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
  - readAheadObjects
```
ReadAheadResult readAheadObjects(ReadAheadRequest request)
                          throws ObsException
```
    Read ahead objects.
    
    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
```
ReadAheadResult deleteReadAheadObjects(String bucketName,
                                       String prefix)
                                throws ObsException
```
    Delete the read-ahead cache.
    
    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
```
ReadAheadQueryResult queryReadAheadObjectsTask(String bucketName,
                                               String taskId)
                                        throws ObsException
```
    Query the progress of a read-ahead task.
    
    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
```
HeaderResponse setBucketDirectColdAccess(String bucketName,
                                         BucketDirectColdAccess access)
                                  throws ObsException
```
    Set the direct reading policy for Archive objects in a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    access - Direct reading policy
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - setBucketDirectColdAccess
```
HeaderResponse setBucketDirectColdAccess(SetBucketDirectColdAccessRequest request)
                                  throws ObsException
```
    Configure the direct reading policy for Archive objects in a bucket.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - getBucketDirectColdAccess
```
BucketDirectColdAccess getBucketDirectColdAccess(String bucketName)
                                          throws ObsException
```
    Obtain the direct reading policy for Archive objects in a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Direct reading policy for Archive objects of a bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - getBucketDirectColdAccess
```
BucketDirectColdAccess getBucketDirectColdAccess(BaseBucketRequest request)
                                          throws ObsException
```
    Obtain the direct reading policy for Archive objects in a bucket.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Direct reading policy for Archive objects in a bucket
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - deleteBucketDirectColdAccess
```
HeaderResponse deleteBucketDirectColdAccess(String bucketName)
                                     throws ObsException
```
    Delete the direct reading policy for Archive objects in a bucket.
    
    Parameters:
    
    bucketName - Bucket name
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
  - deleteBucketDirectColdAccess
```
HeaderResponse deleteBucketDirectColdAccess(BaseBucketRequest request)
                                     throws ObsException
```
    Delete the direct reading policy for Archive objects in a bucket.
    
    Parameters:
    
    request - Request parameters
    
    Returns:
    
    Common response headers
    
    Throws:
    
    ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
    
    Since:
    
    3.20.3
  - close
```
void close()
    throws IOException
```
    Close ObsClient and release connection resources.
    
    Throws:
    
    IOException - ObsClient close exception

Interface IObsClient

Method Summary

Method Detail

refresh

createTemporarySignature

createPostSignature

createBucket

createBucket

createBucket

createBucket

renameObject

renameObject

truncateObject

truncateObject

modifyObject

modifyObject

modifyObject

listBuckets

listBucketsV2

deleteBucket

deleteBucket

listObjects

listObjects

headBucket

headBucket

listVersions

listVersions

listVersions

listVersions

getBucketMetadata

getBucketAcl

getBucketAcl

setBucketAcl

setBucketAcl

getBucketLocation

getBucketLocation

getBucketLocationV2

getBucketStorageInfo

getBucketStorageInfo

getBucketQuota

getBucketQuota

setBucketQuota

setBucketQuota

getBucketStoragePolicy

getBucketStoragePolicy

setBucketStoragePolicy

setBucketStoragePolicy

setBucketCors

setBucketCors

getBucketCors

getBucketCors

deleteBucketCors

deleteBucketCors

getBucketLogging

getBucketLogging

setBucketLoggingConfiguration

setBucketLogging

setBucketLogging

setBucketVersioning

setBucketVersioning

getBucketVersioning

getBucketVersioning

setBucketRequestPayment

setBucketRequestPayment

getBucketRequestPayment

getBucketRequestPayment

getBucketLifecycle

getBucketLifecycle

setBucketLifecycle

setBucketLifecycle

deleteBucketLifecycle

deleteBucketLifecycle

getBucketPolicy

getBucketPolicy

getBucketPolicyV2

getBucketPolicyV2

setBucketPolicy

setBucketPolicy

deleteBucketPolicy

deleteBucketPolicy