TOSV2Client (ve-tos-java-sdk 2.6.0 API)

java.lang.Object
- com.volcengine.tos.TOSV2Client

All Implemented Interfaces:: TOS, TOSV2

public class TOSV2Client
extends Object
implements TOSV2

Constructor Summary

Constructors
Modifier Constructor and Description

protected TOSV2Client(TOSClientConfiguration conf)

Constructors
Modifier	Constructor and Description
`protected`	`TOSV2Client(TOSClientConfiguration conf)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AbortMultipartUploadOutput`	`abortMultipartUpload(AbortMultipartUploadInput input)` abort a multipart upload operation
`AbortMultipartUploadOutput`	`abortMultipartUpload(String bucket, AbortMultipartUploadInput input)` abort a multipart upload operation
`AppendObjectOutput`	`appendObject(AppendObjectInput input)` append content at the tail of an appendable object
`AppendObjectOutput`	`appendObject(String bucket, String objectKey, InputStream content, long offset, RequestOptionsBuilder... builders)` append content at the tail of an appendable object
`void`	`changeCredentials(Credentials credentials)`
`void`	`changeRegionAndEndpoint(String region, String endpoint)`
`void`	`changeTransportConfig(TransportConfig config)`
`CompleteMultipartUploadV2Output`	`completeMultipartUpload(CompleteMultipartUploadV2Input input)` complete a multipart upload operation
`CompleteMultipartUploadOutput`	`completeMultipartUpload(String bucket, CompleteMultipartUploadInput input)` complete a multipart upload operation
`CopyObjectV2Output`	`copyObject(CopyObjectV2Input input)` copy an object in the same bucket
`CopyObjectOutput`	`copyObject(String bucket, String srcObjectKey, String dstObjectKey, RequestOptionsBuilder... builders)` copy an object in the same bucket
`CopyObjectOutput`	`copyObjectFrom(String bucket, String srcBucket, String srcObjectKey, String dstObjectKey, RequestOptionsBuilder... builders)` copy an object from bucket A to bucket B, the method is called by bucket B.
`CopyObjectOutput`	`copyObjectTo(String bucket, String dstBucket, String dstObjectKey, String srcObjectKey, RequestOptionsBuilder... builders)` copy an object from bucket A to bucket B, the method is called by bucket A.
`CreateBucketOutput`	`createBucket(CreateBucketInput input)` create a new bucket
`CreateBucketV2Output`	`createBucket(CreateBucketV2Input input)` create a new bucket
`CreateBucketV2Output`	`createBucket(String bucket)` create a new bucket
`CreateMultipartUploadOutput`	`createMultipartUpload(CreateMultipartUploadInput input)` create a multipart upload operation
`CreateMultipartUploadOutput`	`createMultipartUpload(String bucket, String objectKey, RequestOptionsBuilder... builders)` create a multipart upload operation
`DeleteBucketOutput`	`deleteBucket(DeleteBucketInput input)` delete an existed bucket
`DeleteBucketOutput`	`deleteBucket(String bucket)` delete an existed bucket
`DeleteBucketCORSOutput`	`deleteBucketCORS(DeleteBucketCORSInput input)` delete the CORS of a bucket
`DeleteBucketCustomDomainOutput`	`deleteBucketCustomDomain(DeleteBucketCustomDomainInput input)` delete a specific custom domain of a bucket
`DeleteBucketLifecycleOutput`	`deleteBucketLifecycle(DeleteBucketLifecycleInput input)` delete the lifecycle rules of a bucket
`DeleteBucketMirrorBackOutput`	`deleteBucketMirrorBack(DeleteBucketMirrorBackInput input)` delete the mirrorBack rules of a bucket
`DeleteBucketPolicyOutput`	`deleteBucketPolicy(DeleteBucketPolicyInput input)` delete the policy of a bucket
`DeleteBucketPolicyOutput`	`deleteBucketPolicy(String bucket)` delete the policy of a bucket
`DeleteBucketRealTimeLogOutput`	`deleteBucketRealTimeLog(DeleteBucketRealTimeLogInput input)` delete the realtime log config of a bucket
`DeleteBucketRenameOutput`	`deleteBucketRename(DeleteBucketRenameInput input)` delete the rename-enable config of a bucket
`DeleteBucketReplicationOutput`	`deleteBucketReplication(DeleteBucketReplicationInput input)` delete the replication rules of a bucket
`DeleteBucketWebsiteOutput`	`deleteBucketWebsite(DeleteBucketWebsiteInput input)` delete the website config of a bucket
`DeleteMultiObjectsV2Output`	`deleteMultiObjects(DeleteMultiObjectsV2Input input)` delete a list of objects
`DeleteMultiObjectsOutput`	`deleteMultiObjects(String bucket, DeleteMultiObjectsInput input, RequestOptionsBuilder... builders)` delete a list of objects
`DeleteObjectOutput`	`deleteObject(DeleteObjectInput input)` delete an object
`DeleteObjectOutput`	`deleteObject(String bucket, String objectKey, RequestOptionsBuilder... builders)` delete an object
`DeleteObjectTaggingOutput`	`deleteObjectTagging(DeleteObjectTaggingInput input)` delete object's tags in the object meta info
`DownloadFileOutput`	`downloadFile(DownloadFileInput input)`
`FetchObjectOutput`	`fetchObject(FetchObjectInput input)` fetch an object in the specific url synchronously
`GetBucketACLOutput`	`getBucketACL(GetBucketACLInput input)` get the acl rules of a bucket
`GetBucketCORSOutput`	`getBucketCORS(GetBucketCORSInput input)` get the CORS of a bucket
`GetBucketLifecycleOutput`	`getBucketLifecycle(GetBucketLifecycleInput input)` get the lifecycle rules of a bucket
`GetBucketLocationOutput`	`getBucketLocation(GetBucketLocationInput input)` get the location of a bucket
`GetBucketMirrorBackOutput`	`getBucketMirrorBack(GetBucketMirrorBackInput input)` get the mirrorBack rules of a bucket
`GetBucketNotificationOutput`	`getBucketNotification(GetBucketNotificationInput input)` get the event notification rules of a bucket
`GetBucketPolicyOutput`	`getBucketPolicy(GetBucketPolicyInput input)` get policy of a bucket
`GetBucketPolicyOutput`	`getBucketPolicy(String bucket)` get policy of a bucket
`GetBucketRealTimeLogOutput`	`getBucketRealTimeLog(GetBucketRealTimeLogInput input)` get the realtime log config of a bucket
`GetBucketRenameOutput`	`getBucketRename(GetBucketRenameInput input)` get the rename-enable status of a bucket
`GetBucketReplicationOutput`	`getBucketReplication(GetBucketReplicationInput input)` get the replication rules of a bucket
`GetBucketVersioningOutput`	`getBucketVersioning(GetBucketVersioningInput input)` get the multi-version status of a bucket
`GetBucketWebsiteOutput`	`getBucketWebsite(GetBucketWebsiteInput input)` get the website config of a bucket
`protected TOSClientConfiguration`	`getConfig()`
`protected TosRequestFactory`	`getFactory()`
`GetObjectV2Output`	`getObject(GetObjectV2Input input)` get data and metadata of an object
`GetObjectOutput`	`getObject(String bucket, String objectKey, RequestOptionsBuilder... builders)` get data and metadata of an object
`GetObjectACLV2Output`	`getObjectAcl(GetObjectACLV2Input input)` get object's acl grants or rules
`GetObjectAclOutput`	`getObjectAcl(String bucket, String objectKey, RequestOptionsBuilder... builders)` get object's acl grants or rules
`GetObjectTaggingOutput`	`getObjectTagging(GetObjectTaggingInput input)` get object's tags in the object meta info
`GetObjectToFileOutput`	`getObjectToFile(GetObjectToFileInput input)` get data and metadata of an object and store into a local file
`HeadBucketV2Output`	`headBucket(HeadBucketV2Input input)` get bucket's meta data
`HeadBucketOutput`	`headBucket(String bucket)` get bucket's meta data
`HeadObjectV2Output`	`headObject(HeadObjectV2Input input)` get metadata of an object with its data stream
`HeadObjectOutput`	`headObject(String bucket, String objectKey, RequestOptionsBuilder... builders)` get metadata of an object with its data stream
`ListBucketCustomDomainOutput`	`listBucketCustomDomain(ListBucketCustomDomainInput input)` list all the custom domains of a bucket
`ListBucketsOutput`	`listBuckets(ListBucketsInput input)` list existed bucket owned by you.
`ListBucketsV2Output`	`listBuckets(ListBucketsV2Input input)` list existed bucket owned by you.
`ListMultipartUploadsV2Output`	`listMultipartUploads(ListMultipartUploadsV2Input input)` list multiparts uploading
`ListMultipartUploadsOutput`	`listMultipartUploads(String bucket, ListMultipartUploadsInput input)` list multipart uploads
`ListObjectsV2Output`	`listObjects(ListObjectsV2Input input)` list objects of a bucket deprecated since v2.4.0, use listObjectsType2 instead
`ListObjectsOutput`	`listObjects(String bucket, ListObjectsInput input)` list objects of a bucket
`ListObjectsType2Output`	`listObjectsType2(ListObjectsType2Input input)` list objects of a bucket
`ListObjectVersionsV2Output`	`listObjectVersions(ListObjectVersionsV2Input input)` list multi-version objects of a bucket
`ListObjectVersionsOutput`	`listObjectVersions(String bucket, ListObjectVersionsInput input)` list multi-version objects of a bucket
`ListPartsOutput`	`listParts(ListPartsInput input)` list parts that have been uploaded.
`ListUploadedPartsOutput`	`listUploadedParts(String bucket, ListUploadedPartsInput input, RequestOptionsBuilder... builders)` list parts that have been uploaded.
`PreSignedPolicyURLOutput`	`preSignedPolicyURL(PreSignedPolicyURLInput input)` create a pre-signed for batch object request
`PreSignedPostSignatureOutput`	`preSignedPostSignature(PreSignedPostSignatureInput input)` create a pre-signed for postObject request
`PreSignedURLOutput`	`preSignedURL(PreSignedURLInput input)` create a pre-signed URL
`String`	`preSignedURL(String httpMethod, String bucket, String objectKey, Duration ttl, RequestOptionsBuilder... builders)` create a pre-signed URL
`PreSingedPolicyURLOutput`	`preSingedPolicyURL(PreSingedPolicyURLInput input)` Deprecated.
`PutBucketACLOutput`	`putBucketACL(PutBucketACLInput input)` set the acl rules of a bucket
`PutBucketCORSOutput`	`putBucketCORS(PutBucketCORSInput input)` set the CORS of a bucket
`PutBucketCustomDomainOutput`	`putBucketCustomDomain(PutBucketCustomDomainInput input)` add a custom domain config of a bucket
`PutBucketLifecycleOutput`	`putBucketLifecycle(PutBucketLifecycleInput input)` set the lifecycle rules of a bucket
`PutBucketMirrorBackOutput`	`putBucketMirrorBack(PutBucketMirrorBackInput input)` set the mirrorBack rules of a bucket
`PutBucketNotificationOutput`	`putBucketNotification(PutBucketNotificationInput input)` set the event notification rules of a bucket
`PutBucketPolicyOutput`	`putBucketPolicy(PutBucketPolicyInput input)` set bucket policy
`PutBucketPolicyOutput`	`putBucketPolicy(String bucket, String policy)` set bucket policy
`PutBucketRealTimeLogOutput`	`putBucketRealTimeLog(PutBucketRealTimeLogInput input)` set the realtime log config of a bucket
`PutBucketRenameOutput`	`putBucketRename(PutBucketRenameInput input)` set rename enabled of a bucket
`PutBucketReplicationOutput`	`putBucketReplication(PutBucketReplicationInput input)` set the replication rules of a bucket
`PutBucketStorageClassOutput`	`putBucketStorageClass(PutBucketStorageClassInput input)` set storageClass of a bucket
`PutBucketVersioningOutput`	`putBucketVersioning(PutBucketVersioningInput input)` set the multi-version status of a bucket
`PutBucketWebsiteOutput`	`putBucketWebsite(PutBucketWebsiteInput input)` set the website config of a bucket
`PutFetchTaskOutput`	`putFetchTask(PutFetchTaskInput input)` fetch an object in the specific url asynchronously
`PutObjectOutput`	`putObject(PutObjectInput input)` upload an object to TOS server
`PutObjectOutput`	`putObject(String bucket, String objectKey, InputStream inputStream, RequestOptionsBuilder... builders)` upload an object to TOS server
`PutObjectACLOutput`	`putObjectAcl(PutObjectACLInput input)` set object's acl grants or rules
`PutObjectAclOutput`	`putObjectAcl(String bucket, PutObjectAclInput input)` set object's acl grants or rules
`PutObjectFromFileOutput`	`putObjectFromFile(PutObjectFromFileInput input)` upload an object to TOS server from file
`PutObjectTaggingOutput`	`putObjectTagging(PutObjectTaggingInput input)` set object's tags in the object meta info
`RenameObjectOutput`	`renameObject(RenameObjectInput input)` rename an object in the bucket
`RestoreObjectOutput`	`restoreObject(RestoreObjectInput input)` restore an object in the bucket
`ResumableCopyObjectOutput`	`resumableCopyObject(ResumableCopyObjectInput input)`
`SetObjectMetaOutput`	`setObjectMeta(SetObjectMetaInput input)` set some metadata of the object
`SetObjectMetaOutput`	`setObjectMeta(String bucket, String objectKey, RequestOptionsBuilder... builders)` set some metadata of the object
`UploadFileOutput`	`uploadFile(String bucket, UploadFileInput input, RequestOptionsBuilder... builders)`
`UploadFileV2Output`	`uploadFile(UploadFileV2Input input)`
`UploadPartOutput`	`uploadPart(String bucket, UploadPartInput input, RequestOptionsBuilder... builders)` upload a part for a multipart upload operation
`UploadPartV2Output`	`uploadPart(UploadPartV2Input input)` upload a part for a multipart upload operation
`UploadPartCopyOutput`	`uploadPartCopy(String bucket, UploadPartCopyInput input, RequestOptionsBuilder... builders)` copy a part of object as a part of a multipart upload operation
`UploadPartCopyV2Output`	`uploadPartCopy(UploadPartCopyV2Input input)` copy a part of object as a part of a multipart upload operation
`UploadPartFromFileOutput`	`uploadPartFromFile(UploadPartFromFileInput input)` upload a part from file for a multipart upload operation

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TOSV2Client
```
protected TOSV2Client(TOSClientConfiguration conf)
```
- Method Detail
  - changeCredentials
