| OssClient Class |
The OSS's access entry point interface's implementation.
Inheritance HierarchyNamespace: Aliyun.OSS
Assembly: Aliyun.OSS (in Aliyun.OSS.dll) Version: 2.8.0.0 (2.8.0)
SyntaxThe OssClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | OssClient(String, ICredentialsProvider) |
Creates an instance with specified credential information.
|
| OssClient(Uri, ICredentialsProvider) |
Creates an instance with specified endpoint and credential information.
|
| OssClient(String, ICredentialsProvider, ClientConfiguration) |
Creates an instance with specified credential information and client side configuration.
|
| OssClient(String, String, String) |
Creates an instance of OssClient with OSS endpoint, access key Id, access key secret (cound be found from web console).
|
| OssClient(Uri, ICredentialsProvider, ClientConfiguration) |
Creates an instance with specified endpoint, credential information and credential information.
|
| OssClient(Uri, String, String) |
Creates an instance with specified endpoint, access key Id and access key secret.
|
| OssClient(String, String, String, ClientConfiguration) |
Creates an instance of OssClient with OSS endpoint, access key Id, access key secret and client configuration.
|
| OssClient(String, String, String, String) |
Creates an instance of OssClient with OSS endpoint, access key Id, access key secret (cound be found from web console) and STS token.
|
| OssClient(Uri, String, String, ClientConfiguration) |
Creates an instance with specified endpoint, access key Id and access key secret and configuration.
|
| OssClient(Uri, String, String, String) |
Creates an instance with specified endpoint, access key Id and access key secret and STS token.
|
| OssClient(String, String, String, String, ClientConfiguration) |
Creates an instance of OssClient with OSS endpoint, access key Id, access key secret (cound be found from web console) and STS token.
|
| OssClient(Uri, String, String, String, ClientConfiguration) |
Creates an instance with specified endpoint, access key Id, access key secret, STS security token and configuration.
|
Methods| Name | Description | |
|---|---|---|
| AbortMultipartUpload |
Aborts a multipart upload
|
| AppendObject |
Appends object to OSS according to the AppendObjectRequest |
| BeginAppendObject |
Begins the async call to append object to OSS.
|
| BeginCopyObject |
Begins the async call to copy an object
|
| BeginGetObject(GetObjectRequest, AsyncCallback, Object) |
Begins the async call to get object according to the GetObjectRequest instance.
|
| BeginGetObject(String, String, AsyncCallback, Object) |
Begins the async call to get object by the bucket and key information.
|
| BeginListObjects(String, AsyncCallback, Object) |
Begins the async call to list objects.The returned object is type of OssObjectSummary.
|
| BeginListObjects(ListObjectsRequest, AsyncCallback, Object) |
Begins the async call to list objects under the specified Bucket with specified filters in ListObjectsRequest |
| BeginListObjects(String, String, AsyncCallback, Object) |
Begins the async call to list objects under the specified bucket and prefix
The returned object is type of OssObjectSummary.
|
| BeginPutObject(PutObjectRequest, AsyncCallback, Object) |
Begins the async call to upload object
|
| BeginPutObject(String, String, Stream, AsyncCallback, Object) |
Begins the async call of uploading object to specified bucket.
|
| BeginPutObject(String, String, String, AsyncCallback, Object) |
Begins the async call to upload local file to OSS under the specified bucket.
|
| BeginPutObject(String, String, Stream, ObjectMetadata, AsyncCallback, Object) |
Begins the async call to upload object
|
| BeginPutObject(String, String, String, ObjectMetadata, AsyncCallback, Object) |
Begins the async call to upload object with specified metadata.
|
| BeginUploadPart |
Begins the async call to upload a part
|
| BeginUploadPartCopy |
Begins the async call to copy an existing object as one part of a multipart upload.
|
| CompleteMultipartUpload |
Completes a multipart upload.
|
| CopyBigObject |
Deprecated. Use ResumableCopyObject instead.
Copy the specified file with optional checkpoint support.
|
| CopyObject |
copy an object to another one in OSS.
|
| CreateBucket(String) |
Creates a new bucket
|
| CreateBucket(String, NullableStorageClass) |
Creates the bucket with specified storage class.
|
| CreateSymlink(CreateSymlinkRequest) |
Creates the symlink of the target object
|
| CreateSymlink(String, String, String) |
Creates the symlink of the target object
|
| DeleteBucket |
Deletes a empty bucket.If the bucket is not empty, this will fail.
|
| DeleteBucketCors |
Deletes the CORS rules on the Bucket |
| DeleteBucketLifecycle |
Deletes the bucket's all lifecycle rules.
|
| DeleteBucketLogging |
Deletes the Bucket logging config
|
| DeleteBucketWebsite |
Deletes the Bucket static website config
|
| DeleteObject |
Deletes OssObject。
|
| DeleteObjects |
Deletes multiple objects
|
| DoesBucketExist |
Checks if the bucket exists
|
| DoesObjectExist |
Checks if the object exists
|
| EndAppendObject |
Ends the async call to append object to OSS. WHen it's called, the actual upload has been done.
|
| EndCopyResult |
Ends the async call to copy an object.
|
| EndGetObject |
Ends the async call to get the object.
|
| EndListObjects |
Ends the async call of listing objects.
|
| EndPutObject |
Ends the async call to upload the object.
When it's called, the actual upload has already been done.
|
| EndUploadPart |
Ends the async call to upload a part.
|
| EndUploadPartCopy |
Ends the async call to copy an existing object as one part of a multipart upload.
|
| Equals | (Inherited from Object.) |
 | Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
