构造器和说明 |
---|
OSSClient(String endpoint,
CredentialsProvider credsProvider)
已过时。
|
OSSClient(String endpoint,
CredentialsProvider credsProvider,
ClientConfiguration config)
Uses the specified
CredentialsProvider , client configuration and
OSS endpoint to create a new OSSClient instance. |
OSSClient(String accessKeyId,
String secretAccessKey)
已过时。
|
OSSClient(String endpoint,
String accessKeyId,
String secretAccessKey)
已过时。
|
OSSClient(String endpoint,
String accessKeyId,
String secretAccessKey,
ClientConfiguration config)
已过时。
|
OSSClient(String endpoint,
String accessKeyId,
String secretAccessKey,
String securityToken)
已过时。
|
OSSClient(String endpoint,
String accessKeyId,
String secretAccessKey,
String securityToken,
ClientConfiguration config)
已过时。
|
限定符和类型 | 方法和说明 |
---|---|
void |
abortMultipartUpload(AbortMultipartUploadRequest request)
Abort a multiple parts upload.
|
void |
addBucketCname(AddBucketCnameRequest addBucketCnameRequest)
Adds a Cname for the
Bucket instance. |
void |
addBucketReplication(AddBucketReplicationRequest addBucketReplicationRequest)
Adds a
Bucket 's cross-region replication rule. |
AppendObjectResult |
appendObject(AppendObjectRequest appendObjectRequest)
Append the data to the appendable object specified in
AppendObjectRequest . |
String |
calculatePostSignature(String postPolicy)
Calculates the signature based on the policy and access key secret.
|
CompleteMultipartUploadResult |
completeMultipartUpload(CompleteMultipartUploadRequest request)
Complete a multiple parts upload.
|
CopyObjectResult |
copyObject(CopyObjectRequest copyObjectRequest)
Copies an existing file in OSS from source bucket to the target bucket.
|
CopyObjectResult |
copyObject(String sourceBucketName,
String sourceKey,
String destinationBucketName,
String destinationKey)
Copies an existing file in OSS from source bucket to the target bucket.
|
Bucket |
createBucket(CreateBucketRequest createBucketRequest)
Creates a
Bucket instance with specified CreateBucketRequest
information. |
Bucket |
createBucket(String bucketName)
Creates
Bucket instance. |
CreateLiveChannelResult |
createLiveChannel(CreateLiveChannelRequest createLiveChannelRequest)
Creates a live streaming channel.
|
SelectObjectMetadata |
createSelectObjectMetadata(CreateSelectObjectMetadataRequest createSelectObjectMetadataRequest)
Create select object metadata(create metadata if not exists or overwrite flag set in
CreateSelectObjectMetadataRequest ) |
void |
createSymlink(CreateSymlinkRequest createSymlinkRequest)
Creates a symbol link to a target file under the bucket---this is not
supported for archive class bucket.
|
void |
createSymlink(String bucketName,
String symLink,
String targetObject)
Creates a symlink link to a target file under the bucket---this is not
supported for archive class bucket.
|
void |
createUdf(CreateUdfRequest createUdfRequest)
Creates UDF
|
void |
createUdfApplication(CreateUdfApplicationRequest createUdfApplicationRequest) |
void |
deleteBucket(GenericRequest genericRequest)
Deletes the
Bucket instance. |
void |
deleteBucket(String bucketName)
Deletes the
Bucket instance. |
void |
deleteBucketCname(DeleteBucketCnameRequest deleteBucketCnameRequest)
Deletes one
Bucket 's specific Cname specified by the parameter
domain. |
void |
deleteBucketCname(String bucketName,
String domain)
Deletes one
Bucket 's Cname specified by the parameter domain. |
void |
deleteBucketCORSRules(GenericRequest genericRequest)
Deletes all CORS rules under the bucket.
|
void |
deleteBucketCORSRules(String bucketName)
Deletes all CORS rules under the bucket.
|
void |
deleteBucketEncryption(GenericRequest genericRequest)
Deletes the server-side encryption configuration from the bucket.
|
void |
deleteBucketEncryption(String bucketName)
Deletes the server-side encryption configuration from the bucket.
|
void |
deleteBucketImage(String bucketName)
Deletes the image processing attributes on the specific
Bucket . |
void |
deleteBucketImage(String bucketName,
GenericRequest genericRequest)
Deletes the image processing attributes on the specific
Bucket . |
void |
deleteBucketLifecycle(GenericRequest genericRequest)
Deletes all the
Bucket 's Lifecycle rules. |
void |
deleteBucketLifecycle(String bucketName)
Deletes all the
Bucket 's Lifecycle rules. |
void |
deleteBucketLogging(GenericRequest genericRequest)
Disables the logging on
Bucket . |
void |
deleteBucketLogging(String bucketName)
Disables the logging on
Bucket . |
void |
deleteBucketPolicy(GenericRequest genericRequest)
Delete policy of the
Bucket instance. |
void |
deleteBucketPolicy(String bucketName)
Delete policy of the
Bucket instance. |
void |
deleteBucketQosInfo(GenericRequest genericRequest)
Deletes the bucket qos info.
|
void |
deleteBucketQosInfo(String bucketName)
Deletes the bucket qos info.
|
void |
deleteBucketReplication(DeleteBucketReplicationRequest deleteBucketReplicationRequest)
Deletes the specified
Bucket 's cross region replication rule. |
void |
deleteBucketReplication(String bucketName,
String replicationRuleID)
Deletes the specified
Bucket 's cross region replication rule. |
void |
deleteBucketTagging(GenericRequest genericRequest)
Clears all the tags of the
Bucket instance. |
void |
deleteBucketTagging(String bucketName)
Clears all the tags of the
Bucket instance。 |
void |
deleteBucketWebsite(GenericRequest genericRequest)
Deletes the
Bucket 's static website configuration, which means
disabling the static website on the bucket. |
void |
deleteBucketWebsite(String bucketName)
Deletes the
Bucket 's static website configuration, which means
disabling the static website on the bucket. |
void |
deleteImageStyle(String bucketName,
String styleName)
Deletes a style named by parameter styleName under
Bucket |
void |
deleteImageStyle(String bucketName,
String styleName,
GenericRequest genericRequest)
Deletes a style named by parameter styleName under
Bucket |
void |
deleteLiveChannel(LiveChannelGenericRequest liveChannelGenericRequest)
Deletes the Live Channel。
|
void |
deleteLiveChannel(String bucketName,
String liveChannel)
Deletes the Live Channel.
|
void |
deleteObject(GenericRequest genericRequest)
Deletes the specified
OSSObject by the GenericRequest
instance. |
void |
deleteObject(String bucketName,
String key)
Deletes the specified
OSSObject by bucket name and object key. |
DeleteObjectsResult |
deleteObjects(DeleteObjectsRequest deleteObjectsRequest)
Batch deletes the specified files under a specific bucket.
|
void |
deleteObjectTagging(GenericRequest genericRequest)
Clears all the tags of the OSS object.
|
void |
deleteObjectTagging(String bucketName,
String key)
Clears all the tags of the OSS object.
|
void |
deleteUdf(UdfGenericRequest genericRequest) |
void |
deleteUdfApplication(UdfGenericRequest genericRequest) |
void |
deleteUdfImage(UdfGenericRequest genericRequest) |
void |
deleteVersion(DeleteVersionRequest deleteVersionRequest)
Deletes a specific version of an object in the specified bucket.
|
void |
deleteVersion(String bucketName,
String key,
String versionId)
Deletes a specific version of the specified object in the specified
bucket.
|
DeleteVersionsResult |
deleteVersions(DeleteVersionsRequest deleteVersionsRequest)
Batch deletes the specified object versions under a specific bucket.
|
boolean |
doesBucketExist(GenericRequest genericRequest)
Checks if the
Bucket exists。 |
boolean |
doesBucketExist(String bucketName)
Checks the
Bucket exists . |
boolean |
doesObjectExist(GenericRequest genericRequest)
|
boolean |
doesObjectExist(GenericRequest genericRequest,
boolean isOnlyInOSS)
|
boolean |
doesObjectExist(HeadObjectRequest headObjectRequest)
已过时。
|
boolean |
doesObjectExist(String bucketName,
String key)
|
boolean |
doesObjectExist(String bucketName,
String key,
boolean isOnlyInOSS)
|
DownloadFileResult |
downloadFile(DownloadFileRequest downloadFileRequest)
File download
Very similar with file upload, this method will split the OSS object into
parts and download them in parallel by a thread pool, though by default
the thread pool only has one thread.
|
String |
generatePostPolicy(Date expiration,
PolicyConditions conds)
Generates the post policy form field in JSON format.
|
URL |
generatePresignedUrl(GeneratePresignedUrlRequest request)
Generates a signed url for accessing the
OSSObject with a
specific HTTP method. |
URL |
generatePresignedUrl(String bucketName,
String key,
Date expiration)
Generates a signed url for accessing the
OSSObject with HTTP GET
method. |
URL |
generatePresignedUrl(String bucketName,
String key,
Date expiration,
HttpMethod method)
Generates a signed url for accessing the
OSSObject with a
specific HTTP method. |
String |
generateRtmpUri(GenerateRtmpUriRequest generateRtmpUriRequest)
Generates a RTMP pushing streaming address in the Live Channel.
|
String |
generateRtmpUri(String bucketName,
String liveChannelName,
String PlaylistName,
long expires)
Generates a RTMP pushing streaming address in the Live Channel.
|
void |
generateVodPlaylist(GenerateVodPlaylistRequest generateVodPlaylistRequest)
Generates a VOD playlist (*.m3u8 file) for the *.ts files with specified
time range under the Live Channel.
|
void |
generateVodPlaylist(String bucketName,
String liveChannelName,
String PlaylistName,
long startTime,
long endTime)
Generates a VOD playlist (*.m3u8 file) for the *.ts files with specified
time range under the Live Channel.
|
GetAsyncFetchTaskResult |
getAsyncFetchTask(GetAsyncFetchTaskRequest getAsyncFetchTaskRequest)
Gets the async fetch task information.
|
GetAsyncFetchTaskResult |
getAsyncFetchTask(String bucketName,
String taskId)
Gets the async fetch task information.
|
AccessControlList |
getBucketAcl(GenericRequest genericRequest)
Gets the Access Control List(ACL) of the
Bucket instance. |
AccessControlList |
getBucketAcl(String bucketName)
Returns the Access control List (ACL) of the
Bucket instance. |
List<CnameConfiguration> |
getBucketCname(GenericRequest genericRequest)
Gets the
Bucket 's Cnames. |
List<CnameConfiguration> |
getBucketCname(String bucketName)
Gets the
Bucket 's Cnames. |
List<SetBucketCORSRequest.CORSRule> |
getBucketCORSRules(GenericRequest genericRequest)
Lists all CORS rules from the bucket.
|
List<SetBucketCORSRequest.CORSRule> |
getBucketCORSRules(String bucketName)
Lists all CORS rules from the bucket.
|
ServerSideEncryptionConfiguration |
getBucketEncryption(GenericRequest genericRequest)
Returns the server-side encryption configuration of a bucket.
|
ServerSideEncryptionConfiguration |
getBucketEncryption(String bucketName)
Returns the server-side encryption configuration of a bucket.
|
GetBucketImageResult |
getBucketImage(String bucketName)
Gets the image processing attributes on the specific
Bucket . |
GetBucketImageResult |
getBucketImage(String bucketName,
GenericRequest genericRequest)
Gets the image processing attributes on the specific
Bucket . |
BucketInfo |
getBucketInfo(GenericRequest genericRequest)
Gets the
Bucket 's basic information as well as its ACL. |
BucketInfo |
getBucketInfo(String bucketName)
Gets the
Bucket 's basic information as well as its ACL. |
List<LifecycleRule> |
getBucketLifecycle(GenericRequest genericRequest)
Gets the
Bucket 's Lifecycle rules. |
List<LifecycleRule> |
getBucketLifecycle(String bucketName)
Gets the
Bucket 's lifecycle rules. |
String |
getBucketLocation(GenericRequest genericRequest)
Returns the datacenter name where the
Bucket instance specified
by GenericRequest is hosted. |
String |
getBucketLocation(String bucketName)
Returns the datacenter name where the
Bucket instance is hosted. |
BucketLoggingResult |
getBucketLogging(GenericRequest genericRequest)
Gets the
Bucket 's logging setting. |
BucketLoggingResult |
getBucketLogging(String bucketName)
Gets the
Bucket 's logging setting. |
BucketMetadata |
getBucketMetadata(GenericRequest genericRequest)
Gets all the metadata of
Bucket . |
BucketMetadata |
getBucketMetadata(String bucketName)
Gets the metadata of
Bucket . |
GetBucketPolicyResult |
getBucketPolicy(GenericRequest genericRequest)
Gets policy text of the
Bucket instance. |
GetBucketPolicyResult |
getBucketPolicy(String bucketName)
Gets policy text of the
Bucket instance. |
BucketProcess |
getBucketProcess(GenericRequest genericRequest)
Get the bucket's image accessing configuration
|
BucketProcess |
getBucketProcess(String bucketName)
Gets the bucket's image accessing configuration.
|
BucketQosInfo |
getBucketQosInfo(GenericRequest genericRequest)
Gets the bucket qos info of the
Bucket . |
BucketQosInfo |
getBucketQosInfo(String bucketName)
Gets the bucket qos info of the
Bucket . |
BucketReferer |
getBucketReferer(GenericRequest genericRequest)
Returns http referer information of the
Bucket specified by
bucket name in GenericRequest object. |
BucketReferer |
getBucketReferer(String bucketName)
Returns http referer information of the
Bucket specified by
bucket name. |
List<ReplicationRule> |
getBucketReplication(GenericRequest genericRequest)
Gets all the
Bucket 's cross region replication rules. |
List<ReplicationRule> |
getBucketReplication(String bucketName)
Gets all the
Bucket 's cross region replication rules. |
List<String> |
getBucketReplicationLocation(GenericRequest genericRequest)
Gets the
Bucket 's replication reachable data centers. |
List<String> |
getBucketReplicationLocation(String bucketName)
Gets the
Bucket 's replication reachable data centers. |
BucketReplicationProgress |
getBucketReplicationProgress(GetBucketReplicationProgressRequest getBucketReplicationProgressRequest)
Gets the
Bucket 's progress of the specified cross region
replication rule. |
BucketReplicationProgress |
getBucketReplicationProgress(String bucketName,
String replicationRuleID)
Gets the
Bucket 's progress of the specified cross region
replication rule. |
GetBucketRequestPaymentResult |
getBucketRequestPayment(GenericRequest genericRequest)
Gets the request payment of the
Bucket . |
GetBucketRequestPaymentResult |
getBucketRequestPayment(String bucketName)
Gets the request payment of the
Bucket . |
BucketStat |
getBucketStat(GenericRequest genericRequest)
Gets the
Bucket 's storage information such as object counts,
storage size and executing multipart uploads. |
BucketStat |
getBucketStat(String bucketName)
Gets the
Bucket 's storage information such as object counts,
storage size and executing multipart uploads. |
UserQos |
getBucketStorageCapacity(GenericRequest genericRequest)
Gets the
Bucket 's capacity |
UserQos |
getBucketStorageCapacity(String bucketName)
Gets the
Bucket 's capacity |
TagSet |
getBucketTagging(GenericRequest genericRequest)
Gets the tags of
Bucket instance. |
TagSet |
getBucketTagging(String bucketName)
Gets all tags of the
Bucket instance. |
BucketVersioningConfiguration |
getBucketVersioning(GenericRequest genericRequest)
Returns the versioning configuration for the specified bucket.
|
BucketVersioningConfiguration |
getBucketVersioning(String bucketName)
Returns the versioning configuration for the specified bucket.
|
BucketWebsiteResult |
getBucketWebsite(GenericRequest genericRequest)
Gets the
Bucket 's static webite settings. |
BucketWebsiteResult |
getBucketWebsite(String bucketName)
Gets the
Bucket 's static website settings. |
ClientConfiguration |
getClientConfiguration() |
CredentialsProvider |
getCredentialsProvider() |
URI |
getEndpoint()
Gets OSS services Endpoint.
|
GetImageStyleResult |
getImageStyle(String bucketName,
String styleName)
Gets a style named by parameter styleName under
Bucket |
GetImageStyleResult |
getImageStyle(String bucketName,
String styleName,
GenericRequest genericRequest)
Gets a style named by parameter styleName under the
Bucket |
List<LiveRecord> |
getLiveChannelHistory(LiveChannelGenericRequest liveChannelGenericRequest)
Gets recent
LiveRecord entries from the specified Live Channel. |
List<LiveRecord> |
getLiveChannelHistory(String bucketName,
String liveChannel)
Gets recent
LiveRecord entries from the specified Live Channel. |
LiveChannelInfo |
getLiveChannelInfo(LiveChannelGenericRequest liveChannelGenericRequest)
Gets the Live Channel's configuration.
|
LiveChannelInfo |
getLiveChannelInfo(String bucketName,
String liveChannel)
Gets the Live Channel's configuration.
|
LiveChannelStat |
getLiveChannelStat(LiveChannelGenericRequest liveChannelGenericRequest)
Gets Live Channel's streaming information.
|
LiveChannelStat |
getLiveChannelStat(String bucketName,
String liveChannel)
Gets Live Channel's streaming information.
|
OSSObject |
getObject(GetObjectRequest getObjectRequest)
Gets the
OSSObject from the bucket specified in
GetObjectRequest parameter. |
ObjectMetadata |
getObject(GetObjectRequest getObjectRequest,
File file)
Downloads the file from a file specified by the
GetObjectRequest
parameter. |
OSSObject |
getObject(String bucketName,
String key)
|
OSSObject |
getObject(URL signedUrl,
Map<String,String> requestHeaders)
Gets the
OSSObject from the signed Url. |
ObjectAcl |
getObjectAcl(GenericRequest genericRequest)
Gets the Access Control List (ACL) of the OSS object.
|
ObjectAcl |
getObjectAcl(String bucketName,
String key)
Gets the Access Control List (ACL) of the OSS object.
|
ObjectMetadata |
getObjectMetadata(GenericRequest genericRequest)
Gets all the metadata of
OSSObject . |
ObjectMetadata |
getObjectMetadata(String bucketName,
String key)
Gets all the metadata of
OSSObject . |
TagSet |
getObjectTagging(GenericRequest genericRequest)
Gets all tags of the OSS object.
|
TagSet |
getObjectTagging(String bucketName,
String key)
Gets all tags of the OSS object.
|
SimplifiedObjectMeta |
getSimplifiedObjectMeta(GenericRequest genericRequest)
Gets the simplified metadata information of
OSSObject . |
SimplifiedObjectMeta |
getSimplifiedObjectMeta(String bucketName,
String key)
Gets the simplified metadata information of
OSSObject . |
OSSSymlink |
getSymlink(GenericRequest genericRequest)
Gets the symlink information for the given symlink name.
|
OSSSymlink |
getSymlink(String bucketName,
String symLink)
Gets the symlink information for the given symlink name.
|
UdfApplicationInfo |
getUdfApplicationInfo(UdfGenericRequest genericRequest) |
UdfApplicationLog |
getUdfApplicationLog(GetUdfApplicationLogRequest getUdfApplicationLogRequest) |
List<UdfImageInfo> |
getUdfImageInfo(UdfGenericRequest genericRequest) |
UdfInfo |
getUdfInfo(UdfGenericRequest genericRequest) |
UserQosInfo |
getUserQosInfo()
Gets the User qos info.
|
OSSObject |
getVodPlaylist(GetVodPlaylistRequest getVodPlaylistRequest)
Generates and returns a VOD playlist (m3u8 format) for the *.ts files with specified
time range under the Live Channel, but this VOD playlist would not be stored in OSS Server.
|
OSSObject |
getVodPlaylist(String bucketName,
String liveChannelName,
long startTime,
long endTime)
Generates and returns a VOD playlist (m3u8 format) for the *.ts files with specified
time range under the Live Channel, but this VOD playlist would not be stored in OSS Server.
|
ObjectMetadata |
headObject(HeadObjectRequest headObjectRequest)
Gets all the head data of
OSSObject . |
ObjectMetadata |
headObject(String bucketName,
String key)
Gets all the head data of
OSSObject . |
InitiateMultipartUploadResult |
initiateMultipartUpload(InitiateMultipartUploadRequest request)
Initiates a multiple part upload
Prior to starting a multiple part upload, this method needs to be called
to ask OSS service do some initialization work.
|
boolean |
isBucketExist(String bucketName)
已过时。
|
List<Bucket> |
listBuckets()
Returns all
Bucket instances of the current account. |
BucketList |
listBuckets(ListBucketsRequest listBucketsRequest)
Returns all
Bucket instances of the current account that meet the
conditions specified. |
BucketList |
listBuckets(String prefix,
String marker,
Integer maxKeys)
Returns all
Bucket instances of the current account that meet the
conditions specified. |
List<Style> |
listImageStyle(String bucketName)
Lists all styles under the
Bucket |
List<Style> |
listImageStyle(String bucketName,
GenericRequest genericRequest)
Lists all styles under the
Bucket |
LiveChannelListing |
listLiveChannels(ListLiveChannelsRequest listLiveChannelRequest)
Lists all Live Channels under a bucket that meets the requirement
specified by the parameter listLiveChannelRequest.
|
List<LiveChannel> |
listLiveChannels(String bucketName)
Lists all Live Channels under a bucket.
|
MultipartUploadListing |
listMultipartUploads(ListMultipartUploadsRequest request)
Lists executing multiple parts uploads.
|
ObjectListing |
listObjects(ListObjectsRequest listObjectsRequest)
Lists all objects under the specified
Bucket in the parameter of
ListObjectsRequest |
ObjectListing |
listObjects(String bucketName)
Lists all objects under the specified
Bucket |
ObjectListing |
listObjects(String bucketName,
String prefix)
Lists all objects under the specified
Bucket with the specified
prefix. |
PartListing |
listParts(ListPartsRequest request)
Lists all parts in a multiple parts upload.
|
List<UdfApplicationInfo> |
listUdfApplications() |
List<UdfInfo> |
listUdfs() |
VersionListing |
listVersions(ListVersionsRequest listVersionsRequest)
Returns a list of summary information about the versions in the specified
bucket.
|
VersionListing |
listVersions(String bucketName,
String prefix)
Returns a list of summary information about the versions in the specified
bucket.
|
VersionListing |
listVersions(String bucketName,
String prefix,
String keyMarker,
String versionIdMarker,
String delimiter,
Integer maxResults)
Returns a list of summary information about the versions in the specified
bucket.
|
ResponseMessage |
optionsObject(OptionsRequest request)
Deprecated method.
|
GenericResult |
processObject(ProcessObjectRequest processObjectRequest)
Apply process on the specified image file.
|
void |
putBucketImage(PutBucketImageRequest request)
Sets image processing attributes on the specific
Bucket |
void |
putImageStyle(PutImageStyleRequest putImageStyleRequest)
Adds a new style under
Bucket . |
PutObjectResult |
putObject(PutObjectRequest putObjectRequest)
Uploads the file to
Bucket . |
PutObjectResult |
putObject(String bucketName,
String key,
File file)
Uploads the file to the
Bucket from the file. |
PutObjectResult |
putObject(String bucketName,
String key,
File file,
ObjectMetadata metadata)
Uploads the file to the
Bucket from the file with the
ObjectMetadata . |
PutObjectResult |
putObject(String bucketName,
String key,
InputStream input)
Uploads the file to the
Bucket from the InputStream
instance. |
PutObjectResult |
putObject(String bucketName,
String key,
InputStream input,
ObjectMetadata metadata)
Uploads the file to the
Bucket from the @{link InputStream} with
the ObjectMetadata information。 |
PutObjectResult |
putObject(URL signedUrl,
InputStream requestContent,
long contentLength,
Map<String,String> requestHeaders)
Uploads the file from a InputStream instance to the signed URL with
specified headers.
|
PutObjectResult |
putObject(URL signedUrl,
InputStream requestContent,
long contentLength,
Map<String,String> requestHeaders,
boolean useChunkEncoding)
Uploads the file from a InputStream instance to the signed URL with
specified headers.
|
PutObjectResult |
putObject(URL signedUrl,
String filePath,
Map<String,String> requestHeaders)
Uploads the file from a specified file path to the signed URL with
specified headers
|
PutObjectResult |
putObject(URL signedUrl,
String filePath,
Map<String,String> requestHeaders,
boolean useChunkEncoding)
Uploads the file from a specified file path to the signed URL with
specified headers with the flag of using chunked tranfer encoding.
|
void |
resizeUdfApplication(ResizeUdfApplicationRequest resizeUdfApplicationRequest) |
RestoreObjectResult |
restoreObject(GenericRequest genericRequest)
Restores the object of archive storage.
|
RestoreObjectResult |
restoreObject(String bucketName,
String key)
Restores the object of archive storage.
|
OSSObject |
selectObject(SelectObjectRequest selectObjectRequest)
Select the
OSSObject from the bucket specified in
SelectObjectRequest parameter |
SetAsyncFetchTaskResult |
setAsyncFetchTask(SetAsyncFetchTaskRequest setAsyncFetchTaskRequest)
Sets an async fetch task.
|
SetAsyncFetchTaskResult |
setAsyncFetchTask(String bucketName,
AsyncFetchTaskConfiguration asyncFetchTaskConfiguration)
Sets an async fetch task.
|
void |
setBucketAcl(SetBucketAclRequest setBucketAclRequest)
Sends the request to apply ACL on a
Bucket instance. |
void |
setBucketAcl(String bucketName,
CannedAccessControlList cannedACL)
Applies the Access Control List(ACL) on the
Bucket . |
void |
setBucketCORS(SetBucketCORSRequest request)
Adds CORS rules to the bucket.
|
void |
setBucketEncryption(SetBucketEncryptionRequest setBucketEncryptionRequest)
Creates a new server-side encryption configuration (or replaces an existing one, if present).
|
void |
setBucketLifecycle(SetBucketLifecycleRequest setBucketLifecycleRequest)
Sets the
Bucket 's lifecycle rule. |
void |
setBucketLogging(SetBucketLoggingRequest request)
Enables or disables the
Bucket 's logging. |
void |
setBucketPolicy(SetBucketPolicyRequest setBucketPolicyRequest)
Sets the policy on the
Bucket instance. |
void |
setBucketPolicy(String bucketName,
String policyText)
Sets the policy on the
Bucket instance. |
void |
setBucketProcess(SetBucketProcessRequest setBucketProcessRequest)
Creates the image accessing configuration according to the parameter
setBucketProcessRequest.
|
void |
setBucketQosInfo(SetBucketQosInfoRequest setBucketQosInfoRequest)
sets the qos info for the
Bucket . |
void |
setBucketQosInfo(String bucketName,
BucketQosInfo bucketQosInfo)
sets the qos info for the
Bucket . |
void |
setBucketReferer(SetBucketRefererRequest setBucketRefererRequest)
Sets the http referer on the
Bucket instance in the parameter
setBucketRefererRequest. |
void |
setBucketReferer(String bucketName,
BucketReferer referer)
Sets the http referer on the
Bucket instance specified by the
bucket name. |
void |
setBucketRequestPayment(SetBucketRequestPaymentRequest setBucketRequestPaymentRequest)
Sets the request payment of the
Bucket . |
void |
setBucketRequestPayment(String bucketName,
Payer payer)
Sets the request payment of the
Bucket . |
void |
setBucketStorageCapacity(SetBucketStorageCapacityRequest setBucketStorageCapacityRequest)
Sets the capacity of the
Bucket . |
void |
setBucketStorageCapacity(String bucketName,
UserQos userQos)
Sets the capacity of the
Bucket . |
void |
setBucketTagging(SetBucketTaggingRequest setBucketTaggingRequest)
Sets the tags on the
Bucket instance in
SetBucketTaggingRequest object. |
void |
setBucketTagging(String bucketName,
Map<String,String> tags)
Sets the tags on the
Bucket instance specified by the bucket name |
void |
setBucketTagging(String bucketName,
TagSet tagSet)
Sets the tags on the
Bucket instance. |
void |
setBucketVersioning(SetBucketVersioningRequest setBucketVersioningRequest)
Sets the versioning configuration for the specified bucket.
|
void |
setBucketWebsite(SetBucketWebsiteRequest setBucketWebSiteRequest)
Sets the static website settings for the
Bucket . |
void |
setEndpoint(String endpoint)
Sets OSS services endpoint.
|
void |
setLiveChannelStatus(SetLiveChannelRequest setLiveChannelRequest)
Sets the Live Channel status.
|
void |
setLiveChannelStatus(String bucketName,
String liveChannel,
LiveChannelStatus status)
Sets the Live Channel status.
|
void |
setObjectAcl(SetObjectAclRequest setObjectAclRequest)
Sets the Access Control List (ACL) on a
OSSObject instance. |
void |
setObjectAcl(String bucketName,
String key,
CannedAccessControlList cannedACL)
Sets the Access Control List (ACL) on a
OSSObject instance. |
void |
setObjectTagging(SetObjectTaggingRequest setObjectTaggingRequest)
Sets the tags on the OSS object.
|
void |
setObjectTagging(String bucketName,
String key,
Map<String,String> tags)
Sets the tags on the OSS object.
|
void |
setObjectTagging(String bucketName,
String key,
TagSet tagSet)
Sets the tags on the OSS object.
|
void |
shutdown()
Shuts down the OSS instance (release all resources) The OSS instance is
not usable after its shutdown() is called.
|
void |
switchCredentials(Credentials creds)
Switches to another users with specified credentials
|
void |
switchSignatureVersion(SignVersion signatureVersion)
Switches to another signature version
|
void |
upgradeUdfApplication(UpgradeUdfApplicationRequest upgradeUdfApplicationRequest) |
UploadFileResult |
uploadFile(UploadFileRequest uploadFileRequest)
File upload
This method will automatically split files into parts and upload them in
parallel by a thread pool, though by default the thread pool only has one
thread.
|
UploadPartResult |
uploadPart(UploadPartRequest request)
Uploads a part to a specified multiple upload.
|
UploadPartCopyResult |
uploadPartCopy(UploadPartCopyRequest request)
Uploads Part copy from an existing source object to a target object with
specified upload Id and part number
|
void |
uploadUdfImage(UploadUdfImageRequest uploadUdfImageRequest) |
@Deprecated public OSSClient(String accessKeyId, String secretAccessKey)
OSSClient
instance.accessKeyId
- Access Key ID.secretAccessKey
- Secret Access Key.@Deprecated public OSSClient(String endpoint, String accessKeyId, String secretAccessKey)
OSSClient
instance.endpoint
- OSS endpoint.accessKeyId
- Access Key ID.secretAccessKey
- Secret Access Key.@Deprecated public OSSClient(String endpoint, String accessKeyId, String secretAccessKey, String securityToken)
OSSClient
instance.endpoint
- OSS Endpoint.accessKeyId
- Access Id from STS.secretAccessKey
- Access Key from STSsecurityToken
- Security Token from STS.@Deprecated public OSSClient(String endpoint, String accessKeyId, String secretAccessKey, ClientConfiguration config)
OSSClient
instance.endpoint
- OSS Endpoint。accessKeyId
- Access Key ID。secretAccessKey
- Secret Access Key。config
- A ClientConfiguration
instance. The method would use
default configuration if it's null.@Deprecated public OSSClient(String endpoint, String accessKeyId, String secretAccessKey, String securityToken, ClientConfiguration config)
OSSClient
instance.endpoint
- OSS Endpoint。accessKeyId
- Access Key Id provided by STS.secretAccessKey
- Secret Access Key provided by STS.securityToken
- Security token provided by STS.config
- A ClientConfiguration
instance. The method would use
default configuration if it's null.@Deprecated public OSSClient(String endpoint, CredentialsProvider credsProvider)
CredentialsProvider
and OSS Endpoint to create
a new OSSClient
instance.endpoint
- OSS services Endpoint。credsProvider
- Credentials provider which has access key Id and access Key
secret.public OSSClient(String endpoint, CredentialsProvider credsProvider, ClientConfiguration config)
CredentialsProvider
, client configuration and
OSS endpoint to create a new OSSClient
instance.endpoint
- OSS services Endpoint.credsProvider
- Credentials provider.config
- client configuration.public URI getEndpoint()
public void setEndpoint(String endpoint)
endpoint
- OSS services endpoint.public void switchCredentials(Credentials creds)
OSS
switchCredentials
在接口中 OSS
creds
- the credential to switch to。public void switchSignatureVersion(SignVersion signatureVersion)
OSS
switchSignatureVersion
在接口中 OSS
signatureVersion
- the signature version to switch to。public CredentialsProvider getCredentialsProvider()
public ClientConfiguration getClientConfiguration()
public Bucket createBucket(String bucketName) throws OSSException, ClientException
OSS
Bucket
instance. The bucket name specified must be
globally unique and follow the naming rules from
https://www.alibabacloud.com/help/doc-detail/31827.htm?spm=a3c0i.o32012en
.a3.1.64ece5e0jPpa2t.createBucket
在接口中 OSS
bucketName
- bucket nameOSSException
ClientException
public Bucket createBucket(CreateBucketRequest createBucketRequest) throws OSSException, ClientException
OSS
Bucket
instance with specified CreateBucketRequest
information.createBucket
在接口中 OSS
createBucketRequest
- instance of CreateBucketRequest
, which at least has
bucket name information.OSSException
ClientException
public void deleteBucket(String bucketName) throws OSSException, ClientException
OSS
Bucket
instance. A non-empty bucket could not be
deleted.deleteBucket
在接口中 OSS
bucketName
- bucket name to delete.OSSException
ClientException
public void deleteBucket(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
instance.deleteBucket
在接口中 OSS
genericRequest
- the generic request instance that has the bucket name
information.OSSException
ClientException
public List<Bucket> listBuckets() throws OSSException, ClientException
OSS
Bucket
instances of the current account.listBuckets
在接口中 OSS
Bucket
instances. If there's no buckets, the
list will be empty (instead of null).OSSException
ClientException
public BucketList listBuckets(ListBucketsRequest listBucketsRequest) throws OSSException, ClientException
OSS
Bucket
instances of the current account that meet the
conditions specified.listBuckets
在接口中 OSS
listBucketsRequest
- the ListBucketsRequest instance that defines the criteria
which could have requirements on prefix, marker, maxKeys.Bucket
instances.OSSException
ClientException
public BucketList listBuckets(String prefix, String marker, Integer maxKeys) throws OSSException, ClientException
OSS
Bucket
instances of the current account that meet the
conditions specified.listBuckets
在接口中 OSS
prefix
- The prefix of the bucket name returned. If null, the bucket
name could have any prefix.marker
- The start point in the lexicographic order for the buckets to
return. If null, return the buckets from the beginning in the
lexicographic order. For example, if the account has buckets
bk1, bk2, bk3. If the marker is set as bk2, then only bk2 and
bk3 meet the criteria. But if the marker is null, then all
three buckets meet the criteria.maxKeys
- Max bucket count to return. The valid value is from 1 to 1000,
default is 100 if it's null.Bucket
instances.OSSException
ClientException
public void setBucketAcl(String bucketName, CannedAccessControlList cannedACL) throws OSSException, ClientException
OSS
Bucket
.setBucketAcl
在接口中 OSS
bucketName
- Bucket name.cannedACL
- CannedAccessControlList
instance. If the instance is
null, no ACL change on the bucket (but the request is still
sent).OSSException
ClientException
public void setBucketAcl(SetBucketAclRequest setBucketAclRequest) throws OSSException, ClientException
OSS
Bucket
instance.setBucketAcl
在接口中 OSS
setBucketAclRequest
- SetBucketAclRequest instance which specifies the ACL and the
bucket information.OSSException
ClientException
public AccessControlList getBucketAcl(String bucketName) throws OSSException, ClientException
OSS
Bucket
instance.getBucketAcl
在接口中 OSS
bucketName
- Bucket Name.AccessControlList
.OSSException
ClientException
public AccessControlList getBucketAcl(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
instance.getBucketAcl
在接口中 OSS
genericRequest
- GenericRequest
instance that has the bucket name
information.AccessControlList
instance.OSSException
ClientException
public BucketMetadata getBucketMetadata(String bucketName) throws OSSException, ClientException
OSS
Bucket
.getBucketMetadata
在接口中 OSS
bucketName
- Bucket name.BucketMetadata
instance.OSSException
ClientException
public BucketMetadata getBucketMetadata(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
.getBucketMetadata
在接口中 OSS
genericRequest
- Generic request which specifies the bucket name.BucketMetadata
instance.OSSException
ClientException
public void setBucketReferer(String bucketName, BucketReferer referer) throws OSSException, ClientException
OSS
Bucket
instance specified by the
bucket name.setBucketReferer
在接口中 OSS
bucketName
- Bucket name.referer
- The BucketReferer
instance. If null, it would create a
BucketReferer
instance from default constructor.OSSException
ClientException
public void setBucketReferer(SetBucketRefererRequest setBucketRefererRequest) throws OSSException, ClientException
OSS
Bucket
instance in the parameter
setBucketRefererRequest.setBucketReferer
在接口中 OSS
setBucketRefererRequest
- SetBucketRefererRequest
instance that specify the
bucket name and the BucketReferer
instance.OSSException
ClientException
public BucketReferer getBucketReferer(String bucketName) throws OSSException, ClientException
OSS
Bucket
specified by
bucket name.getBucketReferer
在接口中 OSS
bucketName
- Bucket nameBucketReferer
instance. The BucketReferer object with
empty referer information is returned if there's no http referer
information.OSSException
ClientException
public BucketReferer getBucketReferer(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
specified by
bucket name in GenericRequest object.getBucketReferer
在接口中 OSS
genericRequest
- GenericRequest
instance that has the bucket name.BucketReferer
。OSSException
ClientException
public String getBucketLocation(String bucketName) throws OSSException, ClientException
OSS
Bucket
instance is hosted.
As of 08/03/2017, the valid datacenter names are oss-cn-hangzhou,
oss-cn-qingdao, oss-cn-beijing, oss-cn-hongkong, oss-cn-shenzhen,
oss-cn-shanghai, oss-us-west-1, oss-us-east-1, and oss-ap-southeast-1.getBucketLocation
在接口中 OSS
bucketName
- Bucket name.OSSException
ClientException
public String getBucketLocation(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
instance specified
by GenericRequest is hosted.getBucketLocation
在接口中 OSS
genericRequest
- GenericRequest
instance with bucket name information.OSSException
ClientException
public boolean doesBucketExist(String bucketName) throws OSSException, ClientException
OSS
Bucket
exists .doesBucketExist
在接口中 OSS
bucketName
- Bucket name.OSSException
ClientException
public boolean doesBucketExist(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
exists。doesBucketExist
在接口中 OSS
genericRequest
- GenericRequest
instance that has the bucket name.OSSException
ClientException
@Deprecated public boolean isBucketExist(String bucketName) throws OSSException, ClientException
doesBucketExist(String)
instead.public ObjectListing listObjects(String bucketName) throws OSSException, ClientException
OSS
Bucket
listObjects
在接口中 OSS
bucketName
- Bucket nameObjectListing
instance that has all objects.OSSException
ClientException
public ObjectListing listObjects(String bucketName, String prefix) throws OSSException, ClientException
OSS
Bucket
with the specified
prefix.listObjects
在接口中 OSS
bucketName
- Bucket name.prefix
- The prefix returned object must have.ObjectListing
instance that has all objectsOSSException
ClientException
public ObjectListing listObjects(ListObjectsRequest listObjectsRequest) throws OSSException, ClientException
OSS
Bucket
in the parameter of
ListObjectsRequest
listObjects
在接口中 OSS
listObjectsRequest
- The ListObjectsRequest
instance that defines the
bucket name as well as the criteria such as prefix, marker,
maxKeys, delimiter, etc.ObjectListing
instance that has the objects meet the
criteriaOSSException
ClientException
public VersionListing listVersions(String bucketName, String prefix) throws OSSException, ClientException
OSS
Returns a list of summary information about the versions in the specified bucket.
The returned version summaries are ordered first by key and then by version. Keys are sorted lexicographically (alphabetically) while versions are sorted from most recent to least recent. Both versions with data and delete markers are included in the results.
Because buckets can contain a virtually unlimited number of versions, the
complete results of a list query can be extremely large. To manage large
result sets, OSS uses pagination to split them into multiple
responses. Always check the
VersionListing.isTruncated()
method to determine if the
returned listing is complete or if additional calls are needed to get
more results.
For more information about enabling versioning for a bucket, see
OSS.setBucketVersioning(SetBucketVersioningRequest)
.
listVersions
在接口中 OSS
bucketName
- The name of the OSS bucket whose versions are to be
listed.prefix
- An optional parameter restricting the response to keys
beginning with the specified prefix. Use prefixes to
separate a bucket into different sets of keys,
similar to how a file system organizes files
into directories.OSSException
- If any errors occurred in OSS while processing the
request.ClientException
- If any errors are encountered in the client while making the
request or handling the response.listVersions(ListVersionsRequest)
,
listVersions(String, String, String, String, String, Integer)
public VersionListing listVersions(String bucketName, String prefix, String keyMarker, String versionIdMarker, String delimiter, Integer maxResults) throws OSSException, ClientException
OSS
Returns a list of summary information about the versions in the specified bucket.
The returned version summaries are ordered first by key and then by version. Keys are sorted lexicographically (alphabetically) and versions are sorted from most recent to least recent. Versions with data and delete markers are included in the results.
Because buckets can contain a virtually unlimited number of versions, the
complete results of a list query can be extremely large. To manage large
result sets, OSS uses pagination to split them into multiple
responses. Always check the
VersionListing.isTruncated()
method to determine if the
returned listing is complete or if additional calls are needed
to get more results.
The keyMarker
and versionIdMarker
parameters allow
callers to specify where to start the version listing.
The delimiter
parameter allows groups of keys that share a
delimiter-terminated prefix to be included
in the returned listing. This allows applications to organize and browse
their keys hierarchically, much like how a file system organizes
files into directories. These common prefixes can be retrieved
by calling the VersionListing.getCommonPrefixes()
method.
For example, consider a bucket that contains the following keys:
listVersions
with
a prefix
value of "foo/" and a delimiter
value of "/"
on this bucket, a VersionListing
is returned that contains:
To see deeper into the virtual hierarchy, make
another call to listVersions
setting the prefix parameter to any
interesting common prefix to list the individual versions under that
prefix.
For more information about enabling versioning for a bucket, see
OSS.setBucketVersioning(SetBucketVersioningRequest)
.
listVersions
在接口中 OSS
bucketName
- The name of the OSS bucket whose versions are to be listed.prefix
- An optional parameter restricting the response to keys that
begin with the specified prefix. Use prefixes to
separate a bucket into different sets of keys,
similar to how a file system organizes files
into directories.keyMarker
- Optional parameter indicating where in the sorted list of all
versions in the specified bucket to begin returning results.
Results are always ordered first lexicographically (i.e.
alphabetically) and then from most recent version to least
recent version. If a keyMarker is used without a
versionIdMarker, results begin immediately after that key's
last version. When a keyMarker is used with a versionIdMarker,
results begin immediately after the version with the specified
key and version ID.
This enables pagination; to get the next page of results use
the next key marker and next version ID marker (from
VersionListing.getNextKeyMarker()
and
VersionListing.getNextVersionIdMarker()
) as the
markers for the next request to list versions.
versionIdMarker
- Optional parameter indicating where in the sorted list of all
versions in the specified bucket to begin returning results.
Results are always ordered first lexicographically (i.e.
alphabetically) and then from most recent version to least
recent version. A keyMarker must be specified when specifying
a versionIdMarker. Results begin immediately after the version
with the specified key and version ID.
This enables pagination; to get the next page of results use
the next key marker and next version ID marker (from
VersionListing.getNextKeyMarker()
and
VersionListing.getNextVersionIdMarker()
) as the
markers for the next request to list versions.
delimiter
- Optional parameter that causes keys that contain the same
string between the prefix and the first occurrence of the
delimiter to be rolled up into a single result element in the
VersionListing.getCommonPrefixes()
list. These
rolled-up keys are not returned elsewhere in the response. The
most commonly used delimiter is "/", which simulates a
hierarchical organization similar to a file system directory
structure.maxResults
- Optional parameter indicating the maximum number of results to
include in the response. OSS might return fewer than
this, but will not return more. Even if maxResults is not
specified, OSS will limit the number of results in the
response.OSSException
- If any errors occurred in OSS while processing the
request.ClientException
- If any errors are encountered in the client while making the
request or handling the response.listVersions(String, String)
,
listVersions(ListVersionsRequest)
public VersionListing listVersions(ListVersionsRequest listVersionsRequest) throws OSSException, ClientException
OSS
Returns a list of summary information about the versions in the specified bucket.
The returned version summaries are ordered first by key and then by version. Keys are sorted lexicographically (alphabetically) and versions are sorted from most recent to least recent. Versions with data and delete markers are included in the results.
Because buckets can contain a virtually unlimited number of versions, the
complete results of a list query can be extremely large. To manage large
result sets, OSS uses pagination to split them into multiple
responses. Always check the
VersionListing.isTruncated()
method to determine if the
returned listing is complete or if additional calls are needed
to get more results.
The keyMarker
and versionIdMarker
parameters allow
callers to specify where to start the version listing.
The delimiter
parameter allows groups of keys that share a
delimiter-terminated prefix to be included
in the returned listing. This allows applications to organize and browse
their keys hierarchically, much like how a file system organizes
files into directories. These common prefixes can be retrieved
by calling the VersionListing.getCommonPrefixes()
method.
For example, consider a bucket that contains the following keys:
listVersions
with
a prefix
value of "foo/" and a delimiter
value of "/"
on this bucket, a VersionListing
is returned that contains:
To see deeper into the virtual hierarchy, make
another call to listVersions
setting the prefix parameter to any
interesting common prefix to list the individual versions under that
prefix.
For more information about enabling versioning for a bucket, see
OSS.setBucketVersioning(SetBucketVersioningRequest)
.
listVersions
在接口中 OSS
listVersionsRequest
- The request object containing all options for listing the
versions in a specified bucket.OSSException
- If any errors occurred in OSS while processing the
request.ClientException
- If any errors are encountered in the client while making the
request or handling the response.listVersions(String, String)
,
listVersions(String, String, String, String, String, Integer)
public PutObjectResult putObject(String bucketName, String key, InputStream input) throws OSSException, ClientException
OSS
Bucket
from the InputStream
instance. It overwrites the existing one and the bucket must exist.putObject
在接口中 OSS
bucketName
- Bucket name.key
- object key.input
- InputStream
instance to write from. The must be
readable.OSSException
ClientException
public PutObjectResult putObject(String bucketName, String key, InputStream input, ObjectMetadata metadata) throws OSSException, ClientException
OSS
Bucket
from the @{link InputStream} with
the ObjectMetadata
information。putObject
在接口中 OSS
bucketName
- Bucket name.key
- Object key.input
- InputStream
instance to write from. It must be
readable.metadata
- The ObjectMetadata
instance. If it does not specify
the Content-Length information, the data is encoded by chunked
tranfer encoding.OSSException
ClientException
public PutObjectResult putObject(String bucketName, String key, File file, ObjectMetadata metadata) throws OSSException, ClientException
OSS
Bucket
from the file with the
ObjectMetadata
.putObject
在接口中 OSS
bucketName
- Bucket name.key
- Object key.file
- File object to read from.metadata
- The ObjectMetadata
instance. If it does not specify
the Content-Length information, the data is encoded by chunked
tranfer encoding.OSSException
ClientException
public PutObjectResult putObject(String bucketName, String key, File file) throws OSSException, ClientException
OSS
Bucket
from the file.putObject
在接口中 OSS
bucketName
- Bucket name.key
- Object key.file
- File object to read from.OSSException
ClientException
public PutObjectResult putObject(PutObjectRequest putObjectRequest) throws OSSException, ClientException
OSS
Bucket
.putObject
在接口中 OSS
putObjectRequest
- The PutObjectRequest
instance that has bucket name,
object key, metadata information.PutObjectResult
instance.OSSException
ClientException
public PutObjectResult putObject(URL signedUrl, String filePath, Map<String,String> requestHeaders) throws OSSException, ClientException
OSS
putObject
在接口中 OSS
signedUrl
- Signed url, which has the bucket name, object key, account
information and accessed Ids and its signature. The url is
recommended to be generated by generatePresignedUrl().filePath
- The file path to read fromrequestHeaders
- Request headers, including standard or customized http headers
documented by PutObject REST API.PutObjectResult
instance.OSSException
ClientException
public PutObjectResult putObject(URL signedUrl, String filePath, Map<String,String> requestHeaders, boolean useChunkEncoding) throws OSSException, ClientException
OSS
putObject
在接口中 OSS
signedUrl
- Signed url, which has the bucket name, object key, account
information and accessed Ids and its signature. The url is
recommended to be generated by generatePresignedUrl().filePath
- The file path to read from.requestHeaders
- Request headers, including standard or customized http headers
documented by PutObject REST API.useChunkEncoding
- The flag of using chunked transfer encoding.PutObjectResult
instance.OSSException
ClientException
public PutObjectResult putObject(URL signedUrl, InputStream requestContent, long contentLength, Map<String,String> requestHeaders) throws OSSException, ClientException
OSS
putObject
在接口中 OSS
signedUrl
- Signed Url, which has the bucket name, object key, account
information and accessed Ids and its signature. The url is
recommended to be generated by generatePresignedUrl().requestContent
- InputStream
instance to read from.contentLength
- Hint content length to write.requestHeaders
- Request headers,including standard or customized http headers
documented by PutObject REST API.PutObjectResult
instance.OSSException
ClientException
public PutObjectResult putObject(URL signedUrl, InputStream requestContent, long contentLength, Map<String,String> requestHeaders, boolean useChunkEncoding) throws OSSException, ClientException
OSS
putObject
在接口中 OSS
signedUrl
- Signed Url, which has the bucket name, object key, account
information and accessed Ids and its signature. The url is
recommended to be generated by generatePresignedUrl().requestContent
- InputStream
instance to read from.contentLength
- Hint content length to write. if useChunkEncoding is true,
then -1 is used.requestHeaders
- Rquest headers,including standard or customized http headers
documented by PutObject REST API.useChunkEncoding
- The flag of using chunked transfer encoding.PutObjectResult
instance.OSSException
ClientException
public CopyObjectResult copyObject(String sourceBucketName, String sourceKey, String destinationBucketName, String destinationKey) throws OSSException, ClientException
OSS
copyObject
在接口中 OSS
sourceBucketName
- Source object's bucket name.sourceKey
- Source object's key.destinationBucketName
- Target object's bucket name.destinationKey
- Target object's key.CopyObjectResult
instance.OSSException
ClientException
public CopyObjectResult copyObject(CopyObjectRequest copyObjectRequest) throws OSSException, ClientException
OSS
copyObject
在接口中 OSS
copyObjectRequest
- A CopyObjectRequest
instance that specifies source
file, source bucket and target file, target bucket。CopyObjectResult
instance.OSSException
ClientException
public OSSObject getObject(String bucketName, String key) throws OSSException, ClientException
OSS
getObject
在接口中 OSS
bucketName
- Bucket name.key
- Object Key.OSSObject
instance. The caller is responsible to close
the connection after usage.OSSException
ClientException
public ObjectMetadata getObject(GetObjectRequest getObjectRequest, File file) throws OSSException, ClientException
OSS
GetObjectRequest
parameter.getObject
在接口中 OSS
getObjectRequest
- A GetObjectRequest
instance which specifies bucket
name and object key.file
- Target file instance to download as.OSSException
ClientException
public OSSObject getObject(GetObjectRequest getObjectRequest) throws OSSException, ClientException
OSS
OSSObject
from the bucket specified in
GetObjectRequest
parameter.getObject
在接口中 OSS
getObjectRequest
- A GetObjectRequest
instance which specifies the bucket
name and the object key.OSSObject
instance of the bucket file. The caller is
responsible to close the connection after usage.OSSException
ClientException
public OSSObject getObject(URL signedUrl, Map<String,String> requestHeaders) throws OSSException, ClientException
OSS
OSSObject
from the signed Url.getObject
在接口中 OSS
signedUrl
- The signed Url.requestHeaders
- Request headers, including http standard or OSS customized
headers.OSSObject
instance.The caller is responsible to close
the connection after usage.OSSException
ClientException
public OSSObject selectObject(SelectObjectRequest selectObjectRequest) throws OSSException, ClientException
OSS
OSSObject
from the bucket specified in
SelectObjectRequest
parameterselectObject
在接口中 OSS
selectObjectRequest
- A SelectObjectRequest
instance which specifies the
bucket name
object key
filter expression
input serialization
output serializationOSSObject
instance will be returned. The caller is
responsible to close the connection after usage.OSSException
ClientException
public SimplifiedObjectMeta getSimplifiedObjectMeta(String bucketName, String key) throws OSSException, ClientException
OSS
OSSObject
.
Simplified metadata includes ETag, Size, LastModified and thus it's more lightweight then GetObjectMeta().
getSimplifiedObjectMeta
在接口中 OSS
bucketName
- Bucket name.key
- Object key.SimplifiedObjectMeta
instance of the object.OSSException
ClientException
public SimplifiedObjectMeta getSimplifiedObjectMeta(GenericRequest genericRequest) throws OSSException, ClientException
OSS
OSSObject
.
Simplified metadata includes ETag, Size, LastModified and thus it's more lightweight then GetObjectMeta().
getSimplifiedObjectMeta
在接口中 OSS
genericRequest
- Generic request which specifies the bucket name and object keySimplifiedObjectMeta
instance of specified file.OSSException
ClientException
public ObjectMetadata getObjectMetadata(String bucketName, String key) throws OSSException, ClientException
OSS
OSSObject
.getObjectMetadata
在接口中 OSS
bucketName
- Bucket name.key
- Object key.ObjectMetadata
instance.OSSException
ClientException
public SelectObjectMetadata createSelectObjectMetadata(CreateSelectObjectMetadataRequest createSelectObjectMetadataRequest) throws OSSException, ClientException
OSS
CreateSelectObjectMetadataRequest
)createSelectObjectMetadata
在接口中 OSS
createSelectObjectMetadataRequest
- CreateSelectObjectMetadataRequest
create select object metadata request.SelectObjectMetadata
instance.OSSException
ClientException
public ObjectMetadata getObjectMetadata(GenericRequest genericRequest) throws OSSException, ClientException
OSS
OSSObject
.getObjectMetadata
在接口中 OSS
genericRequest
- Generic request which specifies the bucket name and object
key.ObjectMetadata
instance.OSSException
ClientException
public ObjectMetadata headObject(String bucketName, String key) throws OSSException, ClientException
OSS
OSSObject
.headObject
在接口中 OSS
bucketName
- Bucket name.key
- Object key.ObjectMetadata
instance.OSSException
ClientException
public ObjectMetadata headObject(HeadObjectRequest headObjectRequest) throws OSSException, ClientException
OSS
OSSObject
.headObject
在接口中 OSS
headObjectRequest
- A HeadObjectRequest
instance which specifies the
bucket name and object key, and some constraint information can be set.ObjectMetadata
instance.OSSException
ClientException
public AppendObjectResult appendObject(AppendObjectRequest appendObjectRequest) throws OSSException, ClientException
OSS
AppendObjectRequest
. It's not applicable to normal OSS object.appendObject
在接口中 OSS
appendObjectRequest
- A AppendObjectRequest
instance which specifies the
bucket name, appendable object key, the file or the
InputStream object to append.AppendObjectResult
instance.OSSException
ClientException
public void deleteObject(String bucketName, String key) throws OSSException, ClientException
OSS
OSSObject
by bucket name and object key.deleteObject
在接口中 OSS
bucketName
- Bucket name.key
- Object key.OSSException
ClientException
public void deleteObject(GenericRequest genericRequest) throws OSSException, ClientException
OSS
OSSObject
by the GenericRequest
instance.deleteObject
在接口中 OSS
genericRequest
- The GenericRequest
instance that specfies the bucket
name and object key.OSSException
ClientException
public void deleteVersion(String bucketName, String key, String versionId) throws OSSException, ClientException
OSS
Deletes a specific version of the specified object in the specified bucket. Once deleted, there is no method to restore or undelete an object version. This is the only way to permanently delete object versions that are protected by versioning.
Deleting an object version is permanent and irreversible. It is a privileged operation that only the owner of the bucket containing the version can perform.
Users can only delete a version of an object if versioning is enabled
for the bucket.
For more information about enabling versioning for a bucket, see
OSS.setBucketVersioning(SetBucketVersioningRequest)
.
If attempting to delete an object that does not exist, OSS will return a success message instead of an error message.
deleteVersion
在接口中 OSS
bucketName
- The name of the OSS bucket containing the object to delete.key
- The key of the object to delete.versionId
- The version of the object to delete.OSSException
- If any errors occurred in OSS while processing the request.ClientException
- If any errors are encountered in the client while making the
request or handling the response.public void deleteVersion(DeleteVersionRequest deleteVersionRequest) throws OSSException, ClientException
OSS
Deletes a specific version of an object in the specified bucket. Once deleted, there is no method to restore or undelete an object version. This is the only way to permanently delete object versions that are protected by versioning.
Deleting an object version is permanent and irreversible. It is a privileged operation that only the owner of the bucket containing the version can perform.
Users can only delete a version of an object if versioning is enabled
for the bucket.
For more information about enabling versioning for a bucket, see
OSS.setBucketVersioning(SetBucketVersioningRequest)
.
If attempting to delete an object that does not exist, OSS will return a success message instead of an error message.
deleteVersion
在接口中 OSS
deleteVersionRequest
- The request object containing all options for deleting a
specific version of an OSS object.OSSException
- If any errors occurred in OSS while processing the request.ClientException
- If any errors are encountered in the client while making the
request or handling the response.public DeleteObjectsResult deleteObjects(DeleteObjectsRequest deleteObjectsRequest) throws OSSException, ClientException
OSS
deleteObjects
在接口中 OSS
deleteObjectsRequest
- A DeleteObjectsRequest
instance which specifies the
bucket and file keys to delete.DeleteObjectsResult
instance which specifies each
file's result in normal mode or only failed deletions in quite
mode. By default it's normal mode.OSSException
ClientException
public DeleteVersionsResult deleteVersions(DeleteVersionsRequest deleteVersionsRequest) throws OSSException, ClientException
OSS
deleteVersions
在接口中 OSS
deleteVersionsRequest
- A DeleteVersionsRequest
instance which specifies the
bucket and file keys to delete.DeleteVersionsResult
instance which specifies each
file's result in normal mode or only failed deletions in quite
mode. By default it's normal mode.OSSException
ClientException
public boolean doesObjectExist(String bucketName, String key) throws OSSException, ClientException
OSS
OSSObject
exists under the specific
Bucket
. 302 Redirect or OSS mirroring will not impact the result
of this function.doesObjectExist
在接口中 OSS
bucketName
- Bucket name.key
- Object Key.OSSException
ClientException
public boolean doesObjectExist(String bucketName, String key, boolean isOnlyInOSS)
OSS
OSSObject
exists under the specific
Bucket
. 302 Redirect or OSS mirroring will impact the result of
this function if isOnlyInOSS is true.doesObjectExist
在接口中 OSS
bucketName
- Bucket name.key
- Object Key.isOnlyInOSS
- true if ignore 302 redirect or mirroring; false if considering
302 redirect or mirroring, which could download the object
from source to OSS when the file exists in source but is not
in OSS yet.@Deprecated public boolean doesObjectExist(HeadObjectRequest headObjectRequest) throws OSSException, ClientException
OSS
OSSObject
exists.doesObjectExist
在接口中 OSS
headObjectRequest
- A HeadObjectRequest
instance which specifies the
bucket name and object key. Constraint information is ignored.OSSException
ClientException
public boolean doesObjectExist(GenericRequest genericRequest) throws OSSException, ClientException
OSS
OSSObject
exists under the specific
Bucket
. 302 Redirect or OSS mirroring will not impact the result
of this function.doesObjectExist
在接口中 OSS
genericRequest
- A GenericRequest
instance which specifies the bucket
and object key.OSSException
ClientException
public boolean doesObjectExist(GenericRequest genericRequest, boolean isOnlyInOSS) throws OSSException, ClientException
OSS
OSSObject
exists under the specific
Bucket
. 302 Redirect or OSS mirroring will not impact the result
of this function.doesObjectExist
在接口中 OSS
genericRequest
- A GenericRequest
instance which specifies the bucket
and object key.isOnlyInOSS
- true if ignore 302 redirect or mirroring; false if considering
302 redirect or mirroring, which could download the object
from source to OSS when the file exists in source but is not
in OSS yet.OSSException
ClientException
public void setObjectAcl(String bucketName, String key, CannedAccessControlList cannedACL) throws OSSException, ClientException
OSS
OSSObject
instance.setObjectAcl
在接口中 OSS
bucketName
- Bucket name.key
- Object Key.cannedACL
- One of the three values: Private, PublicRead or
PublicReadWrite.OSSException
ClientException
public void setObjectAcl(SetObjectAclRequest setObjectAclRequest) throws OSSException, ClientException
OSS
OSSObject
instance.setObjectAcl
在接口中 OSS
setObjectAclRequest
- A SetObjectAclRequest
instance which specifies the
object's bucket name and key as well as the ACL information.OSSException
ClientException
public ObjectAcl getObjectAcl(String bucketName, String key) throws OSSException, ClientException
OSS
getObjectAcl
在接口中 OSS
bucketName
- Bucket name.key
- Object Key.ObjectAcl
instance of the object.OSSException
ClientException
public ObjectAcl getObjectAcl(GenericRequest genericRequest) throws OSSException, ClientException
OSS
getObjectAcl
在接口中 OSS
genericRequest
- A GenericRequest
instance which specifies the bucket
name and object key.OSSException
ClientException
public RestoreObjectResult restoreObject(String bucketName, String key) throws OSSException, ClientException
OSS
restoreObject
在接口中 OSS
bucketName
- Bucket name.key
- Object Key.RestoreObjectResult
instance.OSSException
ClientException
public RestoreObjectResult restoreObject(GenericRequest genericRequest) throws OSSException, ClientException
OSS
restoreObject
在接口中 OSS
genericRequest
- A GenericRequest
instance that specifies the bucket
name and object key.RestoreObjectResult
instance.OSSException
ClientException
public void setObjectTagging(String bucketName, String key, Map<String,String> tags) throws OSSException, ClientException
OSS
setObjectTagging
在接口中 OSS
bucketName
- Bucket name.key
- Object name.tags
- The dictionary that contains the tags in the form of <key,
value> pairs.OSSException
ClientException
public void setObjectTagging(String bucketName, String key, TagSet tagSet) throws OSSException, ClientException
OSS
setObjectTagging
在接口中 OSS
bucketName
- Bucket name.key
- Object name.tagSet
- TagSet
instance that has the tags in the form of <key,
value> pairs.OSSException
ClientException
public void setObjectTagging(SetObjectTaggingRequest setObjectTaggingRequest) throws OSSException, ClientException
OSS
setObjectTagging
在接口中 OSS
setObjectTaggingRequest
- SetObjectTaggingRequest
instance that has object
information as well as tagging information.OSSException
ClientException
public TagSet getObjectTagging(String bucketName, String key) throws OSSException, ClientException
OSS
getObjectTagging
在接口中 OSS
bucketName
- Bucket name.key
- Object name.TagSet
instance. If there's no tag, the TagSet object
with empty tag information is returned.OSSException
ClientException
public TagSet getObjectTagging(GenericRequest genericRequest) throws OSSException, ClientException
OSS
getObjectTagging
在接口中 OSS
genericRequest
- A GenericRequest
instance that specifies the bucket
name and object name.TagSet
instance.OSSException
ClientException
public void deleteObjectTagging(String bucketName, String key) throws OSSException, ClientException
OSS
deleteObjectTagging
在接口中 OSS
bucketName
- Bucket name.key
- Object name.OSSException
ClientException
public void deleteObjectTagging(GenericRequest genericRequest) throws OSSException, ClientException
OSS
deleteObjectTagging
在接口中 OSS
genericRequest
- A GenericRequest
instance that specifies the bucket
name and object name.OSSException
ClientException
public URL generatePresignedUrl(String bucketName, String key, Date expiration) throws ClientException
OSS
OSSObject
with HTTP GET
method.generatePresignedUrl
在接口中 OSS
bucketName
- Bucket name.key
- Object key.expiration
- URL's expiration time.OSSObject
object.ClientException
public URL generatePresignedUrl(String bucketName, String key, Date expiration, HttpMethod method) throws ClientException
OSS
OSSObject
with a
specific HTTP method.generatePresignedUrl
在接口中 OSS
bucketName
- Bucket name.key
- Object Key.expiration
- URL's expiration time.method
- HTTP method,Only HttpMethod.GET
and
HttpMethod.PUT
are supported.OSSObject
object.ClientException
public URL generatePresignedUrl(GeneratePresignedUrlRequest request) throws ClientException
OSS
OSSObject
with a
specific HTTP method.generatePresignedUrl
在接口中 OSS
request
- A GeneratePresignedUrlRequest
instance which specifies
the bucket name, file key, expiration time, HTTP method, and
the MD5 signature of the content, etc.OSSObject
object.ClientException
public void abortMultipartUpload(AbortMultipartUploadRequest request) throws OSSException, ClientException
OSS
abortMultipartUpload
在接口中 OSS
request
- A AbortMultipartUploadRequest
instance which specifies
the file name and the upload Id to abort.ClientException
OSSException
public CompleteMultipartUploadResult completeMultipartUpload(CompleteMultipartUploadRequest request) throws OSSException, ClientException
OSS
After all parts uploads finish, this API needs to be called to finalize the upload. All parts' number and their ETag are required and if ETag verification is not passed, the API will fail. The parts' are not necessarily ordered and the final file's content is determined by the order in partETags list.
The API will not automatically retry even if the max retry count is greater than 0 because it's not idempotent.
completeMultipartUpload
在接口中 OSS
request
- A CompleteMultipartUploadRequest
instance which
specifies all parameters to complete multiple part upload.CompleteMultipartUploadResult
instance which has the
key, ETag, url of the final object.ClientException
OSSException
public InitiateMultipartUploadResult initiateMultipartUpload(InitiateMultipartUploadRequest request) throws OSSException, ClientException
OSS
Prior to starting a multiple part upload, this method needs to be called to ask OSS service do some initialization work. Upon a successful call, it returns a globally unique upload ID which could be used for the subsequent operations such as pause, lookup multiple parts, etc. This method will not automatically retry even if the max retry count is greater than 0, because it's not idempotent.
initiateMultipartUpload
在接口中 OSS
request
- A InitiateMultipartUploadRequest
instance which
specifies the bucket name, object key and metadata.InitiateMultipartUploadResult
instance which has the
global unique id if succeeds.ClientException
OSSException
public MultipartUploadListing listMultipartUploads(ListMultipartUploadsRequest request) throws OSSException, ClientException
OSS
Those initialized but not finished multipart uploads would be listed by this method. If the executing multiple parts upload count is more than maxUploads (which could be up to 1000), then it would return the nextUploadIdMaker and nextKeyMaker which could be used for next call. When keyMarker in parameter request is specified, it would list executing multipart uploads whose keys are greater than the keyMarker in lexicographic order and multipart uploads whose keys are equal to the keyMarker and uploadIds are greater than uploadIdMarker in lexicographic order. In the other words, the keyMarker has the priority over the uploadIdMarker and uploadIdMarker only impacts the uploads who has the same keys as the keyMarker.
listMultipartUploads
在接口中 OSS
request
- A ListMultipartUploadsRequest
instance.MultipartUploadListing
instance.
Upon a successful call, it may has nextKeyMarker and
nextUploadIdMarker for the next call in case OSS has remaining
uploads not returned.ClientException
OSSException
public PartListing listParts(ListPartsRequest request) throws OSSException, ClientException
OSS
listParts
在接口中 OSS
request
- A ListPartsRequest
instance.ClientException
OSSException
public UploadPartResult uploadPart(UploadPartRequest request) throws OSSException, ClientException
OSS
uploadPart
在接口中 OSS
request
- A UploadPartRequest
instance which specifies bucket,
object key, upload id, part number, content and length, MD5
digest and chunked transfer encoding flag.UploadPartResult
instance to indicate
the upload result.ClientException
OSSException
public UploadPartCopyResult uploadPartCopy(UploadPartCopyRequest request) throws OSSException, ClientException
OSS
uploadPartCopy
在接口中 OSS
request
- A UploadPartCopyRequest
instance which specifies: 1)
source file 2) source file's copy range 3) target file 4)
target file's upload Id and its part number 5) constraints
such as ETag match or non-match, last modified match or
non-match, etc.UploadPartCopyResult
instance which has the part number
and ETag upon a successful upload.OSSException
ClientException
public void setBucketCORS(SetBucketCORSRequest request) throws OSSException, ClientException
OSS
setBucketCORS
在接口中 OSS
request
- A SetBucketCORSRequest
object that has defined all
CORS rules.OSSException
ClientException
public List<SetBucketCORSRequest.CORSRule> getBucketCORSRules(String bucketName) throws OSSException, ClientException
OSS
getBucketCORSRules
在接口中 OSS
bucketName
- Bucket name.SetBucketCORSRequest.CORSRule
under the bucket.OSSException
ClientException
public List<SetBucketCORSRequest.CORSRule> getBucketCORSRules(GenericRequest genericRequest) throws OSSException, ClientException
OSS
getBucketCORSRules
在接口中 OSS
genericRequest
- A GenericRequest
instance that specifies the bucket
name.SetBucketCORSRequest.CORSRule
under the bucket.OSSException
ClientException
public void deleteBucketCORSRules(String bucketName) throws OSSException, ClientException
OSS
deleteBucketCORSRules
在接口中 OSS
bucketName
- The bucket name.OSSException
ClientException
public void deleteBucketCORSRules(GenericRequest genericRequest) throws OSSException, ClientException
OSS
deleteBucketCORSRules
在接口中 OSS
genericRequest
- The GenericRequest
instance that specifies the bucket
name.OSSException
ClientException
public ResponseMessage optionsObject(OptionsRequest request) throws OSSException, ClientException
OSS
optionsObject
在接口中 OSS
OSSException
ClientException
public void setBucketLogging(SetBucketLoggingRequest request) throws OSSException, ClientException
OSS
Bucket
's logging. To enable the logging,
the TargetBucket attribute in SetBucketLoggingRequest object must be
specified. To disable the logging, the TargetBucket attribute in
SetBucketLoggingRequest object must be null. The logging file will be
hourly rolling log.setBucketLogging
在接口中 OSS
request
- A SetBucketLoggingRequest
instance which specifies the
bucket name to set the logging, the target bucket to store the
logging data and the prefix of the logging file.OSSException
ClientException
public BucketLoggingResult getBucketLogging(String bucketName) throws OSSException, ClientException
OSS
Bucket
's logging setting.getBucketLogging
在接口中 OSS
bucketName
- The bucket name.BucketLoggingResult
instance which contains the logging
settings such as target bucket for data, logging file prefix.OSSException
ClientException
public BucketLoggingResult getBucketLogging(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
's logging setting.getBucketLogging
在接口中 OSS
genericRequest
- The GenericRequest
instance which specifies the bucket
name.BucketLoggingResult
instance which contains the logging
settings such as target bucket for data, logging file prefix.OSSException
ClientException
public void deleteBucketLogging(String bucketName) throws OSSException, ClientException
OSS
Bucket
.deleteBucketLogging
在接口中 OSS
bucketName
- Bucket NameOSSException
ClientException
public void deleteBucketLogging(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
.deleteBucketLogging
在接口中 OSS
genericRequest
- The GenericRequest
instance which specifies the bucket
name.OSSException
ClientException
public void putBucketImage(PutBucketImageRequest request) throws OSSException, ClientException
OSS
Bucket
putBucketImage
在接口中 OSS
request
- A PutBucketImageRequest
instances which specifies some
attributes of image processing.OSSException
ClientException
public GetBucketImageResult getBucketImage(String bucketName) throws OSSException, ClientException
OSS
Bucket
.getBucketImage
在接口中 OSS
bucketName
- The bucket nameGetBucketImageResult
instance which has attributes of
image processingOSSException
ClientException
public GetBucketImageResult getBucketImage(String bucketName, GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
.getBucketImage
在接口中 OSS
bucketName
- The bucket name.genericRequest
- The origin request.GetBucketImageResult
which has the attributes of image
processing.OSSException
ClientException
public void deleteBucketImage(String bucketName) throws OSSException, ClientException
OSS
Bucket
.deleteBucketImage
在接口中 OSS
bucketName
- Bucket nameOSSException
ClientException
public void deleteBucketImage(String bucketName, GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
.deleteBucketImage
在接口中 OSS
bucketName
- Bucket namegenericRequest
- The origin requestOSSException
ClientException
public void putImageStyle(PutImageStyleRequest putImageStyleRequest) throws OSSException, ClientException
OSS
Bucket
.putImageStyle
在接口中 OSS
putImageStyleRequest
- A PutImageStyleRequest
instance that has bucket name
and style informationOSSException
ClientException
public void deleteImageStyle(String bucketName, String styleName) throws OSSException, ClientException
OSS
Bucket
deleteImageStyle
在接口中 OSS
bucketName
- Bucket namestyleName
- Style nameOSSException
ClientException
public void deleteImageStyle(String bucketName, String styleName, GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
deleteImageStyle
在接口中 OSS
bucketName
- Bucket namestyleName
- Style namegenericRequest
- The origin requestOSSException
ClientException
public GetImageStyleResult getImageStyle(String bucketName, String styleName) throws OSSException, ClientException
OSS
Bucket
getImageStyle
在接口中 OSS
bucketName
- Bucket name.styleName
- Style name.GetImageStyleResult
instance which has the style
information if successful or error code if failed.OSSException
ClientException
public GetImageStyleResult getImageStyle(String bucketName, String styleName, GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
getImageStyle
在接口中 OSS
bucketName
- Bucket name.styleName
- Style name.genericRequest
- The origin request.GetImageStyleResult
instance which has the style
information if successful or error code if failed.OSSException
ClientException
public List<Style> listImageStyle(String bucketName) throws OSSException, ClientException
OSS
Bucket
listImageStyle
在接口中 OSS
bucketName
- Bucket name.List
of all styles of the Bucket. If there's no style,
it will be an empty list.OSSException
ClientException
public List<Style> listImageStyle(String bucketName, GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
listImageStyle
在接口中 OSS
bucketName
- Bucket name.genericRequest
- The origin request.List
of all styles of the Bucket. If there's no style,
it will be an empty list.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void setBucketProcess(SetBucketProcessRequest setBucketProcessRequest) throws OSSException, ClientException
OSS
setBucketProcess
在接口中 OSS
setBucketProcessRequest
- A SetBucketTaggingRequest
instance that contains the
image accessing configuration such as enable original picture
protection, etc.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public BucketProcess getBucketProcess(String bucketName) throws OSSException, ClientException
OSS
getBucketProcess
在接口中 OSS
bucketName
- Bucket name.BucketProcess
which contains the image accessing
configurations if succeeds.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public BucketProcess getBucketProcess(GenericRequest genericRequest) throws OSSException, ClientException
OSS
getBucketProcess
在接口中 OSS
genericRequest
- A GenericRequest
instance that has the bucket name.BucketProcess
which contains the image accessing
configurations if succeeds.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void setBucketWebsite(SetBucketWebsiteRequest setBucketWebSiteRequest) throws OSSException, ClientException
OSS
Bucket
. The settings
includes the mandatory home page, the optional 404 page and the routing
rules. If home page is null, then the static website is not enabled on
the bucket.setBucketWebsite
在接口中 OSS
setBucketWebSiteRequest
- A SetBucketWebsiteRequest
instance to set with.OSSException
ClientException
public BucketWebsiteResult getBucketWebsite(String bucketName) throws OSSException, ClientException
OSS
Bucket
's static website settings.getBucketWebsite
在接口中 OSS
bucketName
- The bucket name.BucketWebsiteResult
instanceOSSException
ClientException
public BucketWebsiteResult getBucketWebsite(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
's static webite settings.getBucketWebsite
在接口中 OSS
genericRequest
- The GenericRequest
instance which specifies the bucket
name.BucketWebsiteResult
instance.OSSException
ClientException
public void deleteBucketWebsite(String bucketName) throws OSSException, ClientException
OSS
Bucket
's static website configuration, which means
disabling the static website on the bucket.deleteBucketWebsite
在接口中 OSS
bucketName
- Bucket nameOSSException
ClientException
public void deleteBucketWebsite(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
's static website configuration, which means
disabling the static website on the bucket.deleteBucketWebsite
在接口中 OSS
genericRequest
- The GenericRequest
instance which specifies the bucket
name.OSSException
ClientException
public BucketVersioningConfiguration getBucketVersioning(String bucketName) throws OSSException, ClientException
OSS
Returns the versioning configuration for the specified bucket.
A bucket's versioning configuration can be in one of three possible states:
BucketVersioningConfiguration.OFF
BucketVersioningConfiguration.ENABLED
BucketVersioningConfiguration.SUSPENDED
By default, new buckets are in the
off
state. Once versioning is
enabled for a bucket the status can never be reverted to
off
.
The versioning configuration of a bucket has different implications for
each operation performed on that bucket or for objects within that
bucket. For example, when versioning is enabled a PutObject
operation creates a unique object version-id for the object being uploaded. The
The PutObject
API guarantees that, if versioning is enabled for a bucket at
the time of the request, the new object can only be permanently deleted
using a DeleteVersion
operation. It can never be overwritten.
Additionally, the PutObject
API guarantees that,
if versioning is enabled for a bucket the request,
no other object will be overwritten by that request.
OSS is eventually consistent. It can take time for the versioning status of a bucket to be propagated throughout the system.
getBucketVersioning
在接口中 OSS
bucketName
- The bucket whose versioning configuration will be retrieved.OSSException
- If any errors occurred in OSS while processing the request.ClientException
- If any errors are encountered in the client while making the
request or handling the response.OSS.setBucketVersioning(SetBucketVersioningRequest)
,
OSS.getBucketVersioning(GenericRequest)
public BucketVersioningConfiguration getBucketVersioning(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Returns the versioning configuration for the specified bucket.
A bucket's versioning configuration can be in one of three possible states:
BucketVersioningConfiguration.OFF
BucketVersioningConfiguration.ENABLED
BucketVersioningConfiguration.SUSPENDED
By default, new buckets are in the
off
state. Once versioning is
enabled for a bucket the status can never be reverted to
off
.
The versioning configuration of a bucket has different implications for
each operation performed on that bucket or for objects within that
bucket. For example, when versioning is enabled a PutObject
operation creates a unique object version-id for the object being uploaded. The
The PutObject
API guarantees that, if versioning is enabled for a bucket at
the time of the request, the new object can only be permanently deleted
using a DeleteVersion
operation. It can never be overwritten.
Additionally, the PutObject
API guarantees that,
if versioning is enabled for a bucket the request,
no other object will be overwritten by that request.
OSS is eventually consistent. It can take time for the versioning status of a bucket to be propagated throughout the system.
getBucketVersioning
在接口中 OSS
genericRequest
- GenericRequest
instance that has the bucket name.OSSException
- If any errors occurred in OSS while processing the request.ClientException
- If any errors are encountered in the client while making the
request or handling the response.OSS.setBucketVersioning(SetBucketVersioningRequest)
,
OSS.getBucketVersioning(String)
public void setBucketVersioning(SetBucketVersioningRequest setBucketVersioningRequest) throws OSSException, ClientException
OSS
Sets the versioning configuration for the specified bucket.
A bucket's versioning configuration can be in one of three possible states:
BucketVersioningConfiguration.OFF
BucketVersioningConfiguration.ENABLED
BucketVersioningConfiguration.SUSPENDED
By default, new buckets are in the
off
state. Once versioning is
enabled for a bucket the status can never be reverted to
off
.
Objects created before versioning was enabled or when versioning is
suspended will be given the default null
version ID (see
OSSConstants.NULL_VERSION_ID
). Note that the
null
version ID is a valid version ID and is not the
same as not having a version ID.
The versioning configuration of a bucket has different implications for
each operation performed on that bucket or for objects within that
bucket. For example, when versioning is enabled a PutObject
operation creates a unique object version-id for the object being uploaded. The
The PutObject
API guarantees that, if versioning is enabled for a bucket at
the time of the request, the new object can only be permanently deleted
using a DeleteVersion
operation. It can never be overwritten.
Additionally, the PutObject
API guarantees that,
if versioning is enabled for a bucket the request,
no other object will be overwritten by that request.
Refer to the documentation sections for each API for information on how
versioning status affects the semantics of that particular API.
OSS is eventually consistent. It can take time for the versioning status of a bucket to be propagated throughout the system.
setBucketVersioning
在接口中 OSS
setBucketVersioningRequest
- The request object containing all options for setting the
bucket versioning configuration.OSSException
- If any errors occurred in OSS while processing the request.ClientException
- If any errors are encountered in the client while making the
request or handling the response.OSS.getBucketVersioning(String)
public String generatePostPolicy(Date expiration, PolicyConditions conds)
OSS
generatePostPolicy
在接口中 OSS
expiration
- Policy expiration time.conds
- Policy condition lists.public String calculatePostSignature(String postPolicy) throws ClientException
OSS
calculatePostSignature
在接口中 OSS
postPolicy
- Post policy string in JSON which is generated from
OSS.generatePostPolicy(Date, PolicyConditions)
.ClientException
public void setBucketLifecycle(SetBucketLifecycleRequest setBucketLifecycleRequest) throws OSSException, ClientException
OSS
Bucket
's lifecycle rule.setBucketLifecycle
在接口中 OSS
setBucketLifecycleRequest
- A SetBucketWebsiteRequest
instance which specifies the
lifecycle rulesOSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public List<LifecycleRule> getBucketLifecycle(String bucketName) throws OSSException, ClientException
OSS
Bucket
's lifecycle rules.getBucketLifecycle
在接口中 OSS
bucketName
- Bucket name.LifecycleRule
.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public List<LifecycleRule> getBucketLifecycle(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
's Lifecycle rules.getBucketLifecycle
在接口中 OSS
genericRequest
- The GenericRequest
instance which specifies the bucket
name.LifecycleRule
instances.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void deleteBucketLifecycle(String bucketName) throws OSSException, ClientException
OSS
Bucket
's Lifecycle rules.deleteBucketLifecycle
在接口中 OSS
bucketName
- The bucket name to operate on.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void deleteBucketLifecycle(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
's Lifecycle rules.deleteBucketLifecycle
在接口中 OSS
genericRequest
- The GenericRequest
instance which specifies the bucket
name.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void setBucketTagging(String bucketName, Map<String,String> tags) throws OSSException, ClientException
OSS
Bucket
instance specified by the bucket namesetBucketTagging
在接口中 OSS
bucketName
- Bucket name.tags
- The dictionary that contains the tags in the form of <key,
value> pairsOSSException
ClientException
public void setBucketTagging(String bucketName, TagSet tagSet) throws OSSException, ClientException
OSS
Bucket
instance.setBucketTagging
在接口中 OSS
bucketName
- Bucket name.tagSet
- TagSet
instance that has the tags in the form of <key,
value> paris.OSSException
ClientException
public void setBucketTagging(SetBucketTaggingRequest setBucketTaggingRequest) throws OSSException, ClientException
OSS
Bucket
instance in
SetBucketTaggingRequest
object.setBucketTagging
在接口中 OSS
setBucketTaggingRequest
- SetBucketTaggingRequest
instance that has bucket
information as well as tagging information.OSSException
ClientException
public TagSet getBucketTagging(String bucketName) throws OSSException, ClientException
OSS
Bucket
instance.getBucketTagging
在接口中 OSS
bucketName
- Bucket nameTagSet
instance. If there's no tag, the TagSet object
with empty tag information is returned.OSSException
ClientException
public TagSet getBucketTagging(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
instance.getBucketTagging
在接口中 OSS
genericRequest
- GenericRequest
instance that has the bucket name.TagSet
instance.OSSException
ClientException
public void deleteBucketTagging(String bucketName) throws OSSException, ClientException
OSS
Bucket
instance。deleteBucketTagging
在接口中 OSS
bucketName
- Bucket nameOSSException
ClientException
public void deleteBucketTagging(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
instance.deleteBucketTagging
在接口中 OSS
genericRequest
- GenericRequest
instance that has the bucket nameOSSException
ClientException
public void addBucketReplication(AddBucketReplicationRequest addBucketReplicationRequest) throws OSSException, ClientException
OSS
Bucket
's cross-region replication rule.addBucketReplication
在接口中 OSS
addBucketReplicationRequest
- A AddBucketReplicationRequest
instance which specifies
a replication rule.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public List<ReplicationRule> getBucketReplication(String bucketName) throws OSSException, ClientException
OSS
Bucket
's cross region replication rules.getBucketReplication
在接口中 OSS
bucketName
- Bucket name.ReplicationRule
under the bucket.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public List<ReplicationRule> getBucketReplication(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
's cross region replication rules.getBucketReplication
在接口中 OSS
genericRequest
- The GenericRequest
instance which specifies the bucket
name.ReplicationRule
under the bucket.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void deleteBucketReplication(String bucketName, String replicationRuleID) throws OSSException, ClientException
OSS
Bucket
's cross region replication rule.deleteBucketReplication
在接口中 OSS
bucketName
- Bucket name.replicationRuleID
- Replication Id to delete.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void deleteBucketReplication(DeleteBucketReplicationRequest deleteBucketReplicationRequest) throws OSSException, ClientException
OSS
Bucket
's cross region replication rule.deleteBucketReplication
在接口中 OSS
deleteBucketReplicationRequest
- The DeleteBucketReplicationRequest
instance which
specifies the replication rule Id to delete.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public BucketReplicationProgress getBucketReplicationProgress(String bucketName, String replicationRuleID) throws OSSException, ClientException
OSS
Bucket
's progress of the specified cross region
replication rule.getBucketReplicationProgress
在接口中 OSS
bucketName
- Bucket name.replicationRuleID
- Replication Rule Id.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public BucketReplicationProgress getBucketReplicationProgress(GetBucketReplicationProgressRequest getBucketReplicationProgressRequest) throws OSSException, ClientException
OSS
Bucket
's progress of the specified cross region
replication rule.getBucketReplicationProgress
在接口中 OSS
getBucketReplicationProgressRequest
- The GetBucketReplicationProgressRequest
instance which
specifies the replication rule Id and bucket name.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public List<String> getBucketReplicationLocation(String bucketName) throws OSSException, ClientException
OSS
Bucket
's replication reachable data centers.getBucketReplicationLocation
在接口中 OSS
bucketName
- Bucket name.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public List<String> getBucketReplicationLocation(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
's replication reachable data centers.getBucketReplicationLocation
在接口中 OSS
genericRequest
- The GenericRequest
instance that specifies the bucket
name.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void addBucketCname(AddBucketCnameRequest addBucketCnameRequest) throws OSSException, ClientException
OSS
Bucket
instance.addBucketCname
在接口中 OSS
addBucketCnameRequest
- The request specifies the bucket name and the Cname
information.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public List<CnameConfiguration> getBucketCname(String bucketName) throws OSSException, ClientException
OSS
Bucket
's Cnames.getBucketCname
在接口中 OSS
bucketName
- Bucket name.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public List<CnameConfiguration> getBucketCname(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
's Cnames.getBucketCname
在接口中 OSS
genericRequest
- The GenericRequest
instance which specifies the bucket
name.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void deleteBucketCname(String bucketName, String domain) throws OSSException, ClientException
OSS
Bucket
's Cname specified by the parameter domain.deleteBucketCname
在接口中 OSS
bucketName
- The bucket name。domain
- cname。OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void deleteBucketCname(DeleteBucketCnameRequest deleteBucketCnameRequest) throws OSSException, ClientException
OSS
Bucket
's specific Cname specified by the parameter
domain.deleteBucketCname
在接口中 OSS
deleteBucketCnameRequest
- A DeleteBucketCnameRequest
instance that specifies the
bucket name and the domain name to deleteOSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public BucketInfo getBucketInfo(String bucketName) throws OSSException, ClientException
OSS
Bucket
's basic information as well as its ACL.getBucketInfo
在接口中 OSS
bucketName
- The bucket name。BucketInfo
instance.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public BucketInfo getBucketInfo(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
's basic information as well as its ACL.getBucketInfo
在接口中 OSS
genericRequest
- The GenericRequest
instance which specifies the bucket
name.BucketInfo
instance.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public BucketStat getBucketStat(String bucketName) throws OSSException, ClientException
OSS
Bucket
's storage information such as object counts,
storage size and executing multipart uploads.getBucketStat
在接口中 OSS
bucketName
- The bucket name。BucketStat
instance.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public BucketStat getBucketStat(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
's storage information such as object counts,
storage size and executing multipart uploads.getBucketStat
在接口中 OSS
genericRequest
- The GenericRequest
instance which specifies the bucket
name.BucketStat
instance.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void setBucketStorageCapacity(String bucketName, UserQos userQos) throws OSSException, ClientException
OSS
Bucket
.setBucketStorageCapacity
在接口中 OSS
bucketName
- The bucket name。userQos
- A UserQos
instance which specifies the capacity in GBOSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void setBucketStorageCapacity(SetBucketStorageCapacityRequest setBucketStorageCapacityRequest) throws OSSException, ClientException
OSS
Bucket
.setBucketStorageCapacity
在接口中 OSS
setBucketStorageCapacityRequest
- A SetBucketStorageCapacityRequest
instance which
specifies the bucket name as well as a UserQos instanceOSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public UserQos getBucketStorageCapacity(String bucketName) throws OSSException, ClientException
OSS
Bucket
's capacitygetBucketStorageCapacity
在接口中 OSS
bucketName
- The bucket name.UserQos
instance which has the capacity information.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public UserQos getBucketStorageCapacity(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
's capacitygetBucketStorageCapacity
在接口中 OSS
genericRequest
- The GenericRequest
instance which specifies the bucket
name.UserQos
instance which has the capacity information.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void setBucketEncryption(SetBucketEncryptionRequest setBucketEncryptionRequest) throws OSSException, ClientException
OSS
setBucketEncryption
在接口中 OSS
setBucketEncryptionRequest
- The request object for setting the bucket encryption configuration.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public ServerSideEncryptionConfiguration getBucketEncryption(String bucketName) throws OSSException, ClientException
OSS
getBucketEncryption
在接口中 OSS
bucketName
- Name of the bucket to retrieve encryption configuration for.ServerSideEncryptionConfiguration
.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public ServerSideEncryptionConfiguration getBucketEncryption(GenericRequest genericRequest) throws OSSException, ClientException
OSS
getBucketEncryption
在接口中 OSS
genericRequest
- The GenericRequest
instance which specifies the bucket
name.ServerSideEncryptionConfiguration
.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void deleteBucketEncryption(String bucketName) throws OSSException, ClientException
OSS
deleteBucketEncryption
在接口中 OSS
bucketName
- The bucket name.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void deleteBucketEncryption(GenericRequest genericRequest) throws OSSException, ClientException
OSS
deleteBucketEncryption
在接口中 OSS
genericRequest
- The GenericRequest
instance which specifies the bucket
name.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void setBucketPolicy(String bucketName, String policyText) throws OSSException, ClientException
OSS
Bucket
instance.setBucketPolicy
在接口中 OSS
bucketName
- Bucket name.policyText
- Policy JSON text, please refer to the policy writing rules of AliyunOSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void setBucketPolicy(SetBucketPolicyRequest setBucketPolicyRequest) throws OSSException, ClientException
OSS
Bucket
instance.setBucketPolicy
在接口中 OSS
OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public GetBucketPolicyResult getBucketPolicy(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
instance.getBucketPolicy
在接口中 OSS
genericRequest
- GenericRequest
instance that has the bucket name.InputStream
.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public GetBucketPolicyResult getBucketPolicy(String bucketName) throws OSSException, ClientException
OSS
Bucket
instance.getBucketPolicy
在接口中 OSS
bucketName
- Bucket nameInputStream
.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void deleteBucketPolicy(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
instance.deleteBucketPolicy
在接口中 OSS
genericRequest
- GenericRequest
instance that has the bucket name.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void deleteBucketPolicy(String bucketName) throws OSSException, ClientException
OSS
Bucket
instance.deleteBucketPolicy
在接口中 OSS
bucketName
- Bucket nameOSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public UploadFileResult uploadFile(UploadFileRequest uploadFileRequest) throws Throwable
OSS
uploadFile
在接口中 OSS
uploadFileRequest
- A UploadFileRequest
instance that specifies the bucket
name, object key, file path ,part size (> 100K) and thread
count (from 1 to 1000) and checkpoint file.UploadFileRequest
instance which has the new uploaded
file's key, ETag, location.Throwable
public DownloadFileResult downloadFile(DownloadFileRequest downloadFileRequest) throws Throwable
OSS
downloadFile
在接口中 OSS
downloadFileRequest
- A DownloadFileRequest
instance that specifies the
bucket name, object key, file path, part size (> 100K) and
thread count (from 1 to 1000) and checkpoint file. Also it
could have the ETag and ModifiedSince constraints.DownloadFileResult
instance that has the
ObjectMetadata
information.Throwable
public CreateLiveChannelResult createLiveChannel(CreateLiveChannelRequest createLiveChannelRequest) throws OSSException, ClientException
OSS
createLiveChannel
在接口中 OSS
createLiveChannelRequest
- A CreateLiveChannelRequest
instance that specifies the
target bucket name, channel name, channel status (Enabled or
Disabled), streaming storage status such as media file name,
its .ts file time duration, etc.CreateLiveChannelResult
instance that specifies the
publish url and playback url.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void setLiveChannelStatus(String bucketName, String liveChannel, LiveChannelStatus status) throws OSSException, ClientException
OSS
setLiveChannelStatus
在接口中 OSS
bucketName
- Bucket name.liveChannel
- Live Channel name.status
- Live Channel status: "Enabled" or "Disabled".OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void setLiveChannelStatus(SetLiveChannelRequest setLiveChannelRequest) throws OSSException, ClientException
OSS
setLiveChannelStatus
在接口中 OSS
setLiveChannelRequest
- A SetLiveChannelRequest
instance that specifies the
bucket name, the channel name and the Live Channel status.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public LiveChannelInfo getLiveChannelInfo(String bucketName, String liveChannel) throws OSSException, ClientException
OSS
getLiveChannelInfo
在接口中 OSS
bucketName
- Bucket name.liveChannel
- Live Channel name.LiveChannelInfo
instance that contains the Live
Channel's name, description, bucket name and its streaming
storage information.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public LiveChannelInfo getLiveChannelInfo(LiveChannelGenericRequest liveChannelGenericRequest) throws OSSException, ClientException
OSS
getLiveChannelInfo
在接口中 OSS
liveChannelGenericRequest
- A LiveChannelGenericRequest
instance that specifies
the bucket name and Live Channel name.LiveChannelInfo
instance that contains the Live
Channel's name, description, bucket name and its streaming
storage information.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public LiveChannelStat getLiveChannelStat(String bucketName, String liveChannel) throws OSSException, ClientException
OSS
getLiveChannelStat
在接口中 OSS
bucketName
- Bucket name.liveChannel
- Live Channel name.LiveChannelStat
instance that contains the media's
resolution, frame rate and bandwidth.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public LiveChannelStat getLiveChannelStat(LiveChannelGenericRequest liveChannelGenericRequest) throws OSSException, ClientException
OSS
getLiveChannelStat
在接口中 OSS
liveChannelGenericRequest
- A LiveChannelGenericRequest
instance that specifies
the bucket name and channel name.LiveChannelStat
instance that contains the media's
resolution, frame rate and bandwidth.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void deleteLiveChannel(String bucketName, String liveChannel) throws OSSException, ClientException
OSS
deleteLiveChannel
在接口中 OSS
bucketName
- Bucket name.liveChannel
- Live Channel name.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void deleteLiveChannel(LiveChannelGenericRequest liveChannelGenericRequest) throws OSSException, ClientException
OSS
deleteLiveChannel
在接口中 OSS
liveChannelGenericRequest
- A LiveChannelGenericRequest
instance that specifies
theOSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public List<LiveChannel> listLiveChannels(String bucketName) throws OSSException, ClientException
OSS
listLiveChannels
在接口中 OSS
bucketName
- Bucket name.LiveChannel
instances under the bucket.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public LiveChannelListing listLiveChannels(ListLiveChannelsRequest listLiveChannelRequest) throws OSSException, ClientException
OSS
listLiveChannels
在接口中 OSS
listLiveChannelRequest
- A ListLiveChannelsRequest
that specifies the bucket
name and its requirement on Live Channel instances to return,
such as prefix, marker, max entries to return.LiveChannel
instances that meet the
requirements.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public List<LiveRecord> getLiveChannelHistory(String bucketName, String liveChannel) throws OSSException, ClientException
OSS
LiveRecord
entries from the specified Live Channel.
OSS saves recent 10 LiveRecord (pushing streaming record) for every Live
Channel.getLiveChannelHistory
在接口中 OSS
bucketName
- Bucket name.liveChannel
- Live Channel name.LiveRecord
for the live channel.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public List<LiveRecord> getLiveChannelHistory(LiveChannelGenericRequest liveChannelGenericRequest) throws OSSException, ClientException
OSS
LiveRecord
entries from the specified Live Channel.
OSS saves recent 10 LiveRecord (pushing streaming record) for every Live
Channel.getLiveChannelHistory
在接口中 OSS
liveChannelGenericRequest
- A LiveChannelGenericRequest
instance that specifies
the bucket name and Live Channel name.LiveRecord
for the live channel.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void generateVodPlaylist(String bucketName, String liveChannelName, String PlaylistName, long startTime, long endTime) throws OSSException, ClientException
OSS
generateVodPlaylist
在接口中 OSS
bucketName
- Bucket name.liveChannelName
- Live Channel name.PlaylistName
- The playlist file name, such as (playlist.m3u8).startTime
- The start time of the playlist in epoch time (means *.ts files
time is same or later than it)endTime
- The end time of the playlist in epoch time(means *.ts files
time is no later than it).OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void generateVodPlaylist(GenerateVodPlaylistRequest generateVodPlaylistRequest) throws OSSException, ClientException
OSS
generateVodPlaylist
在接口中 OSS
generateVodPlaylistRequest
- A GenerateVodPlaylistRequest
instance the specifies
the bucket name and the Live Channel name.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public OSSObject getVodPlaylist(String bucketName, String liveChannelName, long startTime, long endTime) throws OSSException, ClientException
OSS
getVodPlaylist
在接口中 OSS
bucketName
- Bucket name.liveChannelName
- Live Channel name.startTime
- The start time of the playlist in epoch time (means *.ts files
time is same or later than it)endTime
- The end time of the playlist in epoch time(means *.ts files
time is no later than it).OSSObject
instance.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public OSSObject getVodPlaylist(GetVodPlaylistRequest getVodPlaylistRequest) throws OSSException, ClientException
OSS
getVodPlaylist
在接口中 OSS
getVodPlaylistRequest
- A GetVodPlaylistRequest
instance the specifies
the bucket name and the Live Channel name.OSSObject
instance.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public String generateRtmpUri(String bucketName, String liveChannelName, String PlaylistName, long expires) throws OSSException, ClientException
OSS
generateRtmpUri
在接口中 OSS
bucketName
- Bucket name.liveChannelName
- Live Channel name.PlaylistName
- The playlist file name such as playlist.m3u8.expires
- Expiration time in epoch time, such as 1459922563.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public String generateRtmpUri(GenerateRtmpUriRequest generateRtmpUriRequest) throws OSSException, ClientException
OSS
generateRtmpUri
在接口中 OSS
generateRtmpUriRequest
- A GenerateRtmpUriRequest
instance that specifies the
bucket name and the Live Channel name.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void createSymlink(String bucketName, String symLink, String targetObject) throws OSSException, ClientException
OSS
createSymlink
在接口中 OSS
bucketName
- Bucket name.symLink
- symlink name.targetObject
- target file key.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void createSymlink(CreateSymlinkRequest createSymlinkRequest) throws OSSException, ClientException
OSS
createSymlink
在接口中 OSS
createSymlinkRequest
- A CreateSymlinkRequest
instance that specifies the
bucket name, symlink name.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public OSSSymlink getSymlink(String bucketName, String symLink) throws OSSException, ClientException
OSS
getSymlink
在接口中 OSS
bucketName
- Bucket name.symLink
- The symlink name.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public OSSSymlink getSymlink(GenericRequest genericRequest) throws OSSException, ClientException
OSS
getSymlink
在接口中 OSS
genericRequest
- A GenericRequest
instance which specifies the bucket
name and symlink name.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public GenericResult processObject(ProcessObjectRequest processObjectRequest) throws OSSException, ClientException
OSS
The supported process includes resize, rotate, crop, watermark, format,
udf, customized style, etc. The GenericResult
instance returned
must be closed by the calller to release connection via calling
getResponse().getContent().close().
processObject
在接口中 OSS
processObjectRequest
- A ProcessObjectRequest
instance that specifies the
bucket name, the object key and the process (such as
image/resize,w_500)GenericResult
instance which must be closed after the
usage by the caller.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void setBucketRequestPayment(String bucketName, Payer payer) throws OSSException, ClientException
OSS
Bucket
.setBucketRequestPayment
在接口中 OSS
bucketName
- The bucket name.payer
- The request payer settingOSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void setBucketRequestPayment(SetBucketRequestPaymentRequest setBucketRequestPaymentRequest) throws OSSException, ClientException
OSS
Bucket
.setBucketRequestPayment
在接口中 OSS
setBucketRequestPaymentRequest
- A SetBucketRequestPaymentRequest
instance that has
the bucket name and payer setting.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public GetBucketRequestPaymentResult getBucketRequestPayment(String bucketName) throws OSSException, ClientException
OSS
Bucket
.getBucketRequestPayment
在接口中 OSS
bucketName
- The bucket name.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public GetBucketRequestPaymentResult getBucketRequestPayment(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
.getBucketRequestPayment
在接口中 OSS
genericRequest
- GenericRequest
instance that has the bucket name.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void setBucketQosInfo(String bucketName, BucketQosInfo bucketQosInfo) throws OSSException, ClientException
OSS
Bucket
.setBucketQosInfo
在接口中 OSS
bucketName
- The bucket name.bucketQosInfo
- The bucket qos info settingOSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void setBucketQosInfo(SetBucketQosInfoRequest setBucketQosInfoRequest) throws OSSException, ClientException
OSS
Bucket
.setBucketQosInfo
在接口中 OSS
setBucketQosInfoRequest
- SetBucketQosInfoRequest
instance that has the bucket name and bucket qos info.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public BucketQosInfo getBucketQosInfo(String bucketName) throws OSSException, ClientException
OSS
Bucket
.getBucketQosInfo
在接口中 OSS
bucketName
- The bucket name.BucketQosInfo
instance.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public BucketQosInfo getBucketQosInfo(GenericRequest genericRequest) throws OSSException, ClientException
OSS
Bucket
.getBucketQosInfo
在接口中 OSS
genericRequest
- GenericRequest
instance that has the bucket name.BucketQosInfo
instance.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void deleteBucketQosInfo(String bucketName) throws OSSException, ClientException
OSS
deleteBucketQosInfo
在接口中 OSS
bucketName
- The bucket nameOSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void deleteBucketQosInfo(GenericRequest genericRequest) throws OSSException, ClientException
OSS
deleteBucketQosInfo
在接口中 OSS
genericRequest
- A GenericRequest
instance that has the bucket nameOSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public UserQosInfo getUserQosInfo() throws OSSException, ClientException
OSS
getUserQosInfo
在接口中 OSS
UserQosInfo
instance.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public SetAsyncFetchTaskResult setAsyncFetchTask(String bucketName, AsyncFetchTaskConfiguration asyncFetchTaskConfiguration) throws OSSException, ClientException
OSS
setAsyncFetchTask
在接口中 OSS
bucketName
- The bucket name.asyncFetchTaskConfiguration
- The async fetch task configuration.SetAsyncFetchTaskResult
instance.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public SetAsyncFetchTaskResult setAsyncFetchTask(SetAsyncFetchTaskRequest setAsyncFetchTaskRequest) throws OSSException, ClientException
OSS
setAsyncFetchTask
在接口中 OSS
setAsyncFetchTaskRequest
- A SetAsyncFetchTaskRequest
instance that specified the bucket name
and the task configuration.SetAsyncFetchTaskResult
instance.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public GetAsyncFetchTaskResult getAsyncFetchTask(String bucketName, String taskId) throws OSSException, ClientException
OSS
getAsyncFetchTask
在接口中 OSS
bucketName
- The bucket name.taskId
- The id of the task which you want to get.GetAsyncFetchTaskResult
instance.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public GetAsyncFetchTaskResult getAsyncFetchTask(GetAsyncFetchTaskRequest getAsyncFetchTaskRequest) throws OSSException, ClientException
OSS
getAsyncFetchTask
在接口中 OSS
getAsyncFetchTaskRequest
- A GetAsyncFetchTaskRequest
instance that specified the bucket name
and the task id.GetAsyncFetchTaskResult
instance.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public void createUdf(CreateUdfRequest createUdfRequest) throws OSSException, ClientException
OSS
createUdf
在接口中 OSS
createUdfRequest
- A CreateUdfRequest
instance.OSSException
- OSS Server side exception.ClientException
- OSS Client side exception.public UdfInfo getUdfInfo(UdfGenericRequest genericRequest) throws OSSException, ClientException
getUdfInfo
在接口中 OSS
OSSException
ClientException
public List<UdfInfo> listUdfs() throws OSSException, ClientException
listUdfs
在接口中 OSS
OSSException
ClientException
public void deleteUdf(UdfGenericRequest genericRequest) throws OSSException, ClientException
deleteUdf
在接口中 OSS
OSSException
ClientException
public void uploadUdfImage(UploadUdfImageRequest uploadUdfImageRequest) throws OSSException, ClientException
uploadUdfImage
在接口中 OSS
OSSException
ClientException
public List<UdfImageInfo> getUdfImageInfo(UdfGenericRequest genericRequest) throws OSSException, ClientException
getUdfImageInfo
在接口中 OSS
OSSException
ClientException
public void deleteUdfImage(UdfGenericRequest genericRequest) throws OSSException, ClientException
deleteUdfImage
在接口中 OSS
OSSException
ClientException
public void createUdfApplication(CreateUdfApplicationRequest createUdfApplicationRequest) throws OSSException, ClientException
createUdfApplication
在接口中 OSS
OSSException
ClientException
public UdfApplicationInfo getUdfApplicationInfo(UdfGenericRequest genericRequest) throws OSSException, ClientException
getUdfApplicationInfo
在接口中 OSS
OSSException
ClientException
public List<UdfApplicationInfo> listUdfApplications() throws OSSException, ClientException
listUdfApplications
在接口中 OSS
OSSException
ClientException
public void deleteUdfApplication(UdfGenericRequest genericRequest) throws OSSException, ClientException
deleteUdfApplication
在接口中 OSS
OSSException
ClientException
public void upgradeUdfApplication(UpgradeUdfApplicationRequest upgradeUdfApplicationRequest) throws OSSException, ClientException
upgradeUdfApplication
在接口中 OSS
OSSException
ClientException
public void resizeUdfApplication(ResizeUdfApplicationRequest resizeUdfApplicationRequest) throws OSSException, ClientException
resizeUdfApplication
在接口中 OSS
OSSException
ClientException
public UdfApplicationLog getUdfApplicationLog(GetUdfApplicationLogRequest getUdfApplicationLogRequest) throws OSSException, ClientException
getUdfApplicationLog
在接口中 OSS
OSSException
ClientException
Copyright © 2019. All Rights Reserved.