```
public void changeCredentials(Credentials credentials)
```
    Specified by:
    
    changeCredentials in interface TOSV2
  - getConfig
```
protected TOSClientConfiguration getConfig()
```
  - getFactory
```
protected TosRequestFactory getFactory()
```
  - changeRegionAndEndpoint
```
public void changeRegionAndEndpoint(String region,
                                    String endpoint)
```
    Specified by:
    
    changeRegionAndEndpoint in interface TOSV2
  - changeTransportConfig
```
public void changeTransportConfig(TransportConfig config)
```
    Specified by:
    
    changeTransportConfig in interface TOSV2
  - createBucket
```
public CreateBucketV2Output createBucket(String bucket)
                                  throws TosException
```
    Description copied from interface: TOSV2
    
    create a new bucket
    
    Specified by:
    
    createBucket in interface TOSV2
    
    Parameters:
    
    bucket - require input's bucketName not null
    
    Returns:
    
    CreateBucketV2Output
    
    Throws:
    
    TosException
  - createBucket
```
public CreateBucketV2Output createBucket(CreateBucketV2Input input)
                                  throws TosException
```
    Description copied from interface: TOSV2
    
    create a new bucket
    
    Specified by:
    
    createBucket in interface TOSV2
    
    Parameters:
    
    input - require input's bucketName not null
    
    Returns:
    
    CreateBucketV2Output
    
    Throws:
    
    TosException
  - headBucket
```
public HeadBucketV2Output headBucket(HeadBucketV2Input input)
                              throws TosException
```
    Description copied from interface: TOSV2
    
    get bucket's meta data
    
    Specified by:
    
    headBucket in interface TOSV2
    
    Parameters:
    
    input - bucket name
    
    Returns:
    
    HeadBucketOutput
    
    Throws:
    
    TosException
  - deleteBucket
```
public DeleteBucketOutput deleteBucket(String bucket)
                                throws TosException
```
    Description copied from interface: TOS
    
    delete an existed bucket
    
    Specified by:
    
    deleteBucket in interface TOS
    
    Parameters:
    
    bucket - bucket name
    
    Returns:
    
    DeleteBucketOutput
    
    Throws:
    
    TosException
  - deleteBucket
```
public DeleteBucketOutput deleteBucket(DeleteBucketInput input)
                                throws TosException
```
    Description copied from interface: TOSV2
    
    delete an existed bucket
    
    Specified by:
    
    deleteBucket in interface TOSV2
    
    Parameters:
    
    input - bucket name
    
    Returns:
    
    DeleteBucketOutput
    
    Throws:
    
    TosException
  - listBuckets
