GeneratePresignedUrlRequest (iijgio-dag-client-all 1.2.4 API)

java.lang.Object
- com.iijgio.dag.IIJGIOWebServiceRequest
- - com.iijgio.dag.services.storage.model.GeneratePresignedUrlRequest

All Implemented Interfaces:

SSECustomerKeyProvider
```
public class GeneratePresignedUrlRequest
extends IIJGIOWebServiceRequest
implements SSECustomerKeyProvider
```
IIJ GIOストレージ＆アナリシスサービスのリソースに対するサイン済URLを生成するためのオプションを含みます。

サイン済URLは、クライアントに対する IIJ GIOストレージ＆アナリシスサービスのリソースのURL、および、認証情報を用いたサインによって構成されていますサイン済URLは他のユーザに対してアカウントや認証情報を提供することなく、リソースへのアクセスを提供する際に使用できます

See Also:

Storage.generatePresignedUrl(GeneratePresignedUrlRequest)

Constructor Summary

Constructors
Constructor and Description
`GeneratePresignedUrlRequest(String bucketName, String key)` HTTP GETリクエストとしてIIJ GIOストレージ＆アナリシスサービスのオブジェクトにアクセスすることが出来るサイン済URLを生成するため、キー及びバケット名を指定して、新規のリクエストオブジェクトを構築します。
`GeneratePresignedUrlRequest(String bucketName, String key, HttpMethod method)` HTTP リクエストとしてIIJ GIOストレージ＆アナリシスサービスのオブジェクトにアクセスすることが出来るサイン済URLを生成するため、キー及びバケット名を指定して、新規のリクエストオブジェクトを構築します。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addRequestParameter(String key, String value)` サイン済URLに含む追加のリクエストパラメタを追加します。追加のリクエストパラメタは、オブジェクトのtorrentリソースにアクセスする場合やオブジェクトの特定バージョンへアクセスする場合などに使用できます。
`String`	`getBucketName()` このリクエストの対象となるバケットの名前を返します。
`String`	`getContentType()` このリクエストの期待するcontent-typeを返します。 content-typeはシグニチャの中に含まれています。
`Date`	`getExpiration()` このサイン済みURLが以降使用できなくなる有効期限を返します。指定されない場合は、デフォルト値が使用されます。
`String`	`getKey()` このリクエストの対象となるオブジェクトのキーを返します。
`HttpMethod`	`getMethod()` このリクエストで使用するHTTPメソッド(GET, PUT, DELETE, HEAD)を返します。 HTTPメソッドを指定した場合、正しくサイン済みURLを利用するためには、指定したHTTPメソッドをURLへ送らなければなりません。
`Map<String,String>`	`getRequestParameters()` サイン済URLに含む、追加のリクエストパラメタの完全なマップを返します。
`ResponseHeaderOverrides`	`getResponseHeaders()` サービスレスポンス内でオーバーライドされたヘッダーを返します。
`SSECustomerKey`	`getSSECustomerKey()` 暗号化に用いるサーバサイド暗号化(SSE-C)の鍵を取得します。
`void`	`setBucketName(String bucketName)` このリクエストの対象となるバケットの名前をセットします。
`void`	`setContentType(String contentType)` このリクエストの期待するcontent-typeを設定します。 content-typeはシグニチャの中に含まれています。
`void`	`setExpiration(Date expiration)` このサイン済みURLが以降使用できなくなる有効期限をセットします。指定されない場合は、デフォルト値が使用されます。
`void`	`setKey(String key)` このリクエストの対象となるオブジェクトのキーをセットします。
`void`	`setMethod(HttpMethod method)` このリクエストで使用するHTTPメソッド(GET, PUT, DELETE, HEAD)をセットします。 HTTPメソッドを指定した場合、正しくサイン済みURLを利用するためには、指定したHTTPメソッドをURLへ送らなければなりません。
`void`	`setResponseHeaders(ResponseHeaderOverrides responseHeaders)` サービスレスポンス内でオーバーライドされたヘッダーを設定します。
`void`	`setSSECustomerKey(SSECustomerKey sseCustomerKey)` オブジェクトの復号化に用いるサーバサイド暗号化(SSE-C)の鍵をセットします。
`GeneratePresignedUrlRequest`	`withBucketName(String bucketName)` このリクエストの対象となるバケットの名前をセットし追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
`GeneratePresignedUrlRequest`	`withContentType(String contentType)` このリクエストの期待するcontent-typeを設定しメソッドの連鎖呼び出しのため、このオブジェクトを返します。
`GeneratePresignedUrlRequest`	`withExpiration(Date expiration)` このサイン済みURLが以降使用できなくなる有効期限をセットし追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。指定されない場合は、デフォルト値が使用されます。
`GeneratePresignedUrlRequest`	`withKey(String key)` このリクエストの対象となるオブジェクトのキーをセットし追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
`GeneratePresignedUrlRequest`	`withMethod(HttpMethod method)` このリクエストで使用するHTTPメソッド(GET, PUT, DELETE, HEAD)をセットし追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。 HTTPメソッドを指定した場合、正しくサイン済みURLを利用するためには、指定したHTTPメソッドをURLへ送らなければなりません。
`GeneratePresignedUrlRequest`	`withResponseHeaders(ResponseHeaderOverrides responseHeaders)` サービスレスポンス内でオーバーライドされたヘッダーを設定し、メソッドの連鎖呼び出しのため、このオブジェクトを返します。
`GeneratePresignedUrlRequest`	`withSSECustomerKey(SSECustomerKey sseKey)` オブジェクトの復号化に用いるサーバサイド暗号化(SSE-C)の鍵をセットします。

Methods inherited from class com.iijgio.dag.IIJGIOWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

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

- Constructor Detail
  - GeneratePresignedUrlRequest
```
public GeneratePresignedUrlRequest(String bucketName,
                                   String key)
