public class PutObjectRequest extends IIJGIOWebServiceRequest implements SSECustomerKeyProvider
PutObjectRequestでは、オブジェクトメタデータおよび定型アクセスコントロールポリシーを
指定することもできます。
IIJ GIOストレージ&アナリシスサービスでは、オブジェクトの一部分だけは保管しません。
呼び出し中に例外が投げられなければ、オブジェクトの全体が保管されています。
アップロード対象が、ファイルかInputStreamかによって、このリクエストの挙動は
異なった挙動を示します。
指定したバケットは、事前に存在しており、アップロードしようとするアカウントには
バケットに対して対するオブジェクトの書き込み権限(Permission.Write
)
を持っていなければなりません
Constructor and Description |
---|
PutObjectRequest(String bucketName,
String key,
File file)
ファイルをアップロードするため、バケットとキーを指定して
オブジェクトを構築します。
リクエストの構築後、ユーザはオブジェクトメタデータや定型のACLを指定することも
できます。
|
PutObjectRequest(String bucketName,
String key,
InputStream input,
ObjectMetadata metadata)
ストリームデータをアップロードするため、バケットとキーを指定して
オブジェクトを構築します。
リクエストの構築後、ユーザはオブジェクトメタデータや定型のACLを指定することも
できます。
|
PutObjectRequest(String bucketName,
String key,
String redirectLocation)
redirect locationも使って新しい オブジェクトを生成します。
リクエストが生成された後、任意ですが、ユーザはオブジェクトのメタデータやcanned ACLを
指定したほうがいいでしょう。
|
Modifier and Type | Method and Description |
---|---|
AccessControlList |
getAccessControlList()
新しいオブジェクト用の任意のaccess control listを返します。
指定されている場合、cannedAclは無視されます。
|
String |
getBucketName()
このリクエストでアップロードするオブジェクトを保管する既存のバケットの名前を返します。
オブジェクトをアップロードするために、ユーザには
Permission.Write
権限が必要です。 |
CannedAccessControlList |
getCannedAcl()
このリクエストでアップロードするオブジェクトに対する定型のアクセスコントロール
ポリシーを返します
|
File |
getFile()
このリクエストでアップロードするデータを含むファイルのパスおよび名前を
Fileオブジェクトとして返します。
アップロードにはファイルもしくはInput Streamのいずれかの指定が必要で、
両方を指定することはできません。
|
ProgressListener |
getGeneralProgressListener()
オブジェクトのダウンロード状況に関する更新を受け取るための任意の進捗リスナーを返します。
|
InputStream |
getInputStream()
このリクエストでアップロードするオブジェクトのデータのInput Streamを返します。
|
String |
getKey()
このリクエストでアップロードするオブジェクトのキーを返します。
|
ObjectMetadata |
getMetadata()
このリクエストでアップロードするオブジェクトのメタデータ
(カスタムユーザメタデータ、Content Typeなど) を返します
|
ProgressListener |
getProgressListener()
Deprecated.
use
getGeneralProgressListener() instead. |
String |
getRedirectLocation()
新しいオブジェクトの任意のredirect locationを返します。
|
SSECustomerKey |
getSSECustomerKey()
暗号化に用いるサーバサイド暗号化(SSE-C)の鍵を取得します。
|
String |
getStorageClass()
IIJ GIOストレージ&アナリシスサービスではストレージクラスは現在未対応です。
|
void |
setAccessControlList(AccessControlList accessControlList)
新しいオブジェクト用の任意のaccess control listをセットします。
指定されている場合、cannedAclは無視されます。
|
void |
setBucketName(String bucketName)
このリクエストでアップロードするオブジェクトを保管する既存のバケットの名前をセットします。
オブジェクトをアップロードするために、ユーザには
Permission.Write
権限が必要です。 |
void |
setCannedAcl(CannedAccessControlList cannedAcl)
このリクエストでアップロードするオブジェクトに対する定型のアクセスコントロール
ポリシーをセットします
|
void |
setFile(File file)
このリクエストでアップロードするデータを含むファイルのパスおよび名前を
Fileオブジェクトとしてセットします。
アップロードにはファイルもしくはInput Streamのいずれかの指定が必要で、
両方を指定することはできません。
|
void |
setGeneralProgressListener(ProgressListener generalProgressListener)
オブジェクトのダウンロード状況に関する更新を受け取るための任意の進捗リスナーをセットします。
|
void |
setInputStream(InputStream inputStream)
このリクエストでアップロードするオブジェクトのデータをInput Streamとしてセットし
ます。
|
void |
setKey(String key)
このリクエストでアップロードするオブジェクトのキーをセットします。
|
void |
setMetadata(ObjectMetadata metadata)
このリクエストでアップロードするオブジェクトのメタデータ
(カスタムユーザメタデータ、Content Typeなど) をセットします
|
void |
setProgressListener(ProgressListener progressListener)
Deprecated.
use
setGeneralProgressListener(ProgressListener) instead. |
void |
setRedirectLocation(String redirectLocation)
新しいオブジェクトの任意のredirect locationをセットします。
|
void |
setSSECustomerKey(SSECustomerKey sseKey)
暗号化に用いるサーバサイド暗号化(SSE-C)の鍵をセットします。
|
void |
setStorageClass(StorageClass storageClass)
IIJ GIOストレージ&アナリシスサービスではストレージクラスは現在未対応です。
|
void |
setStorageClass(String storageClass)
IIJ GIOストレージ&アナリシスサービスではストレージクラスは現在未対応です。
|
PutObjectRequest |
withAccessControlList(AccessControlList accessControlList)
新しいオブジェクト用の任意のaccess control listをセットします。
指定されている場合、cannedAclは無視されます。
追加の連鎖したメソッド呼び出しのため、この を返します。
|
PutObjectRequest |
withBucketName(String bucketName)
このリクエストでアップロードするオブジェクトを保管する既存のバケットの名前をセットし
追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
オブジェクトをアップロードするために、ユーザには
Permission.Write
権限が必要です。 |
PutObjectRequest |
withCannedAcl(CannedAccessControlList cannedAcl)
このリクエストでアップロードするオブジェクトに対する定型のアクセスコントロール
ポリシーをセットし
追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
|
PutObjectRequest |
withFile(File file)
このリクエストでアップロードするデータを含むファイルのパスおよび名前を
Fileオブジェクトとしてセットし
追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
アップロードにはファイルもしくはInput Streamのいずれかの指定が必要で、
両方を指定することはできません。
|
PutObjectRequest |
withGeneralProgressListener(ProgressListener generalProgressListener)
オブジェクトのダウンロード状況に関する更新を受け取るための任意の進捗リスナーをセットし
追加の連鎖したメソッド呼び出しのため、この更新したオブジェクトを返します。
|
PutObjectRequest |
withInputStream(InputStream inputStream)
このリクエストでアップロードするオブジェクトのデータをInput Streamとしてセットし
追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
|
PutObjectRequest |
withKey(String key)
このリクエストでアップロードするオブジェクトのキーをセットし
追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
|
PutObjectRequest |
withMetadata(ObjectMetadata metadata)
このリクエストでアップロードするオブジェクトのメタデータ
(カスタムユーザメタデータ、Content Typeなど) をセットし
追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
|
PutObjectRequest |
withProgressListener(ProgressListener progressListener)
Deprecated.
use
withGeneralProgressListener(ProgressListener) instead. |
PutObjectRequest |
withRedirectLocation(String redirectLocation)
新しいオブジェクトの任意のredirect locationをセットし、
追加の連鎖したメソッド呼び出しのため、この を返します。
|
PutObjectRequest |
withSSECustomerKey(SSECustomerKey sseKey)
暗号化に用いるサーバサイド暗号化(SSE-C)の鍵をセットします。
|
PutObjectRequest |
withStorageClass(StorageClass storageClass)
IIJ GIOストレージ&アナリシスサービスではストレジクラスは現在未対応です。
|
PutObjectRequest |
withStorageClass(String storageClass)
IIJ GIOストレージ&アナリシスサービスではストレージクラスは現在未対応です。
|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials
public PutObjectRequest(String bucketName, String key, File file)
bucketName
- 新たにオブジェクトをアップロードする既存のバケットの名前key
- 新たに保管するオブジェクトのキーfile
- アップロードするファイルのFileオブジェクトPutObjectRequest(String, String, InputStream, ObjectMetadata)
public PutObjectRequest(String bucketName, String key, String redirectLocation)
bucketName
- 新しいオブジェクトがアップロードされる予定の既存のバケット名key
- 新しいオブジェクトを保存する際のキーredirectLocation
- 新しいオブジェクトのredirect locationPutObjectRequest(String, String, InputStream, ObjectMetadata)
,
PutObjectRequest(String, String, File)
public PutObjectRequest(String bucketName, String key, InputStream input, ObjectMetadata metadata)
データストリームのContent Lengthは、オブジェクトメタデータのパラメタとして 指定されなければなりません。IIJ GIOストレージ&アナリシスサービスでは Content Lengthがアップロード前に必要になります。 Content Lengthが指定されていない場合は、Content Lengthを計算するために Input Streamの全てのデータがメモリ上にバッファされ、パフォーマンスの低下を もたらします。
bucketName
- 新たにオブジェクトをアップロードする既存のバケットの名前key
- 新たに保管するオブジェクトのキーinput
- アップロードするストリームmetadata
- オブジェクトメタデータ。最低限Content Lengthが指定されて居なければ
なりません。PutObjectRequest(String, String, File)
public String getBucketName()
Permission.Write
権限が必要です。setBucketName(String)
,
withBucketName(String)
public void setBucketName(String bucketName)
Permission.Write
権限が必要です。bucketName
- このリクエストでアップロードしたオブジェクトを保管する既存の
バケットの名前getBucketName()
,
withBucketName(String)
public PutObjectRequest withBucketName(String bucketName)
Permission.Write
権限が必要です。bucketName
- このリクエストでアップロードしたオブジェクトを保管する既存の
バケットの名前PutObjectRequest
オブジェクトgetBucketName()
,
setBucketName(String)
public String getKey()
setKey(String)
,
withKey(String)
public void setKey(String key)
key
- このリクエストでアップロードするオブジェクトのキーgetKey()
,
withKey(String)
public PutObjectRequest withKey(String key)
key
- このリクエストでアップロードするオブジェクトのキーPutObjectRequest
オブジェクトgetKey()
,
setKey(String)
public String getStorageClass()
このリクエストでアップロードするオブジェクトのストレジクラスを返します
setStorageClass(String)
,
setStorageClass(StorageClass)
,
withStorageClass(StorageClass)
,
withStorageClass(String)
public void setStorageClass(String storageClass)
このリクエストでアップロードするオブジェクトのストレジクラスをセットします
storageClass
- このリクエストでアップロードするオブジェクトのストレジクラスgetStorageClass()
,
setStorageClass(StorageClass)
,
withStorageClass(StorageClass)
,
withStorageClass(String)
public void setStorageClass(StorageClass storageClass)
このリクエストでアップロードするオブジェクトのストレジクラスをセットします
storageClass
- このリクエストでアップロードするオブジェクトのストレジクラスgetStorageClass()
,
setStorageClass(String)
public PutObjectRequest withStorageClass(String storageClass)
このリクエストでアップロードするオブジェクトのストレジクラスをセットし 追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
storageClass
- このリクエストでアップロードするオブジェクトのストレジクラスPutObjectRequest
オブジェクトgetStorageClass()
,
setStorageClass(StorageClass)
,
setStorageClass(String)
,
withStorageClass(StorageClass)
public PutObjectRequest withStorageClass(StorageClass storageClass)
このリクエストでアップロードするオブジェクトのストレジクラスをセットし 追加の連鎖したメソッド呼び出しのため、更新したこのオブジェクトを返します。
storageClass
- このリクエストでアップロードするオブジェクトのストレジクラスPutObjectRequest
オブジェクトgetStorageClass()
,
setStorageClass(StorageClass)
,
setStorageClass(String)
,
withStorageClass(String)
public File getFile()
setFile(File)
,
withFile(File)
,
setInputStream(InputStream)
,
withInputStream(InputStream)
public void setFile(File file)
file
- このリクエストでアップロードするデータを含むファイルのパスおよび名前getFile()
,
withFile(File)
,
getInputStream()
,
withInputStream(InputStream)
public PutObjectRequest withFile(File file)
file
- このリクエストでアップロードするデータを含むファイルのパスおよび名前PutObjectRequest
オブジェクトgetFile()
,
setFile(File)
,
getInputStream()
,
setInputStream(InputStream)
public ObjectMetadata getMetadata()
Input Streamからアップロードする場合、必ずContent Lengthをは オブジェクトメタデータのパラメタとして指定しなければなりません。 Content Lengthが指定されていない場合は、Content Lengthを計算するために Input Streamの全てのデータがメモリ上にバッファされ、パフォーマンスの低下を もたらします。
setMetadata(ObjectMetadata)
,
withMetadata(ObjectMetadata)
public void setMetadata(ObjectMetadata metadata)
Input Streamからアップロードする場合、必ずContent Lengthをは オブジェクトメタデータのパラメタとして指定しなければなりません。 Content Lengthが指定されていない場合は、Content Lengthを計算するために Input Streamの全てのデータがメモリ上にバッファされ、パフォーマンスの低下を もたらします。
metadata
- このリクエストでアップロードするオブジェクトのメタデータgetMetadata()
,
withMetadata(ObjectMetadata)
public PutObjectRequest withMetadata(ObjectMetadata metadata)
Input Streamからアップロードする場合、必ずContent Lengthをは オブジェクトメタデータのパラメタとして指定しなければなりません。 Content Lengthが指定されていない場合は、Content Lengthを計算するために Input Streamの全てのデータがメモリ上にバッファされ、パフォーマンスの低下を もたらします。
metadata
- このリクエストでアップロードするオブジェクトのメタデータPutObjectRequest
オブジェクトgetMetadata()
,
setMetadata(ObjectMetadata)
public CannedAccessControlList getCannedAcl()
setCannedAcl(CannedAccessControlList)
,
withCannedAcl(CannedAccessControlList)
public void setCannedAcl(CannedAccessControlList cannedAcl)
cannedAcl
- アップロードするオブジェクトに対する定型のアクセスコントロールポリシーgetCannedAcl()
,
withCannedAcl(CannedAccessControlList)
public PutObjectRequest withCannedAcl(CannedAccessControlList cannedAcl)
cannedAcl
- アップロードするオブジェクトに対する定型のアクセスコントロールポリシーPutObjectRequest
オブジェクトgetCannedAcl()
,
setCannedAcl(CannedAccessControlList)
public AccessControlList getAccessControlList()
public void setAccessControlList(AccessControlList accessControlList)
accessControlList
- 新しいオブジェクト用の任意のaccess control listpublic PutObjectRequest withAccessControlList(AccessControlList accessControlList)
accessControlList
- 新しいオブジェクト用の任意のaccess control listpublic InputStream getInputStream()
アップロードにはファイルもしくはInput Streamのいずれかの指定が必要で、 両方を指定することはできません。
setInputStream(InputStream)
,
withInputStream(InputStream)
,
setFile(File)
,
withFile(File)
public void setInputStream(InputStream inputStream)
アップロードにはファイルもしくはInput Streamのいずれかの指定が必要で、 両方を指定することはできません。
inputStream
- このリクエストでアップロードするオブジェクトのデータのInput StreamgetInputStream()
,
withInputStream(InputStream)
,
getFile()
,
withFile(File)
public PutObjectRequest withInputStream(InputStream inputStream)
アップロードにはファイルもしくはInput Streamのいずれかの指定が必要で、 両方を指定することはできません。
inputStream
- このリクエストでアップロードするオブジェクトのデータのInput StreamPutObjectRequest
オブジェクトgetInputStream()
,
setInputStream(InputStream)
,
getFile()
,
setFile(File)
public String getRedirectLocation()
public void setRedirectLocation(String redirectLocation)
redirectLocation
- 新しいオブジェクトの任意のredirect locationpublic PutObjectRequest withRedirectLocation(String redirectLocation)
redirectLocation
- 新しいオブジェクトの任意のredirect location@Deprecated public ProgressListener getProgressListener()
getGeneralProgressListener()
instead.@Deprecated public void setProgressListener(ProgressListener progressListener)
setGeneralProgressListener(ProgressListener)
instead.progressListener
- IIJ GIOストレージ&アナリシスサービス クライアントだけで使わているレガシーな進捗リスナー@Deprecated public PutObjectRequest withProgressListener(ProgressListener progressListener)
withGeneralProgressListener(ProgressListener)
instead.progressListener
- IIJ GIOストレージ&アナリシスサービス クライアントだけで使わているレガシーな進捗リスナーpublic ProgressListener getGeneralProgressListener()
public void setGeneralProgressListener(ProgressListener generalProgressListener)
generalProgressListener
- 新しい進捗リスナーpublic PutObjectRequest withGeneralProgressListener(ProgressListener generalProgressListener)
generalProgressListener
- 新しい進捗リスナーpublic SSECustomerKey getSSECustomerKey()
SSECustomerKeyProvider
getSSECustomerKey
in interface SSECustomerKeyProvider
public void setSSECustomerKey(SSECustomerKey sseKey)
sseKey
- 暗号化に用いるサーバサイド暗号化(SSE-C)の鍵public PutObjectRequest withSSECustomerKey(SSECustomerKey sseKey)
追加の連鎖したメソッド呼び出しのため、更新した本クラスのオブジェクトを返します。
sseKey
- 暗号化に用いるサーバサイド暗号化(SSE-C)の鍵Copyright © 2018. All rights reserved.