```
public ListBucketsV2Output listBuckets(ListBucketsV2Input input)
                                throws TosException
```
    Description copied from interface: TOSV2
    
    list existed bucket owned by you.
    
    Specified by:
    
    listBuckets in interface TOSV2
    
    Parameters:
    
    input - no params required
    
    Returns:
    
    ListBucketsV2Output
    
    Throws:
    
    TosException
  - putBucketPolicy
```
public PutBucketPolicyOutput putBucketPolicy(String bucket,
                                             String policy)
                                      throws TosException
```
    Description copied from interface: TOSV2
    
    set bucket policy
    
    Specified by:
    
    putBucketPolicy in interface TOS
    
    Specified by:
    
    putBucketPolicy in interface TOSV2
    
    Parameters:
    
    bucket - bucket name
    
    policy - bucket policy
    
    Returns:
    
    PutBucketPolicyOutput
    
    Throws:
    
    TosException
  - putBucketPolicy
```
public PutBucketPolicyOutput putBucketPolicy(PutBucketPolicyInput input)
                                      throws TosException
```
    Description copied from interface: TOSV2
    
    set bucket policy
    
    Specified by:
    
    putBucketPolicy in interface TOSV2
    
    Parameters:
    
    input - set bucket name and bucket policy
    
    Returns:
    
    PutBucketPolicyOutput
    
    Throws:
    
    TosException
  - getBucketPolicy
```
public GetBucketPolicyOutput getBucketPolicy(String bucket)
                                      throws TosException
```
    Description copied from interface: TOSV2
    
    get policy of a bucket
    
    Specified by:
    
    getBucketPolicy in interface TOS
    
    Specified by:
    
    getBucketPolicy in interface TOSV2
    
    Parameters:
    
    bucket - bucket name
    
    Returns:
    
    GetBucketPolicyOutput
    
    Throws:
    
    TosException
  - getBucketPolicy
```
public GetBucketPolicyOutput getBucketPolicy(GetBucketPolicyInput input)
                                      throws TosException
```
    Description copied from interface: TOSV2
    
    get policy of a bucket
    
    Specified by:
    
    getBucketPolicy in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    GetBucketPolicyOutput
    
    Throws:
    
    TosException
  - deleteBucketPolicy
```
public DeleteBucketPolicyOutput deleteBucketPolicy(String bucket)
                                            throws TosException
```
    Description copied from interface: TOSV2
    
    delete the policy of a bucket
    
    Specified by:
    
    deleteBucketPolicy in interface TOS
    
    Specified by:
    
    deleteBucketPolicy in interface TOSV2
    
    Parameters:
    
    bucket - bucket name
    
    Returns:
    
    DeleteBucketPolicyOutput
    
    Throws:
    
    TosException
  - deleteBucketPolicy
```
public DeleteBucketPolicyOutput deleteBucketPolicy(DeleteBucketPolicyInput input)
                                            throws TosException
```
    Description copied from interface: TOSV2
    
    delete the policy of a bucket
    
    Specified by:
    
    deleteBucketPolicy in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    DeleteBucketPolicyOutput
    
    Throws:
    
    TosException
  - putBucketCORS
```
public PutBucketCORSOutput putBucketCORS(PutBucketCORSInput input)
                                  throws TosException
```
    Description copied from interface: TOSV2
    
    set the CORS of a bucket
    
    Specified by:
    
    putBucketCORS in interface TOSV2
    
    Parameters:
    
    input - set bucket name and the bucket CORS rules
    
    Returns:
    
    PutBucketCORSOutput
    
    Throws:
    
    TosException
  - getBucketCORS
```
public GetBucketCORSOutput getBucketCORS(GetBucketCORSInput input)
                                  throws TosException
```
    Description copied from interface: TOSV2
    
    get the CORS of a bucket
    
    Specified by:
    
    getBucketCORS in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    GetBucketCORSOutput
    
    Throws:
    
    TosException
  - deleteBucketCORS
```
public DeleteBucketCORSOutput deleteBucketCORS(DeleteBucketCORSInput input)
                                        throws TosException
```
    Description copied from interface: TOSV2
    
    delete the CORS of a bucket
    
    Specified by:
    
    deleteBucketCORS in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    DeleteBucketCORSOutput
    
    Throws:
    
    TosException
  - putBucketStorageClass
```
public PutBucketStorageClassOutput putBucketStorageClass(PutBucketStorageClassInput input)
                                                  throws TosException
```
    Description copied from interface: TOSV2
    
    set storageClass of a bucket
    
    Specified by:
    
    putBucketStorageClass in interface TOSV2
    
    Parameters:
    
    input - set bucket name and the specific storageClassType
    
    Returns:
    
    PutBucketStorageClassOutput
    
    Throws:
    
    TosException
  - getBucketLocation
```
public GetBucketLocationOutput getBucketLocation(GetBucketLocationInput input)
                                          throws TosException
```
    Description copied from interface: TOSV2
    
    get the location of a bucket
    
    Specified by:
    
    getBucketLocation in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    GetBucketLocationOutput
    
    Throws:
    
    TosException
  - putBucketLifecycle
```
public PutBucketLifecycleOutput putBucketLifecycle(PutBucketLifecycleInput input)
                                            throws TosException
```
    Description copied from interface: TOSV2
    
    set the lifecycle rules of a bucket
    
    Specified by:
    
    putBucketLifecycle in interface TOSV2
    
    Parameters:
    
    input - set bucket name and the bucket lifecycle rules
    
    Returns:
    
    PutBucketLifecycleOutput
    
    Throws:
    
    TosException
  - getBucketLifecycle
```
public GetBucketLifecycleOutput getBucketLifecycle(GetBucketLifecycleInput input)
                                            throws TosException
```
    Description copied from interface: TOSV2
    
    get the lifecycle rules of a bucket
    
    Specified by:
    
    getBucketLifecycle in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    GetBucketLifecycleOutput
    
    Throws:
    
    TosException
  - deleteBucketLifecycle
```
public DeleteBucketLifecycleOutput deleteBucketLifecycle(DeleteBucketLifecycleInput input)
                                                  throws TosException
```
    Description copied from interface: TOSV2
    
    delete the lifecycle rules of a bucket
    
    Specified by:
    
    deleteBucketLifecycle in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    DeleteBucketLifecycleOutput
    
    Throws:
    
    TosException
  - putBucketMirrorBack
```
public PutBucketMirrorBackOutput putBucketMirrorBack(PutBucketMirrorBackInput input)
                                              throws TosException
```
    Description copied from interface: TOSV2
    
    set the mirrorBack rules of a bucket
    
    Specified by:
    
    putBucketMirrorBack in interface TOSV2
    
    Parameters:
    
    input - set bucket name and the bucket mirrorBack rules
    
    Returns:
    
    PutBucketMirrorBackOutput
    
    Throws:
    
    TosException
  - getBucketMirrorBack
```
public GetBucketMirrorBackOutput getBucketMirrorBack(GetBucketMirrorBackInput input)
                                              throws TosException
```
    Description copied from interface: TOSV2
    
    get the mirrorBack rules of a bucket
    
    Specified by:
    
    getBucketMirrorBack in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    GetBucketMirrorBackOutput
    
    Throws:
    
    TosException
  - deleteBucketMirrorBack
```
public DeleteBucketMirrorBackOutput deleteBucketMirrorBack(DeleteBucketMirrorBackInput input)
                                                    throws TosException
```
    Description copied from interface: TOSV2
    
    delete the mirrorBack rules of a bucket
    
    Specified by:
    
    deleteBucketMirrorBack in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    DeleteBucketMirrorBackOutput
    
    Throws:
    
    TosException
  - putBucketReplication
```
public PutBucketReplicationOutput putBucketReplication(PutBucketReplicationInput input)
                                                throws TosException
```
    Description copied from interface: TOSV2
    
    set the replication rules of a bucket
    
    Specified by:
    
    putBucketReplication in interface TOSV2
    
    Parameters:
    
    input - set bucket name and the bucket replication rules
    
    Returns:
    
    PutBucketReplicationOutput
    
    Throws:
    
    TosException
  - getBucketReplication
```
public GetBucketReplicationOutput getBucketReplication(GetBucketReplicationInput input)
                                                throws TosException
```
    Description copied from interface: TOSV2
    
    get the replication rules of a bucket
    
    Specified by:
    
    getBucketReplication in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    GetBucketReplicationOutput
    
    Throws:
    
    TosException
  - deleteBucketReplication
