com.volcengine.tos

Interface TOSV2

All Superinterfaces:

TOS

All Known Implementing Classes:

TOSV2Client

public interface TOSV2
extends TOS

Method Summary

Modifier and Type	Method and Description
AbortMultipartUploadOutput	abortMultipartUpload(AbortMultipartUploadInput input) abort a multipart upload operation
AppendObjectOutput	appendObject(AppendObjectInput input) append content at the tail of an appendable object
CompleteMultipartUploadV2Output	completeMultipartUpload(CompleteMultipartUploadV2Input input) complete a multipart upload operation
CopyObjectV2Output	copyObject(CopyObjectV2Input input) copy an object in the same 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
DeleteBucketOutput	deleteBucket(DeleteBucketInput input) delete an existed bucket
DeleteBucketPolicyOutput	deleteBucketPolicy(DeleteBucketPolicyInput input) delete the policy of a bucket
DeleteBucketPolicyOutput	deleteBucketPolicy(String bucket) delete the policy of a bucket
DeleteMultiObjectsV2Output	deleteMultiObjects(DeleteMultiObjectsV2Input input) delete a list of objects
DeleteObjectOutput	deleteObject(DeleteObjectInput input) delete an object
DownloadFileOutput	downloadFile(DownloadFileInput input)
GetBucketPolicyOutput	getBucketPolicy(GetBucketPolicyInput input) get policy of a bucket
GetBucketPolicyOutput	getBucketPolicy(String bucket) get policy of a bucket
GetObjectV2Output	getObject(GetObjectV2Input input) get data and metadata of an object
GetObjectACLV2Output	getObjectAcl(GetObjectACLV2Input input) get object's acl grants or rules
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
HeadObjectV2Output	headObject(HeadObjectV2Input input) get metadata of an object with its data stream
ListBucketsV2Output	listBuckets(ListBucketsV2Input input) list existed bucket owned by you.
ListMultipartUploadsV2Output	listMultipartUploads(ListMultipartUploadsV2Input input) list multiparts uploading
ListObjectsV2Output	listObjects(ListObjectsV2Input input) list objects of a bucket
ListObjectVersionsV2Output	listObjectVersions(ListObjectVersionsV2Input input) list multi-version objects of a bucket
ListPartsOutput	listParts(ListPartsInput input) list parts that have been uploaded.
PreSignedURLOutput	preSignedURL(PreSignedURLInput input) create a pre-signed URL
PutBucketPolicyOutput	putBucketPolicy(PutBucketPolicyInput input) set bucket policy
PutBucketPolicyOutput	putBucketPolicy(String bucket, String policy) set bucket policy
PutObjectOutput	putObject(PutObjectInput input) upload an object to TOS server
PutObjectACLOutput	putObjectAcl(PutObjectACLInput input) set object's acl grants or rules
PutObjectFromFileOutput	putObjectFromFile(PutObjectFromFileInput input) upload an object to TOS server from file
SetObjectMetaOutput	setObjectMeta(SetObjectMetaInput input) set some metadata of the object
UploadFileV2Output	uploadFile(UploadFileV2Input input)
UploadPartV2Output	uploadPart(UploadPartV2Input input) upload a part for 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 interface com.volcengine.tos.TOS

abortMultipartUpload, appendObject, completeMultipartUpload, copyObject, copyObjectFrom, copyObjectTo, createBucket, createMultipartUpload, deleteBucket, deleteMultiObjects, deleteObject, getObject, getObjectAcl, headBucket, headObject, listBuckets, listMultipartUploads, listObjects, listObjectVersions, listUploadedParts, preSignedURL, putObject, putObjectAcl, setObjectMeta, uploadFile, uploadPart, uploadPartCopy

Method Detail

createBucket

CreateBucketV2Output createBucket(String bucket)
                           throws TosException

create a new bucket

Parameters:

bucket - require input's bucketName not null

Returns:

CreateBucketV2Output

Throws:

TosException

createBucket

CreateBucketV2Output createBucket(CreateBucketV2Input input)
                           throws TosException

create a new bucket

Parameters:

input - require input's bucketName not null

Returns:

CreateBucketV2Output

Throws:

TosException

headBucket

