com.volcengine.tos

接口 TOS

所有已知子接口:

TOSV2

所有已知实现类:

TOSClient, TOSV2Client

已过时。

@Deprecated
public interface TOS

作者:

volcengine tos

方法概要

限定符和类型	方法和说明
AbortMultipartUploadOutput	abortMultipartUpload(String bucket, AbortMultipartUploadInput input) 已过时。 abort a multipart upload operation
AppendObjectOutput	appendObject(String bucket, String objectKey, InputStream content, long offset, RequestOptionsBuilder... builders) 已过时。 append content at the tail of an appendable object
CompleteMultipartUploadOutput	completeMultipartUpload(String bucket, CompleteMultipartUploadInput input) 已过时。 complete a multipart upload operation
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
CreateMultipartUploadOutput	createMultipartUpload(String bucket, String objectKey, RequestOptionsBuilder... builders) 已过时。 create a multipart upload operation
DeleteBucketOutput	deleteBucket(String bucket) 已过时。 delete an existed bucket
DeleteBucketPolicyOutput	deleteBucketPolicy(String bucket) 已过时。 删除桶策略
DeleteMultiObjectsOutput	deleteMultiObjects(String bucket, DeleteMultiObjectsInput input, RequestOptionsBuilder... builders) 已过时。 delete a list of objects
DeleteObjectOutput	deleteObject(String bucket, String objectKey, RequestOptionsBuilder... builders) 已过时。 delete an object
GetBucketPolicyOutput	getBucketPolicy(String bucket) 已过时。 获取桶策略
GetObjectOutput	getObject(String bucket, String objectKey, RequestOptionsBuilder... builders) 已过时。 get data and metadata of an object
GetObjectAclOutput	getObjectAcl(String bucket, String objectKey, RequestOptionsBuilder... builders) 已过时。 get object's acl grants or rules
HeadBucketOutput	headBucket(String bucket) 已过时。 get bucket's meta data
HeadObjectOutput	headObject(String bucket, String objectKey, RequestOptionsBuilder... builders) 已过时。 get metadata of an object with its data stream
ListBucketsOutput	listBuckets(ListBucketsInput input) 已过时。 list existed bucket owned by you.
ListMultipartUploadsOutput	listMultipartUploads(String bucket, ListMultipartUploadsInput input) 已过时。 list multipart uploads
ListObjectsOutput	listObjects(String bucket, ListObjectsInput input) 已过时。 list objects of a bucket
ListObjectVersionsOutput	listObjectVersions(String bucket, ListObjectVersionsInput input) 已过时。 list multi-version objects of a bucket
ListUploadedPartsOutput	listUploadedParts(String bucket, ListUploadedPartsInput input, RequestOptionsBuilder... builders) 已过时。 list parts that have been uploaded.
String	preSignedURL(String httpMethod, String bucket, String objectKey, Duration ttl, RequestOptionsBuilder... builders) 已过时。 create a pre-signed URL
PutBucketPolicyOutput	putBucketPolicy(String bucket, String policy) 已过时。 设置桶策略
PutObjectOutput	putObject(String bucket, String objectKey, InputStream inputStream, RequestOptionsBuilder... builders) 已过时。 upload an object to TOS server
PutObjectAclOutput	putObjectAcl(String bucket, PutObjectAclInput input) 已过时。 set object's acl grants or rules
SetObjectMetaOutput	setObjectMeta(String bucket, String objectKey, RequestOptionsBuilder... builders) 已过时。 set some metadata of the object
UploadFileOutput	uploadFile(String bucket, UploadFileInput input, RequestOptionsBuilder... builders) 已过时。
UploadPartOutput	uploadPart(String bucket, UploadPartInput input, RequestOptionsBuilder... builders) 已过时。 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

方法详细资料

createBucket

CreateBucketOutput createBucket(CreateBucketInput input)
                         throws TosException

已过时。

create a new bucket

参数:

input - require input's bucketName not null

返回:

CreateBucketOutput

抛出:

TosException

headBucket

HeadBucketOutput headBucket(String bucket)
                     throws TosException

已过时。

get bucket's meta data

参数:

bucket - bucket name

返回:

HeadBucketOutput

抛出:

TosException

deleteBucket

DeleteBucketOutput deleteBucket(String bucket)
                         throws TosException

已过时。

delete an existed bucket