```
public DeleteBucketReplicationOutput deleteBucketReplication(DeleteBucketReplicationInput input)
                                                      throws TosException
```
    Description copied from interface: TOSV2
    
    delete the replication rules of a bucket
    
    Specified by:
    
    deleteBucketReplication in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    DeleteBucketReplicationOutput
    
    Throws:
    
    TosException
  - putBucketVersioning
```
public PutBucketVersioningOutput putBucketVersioning(PutBucketVersioningInput input)
                                              throws TosException
```
    Description copied from interface: TOSV2
    
    set the multi-version status of a bucket
    
    Specified by:
    
    putBucketVersioning in interface TOSV2
    
    Parameters:
    
    input - set bucket name and the bucket multi-version status
    
    Returns:
    
    PutBucketVersioningOutput
    
    Throws:
    
    TosException
  - getBucketVersioning
```
public GetBucketVersioningOutput getBucketVersioning(GetBucketVersioningInput input)
                                              throws TosException
```
    Description copied from interface: TOSV2
    
    get the multi-version status of a bucket
    
    Specified by:
    
    getBucketVersioning in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    GetBucketVersioningOutput
    
    Throws:
    
    TosException
  - putBucketWebsite
```
public PutBucketWebsiteOutput putBucketWebsite(PutBucketWebsiteInput input)
                                        throws TosException
```
    Description copied from interface: TOSV2
    
    set the website config of a bucket
    
    Specified by:
    
    putBucketWebsite in interface TOSV2
    
    Parameters:
    
    input - set bucket name and the bucket website config rules
    
    Returns:
    
    PutBucketWebsiteOutput
    
    Throws:
    
    TosException
  - getBucketWebsite
```
public GetBucketWebsiteOutput getBucketWebsite(GetBucketWebsiteInput input)
                                        throws TosException
```
    Description copied from interface: TOSV2
    
    get the website config of a bucket
    
    Specified by:
    
    getBucketWebsite in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    GetBucketWebsiteOutput
    
    Throws:
    
    TosException
  - deleteBucketWebsite
```
public DeleteBucketWebsiteOutput deleteBucketWebsite(DeleteBucketWebsiteInput input)
                                              throws TosException
```
    Description copied from interface: TOSV2
    
    delete the website config of a bucket
    
    Specified by:
    
    deleteBucketWebsite in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    DeleteBucketWebsiteOutput
    
    Throws:
    
    TosException
  - putBucketNotification
```
public PutBucketNotificationOutput putBucketNotification(PutBucketNotificationInput input)
                                                  throws TosException
```
    Description copied from interface: TOSV2
    
    set the event notification rules of a bucket
    
    Specified by:
    
    putBucketNotification in interface TOSV2
    
    Parameters:
    
    input - set bucket name and the bucket event notification rules
    
    Returns:
    
    PutBucketNotificationOutput
    
    Throws:
    
    TosException
  - getBucketNotification
```
public GetBucketNotificationOutput getBucketNotification(GetBucketNotificationInput input)
                                                  throws TosException
```
    Description copied from interface: TOSV2
    
    get the event notification rules of a bucket
    
    Specified by:
    
    getBucketNotification in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    GetBucketNotificationOutput
    
    Throws:
    
    TosException
  - putBucketCustomDomain
```
public PutBucketCustomDomainOutput putBucketCustomDomain(PutBucketCustomDomainInput input)
                                                  throws TosException
```
    Description copied from interface: TOSV2
    
    add a custom domain config of a bucket
    
    Specified by:
    
    putBucketCustomDomain in interface TOSV2
    
    Parameters:
    
    input - set bucket name and the custom domain rule
    
    Returns:
    
    PutBucketCustomDomainOutput
    
    Throws:
    
    TosException
  - listBucketCustomDomain
```
public ListBucketCustomDomainOutput listBucketCustomDomain(ListBucketCustomDomainInput input)
                                                    throws TosException
```
    Description copied from interface: TOSV2
    
    list all the custom domains of a bucket
    
    Specified by:
    
    listBucketCustomDomain in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    ListBucketCustomDomainOutput
    
    Throws:
    
    TosException
  - deleteBucketCustomDomain
```
public DeleteBucketCustomDomainOutput deleteBucketCustomDomain(DeleteBucketCustomDomainInput input)
                                                        throws TosException
```
    Description copied from interface: TOSV2
    
    delete a specific custom domain of a bucket
    
    Specified by:
    
    deleteBucketCustomDomain in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    DeleteBucketCustomDomainOutput
    
    Throws:
    
    TosException
  - putBucketRealTimeLog
```
public PutBucketRealTimeLogOutput putBucketRealTimeLog(PutBucketRealTimeLogInput input)
                                                throws TosException
```
    Description copied from interface: TOSV2
    
    set the realtime log config of a bucket
    
    Specified by:
    
    putBucketRealTimeLog in interface TOSV2
    
    Parameters:
    
    input - set bucket name and the realtime log config
    
    Returns:
    
    PutBucketRealTimeLogOutput
    
    Throws:
    
    TosException
  - getBucketRealTimeLog
```
public GetBucketRealTimeLogOutput getBucketRealTimeLog(GetBucketRealTimeLogInput input)
                                                throws TosException
```
    Description copied from interface: TOSV2
    
    get the realtime log config of a bucket
    
    Specified by:
    
    getBucketRealTimeLog in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    GetBucketRealTimeLogOutput
    
    Throws:
    
    TosException
  - deleteBucketRealTimeLog
```
public DeleteBucketRealTimeLogOutput deleteBucketRealTimeLog(DeleteBucketRealTimeLogInput input)
                                                      throws TosException
```
    Description copied from interface: TOSV2
    
    delete the realtime log config of a bucket
    
    Specified by:
    
    deleteBucketRealTimeLog in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    DeleteBucketRealTimeLogOutput
    
    Throws:
    
    TosException
  - putBucketACL
```
public PutBucketACLOutput putBucketACL(PutBucketACLInput input)
                                throws TosException
```
    Description copied from interface: TOSV2
    
    set the acl rules of a bucket
    
    Specified by:
    
    putBucketACL in interface TOSV2
    
    Parameters:
    
    input - set bucket name and the bucket lifecycle rules
    
    Returns:
    
    PutBucketACLOutput
    
    Throws:
    
    TosException
  - getBucketACL
```
public GetBucketACLOutput getBucketACL(GetBucketACLInput input)
                                throws TosException
```
    Description copied from interface: TOSV2
    
    get the acl rules of a bucket
    
    Specified by:
    
    getBucketACL in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    GetBucketACLOutput
    
    Throws:
    
    TosException
  - putBucketRename
```
public PutBucketRenameOutput putBucketRename(PutBucketRenameInput input)
                                      throws TosException
```
    Description copied from interface: TOSV2
    
    set rename enabled of a bucket
    
    Specified by:
    
    putBucketRename in interface TOSV2
    
    Parameters:
    
    input - set bucket name and the rename-switch
    
    Returns:
    
    PutBucketRenameOutput
    
    Throws:
    
    TosException
  - getBucketRename
```
public GetBucketRenameOutput getBucketRename(GetBucketRenameInput input)
                                      throws TosException
```
    Description copied from interface: TOSV2
    
    get the rename-enable status of a bucket
    
    Specified by:
    
    getBucketRename in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    GetBucketRenameOutput
    
    Throws:
    
    TosException
  - deleteBucketRename
```
public DeleteBucketRenameOutput deleteBucketRename(DeleteBucketRenameInput input)
                                            throws TosException
```
    Description copied from interface: TOSV2
    
    delete the rename-enable config of a bucket
    
    Specified by:
    
    deleteBucketRename in interface TOSV2
    
    Parameters:
    
    input - set bucket name
    
    Returns:
    
    DeleteBucketRenameOutput
    
    Throws:
    
    TosException
  - getObject
```
public GetObjectV2Output getObject(GetObjectV2Input input)
                            throws TosException
```
    Description copied from interface: TOSV2
    
    get data and metadata of an object
    
    Specified by:
    
    getObject in interface TOSV2
    
    Parameters:
    
    input - set get object options
    
    Returns:
    
    GetObjectV2Output
    
    Throws:
    
    TosException
  - getObjectToFile
```
public GetObjectToFileOutput getObjectToFile(GetObjectToFileInput input)
                                      throws TosException
```
    Description copied from interface: TOSV2
    
    get data and metadata of an object and store into a local file
    
    Specified by:
    
    getObjectToFile in interface TOSV2
    
    Parameters:
    
    input - set get object options
    
    Returns:
    
    GetObjectToFileOutput
    
    Throws:
    
    TosException
  - uploadFile
```
public UploadFileV2Output uploadFile(UploadFileV2Input input)
                              throws TosException
```
    Specified by:
    
    uploadFile in interface TOSV2
    
    Throws:
    
    TosException
  - downloadFile
