接口 IObsClient

所有超级接口:
IObsBucketExtendClient
所有已知实现类:
AbstractBatchClient, AbstractBucketAdvanceClient, AbstractBucketClient, AbstractClient, AbstractDeprecatedBucketClient, AbstractFileClient, AbstractMultipartObjectClient, AbstractObjectClient, AbstractPFSClient, CryptoObsClient, ObsClient, ObsClientAsync, OefClient, SecretFlexibleBucketObsClient, SecretFlexibleObsClient
public interface IObsClient extends IObsBucketExtendClient
Basic OBS interface

  • 方法详细资料

    • refresh

      void refresh(String accessKey, String secretKey, String securityToken)
      Refresh the temporary access key.
      参数:
      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.
      参数:
      request - Parameters in a request for temporarily authorized access
      返回:
      Response to the request for temporarily authorized access
      抛出:
      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.
      参数:
      request - Request parameters for V4 browser-based authorized access
      返回:
      Response to the V4 browser-based authorized access
      抛出:
      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".
      参数:
      bucketName - Bucket name
      返回:
      Bucket information
      抛出:
      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".
      参数:
      bucketName - Bucket name
      location - Bucket location. This parameter is mandatory unless the endpoint belongs to the default region.
      返回:
      Bucket information
      抛出:
      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".
      参数:
      bucket - Bucket information, including the request parameters
      返回:
      Bucket information
      抛出:
      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".
      参数:
      request - Request parameters for creating a bucket
      返回:
      Bucket information
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

    • createVirtualBucket

      CreateVirtualBucketResult createVirtualBucket(CreateVirtualBucketRequest request) throws ObsException
      Create a virtual bucket.
      参数:
      request - Request parameters for creating a virtual bucket
      返回:
      Virtual bucket information
      抛出:
      ObsException

    • listAliasBuckets

      ListBucketAliasResult listAliasBuckets() throws ObsException
      Obtain the bucket alias list.
      返回:
      Alias Bucket list
      抛出:
      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.
      参数:
      bucketName - Bucket name
      objectKey - File name or directory name
      newObjectKey - Name of the renamed file or directory
      返回:
      Response to the request for renaming a file
      抛出:
      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.
      参数:
      request - Parameters of a request for renaming a file
      返回:
      Response to the request for renaming a file
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      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.
      参数:
      bucketName - Bucket name
      objectKey - File name
      newLength - Size of the truncated file
      返回:
      Response to the request for truncating a file
      抛出:
      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.
      参数:
      request - Parameters of a request for truncating a file
      返回:
      Response to the request for truncating a file
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      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.
      参数:
      bucketName - Bucket name
      objectKey - File name
      position - Start position for writing data to a file
      file - Local file path
      返回:
      Files in the bucket that supports the file interface
      抛出:
      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.
      参数:
      bucketName - Bucket name
      objectKey - File name
      position - Start position for writing data to a file
      input - Data stream to be uploaded
      返回:
      Files in the bucket that supports the file interface
      抛出:
      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.
      参数:
      request - Request parameters for writing data to a file
      返回:
      Files in the bucket that supports the file interface
      抛出:
      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.
      参数:
      request - Obtain the request parameters for obtaining the bucket list.
      返回:
      Bucket list
      抛出:
      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.
      参数:
      request - Obtain the request parameters for obtaining the bucket list.
      返回:
      Response to the request for obtaining the bucket list
      抛出:
      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.
      参数:
      bucketName - Bucket name
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Parameters of a request for deleting a bucket
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • listObjects

      ObjectListing listObjects(ListObjectsRequest request) throws ObsException
      List objects in the bucket.
      参数:
      request - Request parameters for listing objects in a bucket
      返回:
      Response to the request for listing objects in the bucket
      抛出:
      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.
      参数:
      bucketName - Bucket name
      返回:
      Response to the request for listing objects in the bucket
      抛出:
      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.
      参数:
      bucketName - Bucket name
      返回:
      Identifier indicating whether the bucket exists
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Identifier indicating whether the bucket exists
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • listVersions

      ListVersionsResult listVersions(ListVersionsRequest request) throws ObsException
      List versioning objects in a bucket.
      参数:
      request - Request parameters for listing versioning objects in the bucket
      返回:
      Response to the request for listing versioning objects in the bucket
      抛出:
      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.
      参数:
      bucketName - Bucket name
      返回:
      Response to the request for listing versioning objects in the bucket
      抛出:
      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.
      参数:
      bucketName - Bucket name
      maxKeys - Maximum number of versioning objects to be listed
      返回:
      Response to the request for listing versioning objects in the bucket
      抛出:
      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.
      参数:
      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
      返回:
      Response to the request for listing versioning objects in the bucket
      抛出:
      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.
      参数:
      request - Request parameters for obtaining bucket metadata
      返回:
      Response to the request for obtaining bucket metadata
      抛出:
      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.
      参数:
      bucketName - Bucket name
      返回:
      Bucket ACL
      抛出:
      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.
      参数:
      request - Request parameters for obtaining the bucket ACL
      返回:
      Response to a request for obtaining the bucket ACL
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • setBucketAcl

      HeaderResponse setBucketAcl(String bucketName, AccessControlList acl) throws ObsException
      Set a bucket ACL.
      参数:
      bucketName - Bucket name
      acl - ACL
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters for setting a bucket ACL
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getBucketLocation

      String getBucketLocation(String bucketName) throws ObsException
      Obtain the bucket location.
      参数:
      bucketName - Bucket name
      返回:
      Bucket location
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Response to the request for obtaining the bucket location
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getBucketLocationV2

      BucketLocationResponse getBucketLocationV2(String bucketName) throws ObsException
      Obtain the bucket location.
      参数:
      bucketName - Bucket name
      返回:
      Response to the request for obtaining the bucket location
      抛出:
      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.
      参数:
      bucketName - Bucket name
      返回:
      Bcket storage information
      抛出:
      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.
      参数:
      request - Bucket name
      返回:
      Bucket storage information
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getBucketQuota

      BucketQuota getBucketQuota(String bucketName) throws ObsException
      Obtain the bucket quota.
      参数:
      bucketName - Bucket name
      返回:
      Bucket quota
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Bucket quota
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • setBucketQuota

      HeaderResponse setBucketQuota(String bucketName, BucketQuota bucketQuota) throws ObsException
      Set the bucket quota.
      参数:
      bucketName - Bucket name
      bucketQuota - Bucket quota
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getBucketStoragePolicy

      BucketStoragePolicyConfiguration getBucketStoragePolicy(String bucketName) throws ObsException
      Obtain the bucket storage class.
      参数:
      bucketName - Bucket name
      返回:
      Bucket storage policy
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Bucket storage policy
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • setBucketStoragePolicy

      HeaderResponse setBucketStoragePolicy(String bucketName, BucketStoragePolicyConfiguration bucketStorage) throws ObsException
      Set the bucket storage class.
      参数:
      bucketName - Bucket name
      bucketStorage - Bucket storage policy
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • setBucketCors

      HeaderResponse setBucketCors(String bucketName, BucketCors bucketCors) throws ObsException
      Configure the bucket CORS.
      参数:
      bucketName - Bucket name
      bucketCors - CORS rules
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getBucketCors

      BucketCors getBucketCors(String bucketName) throws ObsException
      Obtain the bucket CORS rules.
      参数:
      bucketName - Bucket name
      返回:
      Bucket CORS rules
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Bucket CORS configuration
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • deleteBucketCors

      HeaderResponse deleteBucketCors(String bucketName) throws ObsException
      Delete the bucket CORS rules.
      参数:
      bucketName - Bucket name
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getBucketLogging

      BucketLoggingConfiguration getBucketLogging(String bucketName) throws ObsException
      Obtain the logging settings of a bucket.
      参数:
      bucketName - Bucket name
      返回:
      Logging settings of the bucket
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Logging settings of the bucket
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • setBucketLoggingConfiguration

      HeaderResponse setBucketLoggingConfiguration(String bucketName, BucketLoggingConfiguration loggingConfiguration, boolean updateTargetACLifRequired) throws ObsException
      抛出:
      ObsException

    • setBucketLogging

      HeaderResponse setBucketLogging(String bucketName, BucketLoggingConfiguration loggingConfiguration) throws ObsException
      Configure logging for a bucket.
      参数:
      bucketName - Bucket name
      loggingConfiguration - Logging settings
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • setBucketVersioning

      HeaderResponse setBucketVersioning(String bucketName, BucketVersioningConfiguration versioningConfiguration) throws ObsException
      Set the versioning status for a bucket.
      参数:
      bucketName - Bucket name
      versioningConfiguration - Versioning status of the bucket
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getBucketVersioning

      BucketVersioningConfiguration getBucketVersioning(String bucketName) throws ObsException
      Obtain the versioning status for a bucket.
      参数:
      bucketName - Bucket name
      返回:
      Versioning status of the bucket
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Versioning status of the bucket
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • setBucketRequestPayment

      HeaderResponse setBucketRequestPayment(String bucketName, RequestPaymentEnum payer) throws ObsException
      Configure the requester-pays function for a bucket.
      参数:
      bucketName - Bucket name
      payer - The status of the requester-pays function
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Configuration of the requester-pays function of a bucket
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getBucketRequestPayment

      RequestPaymentConfiguration getBucketRequestPayment(String bucketName) throws ObsException
      Obtain the status of the requester-pays function of a bucket.
      参数:
      bucketName - Bucket name
      返回:
      Configuration of the requester-pays function of the bucket
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getBucketRequestPayment

      RequestPaymentConfiguration getBucketRequestPayment(BaseBucketRequest request) throws ObsException
      Obtain the requester-pays status of a bucket.
      参数:
      request - Basic bucket information
      返回:
      Configuration of the requester-pays function of the bucket
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getBucketLifecycle

      LifecycleConfiguration getBucketLifecycle(String bucketName) throws ObsException
      Obtain the bucket lifecycle rules.
      参数:
      bucketName - Bucket name
      返回:
      Bucket lifecycle rules
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Bucket lifecycle rules
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getBucketLifecycle

      LifecycleConfiguration getBucketLifecycle(GetBucketLifecycleRequest request) throws ObsException
      Obtain the bucket lifecycle rules.
      参数:
      request - Request parameters
      返回:
      Bucket lifecycle rules
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.25.10

    • setBucketLifecycle

      HeaderResponse setBucketLifecycle(String bucketName, LifecycleConfiguration lifecycleConfig) throws ObsException
      Set the bucket lifecycle rules.
      参数:
      bucketName - Bucket name
      lifecycleConfig - Bucket lifecycle rules
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • deleteBucketLifecycle

      HeaderResponse deleteBucketLifecycle(String bucketName) throws ObsException
      Delete the bucket lifecycle rules from a bucket.
      参数:
      bucketName - Bucket name
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • deleteBucketLifecycle

      HeaderResponse deleteBucketLifecycle(DeleteBucketLifecycleRequest request) throws ObsException
      Delete the bucket lifecycle rules from a bucket.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.25.10

    • getBucketPolicy

      String getBucketPolicy(String bucketName) throws ObsException
      Obtain bucket policies.
      参数:
      bucketName - Bucket name
      返回:
      Bucket policy, in the JSON format
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Bucket policy, in the JSON format
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getBucketPolicyV2

      BucketPolicyResponse getBucketPolicyV2(String bucketName) throws ObsException
      Obtain bucket policies.
      参数:
      bucketName - Bucket name
      返回:
      Response to a request for obtaining bucket policies
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Response to a request for obtaining bucket policies
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • setBucketPolicy

      HeaderResponse setBucketPolicy(String bucketName, String policy) throws ObsException
      Set bucket policies.
      参数:
      bucketName - Bucket name
      policy - Bucket policy, in the JSON format
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • deleteBucketPolicy

      HeaderResponse deleteBucketPolicy(String bucketName) throws ObsException
      Delete bucket policies.
      参数:
      bucketName - Bucket name
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getBucketWebsite

      WebsiteConfiguration getBucketWebsite(String bucketName) throws ObsException
      Obtain the website hosting configuration of a Bucket
      参数:
      bucketName - Bucket name
      返回:
      Website hosting configuration of a bucket
      抛出:
      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
      参数:
      request - Request parameters
      返回:
      Website hosting configuration of a bucket
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • setBucketWebsite

      HeaderResponse setBucketWebsite(String bucketName, WebsiteConfiguration websiteConfig) throws ObsException
      Configure website hosting for a bucket.
      参数:
      bucketName - Bucket name
      websiteConfig - Website hosting configuration of a bucket
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • deleteBucketWebsite

      HeaderResponse deleteBucketWebsite(String bucketName) throws ObsException
      Delete the website hosting configuration of a bucket.
      参数:
      bucketName - Bucket name
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getBucketTagging

      BucketTagInfo getBucketTagging(String bucketName) throws ObsException
      Obtain bucket tags.
      参数:
      bucketName - Bucket name
      返回:
      Bucket tag
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Bucket tag
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • setBucketTagging

      HeaderResponse setBucketTagging(String bucketName, BucketTagInfo bucketTagInfo) throws ObsException
      Set bucket tags.
      参数:
      bucketName - Bucket name
      bucketTagInfo - Bucket tags
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • deleteBucketTagging

      HeaderResponse deleteBucketTagging(String bucketName) throws ObsException
      Delete bucket tags.
      参数:
      bucketName - Bucket name
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getObjectTagging

      ObjectTagResult getObjectTagging(ObjectTaggingRequest request) throws ObsException
      Obtain object tags.
      参数:
      request - Request parameters
      返回:
      Object tag
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • setObjectTagging

      HeaderResponse setObjectTagging(ObjectTaggingRequest request) throws ObsException
      Set object tags.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • deleteObjectTagging

      HeaderResponse deleteObjectTagging(ObjectTaggingRequest request) throws ObsException
      Delete object tags.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getBucketEncryption

      BucketEncryption getBucketEncryption(String bucketName) throws ObsException
      Obtain bucket encryption configuration.
      参数:
      bucketName - Bucket name
      返回:
      Bucket encryption configuration
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Bucket encryption configuration
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • setBucketEncryption

      HeaderResponse setBucketEncryption(String bucketName, BucketEncryption bucketEncryption) throws ObsException
      Set bucket encryption.
      参数:
      bucketName - Bucket name
      bucketEncryption - Bucket encryption configuration
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • deleteBucketEncryption

      HeaderResponse deleteBucketEncryption(String bucketName) throws ObsException
      Delete bucket encryption configuration.
      参数:
      bucketName - Bucket name
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • setBucketReplication

      HeaderResponse setBucketReplication(String bucketName, ReplicationConfiguration replicationConfiguration) throws ObsException
      Configure cross-region replication for a bucket.
      参数:
      bucketName - Bucket name
      replicationConfiguration - Cross-region replication configuration
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getBucketReplication

      ReplicationConfiguration getBucketReplication(String bucketName) throws ObsException
      Obtain the cross-region replication configuration of a bucket.
      参数:
      bucketName - Bucket name
      返回:
      Cross-region replication configuration
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Cross-region replication configuration
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getCrrProgress

      GetCrrProgressResult getCrrProgress(GetCrrProgressRequest request) throws ObsException
      抛出:
      ObsException

    • deleteBucketReplication

      HeaderResponse deleteBucketReplication(String bucketName) throws ObsException
      Delete the bucket cross-region replication configuration.
      参数:
      bucketName - Bucket name
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getBucketNotification

      BucketNotificationConfiguration getBucketNotification(String bucketName) throws ObsException
      Obtain the notification configuration of a bucket.
      参数:
      bucketName - Bucket name
      返回:
      Bucket notification configuration
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Bucket notification configuration
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • setBucketNotification

      HeaderResponse setBucketNotification(String bucketName, BucketNotificationConfiguration bucketNotificationConfiguration) throws ObsException
      Configure bucket notification.
      参数:
      bucketName - Bucket name
      bucketNotificationConfiguration - Bucket notification configuration
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • putObject

      PutObjectResult putObject(String bucketName, String objectKey, InputStream input, ObjectMetadata metadata) throws ObsException
      Upload an object.
      参数:
      bucketName - Bucket name
      objectKey - Object name
      input - Data stream to be uploaded
      metadata - Object properties
      返回:
      Response to an object upload request
      抛出:
      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.
      参数:
      bucketName - Bucket name
      objectKey - Object name
      input - Data stream to be uploaded
      返回:
      Response to an object upload request
      抛出:
      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.
      参数:
      request - Parameters in an object upload request
      返回:
      Response to an object upload request
      抛出:
      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.
      参数:
      bucketName - Bucket name
      objectKey - Object name
      file - File to be uploaded
      返回:
      Response to an object upload request
      抛出:
      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.
      参数:
      bucketName - Bucket name
      objectKey - Object name
      file - File to be uploaded
      metadata - Object properties
      返回:
      Response to an object upload request
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

    • putObjectInTwoBucket

      PutObjectInTwoBucketResult putObjectInTwoBucket(PutObjectInTwoBucketRequest request) throws ObsException
      抛出:
      ObsException

    • appendObject

      AppendObjectResult appendObject(AppendObjectRequest request) throws ObsException
      Perform an appendable upload.
      参数:
      request - Parameters in an appendable upload request
      返回:
      Response to the appendable upload request
      抛出:
      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.
      参数:
      uploadFileRequest - Parameters in a file upload request
      返回:
      Result of part combination
      抛出:
      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.
      参数:
      request - Request parameters for uploading files in a batch
      返回:
      Batch task execution status
      抛出:
      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.
      参数:
      buckeName - Bucket name
      objectKey - Object name
      返回:
      Whether an object exists
      抛出:
      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.
      参数:
      request - Request parameters for obtaining the properties of an object
      返回:
      Whether an object exists
      抛出:
      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.
      参数:
      downloadFileRequest - Parameters in a request for downloading a file
      返回:
      File download result
      抛出:
      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.
      参数:
      request - Parameters in an object download request
      返回:
      Object information, including the object data stream
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails

    • selectObjectContent

      SelectObjectResult selectObjectContent(SelectObjectRequest selectRequest) throws ObsException
      Selects rows from an object using a SQL statement.
      参数:
      selectRequest - Parameters in an object select request
      返回:
      Select result container
      抛出:
      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.
      参数:
      bucketName - Bucket name
      objectKey - Object name
      versionId - Object version ID
      返回:
      Object information, including the object data stream
      抛出:
      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.
      参数:
      bucketName - Bucket name
      objectKey - Object name
      返回:
      Object information, including the object data stream
      抛出:
      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.
      参数:
      request - Parameters in a request for obtaining the properties of an object
      返回:
      Object properties
      抛出:
      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.
      参数:
      bucketName - Bucket name
      objectKey - Object name
      versionId - Object version ID
      返回:
      Object properties
      抛出:
      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.
      参数:
      bucketName - Bucket name
      objectKey - Object name
      返回:
      Object properties
      抛出:
      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.
      参数:
      request - Parameters in the request for obtaining object properties
      返回:
      Object properties
      抛出:
      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.
      参数:
      request - Parameters in a request for restoring an Archive object
      返回:
      Status of the to-be-restored Archive object
      抛出:
      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.
      参数:
      request - Request parameters for restoring an Archive object
      返回:
      Result of restoring the Archive object
      抛出:
      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.
      参数:
      request - Request parameters for restoring Archive objects in a batch
      返回:
      Batch task execution status
      抛出:
      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.
      参数:
      bucketName - Bucket name
      objectKey - Object name
      versionId - Object version ID
      返回:
      Common response headers
      抛出:
      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.
      参数:
      bucketName - Bucket name
      objectKey - Object name
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters for deleting an object
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • deleteObjects

      DeleteObjectsResult deleteObjects(DeleteObjectsRequest deleteObjectsRequest) throws ObsException
      Delete objects in a batch.
      参数:
      deleteObjectsRequest - Parameters in an object batch deletion request
      返回:
      Result of the object batch deletion request
      抛出:
      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.
      参数:
      bucketName - Bucket name
      objectKey - Object name
      versionId - Object version ID
      返回:
      Object ACL
      抛出:
      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.
      参数:
      bucketName - Bucket name
      objectKey - Object name
      返回:
      Object ACL
      抛出:
      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.
      参数:
      request - Request parameters for obtaining an object ACL
      返回:
      Object ACL
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • setObjectAcl

      HeaderResponse setObjectAcl(String bucketName, String objectKey, AccessControlList acl, String versionId) throws ObsException
      Set an object ACL.
      参数:
      bucketName - Bucket name
      objectKey - Object name
      acl - ACL
      versionId - Object version ID
      返回:
      Common response headers
      抛出:
      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.
      参数:
      bucketName - Bucket name
      objectKey - Object name
      acl - ACL
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • copyObject

      CopyObjectResult copyObject(CopyObjectRequest request) throws ObsException
      Copy an object.
      参数:
      request - Parameters in a request for copying an object
      返回:
      Result of the object copy
      抛出:
      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.
      参数:
      sourceBucketName - Source bucket name
      sourceObjectKey - Source object name
      destBucketName - Destination bucket name
      destObjectKey - Destination object name
      返回:
      Result of the object copy
      抛出:
      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.
      参数:
      request - Parameters in a request for initializing a multipart upload
      返回:
      Result of the multipart upload
      抛出:
      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.
      参数:
      request - Parameters in a request for aborting a multipart upload
      返回:
      Common response headers
      抛出:
      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.
      参数:
      bucketName - Bucket name
      objectKey - Object name
      uploadId - Multipart upload ID
      partNumber - Part number
      input - Data stream to be uploaded
      返回:
      Response to a part upload request
      抛出:
      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.
      参数:
      bucketName - Bucket name
      objectKey - Object name
      uploadId - Multipart upload ID
      partNumber - Part number
      file - File to be uploaded
      返回:
      Response to a part upload request
      抛出:
      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.
      参数:
      request - Parameters in a part upload request
      返回:
      Response to a part upload request
      抛出:
      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.
      参数:
      request - Parameters in the request for copying a part
      返回:
      Response to a part copy request
      抛出:
      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.
      参数:
      request - Parameters in a request for combining parts
      返回:
      Result of part combination
      抛出:
      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.
      参数:
      request - Parameters in a request for listing uploaded parts
      返回:
      Response to a request for listing uploaded parts
      抛出:
      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.
      参数:
      request - Parameters in a request for listing multipart uploads
      返回:
      List of multipart uploads
      抛出:
      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.
      参数:
      request - Request parameters for reading ahead objects
      返回:
      Response to the request for reading ahead objects
      抛出:
      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.
      参数:
      bucketName - Bucket name
      prefix - Name prefix of objects to be read ahead
      返回:
      Response to the request for reading ahead objects
      抛出:
      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.
      参数:
      bucketName - Bucket name
      taskId - ID of the read-ahead task
      返回:
      Response to the request for querying the progress of the read-ahead task
      抛出:
      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.
      参数:
      bucketName - Bucket name
      access - Direct reading policy
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • getBucketDirectColdAccess

      BucketDirectColdAccess getBucketDirectColdAccess(String bucketName) throws ObsException
      Obtain the direct reading policy for Archive objects in a bucket.
      参数:
      bucketName - Bucket name
      返回:
      Direct reading policy for Archive objects of a bucket
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Direct reading policy for Archive objects in a bucket
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • deleteBucketDirectColdAccess

      HeaderResponse deleteBucketDirectColdAccess(String bucketName) throws ObsException
      Delete the direct reading policy for Archive objects in a bucket.
      参数:
      bucketName - Bucket name
      返回:
      Common response headers
      抛出:
      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.
      参数:
      request - Request parameters
      返回:
      Common response headers
      抛出:
      ObsException - OBS SDK self-defined exception, thrown when the interface fails to be called or access to OBS fails
      从以下版本开始:
      3.20.3

    • setBucketTrash

      HeaderResponse setBucketTrash(SetBucketTrashRequest setBucketTrashRequest) throws ObsException
      抛出:
      ObsException

    • getBucketTrash

      GetBucketTrashResult getBucketTrash(GetBucketTrashRequest getBucketTrashRequest) throws ObsException
      抛出:
      ObsException

    • deleteBucketTrash

      HeaderResponse deleteBucketTrash(DeleteBucketTrashRequest deleteBucketTrashRequest) throws ObsException
      抛出:
      ObsException

    • setInventoryConfiguration

      HeaderResponse setInventoryConfiguration(SetInventoryConfigurationRequest request) throws ObsException
      抛出:
      ObsException

    • getInventoryConfiguration

      GetInventoryConfigurationResult getInventoryConfiguration(GetInventoryConfigurationRequest request) throws ObsException
      抛出:
      ObsException

    • listInventoryConfiguration

      ListInventoryConfigurationResult listInventoryConfiguration(ListInventoryConfigurationRequest request) throws ObsException
      抛出:
      ObsException

    • deleteInventoryConfiguration

      HeaderResponse deleteInventoryConfiguration(DeleteInventoryConfigurationRequest request) throws ObsException
      抛出:
      ObsException

    • putBucketPublicAccessBlock

      HeaderResponse putBucketPublicAccessBlock(PutBucketPublicAccessBlockRequest request) throws ObsException
      抛出:
      ObsException

    • getBucketPublicAccessBlock

      GetBucketPublicAccessBlockResult getBucketPublicAccessBlock(GetBucketPublicAccessBlockRequest request) throws ObsException
      抛出:
      ObsException

    • deleteBucketPublicAccessBlock

      HeaderResponse deleteBucketPublicAccessBlock(DeleteBucketPublicAccessBlockRequest request) throws ObsException
      抛出:
      ObsException

    • getBucketPolicyPublicStatus

      GetBucketPolicyPublicStatusResult getBucketPolicyPublicStatus(GetBucketPolicyPublicStatusRequest request) throws ObsException
      抛出:
      ObsException

    • getBucketPublicStatus

      GetBucketPublicStatusResult getBucketPublicStatus(GetBucketPublicStatusRequest request) throws ObsException
      抛出:
      ObsException

    • putSymlink

      HeaderResponse putSymlink(PutSymlinkRequest request) throws ObsException
      抛出:
      ObsException

    • getSymlink

      GetSymlinkResult getSymlink(GetSymlinkRequest request) throws ObsException
      抛出:
      ObsException

    • setBucketQos

      HeaderResponse setBucketQos(SetBucketQosRequest request) throws ObsException
      抛出:
      ObsException

    • getBucketQoS

      GetBucketQoSResult getBucketQoS(GetBucketQoSRequest request)

    • deleteBucketQoS

      HeaderResponse deleteBucketQoS(DeleteBucketQosRequest request) throws ObsException
      抛出:
      ObsException

    • deleteSnapshot

      HeaderResponse deleteSnapshot(DeleteSnapshotRequest request) throws ObsException
      抛出:
      ObsException

    • setSnapshotAllow

      HeaderResponse setSnapshotAllow(SetSnapshotAllowRequest request) throws ObsException
      抛出:
      ObsException

    • setDisallowSnapshot

      HeaderResponse setDisallowSnapshot(SetDisallowSnapshotRequest request) throws ObsException
      抛出:
      ObsException

    • getSnapshotList

      HeaderResponse getSnapshotList(GetSnapshotListRequest request) throws ObsException
      Get snapshot list for a bucket or object
      抛出:
      ObsException

    • getSnapshottableDirList

      GetSnapshottableDirListResult getSnapshottableDirList(GetSnapshottableDirListRequest request) throws ObsException
      抛出:
      ObsException

    • createSnapshot

      CreateSnapshotResponse createSnapshot(CreateSnapshotRequest request) throws ObsException
      抛出:
      ObsException

    • renameSnapshot

      RenameSnapshotResponse renameSnapshot(RenameSnapshotRequest request) throws ObsException
      Rename snapshot for an object
      抛出:
      ObsException

    • close

      void close() throws IOException
      抛出:
      IOException