GeneratePresignedUrlRequest (cos-java-sdk 5.6.54 API)

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

所有已实现的接口:: ReadLimitInfo, Cloneable

public class GeneratePresignedUrlRequest
extends CosServiceRequest

构造器概要

构造器
构造器和说明
`GeneratePresignedUrlRequest(String bucketName, String key)` Creates a new request for generating a pre-signed URL that can be used as part of an HTTP GET request to access the COS object stored under the specified key in the specified bucket.
`GeneratePresignedUrlRequest(String bucketName, String key, HttpMethodName method)` Creates a new request for generating a pre-signed URL that can be used as part of an HTTP request to access the specified COS resource.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addRequestParameter(String key, String value)` Adds an additional request parameter to be included in the pre-signed URL.
`String`	`getBucketName()` Returns the name of the bucket involved in this request.
`String`	`getContentMd5()` Gets the expected content-md5 header of the request.
`String`	`getContentType()` Gets the expected content-type of the request.
`Date`	`getExpiration()` The expiration date at which point the new pre-signed URL will no longer be accepted by COS.
`String`	`getKey()` Returns the key of the object involved in this request.
`HttpMethodName`	`getMethod()` The HTTP method (GET, PUT, DELETE, HEAD) to be used in this request.
`Map<String,String>`	`getRequestParameters()` Returns the complete map of additional request parameters to be included in the pre-signed URL.
`ResponseHeaderOverrides`	`getResponseHeaders()` Returns the headers to be overridden in the service response.
`String`	`getVersionId()` Returns the version ID of the object, only present if versioning has been enabled for the bucket.
`boolean`	`isSignPrefixMode()`
`void`	`rejectIllegalArguments()` Rejects any illegal input (as attributes of this request) by the user.
`void`	`setBucketName(String bucketName)` Sets the name of the bucket involved in this request.
`void`	`setContentMd5(String contentMd5)` Sets the expected content-md5 header of the request.
`void`	`setContentType(String contentType)` Sets the expected content-type of the request.
`void`	`setExpiration(Date expiration)` Sets the expiration date at which point the new pre-signed URL will no longer be accepted by COS.
`void`	`setKey(String key)` Sets the key of the object involved in this request.
`void`	`setMethod(HttpMethodName method)` Sets the HTTP method (GET, PUT, DELETE, HEAD) to be used in this request.
`void`	`setResponseHeaders(ResponseHeaderOverrides responseHeaders)` Sets the headers to be overridden in the service response.
`void`	`setSignPrefixMode(boolean signPrefixMode)`
`void`	`setVersionId(String versionId)` Sets the version ID of the object, only present if versioning has been enabled for the bucket.
`GeneratePresignedUrlRequest`	`withBucketName(String bucketName)` Sets the name of the bucket involved in this request, and returns this request object to enable additional method calls to be chained together.
`GeneratePresignedUrlRequest`	`withContentMd5(String contentMd5)` Sets the expected content-md5 header of the request and returns this object, for method chaining.
`GeneratePresignedUrlRequest`	`withContentType(String contentType)` Sets the expected content-type of the request and returns this object, for method chaining.
`GeneratePresignedUrlRequest`	`withExpiration(Date expiration)` Sets the expiration date at which point the new pre-signed URL will no longer be accepted by COS, and returns this request object to enable additional method calls to be chained together.
`GeneratePresignedUrlRequest`	`withKey(String key)` Sets the key of the object involved in this request, and returns this request object to enable additional method calls to be chained together.
`GeneratePresignedUrlRequest`	`withMethod(HttpMethodName method)` Sets the HTTP method (GET, PUT, DELETE, HEAD) to be used in this request, and returns this request object to enable additional method calls to be chained together.
`GeneratePresignedUrlRequest`	`withResponseHeaders(ResponseHeaderOverrides responseHeaders)` Sets the headers to be overridden in the service response and returns this object, for method chaining.
`GeneratePresignedUrlRequest`	`withVersionId(String versionId)` Sets the version ID of the object, only present if versioning has been enabled for the bucket.

从类继承的方法 com.qcloud.cos.internal.CosServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getCosCredentials, getCustomQueryParameters, getCustomRequestHeaders, getFixedEndpointAddr, getGeneralProgressListener, getReadLimit, getRequestClientOptions, putCustomQueryParameter, putCustomRequestHeader, setCosCredentials, setFixedEndpointAddr, setGeneralProgressListener, withGeneralProgressListener

从类继承的方法 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - GeneratePresignedUrlRequest
```
public GeneratePresignedUrlRequest(String bucketName,
                                   String key)