```
public DownloadFileOutput downloadFile(DownloadFileInput input)
                                throws TosException
```
    Specified by:
    
    downloadFile in interface TOSV2
    
    Throws:
    
    TosException
  - resumableCopyObject
```
public ResumableCopyObjectOutput resumableCopyObject(ResumableCopyObjectInput input)
                                              throws TosException
```
    Specified by:
    
    resumableCopyObject in interface TOSV2
    
    Throws:
    
    TosException
  - headObject
```
public HeadObjectV2Output headObject(HeadObjectV2Input input)
                              throws TosException
```
    Description copied from interface: TOSV2
    
    get metadata of an object with its data stream
    
    Specified by:
    
    headObject in interface TOSV2
    
    Parameters:
    
    input - set head object options
    
    Returns:
    
    HeadObjectV2Output
    
    Throws:
    
    TosException
  - deleteObject
```
public DeleteObjectOutput deleteObject(DeleteObjectInput input)
                                throws TosException
```
    Description copied from interface: TOSV2
    
    delete an object
    
    Specified by:
    
    deleteObject in interface TOSV2
    
    Parameters:
    
    input - set delete object options
    
    Returns:
    
    DeleteObjectOutput
    
    Throws:
    
    TosException
  - deleteMultiObjects
```
public DeleteMultiObjectsV2Output deleteMultiObjects(DeleteMultiObjectsV2Input input)
                                              throws TosException
```
    Description copied from interface: TOSV2
    
    delete a list of objects
    
    Specified by:
    
    deleteMultiObjects in interface TOSV2
    
    Parameters:
    
    input - set delete multi objects options
    
    Returns:
    
    DeleteMultiObjectsV2Output
    
    Throws:
    
    TosException
  - putObject
```
public PutObjectOutput putObject(PutObjectInput input)
                          throws TosException
```
    Description copied from interface: TOSV2
    
    upload an object to TOS server
    
    Specified by:
    
    putObject in interface TOSV2
    
    Parameters:
    
    input - set put object option
    
    Returns:
    
    PutObjectOutput
    
    Throws:
    
    TosException
  - putObjectFromFile
```
public PutObjectFromFileOutput putObjectFromFile(PutObjectFromFileInput input)
                                          throws TosException
```
    Description copied from interface: TOSV2
    
    upload an object to TOS server from file
    
    Specified by:
    
    putObjectFromFile in interface TOSV2
    
    Parameters:
    
    input - set put object option
    
    Returns:
    
    PutObjectFromFileOutput
    
    Throws:
    
    TosException
  - appendObject
```
public AppendObjectOutput appendObject(AppendObjectInput input)
                                throws TosException
```
    Description copied from interface: TOSV2
    
    append content at the tail of an appendable object
    
    Specified by:
    
    appendObject in interface TOSV2
    
    Parameters:
    
    input - set append object option
    
    Returns:
    
    AppendObjectOutput
    
    Throws:
    
    TosException
  - setObjectMeta
```
public SetObjectMetaOutput setObjectMeta(SetObjectMetaInput input)
                                  throws TosException
```
    Description copied from interface: TOSV2
    
    set some metadata of the object
    
    Specified by:
    
    setObjectMeta in interface TOSV2
    
    Parameters:
    
    input - set setObjectMeta option
    
    Returns:
    
    SetObjectMetaOutput
    
    Throws:
    
    TosException
  - listObjects
```
public ListObjectsV2Output listObjects(ListObjectsV2Input input)
                                throws TosException
```
    Description copied from interface: TOSV2
    
    list objects of a bucket deprecated since v2.4.0, use listObjectsType2 instead
    
    Specified by:
    
    listObjects in interface TOSV2
    
    Parameters:
    
    input - list object options
    
    Returns:
    
    ListObjectsV2Output
    
    Throws:
    
    TosException
  - listObjectsType2
```
public ListObjectsType2Output listObjectsType2(ListObjectsType2Input input)
                                        throws TosException
```
    Description copied from interface: TOSV2
    
    list objects of a bucket
    
    Specified by:
    
    listObjectsType2 in interface TOSV2
    
    Parameters:
    
    input - list object options
    
    Returns:
    
    ListObjectsType2Output
    
    Throws:
    
    TosException
  - listObjectVersions
```
public ListObjectVersionsV2Output listObjectVersions(ListObjectVersionsV2Input input)
                                              throws TosException
```
    Description copied from interface: TOSV2
    
    list multi-version objects of a bucket
    
    Specified by:
    
    listObjectVersions in interface TOSV2
    
    Parameters:
    
    input - query params
    
    Returns:
    
    ListObjectVersionsV2Output
    
    Throws:
    
    TosException
  - copyObject
```
public CopyObjectV2Output copyObject(CopyObjectV2Input input)
                              throws TosException
```
    Description copied from interface: TOSV2
    
    copy an object in the same bucket
    
    Specified by:
    
    copyObject in interface TOSV2
    
    Parameters:
    
    input - set copy object option
    
    Returns:
    
    CopyObjectV2Output
    
    Throws:
    
    TosException
  - uploadPartCopy
```
public UploadPartCopyV2Output uploadPartCopy(UploadPartCopyV2Input input)
                                      throws TosException
```
    Description copied from interface: TOSV2
    
    copy a part of object as a part of a multipart upload operation
    
    Specified by:
    
    uploadPartCopy in interface TOSV2
    
    Returns:
    
    UploadPartCopyV2Output
    
    Throws:
    
    TosException
  - putObjectAcl
```
public PutObjectACLOutput putObjectAcl(PutObjectACLInput input)
                                throws TosException
```
    Description copied from interface: TOSV2
    
    set object's acl grants or rules
    
    Specified by:
    
    putObjectAcl in interface TOSV2
    
    Parameters:
    
    input - set acl option.
    
    Returns:
    
    PutObjectACLOutput
    
    Throws:
    
    TosException
  - getObjectAcl
```
public GetObjectACLV2Output getObjectAcl(GetObjectACLV2Input input)
                                  throws TosException
```
    Description copied from interface: TOSV2
    
    get object's acl grants or rules
    
    Specified by:
    
    getObjectAcl in interface TOSV2
    
    Parameters:
    
    input - set bucket, key and versionID.
    
    Returns:
    
    GetObjectACLV2Output
    
    Throws:
    
    TosException
  - putObjectTagging
```
public PutObjectTaggingOutput putObjectTagging(PutObjectTaggingInput input)
                                        throws TosException
```
    Description copied from interface: TOSV2
    
    set object's tags in the object meta info
    
    Specified by:
    
    putObjectTagging in interface TOSV2
    
    Parameters:
    
    input - set object tag set.
    
    Returns:
    
    PutObjectTaggingOutput
    
    Throws:
    
    TosException
  - getObjectTagging
```
public GetObjectTaggingOutput getObjectTagging(GetObjectTaggingInput input)
                                        throws TosException
```
    Description copied from interface: TOSV2
    
    get object's tags in the object meta info
    
    Specified by:
    
    getObjectTagging in interface TOSV2
    
    Parameters:
    
    input - set bucket, key and versionID.
    
    Returns:
    
    GetObjectTaggingOutput
    
    Throws:
    
    TosException
  - deleteObjectTagging
```
public DeleteObjectTaggingOutput deleteObjectTagging(DeleteObjectTaggingInput input)
                                              throws TosException
```
    Description copied from interface: TOSV2
    
    delete object's tags in the object meta info
    
    Specified by:
    
    deleteObjectTagging in interface TOSV2
    
    Parameters:
    
    input - set bucket, key and versionID.
    
    Returns:
    
    DeleteObjectTaggingOutput
    
    Throws:
    
    TosException
  - fetchObject
```
public FetchObjectOutput fetchObject(FetchObjectInput input)
                              throws TosException
```
    Description copied from interface: TOSV2
    
    fetch an object in the specific url synchronously
    
    Specified by:
    
    fetchObject in interface TOSV2
    
    Parameters:
    
    input - set fetch options.
    
    Returns:
    
    FetchObjectOutput
    
    Throws:
    
    TosException
  - putFetchTask
```
public PutFetchTaskOutput putFetchTask(PutFetchTaskInput input)
                                throws TosException
```
    Description copied from interface: TOSV2
    
    fetch an object in the specific url asynchronously
    
    Specified by:
    
    putFetchTask in interface TOSV2
    
    Parameters:
    
    input - set fetch options.
    
    Returns:
    
    PutFetchTaskOutput
    
    Throws:
    
    TosException
  - createMultipartUpload