参数:

bucket - bucket name

返回:

DeleteBucketOutput

抛出:

TosException

listBuckets

ListBucketsOutput listBuckets(ListBucketsInput input)
                       throws TosException

已过时。

list existed bucket owned by you.

参数:

input - no params required

返回:

ListBucketsOutput

抛出:

TosException

putBucketPolicy

PutBucketPolicyOutput putBucketPolicy(String bucket,
                                      String policy)
                               throws TosException

已过时。

设置桶策略

参数:

bucket - 桶名

policy - 桶策略

返回:

PutBucketPolicyOutput

抛出:

TosException

getBucketPolicy

GetBucketPolicyOutput getBucketPolicy(String bucket)
                               throws TosException

已过时。

获取桶策略

参数:

bucket - 桶名

返回:

GetBucketPolicyOutput

抛出:

TosException

deleteBucketPolicy

DeleteBucketPolicyOutput deleteBucketPolicy(String bucket)
                                     throws TosException

已过时。

删除桶策略

参数:

bucket - 桶名

返回:

DeleteBucketPolicyOutput

抛出:

TosException

getObject

GetObjectOutput getObject(String bucket,
                          String objectKey,
                          RequestOptionsBuilder... builders)
                   throws TosException

已过时。

get data and metadata of an object

参数:

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.

返回:

GetObjectOutput

抛出:

TosException

headObject

HeadObjectOutput headObject(String bucket,
                            String objectKey,
                            RequestOptionsBuilder... builders)
                     throws TosException

已过时。

get metadata of an object with its data stream

参数:

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.

返回:

HeadObjectOutput

抛出:

TosException

deleteObject

DeleteObjectOutput deleteObject(String bucket,
                                String objectKey,
                                RequestOptionsBuilder... builders)
                         throws TosException

已过时。

delete an object

参数:

bucket - the bucket to operate

objectKey - the name of object

builders - optional. setting withXXX properties. withVersionID: which version of this object will be deleted

返回:

DeleteObjectOutput

抛出:

TosException

deleteMultiObjects

DeleteMultiObjectsOutput deleteMultiObjects(String bucket,
                                            DeleteMultiObjectsInput input,
                                            RequestOptionsBuilder... builders)
                                     throws TosException

已过时。

delete a list of objects

参数:

bucket - the bucket to operate

input - the objects to be deleted

builders - optional. setting withXXX properties.

返回:

DeleteMultiObjectsOutput

抛出:

TosException

putObject

PutObjectOutput putObject(String bucket,
                          String objectKey,
                          InputStream inputStream,
                          RequestOptionsBuilder... builders)
                   throws TosException

已过时。

upload an object to TOS server

参数:

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'

返回:

PutObjectOutput

抛出:

TosException

uploadFile

@Deprecated
UploadFileOutput uploadFile(String bucket,
                                        UploadFileInput input,
                                        RequestOptionsBuilder... builders)
                                 throws TosException

已过时。

抛出:

TosException

appendObject

AppendObjectOutput appendObject(String bucket,
                                String objectKey,
                                InputStream content,
                                long offset,
                                RequestOptionsBuilder... builders)
                         throws TosException

已过时。

append content at the tail of an appendable object

参数:

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.

返回:

AppendObjectOutput

抛出:

TosException

setObjectMeta

SetObjectMetaOutput setObjectMeta(String bucket,
                                  String objectKey,
                                  RequestOptionsBuilder... builders)
                           throws TosException

已过时。

set some metadata of the object

参数:

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

返回:

SetObjectMetaOutput

抛出:

TosException

listObjects

ListObjectsOutput listObjects(String bucket,
                              ListObjectsInput input)
                       throws TosException

已过时。

list objects of a bucket

参数:

bucket - the bucket to operate

input - query params

返回:

ListObjectsOutput

抛出:

TosException

listObjectVersions

ListObjectVersionsOutput listObjectVersions(String bucket,
                                            ListObjectVersionsInput input)
                                     throws TosException

已过时。

list multi-version objects of a bucket

参数:

bucket - the bucket to operate

input - query params

返回:

ListObjectVersionsOutput

抛出:

TosException

copyObject

CopyObjectOutput copyObject(String bucket,
                            String srcObjectKey,
                            String dstObjectKey,
                            RequestOptionsBuilder... builders)
                     throws TosException

已过时。