```
    HTTP GETリクエストとしてIIJ GIOストレージ＆アナリシスサービスのオブジェクトにアクセスすることが出来るサイン済URLを生成するため、キー及びバケット名を指定して、新規のリクエストオブジェクトを構築します。
    
    Parameters:
    
    bucketName - サインの対象とするオブジェクトを含むバケット名
    
    key - サインの対象とするオブジェクトのキー
  - GeneratePresignedUrlRequest
```
public GeneratePresignedUrlRequest(String bucketName,
                                   String key,
                                   HttpMethod method)
```
    HTTP リクエストとしてIIJ GIOストレージ＆アナリシスサービスのオブジェクトにアクセスすることが出来るサイン済URLを生成するため、キー及びバケット名を指定して、新規のリクエストオブジェクトを構築します。
    
    HTTPメソッドを指定した場合、正しくサイン済みURLを利用するためには、指定したHTTPメソッドをURLへ送らなければなりません。
    
    Parameters:
    
    bucketName - サインの対象とするオブジェクトを含むバケット名
    
    key - サインの対象とするオブジェクトのキー
    
    method - サイン済URLを使用する際の HTTPメソッド(GET, PUT, DELETE, HEAD)
- Method Detail
  - getMethod
```
public HttpMethod getMethod()
```
    このリクエストで使用するHTTPメソッド(GET, PUT, DELETE, HEAD)を返します。 HTTPメソッドを指定した場合、正しくサイン済みURLを利用するためには、指定したHTTPメソッドをURLへ送らなければなりません。
    
    Returns:
    
    サイン済URLを使用する際の HTTPメソッド(GET, PUT, DELETE, HEAD)
  - setMethod
```
public void setMethod(HttpMethod method)
```
    このリクエストで使用するHTTPメソッド(GET, PUT, DELETE, HEAD)をセットします。 HTTPメソッドを指定した場合、正しくサイン済みURLを利用するためには、指定したHTTPメソッドをURLへ送らなければなりません。
    
    Parameters:
    
    method - サイン済URLを使用する際の HTTPメソッド(GET, PUT, DELETE, HEAD)
  - withMethod
```
public GeneratePresignedUrlRequest withMethod(HttpMethod method)
```
    このリクエストで使用するHTTPメソッド(GET, PUT, DELETE, HEAD)をセットし追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。 HTTPメソッドを指定した場合、正しくサイン済みURLを利用するためには、指定したHTTPメソッドをURLへ送らなければなりません。
    
    Parameters:
    
    method - サイン済URLを使用する際の HTTPメソッド(GET, PUT, DELETE, HEAD)
    
    Returns:
    
    更新した、このオブジェクト
  - getBucketName
```
public String getBucketName()
```
    このリクエストの対象となるバケットの名前を返します。
    
    Returns:
    
    このリクエストの対象となるバケットの名前
  - setBucketName
```
public void setBucketName(String bucketName)
```
    このリクエストの対象となるバケットの名前をセットします。
    
    Parameters:
    
    bucketName - このリクエストの対象となるバケットの名前
  - withBucketName
```
public GeneratePresignedUrlRequest withBucketName(String bucketName)
```
    このリクエストの対象となるバケットの名前をセットし追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
    
    Parameters:
    
    bucketName - このリクエストの対象となるバケットの名前
    
    Returns:
    
    更新した、このオブジェクト
  - getKey
```
public String getKey()
```
    このリクエストの対象となるオブジェクトのキーを返します。
    
    Returns:
    
    このリクエストの対象となるオブジェクトのキー
  - setKey
```
public void setKey(String key)
```
    このリクエストの対象となるオブジェクトのキーをセットします。
    
    Parameters:
    
    key - このリクエストの対象となるオブジェクトのキー
  - withKey
```
public GeneratePresignedUrlRequest withKey(String key)
```
    このリクエストの対象となるオブジェクトのキーをセットし追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
    
    Parameters:
    
    key - このリクエストの対象となるオブジェクトのキー
    
    Returns:
    
    更新した、このオブジェクト
  - getExpiration
```
public Date getExpiration()
```
    このサイン済みURLが以降使用できなくなる有効期限を返します。指定されない場合は、デフォルト値が使用されます。
    
    Returns:
    
    このサイン済みURLが以降使用できなくなる有効期限
  - setExpiration
```
public void setExpiration(Date expiration)
```
    このサイン済みURLが以降使用できなくなる有効期限をセットします。指定されない場合は、デフォルト値が使用されます。
    
    Parameters:
    
    expiration - このサイン済みURLが以降使用できなくなる有効期限
  - withExpiration
```
public GeneratePresignedUrlRequest withExpiration(Date expiration)
```
    このサイン済みURLが以降使用できなくなる有効期限をセットし追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。指定されない場合は、デフォルト値が使用されます。
    
    Parameters:
    
    expiration - このサイン済みURLが以降使用できなくなる有効期限
    
    Returns:
    
    更新した、このオブジェクト
  - addRequestParameter
```
public void addRequestParameter(String key,
                                String value)