```
public CreateMultipartUploadOutput createMultipartUpload(CreateMultipartUploadInput input)
                                                  throws TosException
```
    Description copied from interface: TOSV2
    
    create a multipart upload operation
    
    Specified by:
    
    createMultipartUpload in interface TOSV2
    
    Parameters:
    
    input - set the createMultipartUpload option
    
    Returns:
    
    CreateMultipartUploadOutput
    
    Throws:
    
    TosException
  - uploadPart
```
public UploadPartV2Output uploadPart(UploadPartV2Input input)
                              throws TosException
```
    Description copied from interface: TOSV2
    
    upload a part for a multipart upload operation
    
    Specified by:
    
    uploadPart in interface TOSV2
    
    Parameters:
    
    input - set uploadpart option
    
    Returns:
    
    UploadPartV2Output
    
    Throws:
    
    TosException
  - uploadPartFromFile
```
public UploadPartFromFileOutput uploadPartFromFile(UploadPartFromFileInput input)
                                            throws TosException
```
    Description copied from interface: TOSV2
    
    upload a part from file for a multipart upload operation
    
    Specified by:
    
    uploadPartFromFile in interface TOSV2
    
    Parameters:
    
    input - set uploadpart option
    
    Returns:
    
    UploadPartFromFileOutput
    
    Throws:
    
    TosException
  - completeMultipartUpload
```
public CompleteMultipartUploadV2Output completeMultipartUpload(CompleteMultipartUploadV2Input input)
                                                        throws TosException
```
    Description copied from interface: TOSV2
    
    complete a multipart upload operation
    
    Specified by:
    
    completeMultipartUpload in interface TOSV2
    
    Parameters:
    
    input - set completeMultipartUpload option
    
    Returns:
    
    CompleteMultipartUploadV2Output
    
    Throws:
    
    TosException
  - abortMultipartUpload
```
public AbortMultipartUploadOutput abortMultipartUpload(AbortMultipartUploadInput input)
                                                throws TosException
```
    Description copied from interface: TOSV2
    
    abort a multipart upload operation
    
    Specified by:
    
    abortMultipartUpload in interface TOSV2
    
    Parameters:
    
    input - set abortMultipartUpload option
    
    Returns:
    
    AbortMultipartUploadOutput
    
    Throws:
    
    TosException
  - listParts
```
public ListPartsOutput listParts(ListPartsInput input)
                          throws TosException
```
    Description copied from interface: TOSV2
    
    list parts that have been uploaded.
    
    Specified by:
    
    listParts in interface TOSV2
    
    Parameters:
    
    input - set listParts option
    
    Returns:
    
    ListPartsOutput
    
    Throws:
    
    TosException
  - listMultipartUploads
```
public ListMultipartUploadsV2Output listMultipartUploads(ListMultipartUploadsV2Input input)
                                                  throws TosException
```
    Description copied from interface: TOSV2
    
    list multiparts uploading
    
    Specified by:
    
    listMultipartUploads in interface TOSV2
    
    Parameters:
    
    input - ListMultipartUploadsInput
    
    Returns:
    
    ListMultipartUploadsV2Output
    
    Throws:
    
    TosException
  - renameObject
```
public RenameObjectOutput renameObject(RenameObjectInput input)
                                throws TosException
```
    Description copied from interface: TOSV2
    
    rename an object in the bucket
    
    Specified by:
    
    renameObject in interface TOSV2
    
    Parameters:
    
    input - set the source key to be renamed and the renamed key.
    
    Returns:
    
    RenameObjectOutput
    
    Throws:
    
    TosException
  - restoreObject
```
public RestoreObjectOutput restoreObject(RestoreObjectInput input)
                                  throws TosException
```
    Description copied from interface: TOSV2
    
    restore an object in the bucket
    
    Specified by:
    
    restoreObject in interface TOSV2
    
    Parameters:
    
    input - set restoreObject options.
    
    Returns:
    
    RestoreObjectOutput
    
    Throws:
    
    TosException
  - preSignedURL
```
public PreSignedURLOutput preSignedURL(PreSignedURLInput input)
                                throws TosException
```
    Description copied from interface: TOSV2
    
    create a pre-signed URL
    
    Specified by:
    
    preSignedURL in interface TOSV2
    
    Parameters:
    
    input - PreSignedURLInput
    
    Returns:
    
    PreSignedURLOutput
    
    Throws:
    
    TosException
  - preSignedPostSignature
```
public PreSignedPostSignatureOutput preSignedPostSignature(PreSignedPostSignatureInput input)
                                                    throws TosException
```
    Description copied from interface: TOSV2
    
    create a pre-signed for postObject request
    
    Specified by:
    
    preSignedPostSignature in interface TOSV2
    
    Parameters:
    
    input - PreSignedPostSignatureInput
    
    Returns:
    
    PreSignedPostSignatureOutput
    
    Throws:
    
    TosException
  - preSingedPolicyURL
```
@Deprecated
public PreSingedPolicyURLOutput preSingedPolicyURL(PreSingedPolicyURLInput input)
                                                        throws TosException
```
    Deprecated.
    
    Description copied from interface: TOSV2
    
    create a pre-signed for batch object request
    
    Specified by:
    
    preSingedPolicyURL in interface TOSV2
    
    Parameters:
    
    input - PreSingedPolicyURLInput
    
    Returns:
    
    PreSingedPolicyURLOutput
    
    Throws:
    
    TosException
  - preSignedPolicyURL
```
public PreSignedPolicyURLOutput preSignedPolicyURL(PreSignedPolicyURLInput input)
                                            throws TosException
```
    Description copied from interface: TOSV2
    
    create a pre-signed for batch object request
    
    Specified by:
    
    preSignedPolicyURL in interface TOSV2
    
    Parameters:
    
    input - PreSignedPolicyURLInput
    
    Returns:
    
    PreSignedPolicyURLOutput
    
    Throws:
    
    TosException
  - createBucket
```
public CreateBucketOutput createBucket(CreateBucketInput input)
                                throws TosException
```
    Description copied from interface: TOS
    
    create a new bucket
    
    Specified by:
    
    createBucket in interface TOS
    
    Parameters:
    
    input - require input's bucketName not null
    
    Returns:
    
    CreateBucketOutput
    
    Throws:
    
    TosException
  - headBucket
```
public HeadBucketOutput headBucket(String bucket)
                            throws TosException
```
    Description copied from interface: TOS
    
    get bucket's meta data
    
    Specified by:
    
    headBucket in interface TOS
    
    Parameters:
    
    bucket - bucket name
    
    Returns:
    
    HeadBucketOutput
    
    Throws:
    
    TosException
  - listBuckets
```
public ListBucketsOutput listBuckets(ListBucketsInput input)
                              throws TosException
```
    Description copied from interface: TOS
    
    list existed bucket owned by you.
    
    Specified by:
    
    listBuckets in interface TOS
    
    Parameters:
    
    input - no params required
    
    Returns:
    
    ListBucketsOutput
    
    Throws:
    
    TosException
  - getObject
```
public GetObjectOutput getObject(String bucket,
                                 String objectKey,
                                 RequestOptionsBuilder... builders)
                          throws TosException
```
    Description copied from interface: TOS
    
    get data and metadata of an object
    
    Specified by:
    
    getObject in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    objectKey - the name of object
    
    builders - optional. setting withXXX properties. withVersionID: which version of this object. withRange: the range of content. withIfModifiedSince: return if the object modified after the given date, otherwise return status code 304. withIfUnmodifiedSince, withIfMatch, withIfNoneMatch set If-Unmodified-Since, If-Match and If-None-Match.
    
    Returns:
    
    GetObjectOutput
    
    Throws:
    
    TosException
  - headObject
```
public HeadObjectOutput headObject(String bucket,
                                   String objectKey,
                                   RequestOptionsBuilder... builders)
                            throws TosException
```
    Description copied from interface: TOS
    
    get metadata of an object with its data stream
    
    Specified by:
    
    headObject in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    objectKey - the name of object
    
    builders - optional. setting withXXX properties. withVersionID: which version of this object. withRange: the range of content. withIfModifiedSince: return if the object modified after the given date, otherwise return status code 304. withIfUnmodifiedSince, withIfMatch, withIfNoneMatch set If-Unmodified-Since, If-Match and If-None-Match.
    
    Returns:
    
    HeadObjectOutput
    
    Throws:
    
    TosException
  - deleteObject
```
public DeleteObjectOutput deleteObject(String bucket,
                                       String objectKey,
                                       RequestOptionsBuilder... builders)
                                throws TosException
```
    Description copied from interface: TOS
    
    delete an object
    
    Specified by:
    
    deleteObject in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    objectKey - the name of object
    
    builders - optional. setting withXXX properties. withVersionID: which version of this object will be deleted
    
    Returns:
    
    DeleteObjectOutput
    
    Throws:
    
    TosException
  - deleteMultiObjects
