com.qcloud.cos.internal

类 CosServiceRequest

java.lang.Object

com.qcloud.cos.internal.CosServiceRequest

所有已实现的接口:

ReadLimitInfo, Cloneable

直接已知子类:

AbortMultipartUploadRequest, AbstractPutObjectRequest, CompleteMultipartUploadRequest, CopyObjectRequest, CopyPartRequest, CreateBucketRequest, DeleteBucketRequest, DeleteObjectRequest, DeleteObjectsRequest, GeneratePresignedUrlRequest, GenericBucketRequest, GetObjectAclRequest, GetObjectMetadataRequest, GetObjectRequest, InitiateMultipartUploadRequest, ListBucketsRequest, ListMultipartUploadsRequest, ListNextBatchOfObjectsRequest, ListObjectsRequest, ListPartsRequest, ResponseHeaderOverrides, SetBucketAclRequest, SetBucketCrossOriginConfigurationRequest, SetBucketLifecycleConfigurationRequest, SetBucketReplicationConfigurationRequest, SetBucketVersioningConfigurationRequest, SetObjectAclRequest, UploadPartRequest

public class CosServiceRequest
extends Object
implements Cloneable, ReadLimitInfo

构造器概要

构造器

构造器和说明
CosServiceRequest()

方法概要

方法

限定符和类型	方法和说明
protected <T extends CosServiceRequest> T	copyBaseTo(T target) Copies the internal state of this base class to that of the target request.
Map<String,List<String>>	getCustomQueryParameters()
Map<String,String>	getCustomRequestHeaders() Returns an immutable map of custom header names to header values.
ProgressListener	getGeneralProgressListener() Returns the optional progress listener for receiving updates about the progress of the request.
int	getReadLimit() Returns the read limit for mark-and-reset during retries; or -1 if not available.
RequestClientOptions	getRequestClientOptions() Gets the options stored with this request object.
void	putCustomQueryParameter(String name, String value) Add a custom query parameter for the request.
String	putCustomRequestHeader(String name, String value) Put a new custom header to the map of custom header names to custom header values, and return the previous value if the header has already been set in this map.
void	setGeneralProgressListener(ProgressListener progressListener) Sets the optional progress listener for receiving updates about the progress of the request.
<T extends CosServiceRequest> T	withGeneralProgressListener(ProgressListener progressListener) Sets the optional progress listener for receiving updates about the progress of the request, and returns a reference to this object so that method calls can be chained together.

从类继承的方法 java.lang.Object

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

构造器详细资料

CosServiceRequest

public CosServiceRequest()

方法详细资料

setGeneralProgressListener

public void setGeneralProgressListener(ProgressListener progressListener)

Sets the optional progress listener for receiving updates about the progress of the request.

参数:

progressListener - The new progress listener.

getGeneralProgressListener

public ProgressListener getGeneralProgressListener()

Returns the optional progress listener for receiving updates about the progress of the request.

返回:

the optional progress listener for receiving updates about the progress of the request.

withGeneralProgressListener

public <T extends CosServiceRequest> T withGeneralProgressListener(ProgressListener progressListener)

Sets the optional progress listener for receiving updates about the progress of the request, and returns a reference to this object so that method calls can be chained together.

参数:

progressListener - The new progress listener.

返回:

A reference to this updated object so that method calls can be chained together.

getCustomRequestHeaders

public Map<String,String> getCustomRequestHeaders()

Returns an immutable map of custom header names to header values.

返回:

The immutable map of custom header names to header values.

putCustomRequestHeader

public String putCustomRequestHeader(String name,
                            String value)

Put a new custom header to the map of custom header names to custom header values, and return the previous value if the header has already been set in this map.

NOTE: Custom header values set via this method will overwrite any conflicting values coming from the request parameters.

参数:

name - The name of the header to add

value - The value of the header to add

返回:

the previous value for the name if it was set, null otherwise

getCustomQueryParameters

public Map<String,List<String>> getCustomQueryParameters()

返回:

the immutable map of custom query parameters. The parameter value is modeled as a list of strings because multiple values can be specified for the same parameter name.

putCustomQueryParameter

public void putCustomQueryParameter(String name,
                           String value)

Add a custom query parameter for the request. Since multiple values are allowed for the same query parameter, this method does NOT overwrite any existing parameter values in the request.

参数:

name - The name of the query parameter

value - The value of the query parameter. Only the parameter name will be added in the URI if the value is set to null. For example, putCustomQueryParameter("param", null) will be serialized to "?param", while putCustomQueryParameter("param", "") will be serialized to "?param=".

getRequestClientOptions

public RequestClientOptions getRequestClientOptions()

Gets the options stored with this request object. Intended for internal use only.

copyBaseTo

protected final <T extends CosServiceRequest> T copyBaseTo(T target)

Copies the internal state of this base class to that of the target request.

返回:

the target request

getReadLimit

public int getReadLimit()

从接口复制的说明: ReadLimitInfo

Returns the read limit for mark-and-reset during retries; or -1 if not available.

指定者:

getReadLimit 在接口中 ReadLimitInfo