```
    サイン済URLに含む追加のリクエストパラメタを追加します。追加のリクエストパラメタは、オブジェクトのtorrentリソースにアクセスする場合やオブジェクトの特定バージョンへアクセスする場合などに使用できます。
    
    Parameters:
    
    key - 追加するリクエストパラメタのキー。URLのクエリストリングとなります。
    
    value - 追加するリクエストパラメタの値
  - getRequestParameters
```
public Map<String,String> getRequestParameters()
```
    サイン済URLに含む、追加のリクエストパラメタの完全なマップを返します。
    
    Returns:
    
    サイン済URLに含む、追加のリクエストパラメタの完全なマップ
  - getResponseHeaders
```
public ResponseHeaderOverrides getResponseHeaders()
```
    サービスレスポンス内でオーバーライドされたヘッダーを返します。
    
    Returns:
    
    サービスレスポンス内でオーバーライドされたヘッダー
  - setResponseHeaders
```
public void setResponseHeaders(ResponseHeaderOverrides responseHeaders)
```
    サービスレスポンス内でオーバーライドされたヘッダーを設定します。
    
    Parameters:
    
    responseHeaders - サービスレスポンス内でオーバーライドされたヘッダー
  - withResponseHeaders
```
public GeneratePresignedUrlRequest withResponseHeaders(ResponseHeaderOverrides responseHeaders)
```
    サービスレスポンス内でオーバーライドされたヘッダーを設定し、メソッドの連鎖呼び出しのため、このオブジェクトを返します。
    
    Parameters:
    
    responseHeaders - サービスレスポンス内でオーバーライドされたヘッダー
    
    Returns:
    
    メソッドの連鎖呼び出しのため、この
  - getContentType
```
public String getContentType()
```
    このリクエストの期待するcontent-typeを返します。 content-typeはシグニチャの中に含まれています。
    
    Returns:
    
    期待するcontent-type
  - setContentType
```
public void setContentType(String contentType)
```
    このリクエストの期待するcontent-typeを設定します。 content-typeはシグニチャの中に含まれています。
    
    Parameters:
    
    contentType - 期待するcontent-type
  - withContentType
```
public GeneratePresignedUrlRequest withContentType(String contentType)
```
    このリクエストの期待するcontent-typeを設定しメソッドの連鎖呼び出しのため、このオブジェクトを返します。
    
    Parameters:
    
    contentType - 期待するcontent-type
    
    Returns:
    
    メソッドの連鎖呼び出しのため、この
  - getSSECustomerKey
```
public SSECustomerKey getSSECustomerKey()
```
    Description copied from interface: SSECustomerKeyProvider
    
    暗号化に用いるサーバサイド暗号化(SSE-C)の鍵を取得します。
    
    Specified by:
    
    getSSECustomerKey in interface SSECustomerKeyProvider
    
    Returns:
    
    暗号化に用いるサーバサイド暗号化の鍵
  - setSSECustomerKey
```
public void setSSECustomerKey(SSECustomerKey sseCustomerKey)
```
    オブジェクトの復号化に用いるサーバサイド暗号化(SSE-C)の鍵をセットします。
    
    Parameters:
    
    sseCustomerKey - オブジェクトの復号化に用いるサーバサイド暗号化(SSE-C)の鍵
  - withSSECustomerKey
```
public GeneratePresignedUrlRequest withSSECustomerKey(SSECustomerKey sseKey)
```
    オブジェクトの復号化に用いるサーバサイド暗号化(SSE-C)の鍵をセットします。
    メソッドの連鎖呼び出しのため、このオブジェクトを返します。
    
    Parameters:
    
    sseKey - オブジェクトの復号化に用いるサーバサイド暗号化(SSE-C)の鍵
    
    Returns:
    
    メソッドの連鎖呼び出しのため、この

Class GeneratePresignedUrlRequest

Constructor Summary

Method Summary

Methods inherited from class com.iijgio.dag.IIJGIOWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GeneratePresignedUrlRequest

GeneratePresignedUrlRequest

Method Detail

getMethod

setMethod

withMethod

getBucketName

setBucketName

withBucketName

getKey

setKey

withKey

getExpiration

setExpiration

withExpiration

addRequestParameter

getRequestParameters

getResponseHeaders

setResponseHeaders

withResponseHeaders

getContentType

setContentType

withContentType

getSSECustomerKey

setSSECustomerKey

withSSECustomerKey