```
public DeleteMultiObjectsOutput deleteMultiObjects(String bucket,
                                                   DeleteMultiObjectsInput input,
                                                   RequestOptionsBuilder... builders)
                                            throws TosException
```
    Description copied from interface: TOS
    
    delete a list of objects
    
    Specified by:
    
    deleteMultiObjects in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    input - the objects to be deleted
    
    builders - optional. setting withXXX properties.
    
    Returns:
    
    DeleteMultiObjectsOutput
    
    Throws:
    
    TosException
  - putObject
```
public PutObjectOutput putObject(String bucket,
                                 String objectKey,
                                 InputStream inputStream,
                                 RequestOptionsBuilder... builders)
                          throws TosException
```
    Description copied from interface: TOS
    
    upload an object to TOS server
    
    Specified by:
    
    putObject in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    objectKey - the name of object
    
    inputStream - the content of object
    
    builders - optional. setting withXXX properties. withContentType: set Content-Type. withContentDisposition: set Content-Disposition. withContentLanguage: set Content-Language. withContentEncoding: set Content-Encoding. withCacheControl: set Cache-Control. withExpires: set Expires. withMeta: set meta header(s). withContentSHA256: set Content-Sha256. withContentMD5: set Content-MD5. withExpires: set Expires. withServerSideEncryptionCustomer: set server side encryption options. withACL, withACLGrantFullControl, withACLGrantRead, withACLGrantReadAcp, withACLGrantWrite, withACLGrantWriteAcp set object acl. withStorageClass set storage class, 'STANDARD|IA'
    
    Returns:
    
    PutObjectOutput
    
    Throws:
    
    TosException
  - uploadFile
```
public UploadFileOutput uploadFile(String bucket,
                                   UploadFileInput input,
                                   RequestOptionsBuilder... builders)
                            throws TosException
```
    Specified by:
    
    uploadFile in interface TOS
    
    Throws:
    
    TosException
  - appendObject
```
public AppendObjectOutput appendObject(String bucket,
                                       String objectKey,
                                       InputStream content,
                                       long offset,
                                       RequestOptionsBuilder... builders)
                                throws TosException
```
    Description copied from interface: TOS
    
    append content at the tail of an appendable object
    
    Specified by:
    
    appendObject in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    objectKey - the name of object
    
    content - the content of object
    
    offset - append position, equals to the current object-size
    
    builders - optional. setting withXXX properties. withContentType: set Content-Type. withContentDisposition: set Content-Disposition. withContentLanguage: set Content-Language. withContentEncoding: set Content-Encoding. withCacheControl: set Cache-Control. withExpires: set Expires. withMeta: set meta header(s). withExpires: set Expires. withACL, withACLGrantFullControl, withACLGrantRead, withACLGrantReadAcp, withACLGrantWrite, withACLGrantWriteAcp set object acl. withStorageClass set storage class, 'STANDARD|IA' above options only take effect when offset parameter is 0. withContentSHA256: set Content-Sha256. withContentMD5: set Content-MD5.
    
    Returns:
    
    AppendObjectOutput
    
    Throws:
    
    TosException
  - setObjectMeta
```
public SetObjectMetaOutput setObjectMeta(String bucket,
                                         String objectKey,
                                         RequestOptionsBuilder... builders)
                                  throws TosException
```
    Description copied from interface: TOS
    
    set some metadata of the object
    
    Specified by:
    
    setObjectMeta in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    objectKey - the name of object
    
    builders - optional. setting withXXX properties. withContentType set Content-Type. withContentDisposition set Content-Disposition. withContentLanguage set Content-Languag. withContentEncoding set Content-Encoding. withCacheControl set Cache-Control. withExpires set Expires. withMeta set meta header(s). withVersionID which version of this object will be set
    
    Returns:
    
    SetObjectMetaOutput
    
    Throws:
    
    TosException
  - listObjects
```
public ListObjectsOutput listObjects(String bucket,
                                     ListObjectsInput input)
                              throws TosException
```
    Description copied from interface: TOS
    
    list objects of a bucket
    
    Specified by:
    
    listObjects in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    input - query params
    
    Returns:
    
    ListObjectsOutput
    
    Throws:
    
    TosException
  - listObjectVersions
```
public ListObjectVersionsOutput listObjectVersions(String bucket,
                                                   ListObjectVersionsInput input)
                                            throws TosException
```
    Description copied from interface: TOS
    
    list multi-version objects of a bucket
    
    Specified by:
    
    listObjectVersions in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    input - query params
    
    Returns:
    
    ListObjectVersionsOutput
    
    Throws:
    
    TosException
  - copyObject
```
public CopyObjectOutput copyObject(String bucket,
                                   String srcObjectKey,
                                   String dstObjectKey,
                                   RequestOptionsBuilder... builders)
                            throws TosException
```
    Description copied from interface: TOS
    
    copy an object in the same bucket
    
    Specified by:
    
    copyObject in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    srcObjectKey - the source object name
    
    dstObjectKey - the destination object name NOTICE: srcObjectKey and dstObjectKey belongs to the same bucket.
    
    builders - optional. setting withXXX properties. withVersionID the version id of source object. withMetadataDirective copy source object metadata or replace with new object metadata. withACL withACLGrantFullControl withACLGrantRead withACLGrantReadAcp withACLGrantWrite withACLGrantWriteAcp set object acl. withCopySourceIfMatch withCopySourceIfNoneMatch withCopySourceIfModifiedSince withCopySourceIfUnmodifiedSince set copy conditions. withStorageClass set storage class, 'STANDARD|IA' withServerSideEncryptionCustomer: Copy SSE-C加密对象，源对象的加密算法、加密密钥、密钥MD5 if copyObject called with withMetadataDirective(TosHeaders.METADATA_DIRECTIVE_REPLACE), these properties can be used: withContentType set Content-Type. withContentDisposition set Content-Disposition. withContentLanguage set Content-Language. withContentEncoding set Content-Encoding. withCacheControl set Cache-Control. withExpires set Expires. withMeta set meta header(s),
    
    Returns:
    
    CopyObjectOutput
    
    Throws:
    
    TosException
  - copyObjectTo
```
public CopyObjectOutput copyObjectTo(String bucket,
                                     String dstBucket,
                                     String dstObjectKey,
                                     String srcObjectKey,
                                     RequestOptionsBuilder... builders)
                              throws TosException
```
    Description copied from interface: TOS
    
    copy an object from bucket A to bucket B, the method is called by bucket A.
    
    Specified by:
    
    copyObjectTo in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    dstBucket - the destination bucket
    
    dstObjectKey - the destination object name
    
    srcObjectKey - the source object name
    
    builders - optional. setting withXXX properties. withVersionID the version id of source object. withMetadataDirective copy source object metadata or replace with new object metadata. withACL withACLGrantFullControl withACLGrantRead withACLGrantReadAcp withACLGrantWrite withACLGrantWriteAcp set object acl. withCopySourceIfMatch withCopySourceIfNoneMatch withCopySourceIfModifiedSince withCopySourceIfUnmodifiedSince set copy conditions. withStorageClass set storage class, 'STANDARD|IA' withServerSideEncryptionCustomer: Copy SSE-C加密对象，源对象的加密算法、加密密钥、密钥MD5 if copyObjectTo called with withMetadataDirective(TosHeaders.METADATA_DIRECTIVE_REPLACE), these properties can be used: withContentType set Content-Type. withContentDisposition set Content-Disposition. withContentLanguage set Content-Language. withContentEncoding set Content-Encoding. withCacheControl set Cache-Control. withExpires set Expires. withMeta set meta header(s).
    
    Returns:
    
    CopyObjectOutput
    
    Throws:
    
    TosException
  - copyObjectFrom
