类 AbstractBucketClient

所有已实现的接口:
IFSClient, IObsBucketExtendClient, IObsClient, Closeable, AutoCloseable
直接已知子类:
AbstractBucketAdvanceClient

public abstract class AbstractBucketClient extends AbstractDeprecatedBucketClient
  • 构造器详细资料

    • AbstractBucketClient

      public AbstractBucketClient()
  • 方法详细资料

    • createBucket

      public ObsBucket createBucket(String bucketName) throws ObsException
      从接口复制的说明: IObsClient
      Create a bucket.

      Bucket naming rules:

      • Contain only lowercase letters, digits, hyphens (-), and periods (.).
      • Must start with a digit or a letter.
      • Contain 3 to 63 characters.
      • Cannot be an IP address.
      • Cannot end with a hyphen (-).
      • Cannot contain two consecutive periods (..).
      • Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, "my-.bucket" and "my.-bucket".
      参数:
      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

      public ObsBucket createBucket(String bucketName, String location) throws ObsException
      从接口复制的说明: IObsClient
      Create a bucket.
      Create a bucket of a specific name in the given region.

      Bucket naming rules:

      • Contain only lowercase letters, digits, hyphens (-), and periods (.).
      • Must start with a digit or a letter.
      • Contain 3 to 63 characters.
      • Cannot be an IP address.s
      • Cannot end with a hyphen (-).
      • Cannot contain two consecutive periods (..).
      • Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, "my-.bucket" and "my.-bucket".
      参数:
      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

      public ObsBucket createBucket(ObsBucket bucket) throws ObsException
      从接口复制的说明: IObsClient
      Create a bucket.
      Create a bucket of a specific name in the given region.

      Bucket naming rules:

      • Contain only lowercase letters, digits, hyphens (-), and periods (.).
      • Must start with a digit or a letter.
      • Contain 3 to 63 characters.
      • Cannot be an IP address.
      • Cannot end with a hyphen (-).
      • Cannot contain two consecutive periods (..).
      • Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, "my-.bucket" and "my.-bucket".
      参数:
      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

      public ObsBucket createBucket(CreateBucketRequest request) throws ObsException
      从接口复制的说明: IObsClient
      Create a bucket.

      Bucket naming rules:

      • Contain only lowercase letters, digits, hyphens (-), and periods (.).
      • Must start with a digit or a letter.
      • Contain 3 to 63 characters.
      • Cannot be an IP address.
      • Cannot end with a hyphen (-).
      • Cannot contain two consecutive periods (..).
      • Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, "my-.bucket" and "my.-bucket".
      参数:
      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

      public CreateVirtualBucketResult createVirtualBucket(CreateVirtualBucketRequest request) throws ObsException
      从接口复制的说明: IObsClient
      Create a virtual bucket.
      参数:
      request - Request parameters for creating a virtual bucket
      返回:
      Virtual bucket information
      抛出:
      ObsException
    • listBuckets

      public List<ObsBucket> listBuckets(ListBucketsRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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

      public ListBucketsResult listBucketsV2(ListBucketsRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • listAliasBuckets

      public ListBucketAliasResult listAliasBuckets() throws ObsException
      从接口复制的说明: IObsClient
      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
    • headBucket

      public boolean headBucket(String bucketName) throws ObsException
      从接口复制的说明: IObsClient
      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

      public boolean headBucket(BaseBucketRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • deleteBucket

      public HeaderResponse deleteBucket(String bucketName) throws ObsException
      从接口复制的说明: IObsClient
      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

      public HeaderResponse deleteBucket(BaseBucketRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • getBucketMetadata

      public BucketMetadataInfoResult getBucketMetadata(BucketMetadataInfoRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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

      public AccessControlList getBucketAcl(String bucketName) throws ObsException
      从接口复制的说明: IObsClient
      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

      public AccessControlList getBucketAcl(BaseBucketRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • setBucketAcl

      public HeaderResponse setBucketAcl(String bucketName, AccessControlList acl) throws ObsException
      从接口复制的说明: IObsClient
      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

      public HeaderResponse setBucketAcl(SetBucketAclRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • getBucketLocation

      public String getBucketLocation(String bucketName) throws ObsException
      从接口复制的说明: IObsClient
      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

      public BucketLocationResponse getBucketLocation(BaseBucketRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • getBucketLocationV2

      public BucketLocationResponse getBucketLocationV2(String bucketName) throws ObsException
      从接口复制的说明: IObsClient
      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

      public BucketStorageInfo getBucketStorageInfo(String bucketName) throws ObsException
      从接口复制的说明: IObsClient
      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

      public BucketStorageInfo getBucketStorageInfo(BaseBucketRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • getBucketQuota

      public BucketQuota getBucketQuota(String bucketName) throws ObsException
      从接口复制的说明: IObsClient
      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

      public BucketQuota getBucketQuota(BaseBucketRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • setBucketQuota

      public HeaderResponse setBucketQuota(String bucketName, BucketQuota bucketQuota) throws ObsException
      从接口复制的说明: IObsClient
      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

      public HeaderResponse setBucketQuota(SetBucketQuotaRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • getBucketStoragePolicy

      public BucketStoragePolicyConfiguration getBucketStoragePolicy(String bucketName) throws ObsException
      从接口复制的说明: IObsClient
      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

      public BucketStoragePolicyConfiguration getBucketStoragePolicy(BaseBucketRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • setBucketStoragePolicy

      public HeaderResponse setBucketStoragePolicy(String bucketName, BucketStoragePolicyConfiguration bucketStorage) throws ObsException
      从接口复制的说明: IObsClient
      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

      public HeaderResponse setBucketStoragePolicy(SetBucketStoragePolicyRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • setBucketCors

      public HeaderResponse setBucketCors(String bucketName, BucketCors bucketCors) throws ObsException
      从接口复制的说明: IObsClient
      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

      public HeaderResponse setBucketCors(SetBucketCorsRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • getBucketCors

      public BucketCors getBucketCors(String bucketName) throws ObsException
      从接口复制的说明: IObsClient
      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

      public BucketCors getBucketCors(BaseBucketRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • deleteBucketCors

      public HeaderResponse deleteBucketCors(String bucketName) throws ObsException
      从接口复制的说明: IObsClient
      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

      public HeaderResponse deleteBucketCors(BaseBucketRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • getBucketLogging

      public BucketLoggingConfiguration getBucketLogging(String bucketName) throws ObsException
      从接口复制的说明: IObsClient
      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

      public BucketLoggingConfiguration getBucketLogging(BaseBucketRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • setBucketLoggingConfiguration

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

      public HeaderResponse setBucketLogging(String bucketName, BucketLoggingConfiguration loggingConfiguration) throws ObsException
      从接口复制的说明: IObsClient
      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

      public HeaderResponse setBucketLogging(SetBucketLoggingRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • setBucketVersioning

      public HeaderResponse setBucketVersioning(String bucketName, BucketVersioningConfiguration versioningConfiguration) throws ObsException
      从接口复制的说明: IObsClient
      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

      public HeaderResponse setBucketVersioning(SetBucketVersioningRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • getBucketVersioning

      public BucketVersioningConfiguration getBucketVersioning(String bucketName) throws ObsException
      从接口复制的说明: IObsClient
      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

      public BucketVersioningConfiguration getBucketVersioning(BaseBucketRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • setBucketRequestPayment

      public HeaderResponse setBucketRequestPayment(String bucketName, RequestPaymentEnum payer) throws ObsException
      从接口复制的说明: IObsClient
      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

      public HeaderResponse setBucketRequestPayment(SetBucketRequestPaymentRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • getBucketRequestPayment

      public RequestPaymentConfiguration getBucketRequestPayment(String bucketName) throws ObsException
      从接口复制的说明: IObsClient
      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
    • getBucketRequestPayment

      public RequestPaymentConfiguration getBucketRequestPayment(BaseBucketRequest request) throws ObsException
      从接口复制的说明: IObsClient
      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
    • deleteBucketCustomDomain

      public HeaderResponse deleteBucketCustomDomain(String bucketName, String domainName) throws ObsException
      从接口复制的说明: IObsBucketExtendClient
      Deleting the Custom Domain Name of a Bucket
      参数:
      bucketName - Bucket name
      domainName - Custom Domain Name
      返回:
      抛出:
      ObsException
    • deleteBucketCustomDomain

      public HeaderResponse deleteBucketCustomDomain(DeleteBucketCustomDomainRequest request) throws ObsException
      从接口复制的说明: IObsBucketExtendClient
      Deleting the Custom Domain Name of a Bucket
      参数:
      request -
      返回:
      抛出:
      ObsException
    • getBucketCustomDomain

      public BucketCustomDomainInfo getBucketCustomDomain(String bucketName) throws ObsException
      从接口复制的说明: IObsBucketExtendClient
      Obtaining the Custom Domain Name of a Bucket
      参数:
      bucketName - Bucket name
      返回:
      抛出:
      ObsException
    • getBucketCustomDomain

      public BucketCustomDomainInfo getBucketCustomDomain(GetBucketCustomDomainRequest request) throws ObsException
      从接口复制的说明: IObsBucketExtendClient
      Obtaining the Custom Domain Name of a Bucket
      参数:
      request -
      返回:
      抛出:
      ObsException
    • setBucketCustomDomain

      public HeaderResponse setBucketCustomDomain(String bucketName, String domainName) throws ObsException
      从接口复制的说明: IObsBucketExtendClient
      Configuring a Custom Domain Name for a Bucket
      参数:
      bucketName - Bucket name
      domainName - Custom Domain Name
      返回:
      抛出:
      ObsException
    • setBucketCustomDomain

      public HeaderResponse setBucketCustomDomain(SetBucketCustomDomainRequest request) throws ObsException
      从接口复制的说明: IObsBucketExtendClient
      Configuring a Custom Domain Name for a Bucket
      参数:
      request -
      返回:
      抛出:
      ObsException
    • setInventoryConfiguration

      public HeaderResponse setInventoryConfiguration(SetInventoryConfigurationRequest request) throws ObsException
      抛出:
      ObsException
    • getInventoryConfiguration

      public GetInventoryConfigurationResult getInventoryConfiguration(GetInventoryConfigurationRequest request) throws ObsException
      抛出:
      ObsException
    • listInventoryConfiguration

      public ListInventoryConfigurationResult listInventoryConfiguration(ListInventoryConfigurationRequest request) throws ObsException
      抛出:
      ObsException
    • deleteInventoryConfiguration

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