GeneratePresignedUrlRequest (AWS Java SDK for Amazon S3 1.11.366 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.s3.model.GeneratePresignedUrlRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, SSECustomerKeyProvider, Serializable, Cloneable
```
public class GeneratePresignedUrlRequest
extends AmazonWebServiceRequest
implements SSECustomerKeyProvider, Serializable
```
Contains options to generate a pre-signed URL for an Amazon S3 resource.

Pre-signed URLs allow clients to form a URL for an Amazon S3 resource and sign it with the current AWS security credentials. A pre-signed URL may be passed around for other users to access the resource without providing them access to an account's AWS security credentials.

See Also:

AmazonS3.generatePresignedUrl(GeneratePresignedUrlRequest), Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description
`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 Amazon S3 object stored under the specified key in the specified bucket.
`GeneratePresignedUrlRequest(String bucketName, String key, HttpMethod 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 Amazon S3 resource.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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 Amazon S3.
`String`	`getKey()` Returns the key of the object involved in this request.
`String`	`getKmsCmkId()` Returns the KMS customer key id used for server side encryption; or null if there is none.
`HttpMethod`	`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`	`getSSEAlgorithm()` Returns the SSE algorithm used for SSE (with server side key); or null if SSE (with server side key) is not in use.
`SSECustomerKey`	`getSSECustomerKey()` Returns the optional customer-provided server-side encryption key to use to encrypt the uploaded object.
`String`	`getVersionId()` Returns the version ID of the object, only present if versioning has been enabled for the bucket.
`boolean`	`isZeroByteContent()` Returns true if zero byte content is to be used for generating pre-signed URL; false otherwise.
`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 Amazon S3.
`void`	`setKey(String key)` Sets the key of the object involved in this request.
`void`	`setKmsCmkId(String kmsCmkId)` Sets the KMS customer key id used for server side encryption.
`void`	`setMethod(HttpMethod 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`	`setSSEAlgorithm(SSEAlgorithm sseAlgorithm)` Sets the SSE algorithm for server side encryption.
`void`	`setSSEAlgorithm(String sseAlgorithm)` Sets the SSE algorithm for server side encryption.
`void`	`setSSECustomerKey(SSECustomerKey sseCustomerKey)` Sets the customer-provided server-side encryption key to use as part of the generated pre-signed URL.
`void`	`setSSECustomerKeyAlgorithm(SSEAlgorithm sseAlgorithm)` Sets the use of SSE-C (Server Side Encryption with Customer Key) using the given encryption algorithm.
`void`	`setVersionId(String versionId)` Sets the version ID of the object, only present if versioning has been enabled for the bucket.
`void`	`setZeroByteContent(boolean zeroByteContent)` Sets if zero byte content is to be used for generating pre-signed URL.
`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 Amazon S3, 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`	`withKmsCmkId(String kmsCmkId)` Fluent API for `setKmsCmkId(String)`
`GeneratePresignedUrlRequest`	`withMethod(HttpMethod 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`	`withSSEAlgorithm(SSEAlgorithm sseAlgorithm)` Fluent API for `setSSEAlgorithm(SSEAlgorithm)`
`GeneratePresignedUrlRequest`	`withSSEAlgorithm(String sseAlgorithm)` Fluent API for `setSSEAlgorithm(String)`
`GeneratePresignedUrlRequest`	`withSSECustomerKey(SSECustomerKey sseKey)` Sets the customer-provided server-side encryption key to use as part of the generated pre-signed URL, and returns the updated request object so that additional method calls can be chained together.
`GeneratePresignedUrlRequest`	`withSSECustomerKeyAlgorithm(SSEAlgorithm algorithm)` Fluent method for `setSSECustomerKeyAlgorithm(SSEAlgorithm)`.
`GeneratePresignedUrlRequest`	`withVersionId(String versionId)` Sets the version ID of the object, only present if versioning has been enabled for the bucket.
`GeneratePresignedUrlRequest`	`withZeroByteContent(boolean zeroByteContent)` Fluent method for `setZeroByteContent(boolean)`.

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

- Constructor Detail
  - 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 Amazon S3 object stored under the specified key in the specified bucket.
    
    Parameters:
    
    bucketName - The name of the bucket containing the desired Amazon S3 object.
    
    key - The key under which the desired Amazon S3 object is stored.
  - GeneratePresignedUrlRequest
```
public GeneratePresignedUrlRequest(String bucketName,
                                   String key,
                                   HttpMethod 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 Amazon S3 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.
    
    Parameters:
    
    bucketName - The name of the Amazon S3 bucket involved in the operation.
    
    key - The key of the Amazon S3 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.
- Method Detail
  - getKmsCmkId
```
public String getKmsCmkId()
```
    Returns the KMS customer key id used for server side encryption; or null if there is none.
  - setKmsCmkId
```
public void setKmsCmkId(String kmsCmkId)
```
    Sets the KMS customer key id used for server side encryption.
    Note S3 does not require HTTP header “x-amz-server-side-encryption-aws-kms-key-id” to be always present (a default key ID will be used if this header is not present).
    It is also possible to set the header to “alias/aws/s3” to refer to the default KMS CMK ID.
  - withKmsCmkId
```
public GeneratePresignedUrlRequest withKmsCmkId(String kmsCmkId)
```
    Fluent API for setKmsCmkId(String)
  - getSSEAlgorithm
```
public String getSSEAlgorithm()
```
    Returns the SSE algorithm used for SSE (with server side key); or null if SSE (with server side key) is not in use.
  - setSSEAlgorithm
```
public void setSSEAlgorithm(String sseAlgorithm)
```
    Sets the SSE algorithm for server side encryption.
    
    Parameters:
    
    currently - supported values: "AES256" or "aws:kms".
  - withSSEAlgorithm
```
public GeneratePresignedUrlRequest withSSEAlgorithm(String sseAlgorithm)
```
    Fluent API for setSSEAlgorithm(String)
  - setSSEAlgorithm
```
public void setSSEAlgorithm(SSEAlgorithm sseAlgorithm)
```
    Sets the SSE algorithm for server side encryption.
    
    Parameters:
    
    currently - supported values: "AES256" or "aws:kms".
  - withSSEAlgorithm
```
public GeneratePresignedUrlRequest withSSEAlgorithm(SSEAlgorithm sseAlgorithm)
```
    Fluent API for setSSEAlgorithm(SSEAlgorithm)
  - getMethod
```
public HttpMethod 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.
    
    Returns:
    
    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(HttpMethod 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.
    
    Parameters:
    
    method - The HTTP method (GET, PUT, DELETE, HEAD) to be used in this request.
  - withMethod
```
public GeneratePresignedUrlRequest withMethod(HttpMethod 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.
    
    Parameters:
    
    method - The HTTP method (GET, PUT, DELETE, HEAD) to be used in this request.
    
    Returns:
    
    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.
    
    Returns:
    
    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.
    
    Parameters:
    
    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.
    
    Parameters:
    
    bucketName - the name of the bucket involved in this request.
    
    Returns:
    
    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.
    
    Returns:
    
    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.
    
    Parameters:
    
    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.
    
    Parameters:
    
    key - the key of the object involved in this request.
    
    Returns:
    
    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.
    
    Returns:
    
    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.
    
    Parameters:
    
    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.
    
    Parameters:
    
    versionId - The version ID of the object, only present if versioning has been enabled for the bucket.
    
    Returns:
    
    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 Amazon S3. If not specified, a default value will be supplied.
    
    Returns:
    
    The expiration date at which point the new pre-signed URL will no longer be accepted by Amazon S3.
  - setExpiration
```
public void setExpiration(Date expiration)
```
    Sets the expiration date at which point the new pre-signed URL will no longer be accepted by Amazon S3. If not specified, a default value will be supplied.
    
    Parameters:
    
    expiration - The expiration date at which point the new pre-signed URL will no longer be accepted by Amazon S3.
  - withExpiration
```
public GeneratePresignedUrlRequest withExpiration(Date expiration)
```
    Sets the expiration date at which point the new pre-signed URL will no longer be accepted by Amazon S3, and returns this request object to enable additional method calls to be chained together.
    If not specified, a default value will be supplied.
    
    Parameters:
    
    expiration - The expiration date at which point the new pre-signed URL will no longer be accepted by Amazon S3.
    
    Returns:
    
    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. Adding additional request parameters enables more advanced pre-signed URLs, such as accessing Amazon S3's torrent resource for an object, or for specifying a version ID when accessing an object.
    
    Parameters:
    
    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.
    
    Returns:
    
    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.
    
    Returns:
    
    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.
    
    Parameters:
    
    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.
    
    Parameters:
    
    responseHeaders - The headers to be overridden in the service response.
    
    Returns:
    
    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.
    
    Returns:
    
    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.
    
    Parameters:
    
    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.
    
    Parameters:
    
    contentType - The expected content-type
    
    Returns:
    
    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.
    
    Returns:
    
    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.
    
    Parameters:
    
    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.
    
    Parameters:
    
    contentMd5 - The expected content-md5 header value.
    
    Returns:
    
    This GeneratePresignedUrlRequest for method chaining.
  - getSSECustomerKey
```
public SSECustomerKey getSSECustomerKey()
```
    Description copied from interface: SSECustomerKeyProvider
    
    Returns the optional customer-provided server-side encryption key to use to encrypt the uploaded object.
    
    Specified by:
    
    getSSECustomerKey in interface SSECustomerKeyProvider
    
    Returns:
    
    The optional customer-provided server-side encryption key to use to encrypt the uploaded object.
  - setSSECustomerKey
```
public void setSSECustomerKey(SSECustomerKey sseCustomerKey)
```
    Sets the customer-provided server-side encryption key to use as part of the generated pre-signed URL.
    
    Parameters:
    
    sseCustomerKey - The customer-provided server-side encryption key to use as part of the generated pre-signed URL.
  - withSSECustomerKey
```
public GeneratePresignedUrlRequest withSSECustomerKey(SSECustomerKey sseKey)
```
    Sets the customer-provided server-side encryption key to use as part of the generated pre-signed URL, and returns the updated request object so that additional method calls can be chained together.
    
    Parameters:
    
    sseKey - The customer-provided server-side encryption key to use as part of the generated pre-signed URL.
    
    Returns:
    
    This updated request object so that additional method calls can be chained together.
  - setSSECustomerKeyAlgorithm
```
public void setSSECustomerKeyAlgorithm(SSEAlgorithm sseAlgorithm)
```
    Sets the use of SSE-C (Server Side Encryption with Customer Key) using the given encryption algorithm.
    
    Parameters:
    
    sseAlgorithm - The server-side encryption algorithm to use with this customer-provided server-side encryption key; or null if SSE-C is disabled. "AES256" is currently the only supported SSE-C encryption algorithm.
  - withSSECustomerKeyAlgorithm
```
public GeneratePresignedUrlRequest withSSECustomerKeyAlgorithm(SSEAlgorithm algorithm)
```
    Fluent method for setSSECustomerKeyAlgorithm(SSEAlgorithm).
  - isZeroByteContent
```
public boolean isZeroByteContent()
```
    Returns true if zero byte content is to be used for generating pre-signed URL; false otherwise.
  - setZeroByteContent
```
public void setZeroByteContent(boolean zeroByteContent)
```
    Sets if zero byte content is to be used for generating pre-signed URL.
  - withZeroByteContent
```
public GeneratePresignedUrlRequest withZeroByteContent(boolean zeroByteContent)
```
    Fluent method for setZeroByteContent(boolean).
  - rejectIllegalArguments
```
public void rejectIllegalArguments()
```
    Rejects any illegal input (as attributes of this request) by the user.
    
    Throws:
    
    IllegalArgumentException - if there is illegal input from the user.

Class GeneratePresignedUrlRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GeneratePresignedUrlRequest

GeneratePresignedUrlRequest

Method Detail

getKmsCmkId

setKmsCmkId

withKmsCmkId

getSSEAlgorithm

setSSEAlgorithm

withSSEAlgorithm

setSSEAlgorithm

withSSEAlgorithm

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

getSSECustomerKey

setSSECustomerKey

withSSECustomerKey

setSSECustomerKeyAlgorithm

withSSECustomerKeyAlgorithm

isZeroByteContent

setZeroByteContent

withZeroByteContent

rejectIllegalArguments