```
public CopyObjectOutput copyObjectFrom(String bucket,
                                       String srcBucket,
                                       String srcObjectKey,
                                       String dstObjectKey,
                                       RequestOptionsBuilder... builders)
                                throws TosException
```
    Description copied from interface: TOS
    
    copy an object from bucket A to bucket B, the method is called by bucket B.
    
    Specified by:
    
    copyObjectFrom in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    srcBucket - the source bucket
    
    srcObjectKey - the source object name
    
    dstObjectKey - the destination object name
    
    builders - optional. setting withXXX properties. withVersionID the version id of source object. withMetadataDirective copy source object metadata or replace with new object metadata. withACL withACLGrantFullControl withACLGrantRead withACLGrantReadAcp withACLGrantWrite withACLGrantWriteAcp set object acl. withCopySourceIfMatch withCopySourceIfNoneMatch withCopySourceIfModifiedSince withCopySourceIfUnmodifiedSince set copy conditions. withStorageClass set storage class, 'STANDARD|IA' withServerSideEncryptionCustomer: Copy SSE-C加密对象，源对象的加密算法、加密密钥、密钥MD5 if copyObjectFrom called with withMetadataDirective(TosHeaders.METADATA_DIRECTIVE_REPLACE), these properties can be used: withContentType set Content-Type. withContentDisposition set Content-Disposition. withContentLanguage set Content-Language. withContentEncoding set Content-Encoding. withCacheControl set Cache-Control. withExpires set Expires. withMeta set meta header(s).
    
    Returns:
    
    CopyObjectOutput
    
    Throws:
    
    TosException
  - uploadPartCopy
```
public UploadPartCopyOutput uploadPartCopy(String bucket,
                                           UploadPartCopyInput input,
                                           RequestOptionsBuilder... builders)
                                    throws TosException
```
    Description copied from interface: TOS
    
    copy a part of object as a part of a multipart upload operation
    
    Specified by:
    
    uploadPartCopy in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    input - uploadID, destinationKey, sourceBucket, sourceKey, partNumber, partSize and startOffset are inclusive, other parameters are optional.
    
    builders - optional. setting withXXX properties. withCopySourceIfMatch, withCopySourceIfNoneMatch, withCopySourceIfModifiedSince and withCopySourceIfUnmodifiedSince set copy conditions withServerSideEncryption: set server side encryption algorithm, 'AES256'. withServerSideEncryptionCustomer: Copy SSE-C加密对象，源对象的加密算法、加密密钥、密钥MD5
    
    Returns:
    
    UploadPartCopyOutput
    
    Throws:
    
    TosException
  - putObjectAcl
```
public PutObjectAclOutput putObjectAcl(String bucket,
                                       PutObjectAclInput input)
                                throws TosException
```
    Description copied from interface: TOS
    
    set object's acl grants or rules
    
    Specified by:
    
    putObjectAcl in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    input - aclGrant, aclRules can not set both.
    
    Returns:
    
    PutObjectAclOutput
    
    Throws:
    
    TosException
  - getObjectAcl
```
public GetObjectAclOutput getObjectAcl(String bucket,
                                       String objectKey,
                                       RequestOptionsBuilder... builders)
                                throws TosException
```
    Description copied from interface: TOS
    
    get object's acl grants or rules
    
    Specified by:
    
    getObjectAcl in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    objectKey - the name of object
    
    builders - optional. setting withXXX properties. withVersionID the version of the object
    
    Returns:
    
    GetObjectAclOutput
    
    Throws:
    
    TosException
  - createMultipartUpload
```
public CreateMultipartUploadOutput createMultipartUpload(String bucket,
                                                         String objectKey,
                                                         RequestOptionsBuilder... builders)
                                                  throws TosException
```
    Description copied from interface: TOS
    
    create a multipart upload operation
    
    Specified by:
    
    createMultipartUpload in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    objectKey - the name of object
    
    builders - optional. setting withXXX properties. withContentType set Content-Type. withContentDisposition set Content-Disposition. withContentLanguage set Content-Language. withContentEncoding set Content-Encoding. withCacheControl set Cache-Control. withExpires set Expires. withMeta set meta header(s). withContentSHA256 set Content-Sha256. withContentMD5 set Content-MD5. withExpires set Expires. withServerSideEncryptionCustomer set server side encryption options. withACL, WithACLGrantFullControl, withACLGrantRead, withACLGrantReadAcp, withACLGrantWrite, withACLGrantWriteAcp set object acl. withStorageClass set storage class, 'STANDARD|IA'. withServerSideEncryption: set server side encryption algorithm, 'AES256'.
    
    Returns:
    
    CreateMultipartUploadOutput
    
    Throws:
    
    TosException
  - uploadPart
```
public UploadPartOutput uploadPart(String bucket,
                                   UploadPartInput input,
                                   RequestOptionsBuilder... builders)
                            throws TosException
```
    Description copied from interface: TOS
    
    upload a part for a multipart upload operation
    
    Specified by:
    
    uploadPart in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    input - some params are required, eg, key, uploadID, partSize, partNumber and partNumber
    
    builders - optional. setting withXXX properties.
    
    Returns:
    
    UploadPartOutput
    
    Throws:
    
    TosException
  - completeMultipartUpload
```
public CompleteMultipartUploadOutput completeMultipartUpload(String bucket,
                                                             CompleteMultipartUploadInput input)
                                                      throws TosException
```
    Description copied from interface: TOS
    
    complete a multipart upload operation
    
    Specified by:
    
    completeMultipartUpload in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    input - key: the object name, uploadID: the uploadID got from CreateMultipartUpload, uploadedParts: upload part output got from uploadPart or uploadPartCopy
    
    Returns:
    
    CompleteMultipartUploadOutput
    
    Throws:
    
    TosException
  - abortMultipartUpload
```
public AbortMultipartUploadOutput abortMultipartUpload(String bucket,
                                                       AbortMultipartUploadInput input)
                                                throws TosException
```
    Description copied from interface: TOS
    
    abort a multipart upload operation
    
    Specified by:
    
    abortMultipartUpload in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    Returns:
    
    AbortMultipartUploadOutput
    
    Throws:
    
    TosException
  - listUploadedParts
```
public ListUploadedPartsOutput listUploadedParts(String bucket,
                                                 ListUploadedPartsInput input,
                                                 RequestOptionsBuilder... builders)
                                          throws TosException
```
    Description copied from interface: TOS
    
    list parts that have been uploaded.
    
    Specified by:
    
    listUploadedParts in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    input - key, uploadID and other parameters
    
    builders - optional. setting withXXX properties.
    
    Returns:
    
    ListUploadedPartsOutput
    
    Throws:
    
    TosException
  - listMultipartUploads
```
public ListMultipartUploadsOutput listMultipartUploads(String bucket,
                                                       ListMultipartUploadsInput input)
                                                throws TosException
```
    Description copied from interface: TOS
    
    list multipart uploads
    
    Specified by:
    
    listMultipartUploads in interface TOS
    
    Parameters:
    
    bucket - the bucket to operate
    
    input - ListMultipartUploadsInput
    
    Returns:
    
    ListMultipartUploadsOutput
    
    Throws:
    
    TosException
  - preSignedURL
```
public String preSignedURL(String httpMethod,
                           String bucket,
                           String objectKey,
                           Duration ttl,
                           RequestOptionsBuilder... builders)
                    throws TosException
```
    Description copied from interface: TOS
    
    create a pre-signed URL
    
    Specified by:
    
    preSignedURL in interface TOS
    
    Parameters:
    
    httpMethod - the http method in the URL, such as GET, POST, PUT, HEAD
    
    bucket - the bucket to operate
    
    objectKey - the object name
    
    ttl - the time-to-live of signed URL
    
    builders - withVersionID the version id of the object
    
    Returns:
    
    Throws:
    
    TosException

Class TOSV2Client

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TOSV2Client

Method Detail

changeCredentials

getConfig

getFactory

changeRegionAndEndpoint

changeTransportConfig

createBucket

createBucket

headBucket

deleteBucket

deleteBucket

listBuckets

putBucketPolicy

putBucketPolicy

getBucketPolicy

getBucketPolicy

deleteBucketPolicy

deleteBucketPolicy

putBucketCORS

getBucketCORS

deleteBucketCORS

putBucketStorageClass

getBucketLocation

putBucketLifecycle

getBucketLifecycle

deleteBucketLifecycle

putBucketMirrorBack

getBucketMirrorBack

deleteBucketMirrorBack

putBucketReplication

getBucketReplication

deleteBucketReplication

putBucketVersioning

getBucketVersioning

putBucketWebsite

getBucketWebsite

deleteBucketWebsite

putBucketNotification

getBucketNotification

putBucketCustomDomain

listBucketCustomDomain

deleteBucketCustomDomain

putBucketRealTimeLog

getBucketRealTimeLog

deleteBucketRealTimeLog

putBucketACL

getBucketACL

putBucketRename

getBucketRename

deleteBucketRename

getObject

getObjectToFile

uploadFile

downloadFile

resumableCopyObject

headObject

deleteObject

deleteMultiObjects

putObject

putObjectFromFile

appendObject

setObjectMeta

listObjects

listObjectsType2

listObjectVersions

copyObject

uploadPartCopy

putObjectAcl

getObjectAcl

putObjectTagging

getObjectTagging

deleteObjectTagging

fetchObject

putFetchTask