| GeneratePostPolicy |
Generates the post policy
|
| GeneratePresignedUri(GeneratePresignedUriRequest) |
Generates a signed url
|
| GeneratePresignedUri(String, String) |
Generates the signed url with default expiration time (15 min) that supports HTTP GET method.
|
| GeneratePresignedUri(String, String, SignHttpMethod) |
Generates the pre-signed url with specified expiration time that supports the specified HTTP method
|
| GeneratePresignedUri(String, String, DateTime) |
Generates the pre-signed GET url with specified expiration time
|
| GeneratePresignedUri(String, String, DateTime, SignHttpMethod) |
Generates the presigned url with specified method and specified expiration time.
|
| GetBucketAcl |
Gets the bucket ACL
|
| GetBucketCors |
Gets the Bucket CORS rules.
|
| GetBucketInfo |
Gets the bucket information.
|
| GetBucketLifecycle |
Gets Bucket lifecycle instance.
|
| GetBucketLocation |
Gets the bucket location
|
| GetBucketLogging |
Gets the bucket logging config
|
| GetBucketMetadata |
Gets the bucket metadata
|
| GetBucketReferer |
Gets the Bucket referer config
|
| GetBucketStat |
Gets the bucket stat.
|
| GetBucketStorageCapacity |
Gets Bucket storage capacity
|
| GetBucketWebsite |
Gets Bucket static website config
|
| GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetObject(Uri) |
Gets object via signed url
|
| GetObject(GetObjectRequest) |
Gets object via the bucket name and key name in the GetObjectRequest instance.
|
| GetObject(String, String) |
Gets object
|
| GetObject(GetObjectRequest, Stream) |
Gets the object and assign the data to the stream.
|
| GetObjectAcl |
Gets the object ACL
|
| GetObjectMetadata |
Gets OssObject metadata.
|
| GetSymlink |
Gets the target file of the symlink.
|
| GetType |
Gets the Type of the current instance.
(Inherited from Object.) |
| InitiateMultipartUpload |
Initiate a multipart upload
|
| ListBuckets |
List all buckets under the current account.
|
| ListBuckets(ListBucketsRequest) |
Lists all buckets according to the ListBucketsRequest, which could have filters by prefix, marker, etc.
|
| ListMultipartUploads |
Lists ongoing multipart uploads
|
| ListObjects(String) |
Lists all objects under the Bucket |
| ListObjects(ListObjectsRequest) |
Lists objects according to the ListObjectsRequest.
The returned object is type of OssObjectSummary.
|
| ListObjects(String, String) |
Lists object with specified prefix
|
| ListParts |
Lists successfully uploaded parts of a specific upload id
|
| MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| ModifyObjectMeta |
Modify the object metadata.
|
| PutBigObject(String, String, Stream, ObjectMetadata, NullableInt64) |
Deprecated method. Use ResumableUploadObject instead.
Upload the specified file to OSS.
If the file size is same or less than the part size, use normal file upload instead.
Otherwise it will use multipart file upload.
|
| PutBigObject(String, String, String, ObjectMetadata, NullableInt64) |
Deprecated method.Please use ResumableUploadObject.
Uploads the specified file with optional part size.
If the file size is not bigger than the part size, then use normal file upload.
Otherwise use multipart upload.
|
| PutObject(PutObjectRequest) |
Upload a OssObject according to PutObjectRequest.
|
| PutObject(Uri, Stream) |
Uploads the instream via the signed url.
|
| PutObject(Uri, String) |
Uploads the file via the signed url.
|
| PutObject(String, String, Stream) |
Puts object to the specified bucket with specified object key.
|
| PutObject(String, String, String) |
Uploads a local file to OSS under the specified bucket
|
| PutObject(Uri, Stream, ObjectMetadata) |
Uploads the stream via the signed url with the metadata.
|
| PutObject(Uri, String, ObjectMetadata) |
Uploads the file via the signed url with the metadata.
|
| PutObject(String, String, Stream, ObjectMetadata) |
Uploads the content to object under the specified bucket and object key.
|
| PutObject(String, String, String, ObjectMetadata) |
Uploads a local file with specified metadata to OSS.
|
| RestoreObject |
Restores the object.
|
| ResumableCopyObject |
Resumable object copy.
If the file size is less than part size, normal file upload is used; otherwise multipart upload is used.
|
| ResumableDownloadObject |
Download a file.
Internally it may use multipart download in case the file is big
|
| ResumableUploadObject(UploadObjectRequest) | |
| ResumableUploadObject(String, String, Stream, ObjectMetadata, String, NullableInt64, EventHandlerStreamTransferProgressArgs) | |
| ResumableUploadObject(String, String, String, ObjectMetadata, String, NullableInt64, EventHandlerStreamTransferProgressArgs) |
Resumable file upload. It automaticlly uses multipart upload upon big file and also support resume upload after a failed upload.
|
| SetBucketAcl(SetBucketAclRequest) |
Sets the bucket ACL
|
| SetBucketAcl(String, CannedAccessControlList) |
Sets the bucket ACL
|
| SetBucketCors |
Sets the CORS rules for the Bucket |
| SetBucketLifecycle |
Sets Bucket lifecycle rule
|
| SetBucketLogging |
Sets Bucket logging config
OSS will log the access information on this bucket, according to the logging config
The hourly log file will be stored in the target bucket.
|
| SetBucketReferer |
Sets the Bucket referer config
|
| SetBucketStorageCapacity |
Sets Bucket storage capacity
|
| SetBucketWebsite |
Sets Bucket static website config
|
| SetEndpoint |
Sets the endpoint
|
| SetObjectAcl(SetObjectAclRequest) |
Sets the object ACL
|
| SetObjectAcl(String, String, CannedAccessControlList) |
Sets the object ACL
|
| SwitchCredentials |
Switches the user credentials
|
| ThrowIfNullRequestTRequestType | |
| ToString | (Inherited from Object.) |
| UploadPart |
Uploads a part
|
| UploadPartCopy |
Copy an existing object as one part of a multipart upload.
|
See Also