CosServiceRequest (cos-java-sdk 5.6.137 API)

java.lang.Object
- com.qcloud.cos.internal.CosServiceRequest

All Implemented Interfaces:

ReadLimitInfo, Cloneable

Direct Known Subclasses:

AbortMultipartUploadRequest, AbstractPutObjectRequest, AutoTranslationBlockRequest, BucketDomainCertificateRequest, CIServiceRequest, CompleteMultipartUploadRequest, CopyObjectRequest, CopyPartRequest, CosSnapshotRequest, CreateBucketRequest, DecompressionRequest, DeleteBucketDomainConfigurationRequest, DeleteBucketInventoryConfigurationRequest, DeleteBucketRequest, DeleteObjectRequest, DeleteObjectsRequest, DeleteObjectTaggingRequest, DeleteVersionRequest, DetectCarRequest, DocHtmlRequest, GeneratePresignedUrlRequest, GenerateQrcodeRequest, GenericBucketRequest, GetAsyncFetchTaskRequest, GetBucketDomainConfigurationRequest, GetBucketIntelligentTierConfigurationRequest, GetBucketInventoryConfigurationRequest, GetBucketRefererConfigurationRequest, GetBucketWebsiteConfigurationRequest, GetObjectAclRequest, GetObjectMetadataRequest, GetObjectRequest, GetObjectTaggingRequest, GetSymlinkRequest, ImageAuditingRequest, ImageLabelRequest, ImageLabelV2Request, ImageProcessRequest, ImageSearchRequest, InitiateMultipartUploadRequest, ListBucketInventoryConfigurationsRequest, ListBucketsRequest, ListMultipartUploadsRequest, ListNextBatchOfObjectsRequest, ListNextBatchOfVersionsRequest, ListObjectsRequest, ListPartsRequest, ListVersionsRequest, PrivateM3U8Request, PutAsyncFetchTaskRequest, PutInstructionFileRequest, PutSymlinkRequest, RenameRequest, RestoreObjectRequest, SelectObjectContentRequest, SetBucketAclRequest, SetBucketCrossOriginConfigurationRequest, SetBucketDomainCertificateRequest, SetBucketDomainConfigurationRequest, SetBucketIntelligentTierConfigurationRequest, SetBucketInventoryConfigurationRequest, SetBucketLifecycleConfigurationRequest, SetBucketLoggingConfigurationRequest, SetBucketPolicyRequest, SetBucketRefererConfigurationRequest, SetBucketReplicationConfigurationRequest, SetBucketTaggingConfigurationRequest, SetBucketVersioningConfigurationRequest, SetBucketWebsiteConfigurationRequest, SetObjectAclRequest, SetObjectTaggingRequest, UploadPartRequest
```
public class CosServiceRequest
extends Object
implements Cloneable, ReadLimitInfo
```

Constructor Summary

Constructors
Constructor and Description

CosServiceRequest()

Constructors
Constructor and Description
`CosServiceRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CosServiceRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`protected <T extends CosServiceRequest> T`	`copyBaseTo(T target)` Copies the internal state of this base class to that of the target request.
`String`	`getCiSpecialEndParameter()`
`CosServiceRequest`	`getCloneRoot()` Returns the root object from which the current object was cloned; or null if there isn't one.
`CosServiceRequest`	`getCloneSource()` Returns the source object from which the current object was cloned; or null if there isn't one.
`COSCredentials`	`getCosCredentials()`
`Map<String,List<String>>`	`getCustomQueryParameters()`
`Map<String,String>`	`getCustomRequestHeaders()` Returns an immutable map of custom header names to header values.
`String`	`getFixedEndpointAddr()` Returns the setted server ip and port.
`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`	`setCiSpecialEndParameter(String ciSpecialEndParameter)`
`void`	`setCosCredentials(COSCredentials cosCredentials)`
`void`	`setFixedEndpointAddr(String fixedEndpointAddr)` Sets the cos server ip and port .
`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.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CosServiceRequest
```
public CosServiceRequest()
```
- Method Detail
  - setGeneralProgressListener
```
public void setGeneralProgressListener(ProgressListener progressListener)
```
    Sets the optional progress listener for receiving updates about the progress of the request.
    
    Parameters:
    
    progressListener - The new progress listener.
  - getGeneralProgressListener
```
public ProgressListener getGeneralProgressListener()
```
    Returns the optional progress listener for receiving updates about the progress of the request.
    
    Returns:
    
    the optional progress listener for receiving updates about the progress of the request.
  - setFixedEndpointAddr
```
public void setFixedEndpointAddr(String fixedEndpointAddr)
```
    Sets the cos server ip and port .
    
    Parameters:
    
    fixedEndpointAddr - ip and port string, format is ip:port
  - getFixedEndpointAddr
```
public String getFixedEndpointAddr()
```
    Returns the setted server ip and port.
    
    Returns:
    
    The setted ip and port string
  - 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.
    
    Parameters:
    
    progressListener - The new progress listener.
    
    Returns:
    
    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.
    
    Returns:
    
    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.
    
    Parameters:
    
    name - The name of the header to add
    
    value - The value of the header to add
    
    Returns:
    
    the previous value for the name if it was set, null otherwise
  - getCustomQueryParameters
```
public Map<String,List<String>> getCustomQueryParameters()
```
    Returns:
    
    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.
    
    Parameters:
    
    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.
    
    Returns:
    
    the target request
  - getReadLimit
```
public int getReadLimit()
```
    Description copied from interface: ReadLimitInfo
    
    Returns the read limit for mark-and-reset during retries; or -1 if not available.
    
    Specified by:
    
    getReadLimit in interface ReadLimitInfo
  - getCloneSource
```
public CosServiceRequest getCloneSource()
```
    Returns the source object from which the current object was cloned; or null if there isn't one.
  - getCloneRoot
```
public CosServiceRequest getCloneRoot()
```
    Returns the root object from which the current object was cloned; or null if there isn't one.
  - clone
```
public CosServiceRequest clone()
```
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class Object
    
    See Also:
    
    Object.clone()
  - getCosCredentials
```
public COSCredentials getCosCredentials()
```
  - setCosCredentials
```
public void setCosCredentials(COSCredentials cosCredentials)
```
  - getCiSpecialEndParameter
```
public String getCiSpecialEndParameter()
```
  - setCiSpecialEndParameter
```
public void setCiSpecialEndParameter(String ciSpecialEndParameter)
```

Class CosServiceRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CosServiceRequest

Method Detail

setGeneralProgressListener

getGeneralProgressListener

setFixedEndpointAddr

getFixedEndpointAddr

withGeneralProgressListener

getCustomRequestHeaders

putCustomRequestHeader

getCustomQueryParameters

putCustomQueryParameter

getRequestClientOptions

copyBaseTo

getReadLimit

getCloneSource

getCloneRoot

clone

getCosCredentials

setCosCredentials

getCiSpecialEndParameter

setCiSpecialEndParameter