com.aliyun.oss.model

Class GenericRequest

java.lang.Object

com.aliyun.oss.model.WebServiceRequest

com.aliyun.oss.model.GenericRequest

Direct Known Subclasses:

AbortMultipartUploadRequest, AddBucketCnameRequest, AddBucketReplicationRequest, AsyncProcessObjectRequest, CompleteBucketWormRequest, CompleteMultipartUploadRequest, CreateBucketCnameTokenRequest, CreateBucketRequest, CreateBucketVpcipRequest, CreateDirectoryRequest, CreateSymlinkRequest, CreateVpcipRequest, DeleteBucketCnameRequest, DeleteBucketInventoryConfigurationRequest, DeleteBucketReplicationRequest, DeleteBucketVpcipRequest, DeleteDirectoryRequest, DeleteObjectsRequest, DeleteVersionRequest, DeleteVersionsRequest, DeleteVpcipRequest, DescribeRegionsRequest, DoMetaQueryRequest, DownloadFileRequest, ExtendBucketWormRequest, GetAsyncFetchTaskRequest, GetBucketCnameTokenRequest, GetBucketInventoryConfigurationRequest, GetBucketReplicationProgressRequest, GetObjectRequest, InitiateBucketWormRequest, InitiateMultipartUploadRequest, ListBucketInventoryConfigurationsRequest, ListMultipartUploadsRequest, ListObjectsRequest, ListObjectsV2Request, ListPartsRequest, ListVersionsRequest, LiveChannelGenericRequest, OptionsRequest, ProcessObjectRequest, PutBucketAccessMonitorRequest, PutBucketImageRequest, PutImageStyleRequest, PutObjectRequest, RenameObjectRequest, RestoreObjectRequest, SetAsyncFetchTaskRequest, SetBucketAclRequest, SetBucketCallbackPolicyRequest, SetBucketCORSRequest, SetBucketEncryptionRequest, SetBucketInventoryConfigurationRequest, SetBucketLifecycleRequest, SetBucketLoggingRequest, SetBucketPolicyRequest, SetBucketProcessRequest, SetBucketQosInfoRequest, SetBucketRefererRequest, SetBucketRequestPaymentRequest, SetBucketResourceGroupRequest, SetBucketStorageCapacityRequest, SetBucketTransferAccelerationRequest, SetBucketVersioningRequest, SetBucketWebsiteRequest, SetObjectAclRequest, SetTaggingRequest, UploadFileRequest, UploadPartRequest, VpcPolicy

public class GenericRequest
extends WebServiceRequest

A generic request that contains some basic request options, such as bucket name, object key, costom headers, progress listener and so on.

Field Summary

Fields inherited from class com.aliyun.oss.model.WebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GenericRequest()
GenericRequest(String bucketName)
GenericRequest(String bucketName, String key)
GenericRequest(String bucketName, String key, String versionId)

Method Summary

Modifier and Type	Method and Description
String	getBucketName()
String	getKey()
Payer	getRequestPayer() *
String	getVersionId() Gets the optional version ID specifying which version of the object to operate.
void	setBucketName(String bucketName)
void	setKey(String key)
void	setRequestPayer(Payer payer) *
void	setVersionId(String versionId) Sets the optional version ID specifying which version of the object to operate.
GenericRequest	withBucketName(String bucketName)
GenericRequest	withKey(String key)
GenericRequest	withRequestPayer(Payer payer) *
GenericRequest	withVersionId(String versionId) Sets the optional version ID specifying which version of the object to download and returns this object, enabling additional method calls to be chained together.

Methods inherited from class com.aliyun.oss.model.WebServiceRequest

addAdditionalHeaderName, addHeader, addParameter, getAdditionalHeaderNames, getEndpoint, getHeaders, getParameters, getProgressListener, isLogEnabled, setAdditionalHeaderNames, setEndpoint, setHeaders, setLogEnabled, setParameters, setProgressListener, withProgressListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenericRequest

public GenericRequest()

GenericRequest

public GenericRequest(String bucketName)

GenericRequest

public GenericRequest(String bucketName,
                      String key)

GenericRequest

public GenericRequest(String bucketName,
                      String key,
                      String versionId)

Method Detail

getBucketName

public String getBucketName()

setBucketName

public void setBucketName(String bucketName)

withBucketName

public GenericRequest withBucketName(String bucketName)

getKey

public String getKey()

setKey

public void setKey(String key)

withKey

public GenericRequest withKey(String key)

getVersionId

public String getVersionId()

Gets the optional version ID specifying which version of the object to operate. If not specified, the most recent version will be operated.

Objects created before versioning was enabled or when versioning is suspended are 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.

Returns:

The optional version ID specifying which version of the object to operate. If not specified, the most recent version will be operated.

setVersionId

public void setVersionId(String versionId)

Sets the optional version ID specifying which version of the object to operate. If not specified, the most recent version will be operated.

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.

Parameters:

versionId - The optional version ID specifying which version of the object to operate.

withVersionId

public GenericRequest withVersionId(String versionId)

Sets the optional version ID specifying which version of the object to download and returns this object, enabling additional method calls to be chained together. If not specified, the most recent version will be operated.

Objects created before versioning was enabled or when versioning is suspended will be given the default or 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.

Parameters:

versionId - The optional version ID specifying which version of the object to operate.

Returns:

The updated request object.

setRequestPayer

public void setRequestPayer(Payer payer)

*

Sets the one who pays for the request The Third party should set request payer when requesting resources.

Parameters:

payer - The one who pays for the request

getRequestPayer

public Payer getRequestPayer()

*

Gets the one who pays for the request

Returns:

The one who pays for the request

withRequestPayer

public GenericRequest withRequestPayer(Payer payer)

*

Sets the one who pays for the request The Third party should set request payer when requesting resources.

Parameters:

payer - The one who pays for the request

Returns:

The updated request object.