public class GetObjectRequest extends IIJGIOWebServiceRequest implements SSECustomerKeyProvider
IIJ GIOストレージ&アナリシスサービスのオブジェクトをダウンロードするオプションを 提供します。
全てのGetObjectRequests
オブジェクトは、バケット名とキーを
指定しなければなりません。
また、以下を指定することもできます。
Constructor and Description |
---|
GetObjectRequest(String bucketName,
String key)
新規の オブジェクトを必須パラメタを指定して構築します。
|
GetObjectRequest(String bucketName,
String key,
String versionId)
IIJ GIOストレージ&アナリシスサービスではオブジェクトのバージョニングには現在未対応です
新規の オブジェクトをパラメタを指定して構築します。
|
Modifier and Type | Method and Description |
---|---|
String |
getBucketName()
ダウンロードするオブジェクトを含むバケットの名前を返します。
|
ProgressListener |
getGeneralProgressListener()
オブジェクトのダウンロード状態の更新を受け取る任意の進捗リスナーを取得します。
|
String |
getKey()
ダウンロードするオブジェクトのキーを返します。
|
List<String> |
getMatchingETagConstraints()
ETag制約のオプションリストを返します。
ETag制約が指定されている場合、オブジェクトの現在のETagがリクエスト実行時に
リストに含まれている場合にのみリクエストの実行は行われます。
|
Date |
getModifiedSinceConstraint()
更新制約の設定日時を取得します
この制約が指定されている場合、ソースオブジェクトが指定日時以降に更新されている
場合にのみリクエストの実行は行われます。
|
List<String> |
getNonmatchingETagConstraints()
ETag制約のオプションリストを返します。
このETag制約が指定されている場合、ソースオブジェクトの現在のETagがリクエスト実行時に
リストに含まれていない場合にのみリクエストの実行は行われます。
|
ProgressListener |
getProgressListener()
Deprecated.
代わりに、
getGeneralProgressListener() を使ってください。 |
long[] |
getRange()
オプションとなる、このリクエストでダウンロードするファイルの一部を示す
バイトレンジを返します。
|
ResponseHeaderOverrides |
getResponseHeaders()
サービスレスポンスでオーバーライドされたヘッダーを返します。
|
SSECustomerKey |
getSSECustomerKey()
暗号化に用いるサーバサイド暗号化(SSE-C)の鍵を取得します。
|
Date |
getUnmodifiedSinceConstraint()
未更新制約の設定日時を返します。
この制約が指定されている場合、ソースオブジェクトが指定日時以降に更新されていない
場合にのみリクエストの実行は行われます。
|
String |
getVersionId()
IIJ GIOストレージ&アナリシスサービスではオブジェクトのバージョニングには現在未対応です
*
|
void |
setBucketName(String bucketName)
ダウンロードするオブジェクトを含むバケットの名前をセットします。
|
void |
setGeneralProgressListener(ProgressListener generalProgressListener)
オブジェクトのダウンロード状態の更新を受け取る任意の進捗リスナーを設定します。
|
void |
setKey(String key)
ダウンロードするオブジェクトのキーをセットします
|
void |
setMatchingETagConstraints(List<String> eTagList)
ETag制約のオプションリストをセットします。
ETag制約が指定されている場合、ソースオブジェクトの現在のETagがリクエスト実行時に
リストに含まれている場合にのみリクエストの実行は行われます。
|
void |
setModifiedSinceConstraint(Date date)
更新制約の設定日時をセットします
この制約が指定されている場合、ソースオブジェクトが指定日時以降に更新されている
場合にのみリクエストの実行は行われます。
|
void |
setNonmatchingETagConstraints(List<String> eTagList)
ETag制約のオプションリストをセットします。
このETag制約が指定されている場合、ソースオブジェクトの現在のETagがリクエスト実行時に
リストに含まれていない場合にのみリクエストの実行は行われます。
|
void |
setProgressListener(ProgressListener progressListener)
Deprecated.
代わりに、
setGeneralProgressListener(ProgressListener) を使ってください。 |
void |
setRange(long start,
long end)
オプションとなる、このリクエストでダウンロードするファイルの一部を示す
バイトレンジをセットします。
|
void |
setResponseHeaders(ResponseHeaderOverrides responseHeaders)
サービスレスポンスでオーバーライドされたヘッダーを返します。
|
void |
setSSECustomerKey(SSECustomerKey sseKey)
オブジェクトの復号化に用いるサーバサイド暗号化(SSE-C)の鍵をセットします。
|
void |
setUnmodifiedSinceConstraint(Date date)
未更新制約の設定日時をセットします。
この制約が指定されている場合、ソースオブジェクトが指定日時以降に更新されていない
場合にのみリクエストの実行は行われます。
|
void |
setVersionId(String versionId)
IIJ GIOストレージ&アナリシスサービスではオブジェクトのバージョニングには現在未対応です
|
GetObjectRequest |
withBucketName(String bucketName)
ダウンロードするオブジェクトを含むバケットの名前をセットし
追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
|
GetObjectRequest |
withGeneralProgressListener(ProgressListener progressListener)
オブジェクトのダウンロード状態の更新を受け取る任意の進捗リスナーを設定し
追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
|
GetObjectRequest |
withKey(String key)
ダウンロードするオブジェクトのキーをセットし
追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
|
GetObjectRequest |
withMatchingETagConstraint(String eTag)
ETag制約のオプションリストへ、ETagを追加し、
追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
ETag制約が指定されている場合、ソースオブジェクトの現在のETagがリクエスト実行時に
リストに含まれている場合にのみリクエストの実行は行われます。
|
GetObjectRequest |
withModifiedSinceConstraint(Date date)
更新制約の設定日時をセットし
追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
この制約が指定されている場合、ソースオブジェクトが指定日時以降に更新されている
場合にのみリクエストの実行は行われます。
|
GetObjectRequest |
withNonmatchingETagConstraint(String eTag)
ETag制約のオプションリストに制約を追加し、
追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
このETag制約が指定されている場合、ソースオブジェクトの現在のETagがリクエスト実行時に
リストに含まれていない場合にのみリクエストの実行は行われます。
|
GetObjectRequest |
withProgressListener(ProgressListener progressListener)
Deprecated.
代わりに、
withGeneralProgressListener(ProgressListener) を使ってください。 |
GetObjectRequest |
withRange(long start,
long end)
オプションとなる、このリクエストでダウンロードするファイルの一部を示す
バイトレンジをセットし
追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
|
GetObjectRequest |
withResponseHeaders(ResponseHeaderOverrides responseHeaders)
サービスレスポンスでオーバーライドされたヘッダーを設定し、
追加の連鎖したメソッド呼び出しのため、
更新したこのオブジェクトを返します。
|
GetObjectRequest |
withSSECustomerKey(SSECustomerKey sseKey)
オブジェクトの復号化に用いるサーバサイド暗号化(SSE-C)の鍵をセットします。
|
GetObjectRequest |
withUnmodifiedSinceConstraint(Date date)
未更新制約の設定日時をセットし
追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
この制約が指定されている場合、ソースオブジェクトが指定日時以降に更新されていない
場合にのみリクエストの実行は行われます。
|
GetObjectRequest |
withVersionId(String versionId)
IIJ GIOストレージ&アナリシスサービスではオブジェクトのバージョニングには現在未対応です
|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials
public GetObjectRequest(String bucketName, String key)
bucketName
- オブジェクトを含むバケット名key
- オブジェクトのキーGetObjectRequest(String, String, String)
public GetObjectRequest(String bucketName, String key, String versionId)
bucketName
- オブジェクトを含むバケット名key
- オブジェクトのキーversionId
- オブジェクトの特定バージョンをダウンロードする際のバージョンIDGetObjectRequest(String, String)
public String getBucketName()
setBucketName(String)
,
withBucketName(String)
public void setBucketName(String bucketName)
bucketName
- ダウンロードするオブジェクトを含むバケットの名前getBucketName()
,
withBucketName(String)
public GetObjectRequest withBucketName(String bucketName)
bucketName
- ダウンロードするオブジェクトを含むバケットの名前GetObjectRequest
オブジェクトgetBucketName()
,
setBucketName(String)
public String getKey()
setKey(String)
,
withKey(String)
public void setKey(String key)
key
- ダウンロードするオブジェクトのキーgetKey()
,
withKey(String)
public GetObjectRequest withKey(String key)
key
- ダウンロードするオブジェクトのキーGetObjectRequest
オブジェクトgetKey()
,
setKey(String)
public String getVersionId()
オプションとなるダウンロードするオブジェクトのバージョンIDを返します。 指定されていない場合は、最新版がダウンロードされます。
バージョニングが有効になるまえやバージョニングが中断しているオブジェクトは
デフォルトもしくはnull
がバージョンIDとして返ります。
(Constants.NULL_VERSION_ID
を参照)
注意: null
バージョンIDは有効なバージョンIDで、バージョンIDを
持っていない状態とは異なります。
setVersionId(String)
,
withVersionId(String)
public void setVersionId(String versionId)
オプションとなるダウンロードするオブジェクトのバージョンIDをセットします。 指定さていない場合は、最新版がダウンロードされます。
バージョニングが有効になるまえやバージョニングが中断しているオブジェクトは
デフォルトもしくはnull
がバージョンIDとして返ります。
(Constants.NULL_VERSION_ID
を参照)
注意: null
バージョンIDは有効なバージョンIDで、バージョンIDを
持っていない状態とは異なります。
versionId
- オプションとなるダウンロードするオブジェクトのバージョンIDgetVersionId()
,
withVersionId(String)
public GetObjectRequest withVersionId(String versionId)
オプションとなるダウンロードするオブジェクトのバージョンIDをセットし 追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。 指定さていない場合は、最新版がダウンロードされます。
バージョニングが有効になるまえやバージョニングが中断しているオブジェクトは
デフォルトもしくはnull
がバージョンIDとして返ります。
(Constants.NULL_VERSION_ID
を参照)
注意: null
バージョンIDは有効なバージョンIDで、バージョンIDを
持っていない状態とは異なります。
versionId
- オプションとなるダウンロードするオブジェクトのバージョンIDGetObjectRequest
オブジェクトgetVersionId()
,
setVersionId(String)
public long[] getRange()
オプションとなる、このリクエストでダウンロードするファイルの一部を示す バイトレンジを返します。
レンジは、バイトレンジの開始インデックスと終了インデックスの2要素の配列として返ります。 バイトレンジが指定されていなかった場合は、オブジェクトの全体がダウンロードされます
null
setRange(long, long)
,
withRange(long, long)
public void setRange(long start, long end)
オプションとなる、このリクエストでダウンロードするファイルの一部を示す バイトレンジをセットします。
オブジェクトの最初の1バイトはポジション'0'となります。 バイトレンジが指定されていなかった場合は、オブジェクトの全体がダウンロードされます
start
- ダウンロードするオブジェクトのバイトレンジの開始位置end
- ダウンロードするオブジェクトのバイトレンジの終了位置getRange()
,
withRange(long, long)
public GetObjectRequest withRange(long start, long end)
オプションとなる、このリクエストでダウンロードするファイルの一部を示す バイトレンジをセットし 追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
オブジェクトの最初の1バイトはポジション'0'となります。 バイトレンジが指定されていなかった場合は、オブジェクトの全体がダウンロードされます
start
- ダウンロードするオブジェクトのバイトレンジの開始位置end
- ダウンロードするオブジェクトのバイトレンジの終了位置GetObjectRequest
オブジェクトgetRange()
,
setRange(long, long)
public List<String> getMatchingETagConstraints()
ETag制約は、「以降未更新」制約と共に使われ、他の制約と共には使われません
setMatchingETagConstraints(List)
,
withMatchingETagConstraint(String)
public void setMatchingETagConstraints(List<String> eTagList)
eTagList
- ETag制約のオプションリストgetMatchingETagConstraints()
,
withMatchingETagConstraint(String)
public GetObjectRequest withMatchingETagConstraint(String eTag)
eTag
- 追加するETag制約GetObjectRequest
オブジェクトgetMatchingETagConstraints()
,
setMatchingETagConstraints(List)
public List<String> getNonmatchingETagConstraints()
setNonmatchingETagConstraints(List)
,
withNonmatchingETagConstraint(String)
public void setNonmatchingETagConstraints(List<String> eTagList)
eTagList
- ETag制約のオプションリストgetNonmatchingETagConstraints()
,
withNonmatchingETagConstraint(String)
public GetObjectRequest withNonmatchingETagConstraint(String eTag)
eTag
- 追加するETag制約GetObjectRequest
オブジェクトgetNonmatchingETagConstraints()
,
setNonmatchingETagConstraints(List)
public Date getUnmodifiedSinceConstraint()
setUnmodifiedSinceConstraint(Date)
,
withUnmodifiedSinceConstraint(Date)
public void setUnmodifiedSinceConstraint(Date date)
未更新制約は、ETag一致制約と共に使われ、他の制約と共には使われません
注意: IIJ GIOストレージ&アナリシスサービスでは未来の時刻は無視します
date
- 未更新制約の設定日時getUnmodifiedSinceConstraint()
,
withUnmodifiedSinceConstraint(Date)
public GetObjectRequest withUnmodifiedSinceConstraint(Date date)
未更新制約は、ETag一致制約と共に使われ、他の制約と共には使われません
注意: IIJ GIOストレージ&アナリシスサービスでは未来の時刻は無視します
date
- 未更新制約の設定日時GetObjectRequest
オブジェクトgetUnmodifiedSinceConstraint()
,
setUnmodifiedSinceConstraint(Date)
public Date getModifiedSinceConstraint()
更新制約は、ETag不一致制約と共に使われ、他の制約と共には使われません
setModifiedSinceConstraint(Date)
,
withModifiedSinceConstraint(Date)
public void setModifiedSinceConstraint(Date date)
更新制約は、ETag不一致制約と共に使われ、他の制約と共には使われません
date
- 更新制約の設定日時getModifiedSinceConstraint()
,
withModifiedSinceConstraint(Date)
public GetObjectRequest withModifiedSinceConstraint(Date date)
注意: IIJ GIOストレージ&アナリシスサービスでは未来の時刻は無視します
date
- 更新制約の設定日時CopyObjectRequest
オブジェクトgetModifiedSinceConstraint()
,
setModifiedSinceConstraint(Date)
public ResponseHeaderOverrides getResponseHeaders()
public void setResponseHeaders(ResponseHeaderOverrides responseHeaders)
responseHeaders
- サービスレスポンスでオーバーライドされたヘッダーpublic GetObjectRequest withResponseHeaders(ResponseHeaderOverrides responseHeaders)
responseHeaders
- サービスレスポンスでオーバーライドされたヘッダーGetObjectRequest
@Deprecated public ProgressListener getProgressListener()
getGeneralProgressListener()
を使ってください。@Deprecated public void setProgressListener(ProgressListener progressListener)
setGeneralProgressListener(ProgressListener)
を使ってください。progressListener
- IIJ GIOストレージ&アナリシスサービス クライアントでだけ使われてる
レガシーな進捗リスナー@Deprecated public GetObjectRequest withProgressListener(ProgressListener progressListener)
withGeneralProgressListener(ProgressListener)
を使ってください。progressListener
- IIJ GIOストレージ&アナリシスサービス クライアントでだけ使われてる
レガシーな進捗リスナーpublic ProgressListener getGeneralProgressListener()
public void setGeneralProgressListener(ProgressListener generalProgressListener)
generalProgressListener
- 新しい進捗リスナーpublic GetObjectRequest withGeneralProgressListener(ProgressListener progressListener)
progressListener
- 新しい進捗リスナーpublic SSECustomerKey getSSECustomerKey()
SSECustomerKeyProvider
getSSECustomerKey
in interface SSECustomerKeyProvider
public void setSSECustomerKey(SSECustomerKey sseKey)
sseKey
- オブジェクトの復号化に用いるサーバサイド暗号化(SSE-C)の鍵public GetObjectRequest withSSECustomerKey(SSECustomerKey sseKey)
追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
sseKey
- オブジェクトの復号化に用いるサーバサイド暗号化(SSE-C)の鍵setSSECustomerKey(SSECustomerKey)
Copyright © 2018. All rights reserved.