HeadBucketV2Output headBucket(HeadBucketV2Input input)
                       throws TosException

get bucket's meta data

Parameters:

input - bucket name

Returns:

HeadBucketOutput

Throws:

TosException

deleteBucket

DeleteBucketOutput deleteBucket(DeleteBucketInput input)
                         throws TosException

delete an existed bucket

Parameters:

input - bucket name

Returns:

DeleteBucketOutput

Throws:

TosException

listBuckets

ListBucketsV2Output listBuckets(ListBucketsV2Input input)
                         throws TosException

list existed bucket owned by you.

Parameters:

input - no params required

Returns:

ListBucketsV2Output

Throws:

TosException

putBucketPolicy

PutBucketPolicyOutput putBucketPolicy(String bucket,
                                      String policy)
                               throws TosException

set bucket policy

Specified by:

putBucketPolicy in interface TOS

Parameters:

bucket - bucket name

policy - bucket policy

Returns:

PutBucketPolicyOutput

Throws:

TosException

putBucketPolicy

PutBucketPolicyOutput putBucketPolicy(PutBucketPolicyInput input)
                               throws TosException

set bucket policy

Parameters:

input - set bucket name and bucket policy

Returns:

PutBucketPolicyOutput

Throws:

TosException

getBucketPolicy

GetBucketPolicyOutput getBucketPolicy(String bucket)
                               throws TosException

get policy of a bucket

Specified by:

getBucketPolicy in interface TOS

Parameters:

bucket - bucket name

Returns:

GetBucketPolicyOutput

Throws:

TosException

getBucketPolicy

GetBucketPolicyOutput getBucketPolicy(GetBucketPolicyInput input)
                               throws TosException

get policy of a bucket

Parameters:

input - set bucket name

Returns:

GetBucketPolicyOutput

Throws:

TosException

deleteBucketPolicy

DeleteBucketPolicyOutput deleteBucketPolicy(String bucket)
                                     throws TosException

delete the policy of a bucket

Specified by:

deleteBucketPolicy in interface TOS

Parameters:

bucket - bucket name

Returns:

DeleteBucketPolicyOutput

Throws:

TosException

deleteBucketPolicy

DeleteBucketPolicyOutput deleteBucketPolicy(DeleteBucketPolicyInput input)
                                     throws TosException

delete the policy of a bucket

Parameters:

input - set bucket name

Returns:

DeleteBucketPolicyOutput

Throws:

TosException

getObject

GetObjectV2Output getObject(GetObjectV2Input input)
                     throws TosException

get data and metadata of an object

Parameters:

input - set get object options

Returns:

GetObjectV2Output

Throws:

TosException

getObjectToFile

GetObjectToFileOutput getObjectToFile(GetObjectToFileInput input)
                               throws TosException

get data and metadata of an object and store into a local file

Parameters:

input - set get object options

Returns:

GetObjectToFileOutput

Throws:

TosException

uploadFile

UploadFileV2Output uploadFile(UploadFileV2Input input)
                       throws TosException

Throws:

TosException

downloadFile

DownloadFileOutput downloadFile(DownloadFileInput input)
                         throws TosException

Throws:

TosException

headObject

HeadObjectV2Output headObject(HeadObjectV2Input input)
                       throws TosException

get metadata of an object with its data stream

Parameters:

input - set head object options

Returns:

HeadObjectV2Output

Throws:

TosException

deleteObject

DeleteObjectOutput deleteObject(DeleteObjectInput input)
                         throws TosException

delete an object

Parameters:

input - set delete object options

Returns:

DeleteObjectOutput

Throws:

TosException

deleteMultiObjects

DeleteMultiObjectsV2Output deleteMultiObjects(DeleteMultiObjectsV2Input input)
                                       throws TosException

delete a list of objects

Parameters:

input - set delete multi objects options

Returns:

DeleteMultiObjectsV2Output

Throws:

TosException

putObject

PutObjectOutput putObject(PutObjectInput input)
                   throws TosException

upload an object to TOS server

Parameters:

input - set put object option

Returns:

PutObjectOutput

Throws:

TosException

putObjectFromFile

PutObjectFromFileOutput putObjectFromFile(PutObjectFromFileInput input)
                                   throws TosException