```
    Creates a new request for generating a pre-signed URL that can be used as part of an HTTP GET request to access the COS object stored under the specified key in the specified bucket.
    
    参数:
    
    bucketName - The name of the bucket containing the desired COS object.
    
    key - The key under which the desired COS object is stored.
  - GeneratePresignedUrlRequest
```
public GeneratePresignedUrlRequest(String bucketName,
                                   String key,
                                   HttpMethodName method)
```
    Creates a new request for generating a pre-signed URL that can be used as part of an HTTP request to access the specified COS resource.
    
    When specifying an HTTP method, you must send the pre-signed URL with the same HTTP method in order to successfully use the pre-signed URL.
    
    参数:
    
    bucketName - The name of the COS bucket involved in the operation.
    
    key - The key of the COS object involved in the operation.
    
    method - The HTTP method (GET, PUT, DELETE, HEAD) to be used in the request when the pre-signed URL is used.
- 方法详细资料
  - getMethod
```
public HttpMethodName getMethod()
```
    The HTTP method (GET, PUT, DELETE, HEAD) to be used in this request. The same HTTP method must be used in the request when the pre-signed URL is used.
    
    返回:
    
    The HTTP method (GET, PUT, DELETE, HEAD) to be used in this request and when the pre-signed URL is used.
  - setMethod
```
public void setMethod(HttpMethodName method)
```
    Sets the HTTP method (GET, PUT, DELETE, HEAD) to be used in this request. The same HTTP method must be used in the request when the pre-signed URL is used.
    
    参数:
    
    method - The HTTP method (GET, PUT, DELETE, HEAD) to be used in this request.
  - withMethod
```
public GeneratePresignedUrlRequest withMethod(HttpMethodName method)
```
    Sets the HTTP method (GET, PUT, DELETE, HEAD) to be used in this request, and returns this request object to enable additional method calls to be chained together.
    The same HTTP method must be used in the request when the pre-signed URL is used.
    
    参数:
    
    method - The HTTP method (GET, PUT, DELETE, HEAD) to be used in this request.
    
    返回:
    
    The updated request object, so that additional method calls can be chained together.
  - getBucketName
```
public String getBucketName()
```
    Returns the name of the bucket involved in this request.
    
    返回:
    
    the name of the bucket involved in this request.
  - setBucketName
```
public void setBucketName(String bucketName)
```
    Sets the name of the bucket involved in this request.
    
    参数:
    
    bucketName - the name of the bucket involved in this request.
  - withBucketName
```
public GeneratePresignedUrlRequest withBucketName(String bucketName)
```
    Sets the name of the bucket involved in this request, and returns this request object to enable additional method calls to be chained together.
    
    参数:
    
    bucketName - the name of the bucket involved in this request.
    
    返回:
    
    The updated request object, so that additional method calls can be chained together.
  - getKey
```
public String getKey()
```
    Returns the key of the object involved in this request.
    
    返回:
    
    The key of the object involved in this request.
  - setKey
```
public void setKey(String key)
```
    Sets the key of the object involved in this request.
    
    参数:
    
    key - the key of the object involved in this request.
  - withKey
```
public GeneratePresignedUrlRequest withKey(String key)
```
    Sets the key of the object involved in this request, and returns this request object to enable additional method calls to be chained together.
    
    参数:
    
    key - the key of the object involved in this request.
    
    返回:
    
    The updated request object, so that additional method calls can be chained together.
  - getVersionId
```
public String getVersionId()
```
    Returns the version ID of the object, only present if versioning has been enabled for the bucket.
    
    返回:
    
    The version ID of the object, only present if versioning has been enabled for the bucket.
  - setVersionId
```
public void setVersionId(String versionId)
```
    Sets the version ID of the object, only present if versioning has been enabled for the bucket.
    
    参数:
    
    versionId - The version ID of the object, only present if versioning has been enabled for the bucket.
  - withVersionId
```
public GeneratePresignedUrlRequest withVersionId(String versionId)
```
    Sets the version ID of the object, only present if versioning has been enabled for the bucket. Returns the GeneratePresignedUrlRequest object for method chanining.
    
    参数:
    
    versionId - The version ID of the object, only present if versioning has been enabled for the bucket.
    
    返回:
    
    This object for method chaining.
  - getExpiration
```
public Date getExpiration()
```
    The expiration date at which point the new pre-signed URL will no longer be accepted by COS. If not specified, a default value will be supplied.
    
    返回:
    
    The expiration date at which point the new pre-signed URL will no longer be accepted by COS.
  - setExpiration
```
public void setExpiration(Date expiration)
```
    Sets the expiration date at which point the new pre-signed URL will no longer be accepted by COS. If not specified, a default value will be supplied.
    
    参数:
    
    expiration - The expiration date at which point the new pre-signed URL will no longer be accepted by COS.
  - withExpiration
```
public GeneratePresignedUrlRequest withExpiration(Date expiration)
```
    Sets the expiration date at which point the new pre-signed URL will no longer be accepted by COS, and returns this request object to enable additional method calls to be chained together.
    If not specified, a default value will be supplied.
    
    参数:
    
    expiration - The expiration date at which point the new pre-signed URL will no longer be accepted by COS.
    
    返回:
    
    The updated request object, so that additional method calls can be chained together.
  - addRequestParameter
```
public void addRequestParameter(String key,
                                String value)
