Click or drag to resize

ObsClient Methods

The ObsClient type exposes the following members.

Methods
  NameDescription
Public methodAbortMultipartUpload
Abort a multipart upload.
Public methodAppendObject
Perform an appendable upload.
Public methodBeginAbortMultipartUpload
Start the asynchronous request for aborting a multipart upload.
Public methodBeginAppendObject
Start the asynchronous request for an appendable upload.
Public methodBeginCompleteMultipartUpload
Start the asynchronous request for combining parts.
Public methodBeginCopyObject
Start the asynchronous request for copying an object.
Public methodBeginCopyPart
Start the asynchronous request for copying a part.
Public methodBeginCreateBucket
Start the asynchronous request for creating a bucket.
Public methodBeginDeleteBucket
Start the asynchronous request for deleting a bucket.
Public methodBeginDeleteBucketCors
Start the asynchronous request for deleting the CORS configuration from a specified bucket.
Public methodBeginDeleteBucketLifecycle
Start the asynchronous request for deleting the bucket lifecycle rules.
Public methodBeginDeleteBucketPolicy
Start the asynchronous request for deleting bucket policies.
Public methodBeginDeleteBucketReplication
Start the asynchronous request for deleting the cross-region replication configuration from a bucket.
Public methodBeginDeleteBucketTagging
Start the asynchronous request for deleting bucket tags.
Public methodBeginDeleteBucketWebsite
Start the asynchronous request for deleting the website hosting configuration.
Public methodBeginDeleteObject
Start the asynchronous request for deleting an object.
Public methodBeginDeleteObjects
Start the asynchronous request for deleting objects in a batch.
Public methodBeginGetBucketAcl
Start the asynchronous request for obtaining a bucket ACL.
Public methodBeginGetBucketCors
Start the asynchronous request for obtaining the bucket CORS configuration.
Public methodBeginGetBucketLifecycle
Start the asynchronous request for obtaining the bucket lifecycle rules.
Public methodBeginGetBucketLocation
Start the asynchronous request for obtaining the bucket location.
Public methodBeginGetBucketLogging
Start the asynchronous request for obtaining the bucket logging configuration.
Public methodBeginGetBucketMetadata
Start the asynchronous request for obtaining bucket metadata.
Public methodBeginGetBucketNotification
Start the asynchronous request for obtaining the bucket notification configuration.
Public methodBeginGetBucketPolicy
Start the asynchronous request for obtaining bucket policies.
Public methodBeginGetBucketQuota
Start the asynchronous request for obtaining a bucket quota.
Public methodBeginGetBucketReplication
Start the asynchronous request for obtaining the cross-region replication configuration of a bucket.
Public methodBeginGetBucketStorageInfo
Start the asynchronous request for obtaining the bucket storage information.
Public methodBeginGetBucketStoragePolicy
Start the asynchronous request for obtaining bucket storage policies.
Public methodBeginGetBucketTagging
Start the asynchronous request for obtaining bucket tags.
Public methodBeginGetBucketVersioning
Start the asynchronous request for obtaining the bucket versioning configuration.
Public methodBeginGetBucketWebsite
Start the asynchronous request for obtaining the website hosting configuration.
Public methodBeginGetObject
End the asynchronous request for downloading an object.
Public methodBeginGetObjectAcl
Start the asynchronous request for obtaining an object ACL.
Public methodBeginGetObjectMetadata
Start the asynchronous request for obtaining object properties.
Public methodBeginHeadBucket
Start the asynchronous request for checking whether a bucket exists.
Public methodBeginInitiateMultipartUpload
Start the asynchronous request for initializing a multipart upload.
Public methodBeginListBuckets
Start the asynchronous request for obtaining the bucket list.
Public methodBeginListMultipartUploads
Start the asynchronous request for listing multipart uploads.
Public methodBeginListObjects
Start the asynchronous request for listing objects in a bucket.
Public methodBeginListParts
Start the asynchronous request for listing uploaded parts.
Public methodBeginListVersions
Start the asynchronous request for listing versioning objects in a bucket.
Public methodBeginPutObject
Start the asynchronous request for uploading an object.
Public methodBeginRestoreObject
Start the asynchronous request for restoring an Archive object.
Public methodBeginSetBucketAcl
Start the asynchronous request for configuring a bucket ACL.
Public methodBeginSetBucketCors
Start the asynchronous request for configuring bucket CORS.
Public methodBeginSetBucketLifecycle
Start the asynchronous request for setting the bucket lifecycle rules.
Public methodBeginSetBucketLogging
Start the asynchronous request for configuring bucket logging
Public methodBeginSetBucketNotification
Start the asynchronous request for configuring bucket notification.
Public methodBeginSetBucketPolicy
Start the asynchronous request for setting bucket policies.
Public methodBeginSetBucketQuota
Start the asynchronous request for configuring a bucket quota.
Public methodBeginSetBucketReplication
Start the asynchronous request for configuring cross-region replication for a bucket.
Public methodBeginSetBucketStoragePolicy
Start the asynchronous request for setting a bucket storage class.
Public methodBeginSetBucketTagging
Start the asynchronous request for setting bucket tags.
Public methodBeginSetBucketVersioning
Start the asynchronous request for configuring bucket versioning.
Public methodBeginSetBucketWebsiteConfiguration
Start the asynchronous request for configuring bucket website hosting.
Public methodBeginSetObjectAcl
Start the asynchronous request for configuring an object ACL.
Public methodBeginUploadPart
Start the asynchronous request for uploading a part.
Public methodCompleteMultipartUpload
Combine parts.
Public methodCopyObject
Copy an object.
Public methodCopyPart
Copy a part.
Public methodCreateBucket
Create a bucket. A bucket name must be unique in OBS. If a user repeatedly creates buckets with the same name in one region, status code "200" is returned. In other cases, status code "409" is returned. Each user can create a maximum of 100 buckets.
Public methodCreatePostSignature
Generate browser-based authentication parameters. Currently, this function is not supported.
Public methodCreateTemporarySignature
Generate parameters for a temporary authentication request.
Public methodDeleteBucket
Delete a bucket. The bucket to be deleted must be empty (containing no objects, noncurrent object versions, or part fragments).
Public methodDeleteBucketCors
Delete the CORS rules from a bucket.
Public methodDeleteBucketLifecycle
Delete the bucket lifecycle rules from a bucket.
Public methodDeleteBucketPolicy
Delete bucket policies.
Public methodDeleteBucketReplication
Delete the cross-region replication configuration from a bucket.
Public methodDeleteBucketTagging
Delete bucket tags.
Public methodDeleteBucketWebsite
Delete the website hosting configuration from a bucket.
Public methodDeleteObject
Delete an object.
Public methodDeleteObjects
Delete objects in a batch.
Public methodDownloadFile
Download a file in resumable mode.
Public methodEndAbortMultipartUpload
End the asynchronous request for aborting a multipart upload.
Public methodEndAppendObject
End the asynchronous appendable upload request.
Public methodEndCompleteMultipartUpload
End the asynchronous request for combining parts.
Public methodEndCopyObject
End the asynchronous request for copying an object.
Public methodEndCopyPart
End the asynchronous request for copying a part.
Public methodEndCreateBucket
End the asynchronous request for creating a bucket.
Public methodEndDeleteBucket
End the asynchronous request for deleting a bucket.
Public methodEndDeleteBucketCors
End the asynchronous request for deleting the CORS configuration from a specified bucket.
Public methodEndDeleteBucketLifecycle
End the asynchronous request for deleting the bucket lifecycle rules.
Public methodEndDeleteBucketPolicy
End the asynchronous request for deleting bucket policies.
Public methodEndDeleteBucketReplication
End the asynchronous request for deleting the cross-region replication configuration from a bucket.
Public methodEndDeleteBucketTagging
End the asynchronous request for deleting bucket tags.
Public methodEndDeleteBucketWebsite
End the asynchronous request for deleting the website hosting configuration.
Public methodEndDeleteObject
End the asynchronous object deletion request.
Public methodEndDeleteObjects
End the asynchronous request for deleting objects in a batch.
Public methodEndGetBucketAcl
End the asynchronous request for obtaining a bucket ACL.
Public methodEndGetBucketCors
End the asynchronous request for obtaining the bucket CORS configuration.
Public methodEndGetBucketLifecycle
Public methodEndGetBucketLocation
End the asynchronous request for obtaining the bucket location.
Public methodEndGetBucketLogging
End the asynchronous request for obtaining the bucket logging configuration.
Public methodEndGetBucketMetadata
End the asynchronous request for obtaining bucket metadata.
Public methodEndGetBucketNotification
End the asynchronous request for obtaining the bucket notification configuration.
Public methodEndGetBucketPolicy
End the asynchronous request for obtaining bucket policies.
Public methodEndGetBucketQuota
End the asynchronous request for obtaining a bucket quota.
Public methodEndGetBucketReplication
End the asynchronous request for obtaining the cross-region replication configuration of a bucket.
Public methodEndGetBucketStorageInfo
End the asynchronous request for obtaining the bucket storage information.
Public methodEndGetBucketStoragePolicy
End the asynchronous request for obtaining bucket storage policies.
Public methodEndGetBucketTagging
End the asynchronous request for obtaining bucket tags.
Public methodEndGetBucketVersioning
End the asynchronous request for obtaining the bucket versioning configuration.
Public methodEndGetBucketWebsite
End the asynchronous request for obtaining the website hosting configuration.
Public methodEndGetObject
End the asynchronous request for downloading an object.
Public methodEndGetObjectAcl
End the asynchronous request for obtaining an object ACL.
Public methodEndGetObjectMetadata
End the asynchronous request for obtaining object properties.
Public methodEndHeadBucket
End the asynchronous request for checking whether a bucket exists.
Public methodEndInitiateMultipartUpload
End the asynchronous request for initializing a multipart upload.
Public methodEndListBuckets
End the asynchronous request for obtaining the bucket list.
Public methodEndListMultipartUploads
End the asynchronous request for listing multipart uploads.
Public methodEndListObjects
End the asynchronous request for listing objects in a bucket.
Public methodEndListParts
End the asynchronous request for listing uploaded parts.
Public methodEndListVersions
End the asynchronous request for listing versioning objects in a bucket.
Public methodEndPutObject
End the asynchronous request for uploading an object.
Public methodEndRestoreObject
End the asynchronous request for restoring an Archive object.
Public methodEndSetBucketAcl
End the asynchronous request for configuring a bucket ACL.
Public methodEndSetBucketCors
End the asynchronous request for configuring bucket CORS.
Public methodEndSetBucketLifecycle
End the asynchronous request for setting the bucket lifecycle rules.
Public methodEndSetBucketLogging
End the asynchronous request for configuring bucket logging
Public methodEndSetBucketNotification
End the asynchronous request for configuring bucket notification.
Public methodEndSetBucketPolicy
End the asynchronous request for setting bucket policies.
Public methodEndSetBucketQuota
End the asynchronous request for configuring a bucket quota.
Public methodEndSetBucketReplication
End the asynchronous request for configuring cross-region replication for a bucket.
Public methodEndSetBucketStoragePolicy
End the asynchronous request for setting a bucket storage class.
Public methodEndSetBucketTagging
End the asynchronous request for setting bucket tags.
Public methodEndSetBucketVersioning
End the asynchronous request for configuring bucket versioning.
Public methodEndSetBucketWebsiteConfiguration
End the asynchronous request for configuring bucket website hosting.
Public methodEndSetObjectAcl
End the asynchronous request for configuring an object ACL.
Public methodEndUploadPart
End the asynchronous request for uploading a part.
Public methodGetBucketAcl
Obtain a bucket ACL.
Public methodGetBucketCors
Obtain the CORS rules of a bucket.
Public methodGetBucketLifecycle
Obtain the lifecycle rules of a bucket.
Public methodGetBucketLocation
Obtain the bucket location.
Public methodGetBucketLogging
Obtain bucket logging configuration.
Public methodGetBucketMetadata
Obtain bucket metadata.
Public methodGetBucketNotification
Obtain the notification configuration of a bucket.
Public methodGetBucketPolicy
Obtain bucket policies.
Public methodGetBucketQuota
Obtain the bucket quota. Value "0" indicates that no upper limit is set for the bucket quota.
Public methodGetBucketReplication
Obtain the cross-region replication configuration of a bucket.
Public methodGetBucketStorageInfo
Obtain storage information about a bucket, including the bucket size and number of objects in the bucket.
Public methodGetBucketStoragePolicy
Obtain bucket storage policies.
Public methodGetBucketTagging
Obtain bucket tags.
Public methodGetBucketVersioning
Obtain the versioning status of a bucket.
Public methodGetBucketWebsite
Obtain the website hosting configuration of a bucket.
Public methodGetObject
Download an object.
Public methodGetObjectAcl
Obtain an object ACL.
Public methodGetObjectMetadata(GetObjectMetadataRequest)
Obtain object properties.
Public methodGetObjectMetadata(String, String)
Obtain object properties.
Public methodGetObjectMetadata(String, String, String)
Obtain object properties.
Public methodHeadBucket
Check whether a bucket exists. If the returned HTTP status code is "200", the bucket exists. If the returned HTTP status code is "404", the bucket does not exist.
Public methodInitiateMultipartUpload
Initialize a multipart upload.
Public methodListBuckets
Obtain the bucket list. In the list, bucket names are displayed in lexicographical order.
Public methodListMultipartUploads
List multipart uploads.
Public methodListObjects
List objects in a bucket.
Public methodListParts
List uploaded parts.
Public methodListVersions
List versioning objects in a bucket.
Public methodPutObject
Upload an object.
Public methodRefresh
Refresh the temporary access key.
Public methodRestoreObject
Restore an Archive object.
Public methodSetBucketAcl
Set the bucket ACL.
Public methodSetBucketCors
Set CORS rules for a bucket to allow client browsers to send cross-domain requests.
Public methodSetBucketLifecycle
Set lifecycle rules for a bucket.
Public methodSetBucketLogging
Configure bucket logging.
Public methodSetBucketNotification
Configure bucket notification.
Public methodSetBucketPolicy
Set a bucket policy. If the bucket already has a policy, the policy will be overwritten by the one specified in this request.
Public methodSetBucketQuota
Set the bucket quota.
Public methodSetBucketReplication
Configure cross-region replication for a bucket.
Public methodSetBucketStoragePolicy
Set storage class for a bucket.
Public methodSetBucketTagging
Set bucket tags.
Public methodSetBucketVersioning
Set bucket versioning.
Public methodSetBucketWebsiteConfiguration
Configure website hosting for a bucket.
Public methodSetObjectAcl
Set an object ACL.
Public methodUploadFile
Upload a file in resumable mode.
Public methodUploadPart
Upload a part.
Public methodUploadStream
Upload data streams in resumable mode.
Top
See Also