com.amazonaws.services.s3.model

## クラス GeneratePresignedUrlRequest

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

-     public class GeneratePresignedUrlRequest
      extends AmazonWebServiceRequest

  Contains options to genearate 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.

  関連項目:
    `AmazonS3.generatePresignedUrl(GeneratePresignedUrlRequest)`

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `GeneratePresignedUrlRequest(java.lang.String bucketName, java.lang.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(java.lang.String bucketName, java.lang.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.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `addRequestParameter(java.lang.String key, java.lang.String value)` Adds an additional request parameter to be included in the pre-signed URL.
    `java.lang.String` | `getBucketName()` Returns the name of the bucket involved in this request.
    `java.lang.String` | `getContentType()` Gets the expected content-type of the request.
    `java.util.Date` | `getExpiration()` The expiration date at which point the new pre-signed URL will no longer be accepted by Amazon S3.
    `java.lang.String` | `getKey()` Returns the key of the object involved in this request.
    `HttpMethod` | `getMethod()` The HTTP method (GET, PUT, DELETE, HEAD) to be used in this request.
    `java.util.Map<java.lang.String,java.lang.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.
    `void` | `setBucketName(java.lang.String bucketName)` Sets the name of the bucket involved in this request.
    `void` | `setContentType(java.lang.String contentType)` Sets the expected content-type of the request.
    `void` | `setExpiration(java.util.Date expiration)` Sets the expiration date at which point the new pre-signed URL will no longer be accepted by Amazon S3.
    `void` | `setKey(java.lang.String key)` Sets the key of the object involved in this request.
    `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.
    `GeneratePresignedUrlRequest` | `withBucketName(java.lang.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` | `withContentType(java.lang.String contentType)` Sets the expected content-type of the request and returns this object, for method chaining.
    `GeneratePresignedUrlRequest` | `withExpiration(java.util.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(java.lang.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(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.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

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

- - ### コンストラクタの詳細

    - #### GeneratePresignedUrlRequest

          public GeneratePresignedUrlRequest(java.lang.String bucketName,
                                     java.lang.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.
      パラメータ:
        `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(java.lang.String bucketName,
                                     java.lang.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.

      パラメータ:
        `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.

  - ### メソッドの詳細

    - #### 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.
      戻り値:
        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.
      パラメータ:
        `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.

      パラメータ:
        `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 java.lang.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(java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.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.

    - #### getExpiration

          public java.util.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.
      戻り値:
        The expiration date at which point the new pre-signed URL will no longer be accepted by Amazon S3.

    - #### setExpiration

          public void setExpiration(java.util.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.
      パラメータ:
        `expiration` - The expiration date at which point the new pre-signed URL will no longer be accepted by Amazon S3.

    - #### withExpiration

          public GeneratePresignedUrlRequest withExpiration(java.util.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.

      パラメータ:
        `expiration` - The expiration date at which point the new pre-signed URL will no longer be accepted by Amazon S3.
      戻り値:
        The updated request object, so that additional method calls can be chained together.

    - #### addRequestParameter

          public void addRequestParameter(java.lang.String key,
                                 java.lang.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.
      パラメータ:
        `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 java.util.Map<java.lang.String,java.lang.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 java.lang.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(java.lang.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(java.lang.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.