```
    Adds an additional request parameter to be included in the pre-signed URL.
    
    参数:
    
    key - The name of the request parameter, as it appears in the URL's query string (e.g. versionId).
    
    value - The (optional) value of the request parameter being added.
  - getRequestParameters
```
public Map<String,String> getRequestParameters()
```
    Returns the complete map of additional request parameters to be included in the pre-signed URL.
    
    返回:
    
    The complete map of additional request parameters to be included in the pre-signed URL.
  - getResponseHeaders
```
public ResponseHeaderOverrides getResponseHeaders()
```
    Returns the headers to be overridden in the service response.
    
    返回:
    
    the headers to be overridden in the service response.
  - setResponseHeaders
```
public void setResponseHeaders(ResponseHeaderOverrides responseHeaders)
```
    Sets the headers to be overridden in the service response.
    
    参数:
    
    responseHeaders - The headers to be overridden in the service response.
  - withResponseHeaders
```
public GeneratePresignedUrlRequest withResponseHeaders(ResponseHeaderOverrides responseHeaders)
```
    Sets the headers to be overridden in the service response and returns this object, for method chaining.
    
    参数:
    
    responseHeaders - The headers to be overridden in the service response.
    
    返回:
    
    This GeneratePresignedUrlRequest for method chaining.
  - getContentType
```
public String getContentType()
```
    Gets the expected content-type of the request. The content-type is included in the signature.
    
    返回:
    
    The expected content-type
  - setContentType
```
public void setContentType(String contentType)
```
    Sets the expected content-type of the request. The content-type is included in the signature.
    
    参数:
    
    contentType - The expected content-type
  - withContentType
```
public GeneratePresignedUrlRequest withContentType(String contentType)
```
    Sets the expected content-type of the request and returns this object, for method chaining.
    
    参数:
    
    contentType - The expected content-type
    
    返回:
    
    This GeneratePresignedUrlRequest for method chaining.
  - getContentMd5
```
public String getContentMd5()
```
    Gets the expected content-md5 header of the request. This header value will be included when calculating the signature, and future requests must include the same content-md5 header value to access the presigned URL.
    
    返回:
    
    The expected content-md5 header value.
  - setContentMd5
```
public void setContentMd5(String contentMd5)
```
    Sets the expected content-md5 header of the request. This header value will be included when calculating the signature, and future requests must include the same content-md5 header value to access the presigned URL.
    
    参数:
    
    contentMd5 - The expected content-md5 header value.
  - withContentMd5
```
public GeneratePresignedUrlRequest withContentMd5(String contentMd5)
```
    Sets the expected content-md5 header of the request and returns this object, for method chaining.
    
    参数:
    
    contentMd5 - The expected content-md5 header value.
    
    返回:
    
    This GeneratePresignedUrlRequest for method chaining.
  - rejectIllegalArguments
```
public void rejectIllegalArguments()
```
    Rejects any illegal input (as attributes of this request) by the user.
    
    抛出:
    
    IllegalArgumentException - if there is illegal input from the user.
  - isSignPrefixMode
```
public boolean isSignPrefixMode()
```
  - setSignPrefixMode
```
public void setSignPrefixMode(boolean signPrefixMode)
```

类 GeneratePresignedUrlRequest

构造器概要

方法概要

从类继承的方法 com.qcloud.cos.internal.CosServiceRequest

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

构造器详细资料

GeneratePresignedUrlRequest

GeneratePresignedUrlRequest

方法详细资料

getMethod

setMethod

withMethod

getBucketName

setBucketName

withBucketName

getKey

setKey

withKey

getVersionId

setVersionId

withVersionId

getExpiration

setExpiration

withExpiration

addRequestParameter

getRequestParameters

getResponseHeaders

setResponseHeaders

withResponseHeaders

getContentType

setContentType

withContentType

getContentMd5

setContentMd5

withContentMd5

rejectIllegalArguments

isSignPrefixMode

setSignPrefixMode