upload an object to TOS server from file

Parameters:

input - set put object option

Returns:

PutObjectFromFileOutput

Throws:

TosException

appendObject

AppendObjectOutput appendObject(AppendObjectInput input)
                         throws TosException

append content at the tail of an appendable object

Parameters:

input - set append object option

Returns:

AppendObjectOutput

Throws:

TosException

setObjectMeta

SetObjectMetaOutput setObjectMeta(SetObjectMetaInput input)
                           throws TosException

set some metadata of the object

Parameters:

input - set setObjectMeta option

Returns:

SetObjectMetaOutput

Throws:

TosException

listObjects

ListObjectsV2Output listObjects(ListObjectsV2Input input)
                         throws TosException

list objects of a bucket

Parameters:

input - list object options

Returns:

ListObjectsV2Output

Throws:

TosException

listObjectVersions

ListObjectVersionsV2Output listObjectVersions(ListObjectVersionsV2Input input)
                                       throws TosException

list multi-version objects of a bucket

Parameters:

input - query params

Returns:

ListObjectVersionsV2Output

Throws:

TosException

copyObject

CopyObjectV2Output copyObject(CopyObjectV2Input input)
                       throws TosException

copy an object in the same bucket

Parameters:

input - set copy object option

Returns:

CopyObjectV2Output

Throws:

TosException

uploadPartCopy

UploadPartCopyV2Output uploadPartCopy(UploadPartCopyV2Input input)
                               throws TosException

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

Parameters:

input -

Returns:

UploadPartCopyV2Output

Throws:

TosException

putObjectAcl

PutObjectACLOutput putObjectAcl(PutObjectACLInput input)
                         throws TosException

set object's acl grants or rules

Parameters:

input - set acl option.

Returns:

PutObjectACLOutput

Throws:

TosException

getObjectAcl

GetObjectACLV2Output getObjectAcl(GetObjectACLV2Input input)
                           throws TosException

get object's acl grants or rules

Parameters:

input - set acl option.

Returns:

GetObjectACLV2Output

Throws:

TosException

createMultipartUpload

CreateMultipartUploadOutput createMultipartUpload(CreateMultipartUploadInput input)
                                           throws TosException

create a multipart upload operation

Parameters:

input - set the createMultipartUpload option

Returns:

CreateMultipartUploadOutput

Throws:

TosException

uploadPart

UploadPartV2Output uploadPart(UploadPartV2Input input)
                       throws TosException

upload a part for a multipart upload operation

Parameters:

input - set uploadpart option

Returns:

UploadPartV2Output

Throws:

TosException

uploadPartFromFile

UploadPartFromFileOutput uploadPartFromFile(UploadPartFromFileInput input)
                                     throws TosException

upload a part from file for a multipart upload operation

Parameters:

input - set uploadpart option

Returns:

UploadPartFromFileOutput

Throws:

TosException

completeMultipartUpload

CompleteMultipartUploadV2Output completeMultipartUpload(CompleteMultipartUploadV2Input input)
                                                 throws TosException

complete a multipart upload operation

Parameters:

input - set completeMultipartUpload option

Returns:

CompleteMultipartUploadV2Output

Throws:

TosException

abortMultipartUpload

AbortMultipartUploadOutput abortMultipartUpload(AbortMultipartUploadInput input)
                                         throws TosException

abort a multipart upload operation

Parameters:

input - set abortMultipartUpload option

Returns:

AbortMultipartUploadOutput

Throws:

TosException

listParts

ListPartsOutput listParts(ListPartsInput input)
                   throws TosException

list parts that have been uploaded.

Parameters:

input - set listParts option

Returns:

ListPartsOutput

Throws:

TosException

listMultipartUploads

ListMultipartUploadsV2Output listMultipartUploads(ListMultipartUploadsV2Input input)
                                           throws TosException

list multiparts uploading

Parameters:

input - ListMultipartUploadsInput

Returns:

ListMultipartUploadsV2Output

Throws:

TosException

preSignedURL

PreSignedURLOutput preSignedURL(PreSignedURLInput input)
                         throws TosException

create a pre-signed URL

Parameters:

input - PreSignedURLInput

Returns:

PreSignedURLOutput

Throws:

TosException