copy an object in the same bucket

参数:

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),

返回:

CopyObjectOutput

抛出:

TosException

copyObjectTo

CopyObjectOutput copyObjectTo(String bucket,
                              String dstBucket,
                              String dstObjectKey,
                              String srcObjectKey,
                              RequestOptionsBuilder... builders)
                       throws TosException

已过时。

copy an object from bucket A to bucket B, the method is called by bucket A.

参数:

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).

返回:

CopyObjectOutput

抛出:

TosException

copyObjectFrom

CopyObjectOutput copyObjectFrom(String bucket,
                                String srcBucket,
                                String srcObjectKey,
                                String dstObjectKey,
                                RequestOptionsBuilder... builders)
                         throws TosException

已过时。

copy an object from bucket A to bucket B, the method is called by bucket B.

参数:

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).

返回:

CopyObjectOutput

抛出:

TosException

uploadPartCopy

UploadPartCopyOutput uploadPartCopy(String bucket,
                                    UploadPartCopyInput input,
                                    RequestOptionsBuilder... builders)
                             throws TosException

已过时。

copy a part of object as a part of a multipart upload operation

参数:

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

返回:

UploadPartCopyOutput

抛出:

TosException

putObjectAcl

PutObjectAclOutput putObjectAcl(String bucket,
                                PutObjectAclInput input)
                         throws TosException

已过时。

set object's acl grants or rules

参数:

bucket - the bucket to operate

input - aclGrant, aclRules can not set both.

返回:

PutObjectAclOutput

抛出:

TosException

getObjectAcl

GetObjectAclOutput getObjectAcl(String bucket,
                                String objectKey,
                                RequestOptionsBuilder... builders)
                         throws TosException

已过时。

get object's acl grants or rules

参数:

bucket - the bucket to operate

objectKey - the name of object

builders - optional. setting withXXX properties. withVersionID the version of the object

返回:

GetObjectAclOutput

抛出:

TosException

createMultipartUpload

CreateMultipartUploadOutput createMultipartUpload(String bucket,
                                                  String objectKey,
                                                  RequestOptionsBuilder... builders)
                                           throws TosException

已过时。

create a multipart upload operation

参数:

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'.

返回:

CreateMultipartUploadOutput

抛出:

TosException

uploadPart

UploadPartOutput uploadPart(String bucket,
                            UploadPartInput input,
                            RequestOptionsBuilder... builders)
                     throws TosException

已过时。

upload a part for a multipart upload operation

参数:

bucket - the bucket to operate

input - some params are required, eg, key, uploadID, partSize, partNumber and partNumber

builders - optional. setting withXXX properties.

返回:

UploadPartOutput

抛出:

TosException

completeMultipartUpload

CompleteMultipartUploadOutput completeMultipartUpload(String bucket,
                                                      CompleteMultipartUploadInput input)
                                               throws TosException

已过时。

complete a multipart upload operation

参数:

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

返回:

CompleteMultipartUploadOutput

抛出:

TosException

abortMultipartUpload

AbortMultipartUploadOutput abortMultipartUpload(String bucket,
                                                AbortMultipartUploadInput input)
                                         throws TosException

已过时。

abort a multipart upload operation

参数:

bucket - the bucket to operate

input -

返回:

AbortMultipartUploadOutput

抛出:

TosException

listUploadedParts

ListUploadedPartsOutput listUploadedParts(String bucket,
                                          ListUploadedPartsInput input,
                                          RequestOptionsBuilder... builders)
                                   throws TosException

已过时。

list parts that have been uploaded.

参数:

bucket - the bucket to operate

input - key, uploadID and other parameters

builders - optional. setting withXXX properties.

返回:

ListUploadedPartsOutput

抛出:

TosException

listMultipartUploads

ListMultipartUploadsOutput listMultipartUploads(String bucket,
                                                ListMultipartUploadsInput input)
                                         throws TosException

已过时。

list multipart uploads

参数:

bucket - the bucket to operate

input - ListMultipartUploadsInput

返回:

ListMultipartUploadsOutput

抛出:

TosException

preSignedURL

String preSignedURL(String httpMethod,
                    String bucket,
                    String objectKey,
                    Duration ttl,
                    RequestOptionsBuilder... builders)
             throws TosException

已过时。

create a pre-signed URL

参数:

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

返回:

抛出:

TosException