public interface Storage
IIJ GIOストレージ&アナリシスサービスはインターネットのためのストレージを提供し、 開発者がより簡単にウェブスケールコンピューティングをするように設計されています。
IIJ GIOストレージ&アナリシスサービス SDKはウェブ上のどこから、いつでも、どんなデータ量でも 格納および取得することができるシンプルなインターフェイスを提供しています。
Modifier and Type | Method and Description |
---|---|
void |
abortMultipartUpload(AbortMultipartUploadRequest request)
マルチパートアップロードを中断します。
|
void |
addRequestEventListener(SendRequestEventListener requestEventListener) |
void |
addResponseEventListener(ReceiveResponseEventListener responseEventListener) |
CompleteMultipartUploadResult |
completeMultipartUpload(CompleteMultipartUploadRequest request)
前回までにアップロードされたパートを組み立てることで、
マルチパートアップロードを完了させます。
|
CopyObjectResult |
copyObject(CopyObjectRequest copyObjectRequest)
IIJ GIOストレージ&アナリシスサービス のオブジェクトを新しい場所へコピーします。
|
CopyObjectResult |
copyObject(String sourceBucketName,
String sourceKey,
String destinationBucketName,
String destinationKey)
IIJ GIOストレージ&アナリシスサービス のオブジェクトを新しい場所へコピーします。
|
CopyPartResult |
copyPart(CopyPartRequest copyPartRequest)
既存オブジェクトをマルチパートアップロードの単一パートにコピーします。
|
Bucket |
createBucket(CreateBucketRequest createBucketRequest)
デフォルトのリージョン
Region.Default で新たなIIJ GIOストレージ&アナリシスサービスのバケットを作成します。 |
Bucket |
createBucket(String bucketName)
デフォルトのリージョン
Region.Default で指定されたバケット名の
新たなIIJ GIOストレージ&アナリシスサービスのバケットを作成します。 |
Bucket |
createBucket(String bucketName,
CannedAccessControlList cannedAcl)
指定されたIIJ GIOストレージ&アナリシスサービス リージョンで指定されたバケット名の
新たなIIJ GIOストレージ&アナリシスサービスのバケットを作成します。
このメソッドは非標準の場合に提供されています;
標準的な場合には
createBucket(String, Region) を使用して
Region 列挙値を渡します。 |
Bucket |
createBucket(String bucketName,
Region region)
指定されたIIJ GIOストレージ&アナリシスサービス リージョンで指定されたバケット名の
新たなIIJ GIOストレージ&アナリシスサービスのバケットを作成します。
|
Bucket |
createBucket(String bucketName,
String region)
指定されたIIJ GIOストレージ&アナリシスサービス リージョンで指定されたバケット名の
新たなIIJ GIOストレージ&アナリシスサービスのバケットを作成します。
|
void |
deleteBucket(DeleteBucketRequest deleteBucketRequest)
指定のバケットを削除します。指定バケット内のオブジェクトは、事前にすべて削除されている
必要があります。
|
void |
deleteBucket(String bucketName)
指定のバケットを削除します。指定バケット内のオブジェクトは、事前にすべて削除されている
必要があります。
|
void |
deleteBucketCrossOriginConfiguration(String bucketName)
指定バケットのCORS(Cross-Origin Resource Sharing)設定を削除します。
|
void |
deleteBucketPolicy(DeleteBucketPolicyRequest deleteBucketPolicyRequest)
指定バケットに割り当てられているポリシー情報を削除します。
|
void |
deleteBucketPolicy(String bucketName)
指定バケットに割り当てられているポリシー情報を削除します。
|
void |
deleteBucketWebsiteConfiguration(DeleteBucketWebsiteConfigurationRequest deleteBucketWebsiteConfigurationRequest)
この操作はバケットのウェブサイト設定を削除します。
|
void |
deleteBucketWebsiteConfiguration(String bucketName)
この操作はバケットのウェブサイト設定を削除します。
|
void |
deleteObject(DeleteObjectRequest deleteObjectRequest)
指定バケット内の指定のオブジェクトを削除します。
|
void |
deleteObject(String bucketName,
String key)
指定バケット内の指定のオブジェクトを削除します。
|
DeleteObjectsResult |
deleteObjects(DeleteObjectsRequest deleteObjectsRequest)
指定バケット内にある複数のオブジェクトを削除します。
|
boolean |
doesBucketExist(String bucketName)
指定されたバケットの存在有無をチェックします。
|
URL |
generatePresignedUrl(GeneratePresignedUrlRequest generatePresignedUrlRequest)
IIJ GIOストレージ&アナリシスサービス リソースへアクセスする、サイン済みの URL を取得します。
|
URL |
generatePresignedUrl(String bucketName,
String key,
Date expiration)
IIJ GIOストレージ&アナリシスサービス リソースへアクセスする、サイン済みの URL を取得します。
|
URL |
generatePresignedUrl(String bucketName,
String key,
Date expiration,
HttpMethod method)
IIJ GIOストレージ&アナリシスサービス リソースへアクセスする、サイン済みの URL を取得します。
|
Owner |
getAccountOwner()
リクエストの認証済みの送信者が使用しているIIJ GIOストレージ&アナリシスサービス
アカウントの現在の所有者を取得します。
|
AccessControlList |
getBucketAcl(GetBucketAclRequest getBucketAclRequest)
指定されたIIJ GIOストレージ&アナリシスサービスバケットの
AccessControlList (ACL)を取得します。 |
AccessControlList |
getBucketAcl(String bucketName)
指定されたIIJ GIOストレージ&アナリシスサービスバケットの
AccessControlList (ACL)を取得します。 |
BucketCrossOriginConfiguration |
getBucketCrossOriginConfiguration(String bucketName)
指定バケットのCORS(Cross-Origin Resource Sharing)設定を取得します。
|
String |
getBucketLocation(GetBucketLocationRequest getBucketLocationRequest)
指定したバケットをIIJ GIOストレージ&アナリシスサービスが保存している
地理的リージョン情報を取得します。
|
String |
getBucketLocation(String bucketName)
指定されたバケットを格納するIIJ GIOストレージ&アナリシスサービスの地理的なリージョンを取得します。
|
BucketPolicy |
getBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest)
指定バケットのポリシー情報を取得します。
|
BucketPolicy |
getBucketPolicy(String bucketName)
指定バケットのポリシー情報を取得します。
|
BucketWebsiteConfiguration |
getBucketWebsiteConfiguration(GetBucketWebsiteConfigurationRequest getBucketWebsiteConfigurationRequest)
指定バケットのウェブサイト設定を取得します。
|
BucketWebsiteConfiguration |
getBucketWebsiteConfiguration(String bucketName)
指定バケットのウェブサイト設定を取得します。
|
StorageObject |
getObject(GetObjectRequest getObjectRequest)
IIJ GIOストレージ&アナリシスサービス へ保存されている、指定バケット名,キーのオブジェクトを取得します。
|
ObjectMetadata |
getObject(GetObjectRequest getObjectRequest,
File destinationFile)
IIJ GIOストレージ&アナリシスサービス へ保存されている、指定バケット名,キーのオブジェクトの
メタデータを取得し、オブジェクト本体を指定のファイルへ保存します。
|
StorageObject |
getObject(String bucketName,
String key)
IIJ GIOストレージ&アナリシスサービス へ保存されている、指定バケット名,キーのオブジェクトを取得します。
|
AccessControlList |
getObjectAcl(String bucketName,
String key)
IIJ GIOストレージ&アナリシスサービスで指定されたオブジェクトの
AccessControlList (ACL) を取得します。 |
ObjectMetadata |
getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest)
実際にオブジェクト自体を取得することなく、
指定されたIIJ GIOストレージ&アナリシスサービスオブジェクトのメタデータを取得します。
|
ObjectMetadata |
getObjectMetadata(String bucketName,
String key)
実際にオブジェクト自体を取得することなく、
指定されたIIJ GIOストレージ&アナリシスサービスオブジェクトのメタデータを取得します。
|
StorageSpace |
getStorageSpace()
以下からなる契約中のストレージ情報を取得します。
契約容量
総使用量(全てのアカウントの使用容量)
現在のアカウントの使用容量
|
InitiateMultipartUploadResult |
initiateMultipartUpload(InitiateMultipartUploadRequest request)
マルチパートアップロードの事前設定を行い、アップロードIDを持つInitiateMultipartUploadResultオブジェクトを返します。
|
List<Bucket> |
listBuckets()
リクエストの認証済みの送信者が所有している
IIJ GIOストレージ&アナリシスサービスバケットのすべてのリストを返します。
|
List<Bucket> |
listBuckets(ListBucketsRequest listBucketsRequest)
リクエストの認証済みの送信者が所有している
IIJ GIOストレージ&アナリシスサービスバケットのすべてのリストを返します。
|
MultipartUploadListing |
listMultipartUploads(ListMultipartUploadsRequest request)
現在進行中のマルチパートアップロードのリストを作ります。
|
ObjectListing |
listNextBatchOfObjects(ObjectListing previousObjectListing)
不完全なオブジェクトリストの継続と結果の次のページを取得する簡単な方法を提供します。
|
ObjectListing |
listObjects(ListObjectsRequest listObjectsRequest)
指定されたバケット内のオブジェクトに関する概要情報のリストを返します。
|
ObjectListing |
listObjects(String bucketName)
指定されたバケット内のオブジェクトに関する概要情報のリストを返します。
|
ObjectListing |
listObjects(String bucketName,
String prefix)
指定されたバケット内のオブジェクトに関する概要情報のリストを返します。
|
PartListing |
listParts(ListPartsRequest request)
特定のマルチパートアップロードでアップロードされたパートのリストを作ります。
|
PutObjectResult |
putObject(PutObjectRequest putObjectRequest)
指定の IIJ GIOストレージ&アナリシスサービス バケットへ、新しいオブジェクトをアップロードします。
PutObjectRequest はリクエストに関するすべての詳細情報を保持します。 |
PutObjectResult |
putObject(String bucketName,
String key,
File file)
ファイルを指定のバケット,キーで IIJ GIOストレージ&アナリシスサービス へアップロードします。
|
PutObjectResult |
putObject(String bucketName,
String key,
InputStream input,
ObjectMetadata metadata)
指定のバケット,キーで ストリームとメタデータを IIJ GIOストレージ&アナリシスサービス へアップロードします。
|
void |
setBucketAcl(SetBucketAclRequest setBucketAclRequest)
指定されたIIJ GIOストレージ&アナリシスサービスバケットの
AccessControlList を設定します。 |
void |
setBucketAcl(String bucketName,
AccessControlList acl)
指定されたIIJ GIOストレージ&アナリシスサービスバケットの
AccessControlList を設定します。 |
void |
setBucketAcl(String bucketName,
CannedAccessControlList acl)
事前設定
CannedAccessControlLists のいずれかを使用して
IIJ GIOストレージ&アナリシスサービスで指定されたバケットのCannedAccessControlList を
設定します。 |
void |
setBucketCrossOriginConfiguration(String bucketName,
BucketCrossOriginConfiguration bucketCrossOriginConfiguration)
指定バケットのCORS(Cross-Origin Resource Sharing)設定をセットします。
|
void |
setBucketPolicy(SetBucketPolicyRequest setBucketPolicyRequest)
指定のバケットにポリシーを割り当てます。
|
void |
setBucketPolicy(String bucketName,
String policyText)
指定のバケットにポリシーを割り当てます。
|
void |
setBucketWebsiteConfiguration(SetBucketWebsiteConfigurationRequest setBucketWebsiteConfigurationRequest)
指定バケットのウェブサイト設定を設定します。
|
void |
setBucketWebsiteConfiguration(String bucketName,
BucketWebsiteConfiguration configuration)
指定バケットのウェブサイト設定を設定します。
|
void |
setEndpoint(String endpoint)
このクライアントのデフォルトのエンドポイントをオーバーライドします。
|
void |
setObjectAcl(String bucketName,
String key,
AccessControlList acl)
IIJ GIOストレージ&アナリシスサービスで指定されたオブジェクトの
AccessControlList を設定します。 |
void |
setObjectAcl(String bucketName,
String key,
CannedAccessControlList acl)
事前設定
CannedAccessControlLists のいずれかを使用して
IIJ GIOストレージ&アナリシスサービスで指定されたオブジェクトのCannedAccessControlList を
設定します。 |
void |
setObjectMetadata(String bucketName,
String key,
ObjectMetadata metadata)
指定のバケット,キーに該当するオブジェクトのメタデータを変更します。
|
UploadPartResult |
uploadPart(UploadPartRequest request)
マルチパートアップロードの単一パートのアップロードを行います。
|
void setEndpoint(String endpoint)
指定されたIIJ GIOストレージ&アナリシスサービスのリージョンにリクエストを送信するには 、このメソッドを使用します。
プロトコルを含む完全なURL(例:"https://storage-dag.iijgio.com")または
エンドポイント(例:"storage-dag.iijgio.com")を渡します。
プロトコルが指定されていない場合はこのクライアントのデフォルトプロトコル
ClientConfiguration
が使用されます。
endpoint
- このクライアントが通信するリージョン固有のIIJIOエンドポイントの
プロトコルを含む完全なURL(例:"https://storage-dag.iijgio.com")または
エンドポイント(例:"storage-dag.iijgio.com")IllegalArgumentException
- 指定されたエンドポイントが有効なURLエンドポイントではない場合ObjectListing listObjects(String bucketName) throws IIJGIOClientException
リストは常に辞書(アルファベット順)の順序で返されます。
バケットは事実上無制限のオブジェクトキーを所有することができるため、
リストクエリのすべての結果は非常に大きくなることがあります。
大きな結果セットを管理するためにIIJ GIOストレージ&アナリシスサービスでは複数回答に
それらを分割するページネーションを使用しています。
ObjectListing.isTruncated()
メソッドは返されたリストが完了しているのか
またはより多くの結果を得るために追加の呼び出しが必要なのか常に確認しています。
また、オブジェクトリストの次のページを取得する簡単な方法として、
StorageClient.listNextBatchOfObjects(ObjectListing)
メソッドを用います。
バケット内のオブジェクトキーの総数は、実質上リストのパフォーマンスには影響しません。
bucketName
- IIJ GIOストレージ&アナリシスサービスの バケット名IIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーStorageClient.listObjects(String, String)
,
StorageClient.listObjects(ListObjectsRequest)
ObjectListing listObjects(String bucketName, String prefix) throws IIJGIOClientException
区切り文字が指定されている場合は共通接頭辞など、リクエストパラメータによっては
追加情報が返されます。
リストは常に辞書(アルファベット順)の順序で返されます。
バケットは事実上無制限のオブジェクトキーを所有することができるため、
リストクエリのすべての結果は非常に大きくなることがあります。
大きな結果セットを管理するためにIIJ GIOストレージ&アナリシスサービス でSは
複数回答にそれらを分割するページネーションを使用しています。
ObjectListing.isTruncated()
メソッドは返されたリストが完了しているのか
またはより多くの結果を得るために追加の呼び出しが必要なのか常に確認しています。
また、オブジェクトリストの次のページを取得する簡単な方法として、
StorageClient.listNextBatchOfObjects(ObjectListing)
メソッドを用います。
例えば、次のオブジェクトキーが含まれているバケットの場合:
prefix
値を"foo/"、delimiter
値を"/"でlistObjects
を呼び出す場合、
返されるObjectListing
には一つのオブジェクトキー("foo/boo")と
common prefixesリストの一つのエントリ("foo/bar/")が含まれている。listObjects
の別の呼び出しを行う。
バケット内のオブジェクトキーの総数は、実質上リストのパフォーマンスには影響しません。
bucketName
- IIJ GIOストレージ&アナリシスサービスの バケット名prefix
- 指定された接頭辞で始まるオブジェクトキーへのレスポンスを制限するオプションのパラメータ。
ファイルシステムがディレクトリにファイルを整理する方法と同様に
prefixesを使用して異なるオブジェクトキーのセットにバケットを分離します。IIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーStorageClient.listObjects(String)
,
StorageClient.listObjects(ListObjectsRequest)
ObjectListing listObjects(ListObjectsRequest listObjectsRequest) throws IIJGIOClientException
区切り文字が指定されている場合は共通接頭辞など、リクエストパラメータによっては
追加情報が返されます。
リストは常に辞書(アルファベット順)の順序で返されます。
バケットは事実上無制限のオブジェクトキーを所有することができるため、
リストクエリのすべての結果は非常に大きくなることがあります。
大きな結果セットを管理するためにIIJ GIOストレージ&アナリシスサービスでは
複数回答にそれらを分割するページネーションを使用しています。
ObjectListing.isTruncated()
メソッドは返されたリストが完了しているのか
またはより多くの結果を得るために追加の呼び出しが必要なのか常に確認しています。
また、オブジェクトリストの次のページを取得する簡単な方法として、
StorageClient.listNextBatchOfObjects(ObjectListing)
メソッドを用います。
ListObjectsRequest.setDelimiter(String)
で区切り文字を設定すると、
オブジェクトキーのグループを可能にして共有区切り記号接頭辞が返されるリストに含まれる。
これにより、ファイルシステムがディレクトリにファイルを整理する方法と同様に
アプリケーションはオブジェクトキーを階層的に整理、閲覧できます。
これらの共通の接頭辞は、ObjectListing.getCommonPrefixes()
メソッドを使用して取得することができます。
例えば、次のオブジェクトキーが含まれているバケットの場合:
prefix
値を"foo/"、delimiter
値を"/"でlistObjects
を呼び出す場合、
返されるObjectListing
には一つのオブジェクトキー("foo/boo")と
common prefixesリストの一つのエントリ("foo/bar/")が含まれている。listObjects
の別の呼び出しを行う。
バケット内のオブジェクトキーの総数は、実質上リストのパフォーマンスには影響しません。
listObjectsRequest
- 指定されたバケット内のオブジェクトを一覧表示する
すべてのオプションを含むリクエスト・オブジェクトIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーStorageClient.listObjects(String)
,
StorageClient.listObjects(String, String)
ObjectListing listNextBatchOfObjects(ObjectListing previousObjectListing) throws IIJGIOClientException
オブジェクトのリストを継続し、結果の次のページを取得するには、
listObjects
メソッドのいずれかからの最初のObjectListing
を呼び出します。
不完全な場合(ObjectListing.isTruncated()
がtrue
の場合)、
ObjectListing
を渡して結果の次のページを取得するためにこのメソッドに戻ります。
返されたObjectListing
が完全なことを示すまで、
より多くの結果を取得するにはこのメソッドを続けて使用します。
previousObjectListing
- 前の不完全なObjectListing
完全なObjectListing
の場合、IIJ GIOストレージ&アナリシスサービスに接続することなく
空の ObjectListing
が返されます。ObjectListing
の最後の結果からすぐ始まる
ObjectListing
結果の次のセットIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーStorageClient.listObjects(String)
,
StorageClient.listObjects(String, String)
,
StorageClient.listObjects(ListObjectsRequest)
Owner getAccountOwner() throws IIJGIOClientException
呼び出し元がIIJ GIOストレージ&アナリシスサービスに登録されている 有効なAccessKeyIdを使用して認証する必要があります。
IIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーboolean doesBucketExist(String bucketName) throws IIJGIOClientException
IIJ GIOストレージ&アナリシスサービスのバケットは、グローバルな名前空間で名前が付けられます; このメソッドの使用は指定されたバケット名の存在有無確認に限られるので 新しいバケットを作成するために使用することはできません。
bucketName
- チェックするバケット名true
存在しない場合:false
IIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーcreateBucket(CreateBucketRequest)
List<Bucket> listBuckets() throws IIJGIOClientException
ユーザーはIIJ GIOストレージ&アナリシスサービスに登録されている有効なAccessKeyIdで認証する必要があります。
匿名のリクエストはバケットリストは取得できず、
ユーザーは作成していないバケットリストを取得することはできません。
IIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーlistBuckets(ListBucketsRequest)
List<Bucket> listBuckets(ListBucketsRequest listBucketsRequest) throws IIJGIOClientException
ユーザーはIIJ GIOストレージ&アナリシスサービスに登録されている有効なAccessKeyIdで認証する必要があります。
匿名のリクエストはバケットリストは取得できないし、
ユーザーは作成していないバケットリストを取得することはできません。
listBucketsRequest
- バケットのリストリ関連するすべてのオプションを含むリクエスト・オブジェクトIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーlistBuckets()
String getBucketLocation(GetBucketLocationRequest getBucketLocationRequest) throws IIJGIOClientException
バケットの位置制約を参照するためには、ユーザはバケットオーナーでなければなりません。
Region
列挙子を取得するには、Region.fromValue(String)
を使ってください。
渡された値が基地のRegion
値でない場合は、
IllegalArgumentException
を処理する必要があります。
Region
列挙子はこのメソッドから直接返されないことを留意してください。
getBucketLocationRequest
- 調べたいIIJ GIOストレージ&アナリシスサービスバケット名を含んだリクエスト・オブジェクト。
これはユーザが所有するバケットでなければなりません。IIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーRegion
String getBucketLocation(String bucketName) throws IIJGIOClientException
バケットのロケーション状態を表示するには、自分所有のバケットである必要があります
Region.fromValue(String)
を使用してRegion
列挙値を取得しますが、
渡された値が知られているリージョンの値でない場合は
IllegalArgumentException
処理をする用意ができています。
Region
列挙値は、このメソッドから直接返されないことに注意してください。
bucketName
- ルックアップするIIJ GIOストレージ&アナリシスサービスのバケットの名前
自分所有のバケットである必要があるIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーRegion
Bucket createBucket(CreateBucketRequest createBucketRequest) throws IIJGIOClientException
Region.Default
で新たなIIJ GIOストレージ&アナリシスサービスのバケットを作成します。
IIJ GIOストレージ&アナリシスサービスに格納されているすべてのオブジェクトは、バケット内に含まれている。 バケットはIIJ GIOストレージ&アナリシスサービスで格納されているオブジェクトの名前空間をトップレベルで分割します。 バケットの中では、任意の名前をオブジェクトに使用することができます。 しかし、バケット名はIIJ GIOストレージ&アナリシスサービスのすべての間で一意である必要があります。
バケットの所有権は、インターネットドメイン名の所有権に類似しています。 IIJ GIOストレージ&アナリシスサービスの中では、単一のユーザーのみ、各バケットを所有しています。 一度IIJ GIOストレージ&アナリシスサービスで一意の名前でバケットが作成されると、 任意の方法でバケット内のオブジェクトに名前を付けて整理します。 バケットの所有権は所有者がIIJ GIOストレージ&アナリシスサービスのアカウントである限り保持されます。
DNSの要件に準拠するため、次の制約が適用されます:
バケットに格納可能なオブジェクトの数に制限はありません。 使用しているバケットの数に基づいてパフォーマンスが変化することはありません。 すべてのオブジェクトは単一のバケット内に格納します。 または複数のバケット間で整理します。
バケットは、入れ子にすることはできません; バケットは、他のバケット内に作成することはできません。
アプリケーションの高有用性コードパスでバケット作成、 または削除の呼び出しをしないでください。 頻繁に走らない別の初期化またはセットアップルーチンでバケットを作成または削除します。
バケットを作成するには、IIJ GIOストレージ&アナリシスサービスに登録されている 有効なAccessKeyIdで認証を行います。 匿名リクエストはバケットを作成することができません。
createBucketRequest
- IIJ GIOストレージ&アナリシスサービス バケットを作成するすべてのオプションを含むリクエスト・オブジェクトIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーBucket createBucket(String bucketName) throws IIJGIOClientException
Region.Default
で指定されたバケット名の
新たなIIJ GIOストレージ&アナリシスサービスのバケットを作成します。
IIJ GIOストレージ&アナリシスサービスに格納されているすべてのオブジェクトは、バケット内に含まれている。 バケットはIIJ GIOストレージ&アナリシスサービスで格納されているオブジェクトの名前空間をトップレベルで分割します。 バケットの中では、任意の名前をオブジェクトに使用することができます。 しかし、バケット名はIIJ GIOストレージ&アナリシスサービスのすべての間で一意である必要があります。
バケットの所有権は、インターネットドメイン名の所有権に類似しています。 IIJ GIOストレージ&アナリシスサービスの中では、単一のユーザーのみ、各バケットを所有しています。 一度IIJ GIOストレージ&アナリシスサービスで一意の名前でバケットが作成されると、 任意の方法でバケット内のオブジェクトに名前を付けて整理します。 バケットの所有権は所有者がIIJ GIOストレージ&アナリシスサービスのアカウントである限り保持されます。
DNSの要件に準拠するため、次の制約が適用されます:
バケットに格納可能なオブジェクトの数に制限はありません。 使用しているバケットの数に基づいてパフォーマンスが変化することはありません。 すべてのオブジェクトは単一のバケット内に格納します。 または複数のバケット間で整理します。
バケットは、入れ子にすることはできません; バケットは、他のバケット内に作成することはできません。
アプリケーションの高有用性コードパスでバケット作成、 または削除の呼び出しをしないでください。 頻繁に走らない別の初期化またはセットアップルーチンでバケットを作成または削除します。
バケットを作成するには、IIJ GIOストレージ&アナリシスサービスに登録されている 有効なAccessKeyIdで認証を行います。 匿名リクエストはバケットを作成することができません。
bucketName
- 作成するバケット名
IIJ GIOストレージ&アナリシスサービスのすべてのバケットは単一の名前空間を占有する;
与えられた一意の名前でバケットを確保するIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーBucket createBucket(String bucketName, Region region) throws IIJGIOClientException
IIJ GIOストレージ&アナリシスサービスに格納されているすべてのオブジェクトは、バケット内に含まれている。 バケットはIIJ GIOストレージ&アナリシスサービスで格納されているオブジェクトの名前空間をトップレベルで分割します。 バケットの中では、任意の名前をオブジェクトに使用することができます。 しかし、バケット名はIIJ GIOストレージ&アナリシスサービスのすべての間で一意である必要があります。
バケットの所有権は、インターネットドメイン名の所有権に類似しています。 IIJ GIOストレージ&アナリシスサービスの中では、単一のユーザーのみ、各バケットを所有しています。 一度IIJ GIOストレージ&アナリシスサービスで一意の名前でバケットが作成されると、 任意の方法でバケット内のオブジェクトに名前を付けて整理します。 バケットの所有権は所有者がIIJ GIOストレージ&アナリシスサービスのアカウントである限り保持されます。
DNSの要件に準拠するため、次の制約が適用されます:
バケットに格納可能なオブジェクトの数に制限はありません。 使用しているバケットの数に基づいてパフォーマンスが変化することはありません。 すべてのオブジェクトは単一のバケット内に格納します。 または複数のバケット間で整理します。
バケットは、入れ子にすることはできません; バケットは、他のバケット内に作成することはできません。
アプリケーションの高有用性コードパスでバケット作成、 または削除の呼び出しをしないでください。 頻繁に走らない別の初期化またはセットアップルーチンでバケットを作成または削除します。
バケットを作成するには、IIJ GIOストレージ&アナリシスサービスに登録されている 有効なAccessKeyIdで認証を行います。 匿名リクエストはバケットを作成することができません。
bucketName
- 作成するバケット名region
- 新しいバケットを作成するIIJ GIOストレージ&アナリシスサービス リージョンIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーRegion
Bucket createBucket(String bucketName, String region) throws IIJGIOClientException
このメソッドは非標準の場合に提供されています;
標準的な場合には createBucket(String, Region)
を使用して
Region
列挙値を渡します。
IIJ GIOストレージ&アナリシスサービスに格納されているすべてのオブジェクトは、バケット内に含まれている。 バケットはIIJ GIOストレージ&アナリシスサービスで格納されているオブジェクトの名前空間をトップレベルで分割します。 バケットの中では、任意の名前をオブジェクトに使用することができます。 しかし、バケット名はIIJ GIOストレージ&アナリシスサービスのすべての間で一意である必要があります。
バケットの所有権は、インターネットドメイン名の所有権に類似しています。 IIJ GIOストレージ&アナリシスサービスの中では、単一のユーザーのみ、各バケットを所有しています。 一度IIJ GIOストレージ&アナリシスサービスで一意の名前でバケットが作成されると、 任意の方法でバケット内のオブジェクトに名前を付けて整理します。 バケットの所有権は所有者がIIJ GIOストレージ&アナリシスサービスのアカウントである限り保持されます。
DNSの要件に準拠するため、次の制約が適用されます:
バケットに格納可能なオブジェクトの数に制限はありません。 使用しているバケットの数に基づいてパフォーマンスが変化することはありません。 すべてのオブジェクトは単一のバケット内に格納します。 または複数のバケット間で整理します。
バケットは、入れ子にすることはできません; バケットは、他のバケット内に作成することはできません。
アプリケーションの高有用性コードパスでバケット作成、 または削除の呼び出しをしないでください。 頻繁に走らない別の初期化またはセットアップルーチンでバケットを作成または削除します。
バケットを作成するには、IIJ GIOストレージ&アナリシスサービスに登録されている 有効なAccessKeyIdで認証を行います。 匿名リクエストはバケットを作成することができません。
bucketName
- 作成するバケット名region
- 新しいバケットを作成するIIJ GIOストレージ&アナリシスサービス リージョンIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーRegion
Bucket createBucket(String bucketName, CannedAccessControlList cannedAcl) throws IIJGIOClientException
createBucket(String, Region)
を使用して
Region
列挙値を渡します。
IIJ GIOストレージ&アナリシスサービスに格納されているすべてのオブジェクトは、バケット内に含まれている。 バケットはIIJ GIOストレージ&アナリシスサービスで格納されているオブジェクトの名前空間をトップレベルで分割します。 バケットの中では、任意の名前をオブジェクトに使用することができます。 しかし、バケット名はIIJ GIOストレージ&アナリシスサービスのすべての間で一意である必要があります。
バケットの所有権は、インターネットドメイン名の所有権に類似しています。 IIJ GIOストレージ&アナリシスサービスの中では、単一のユーザーのみ、各バケットを所有しています。 一度IIJ GIOストレージ&アナリシスサービスで一意の名前でバケットが作成されると、 任意の方法でバケット内のオブジェクトに名前を付けて整理します。 バケットの所有権は所有者がIIJ GIOストレージ&アナリシスサービスのアカウントである限り保持されます。
DNSの要件に準拠するため、次の制約が適用されます:
バケットに格納可能なオブジェクトの数に制限はありません。 使用しているバケットの数に基づいてパフォーマンスが変化することはありません。 すべてのオブジェクトは単一のバケット内に格納します。 または複数のバケット間で整理します。
バケットは、入れ子にすることはできません; バケットは、他のバケット内に作成することはできません。
アプリケーションの高有用性コードパスでバケット作成、 または削除の呼び出しをしないでください。 頻繁に走らない別の初期化またはセットアップルーチンでバケットを作成または削除します。
バケットを作成するには、IIJ GIOストレージ&アナリシスサービスに登録されている 有効なAccessKeyIdで認証を行います。 匿名リクエストはバケットを作成することができません。
bucketName
- 作成するバケット名cannedAcl
- 作成するバケットに設定する Canned ACLIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーRegion
AccessControlList getObjectAcl(String bucketName, String key) throws IIJGIOClientException
AccessControlList
(ACL) を取得します。
IIJ GIOストレージ&アナリシスサービスでの各バケットとオブジェクトはアクセス制御ポリシーを定義する ACLを持つ。リクエストが作られると、IIJ GIOストレージ&アナリシスサービスは、その標準的な認証手順を 使用してリクエストを認証してから、バケットやオブジェクトへのアクセスを許可された 送信者を確認するためにACLをチェックします。送信者が承認されている場合は、 リクエストは続行する。その他の場合はIIJ GIOストレージ&アナリシスサービスはエラーを返します。
bucketName
- ACLを取得するオブジェクトを含むバケットの名前key
- ACLを取得する指定されたバケット内のオブジェクトキーAccessControlList
IIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーvoid setObjectAcl(String bucketName, String key, AccessControlList acl) throws IIJGIOClientException
AccessControlList
を設定します。
IIJ GIOストレージ&アナリシスサービスでの各バケットとオブジェクトはアクセス制御ポリシーを定義する ACLを持ちます。リクエストが作られると、IIJ GIOストレージ&アナリシスサービスは、その標準的な認証手順を 使用してリクエストを認証してから、バケットやオブジェクトへのアクセスを許可された 送信者を確認するためにACLをチェックします。送信者が承認されている場合は、 リクエストは続行する。その他の場合はIIJ GIOストレージ&アナリシスサービスはエラーを返します。
カスタムAccessControlList
を構築する場合、
呼出者は通常オブジェクトの現在AccessControlList
を取得(
StorageClient.getObjectAcl(String, String)
)し、
必要に応じてそれを修正し、このメソッドを使用して新しいACLをアップロードします。
bucketName
- ACLを設定するオブジェクトを含むバケットの名前key
- ACLを設定する指定されたバケット内のオブジェクトキーacl
- 指定されたオブジェクトの新しいAccessControlList
IIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーsetObjectAcl(String, String, CannedAccessControlList)
void setObjectAcl(String bucketName, String key, CannedAccessControlList acl) throws IIJGIOClientException
CannedAccessControlLists
のいずれかを使用して
IIJ GIOストレージ&アナリシスサービスで指定されたオブジェクトのCannedAccessControlList
を
設定します。
CannedAccessControlList
は、一般的に使用されるアクセス制御ポリシーを持つ
オブジェクトやバケットを設定する簡単な方法を提供しています。
IIJ GIOストレージ&アナリシスサービスでの各バケットとオブジェクトはアクセス制御ポリシーを定義する ACLを持つ。リクエストが作られると、IIJ GIOストレージ&アナリシスサービスは、その標準的な認証手順を 使用してリクエストを認証してから、バケットやオブジェクトへのアクセスを許可された 送信者を確認するためにACLをチェックします。送信者が承認されている場合は、 リクエストは続行する。その他の場合はIIJ GIOストレージ&アナリシスサービスはエラーを返します。
bucketName
- ACLを設定するオブジェクトを含むバケットの名前key
- ACLを設定する指定されたバケット内のオブジェクトキーacl
- 指定されたオブジェクトの新しい事前設定CannedAccessControlList
IIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーsetObjectAcl(String, String, AccessControlList)
AccessControlList getBucketAcl(String bucketName) throws IIJGIOClientException
AccessControlList
(ACL)を取得します。
IIJ GIOストレージ&アナリシスサービスでの各バケットとオブジェクトはアクセス制御ポリシーを定義する ACLを持つ。リクエストが作られると、IIJ GIOストレージ&アナリシスサービスは、その標準的な認証手順を 使用してリクエストを認証してから、バケットやオブジェクトへのアクセスを許可された 送信者を確認するためにACLをチェックします。送信者が承認されている場合は、 リクエストは続行する。その他の場合はIIJ GIOストレージ&アナリシスサービスはエラーを返します。
bucketName
- ACLを取得するバケットの名前AccessControlList
IIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーvoid setBucketAcl(String bucketName, AccessControlList acl) throws IIJGIOClientException
AccessControlList
を設定します。
IIJ GIOストレージ&アナリシスサービスでの各バケットとオブジェクトはアクセス制御ポリシーを定義する ACLを持つ。リクエストが作られると、IIJ GIOストレージ&アナリシスサービスは、その標準的な認証手順を 使用してリクエストを認証してから、バケットやオブジェクトへのアクセスを許可された 送信者を確認するためにACLをチェックします。送信者が承認されている場合は、 リクエストは続行する。その他の場合はIIJ GIOストレージ&アナリシスサービスはエラーを返します。
カスタムAccessControlList
を構築する場合、
呼出者は通常バケットの現在AccessControlList
を取得(
StorageClient.getBucketAcl(String)
)し、
必要に応じてそれを修正し、このメソッドを使用して新しいACLをアップロードします。
bucketName
- ACLを指定するバケットの名前acl
- 指定されたバケットの新しいAccessControlListIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーsetBucketAcl(String, CannedAccessControlList)
void setBucketAcl(SetBucketAclRequest setBucketAclRequest) throws IIJGIOClientException
AccessControlList
を設定します。
IIJ GIOストレージ&アナリシスサービスでの各バケットとオブジェクトはアクセス制御ポリシーを定義する ACLを持つ。リクエストが作られると、IIJ GIOストレージ&アナリシスサービスは、その標準的な認証手順を 使用してリクエストを認証してから、バケットやオブジェクトへのアクセスを許可された 送信者を確認するためにACLをチェックします。送信者が承認されている場合は、 リクエストは続行する。その他の場合はIIJ GIOストレージ&アナリシスサービスはエラーを返します。
カスタムAccessControlList
を構築する場合、
呼出者は通常バケットの現在AccessControlList
を取得(
StorageClient.getBucketAcl(String)
)し、
必要に応じてそれを修正し、このメソッドを使用して新しいACLをアップロードします。
setBucketAclRequest
- 変更するバケットと設定するACLを持つリクエスト・オブジェクト。IIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーAccessControlList getBucketAcl(GetBucketAclRequest getBucketAclRequest) throws IIJGIOClientException
AccessControlList
(ACL)を取得します。
IIJ GIOストレージ&アナリシスサービスでの各バケットとオブジェクトはアクセス制御ポリシーを定義する ACLを持つ。リクエストが作られると、IIJ GIOストレージ&アナリシスサービスは、その標準的な認証手順を 使用してリクエストを認証してから、バケットやオブジェクトへのアクセスを許可された 送信者を確認するためにACLをチェックします。送信者が承認されている場合は、 リクエストは続行する。その他の場合はIIJ GIOストレージ&アナリシスサービスはエラーを返します。
getBucketAclRequest
- ACLを取得するバケット名を持つリクエスト・オブジェクト。AccessControlList
IIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーvoid setBucketAcl(String bucketName, CannedAccessControlList acl) throws IIJGIOClientException
CannedAccessControlLists
のいずれかを使用して
IIJ GIOストレージ&アナリシスサービスで指定されたバケットのCannedAccessControlList
を
設定します。
CannedAccessControlList
は、一般的に使用されるアクセス制御ポリシーを持つ
オブジェクトやバケットを設定する簡単な方法を提供しています。
IIJ GIOストレージ&アナリシスサービスでの各バケットとオブジェクトはアクセス制御ポリシーを定義する ACLを持つ。リクエストが作られると、IIJ GIOストレージ&アナリシスサービスは、その標準的な認証手順を 使用してリクエストを認証してから、バケットやオブジェクトへのアクセスを許可された 送信者を確認するためにACLをチェックします。送信者が承認されている場合は、 リクエストは続行する。その他の場合はIIJ GIOストレージ&アナリシスサービスはエラーを返します。
bucketName
- ACLを指定するバケットの名前acl
- 指定されたバケットの新しい事前設定CannedAccessControlList
IIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーsetBucketAcl(String, AccessControlList)
ObjectMetadata getObjectMetadata(String bucketName, String key) throws IIJGIOClientException
これは唯一のオブジェクトメタデータを取得するのに便利ですし、 オブジェクトデータを取得する上で帯域幅を浪費することが回避されます。
オブジェクトメタデータはIIJ GIOストレージ&アナリシスサービスでオブジェクトに関連付けられる コンテンツタイプ、コンテンツの性質等だけでなく、 カスタムユーザーのメタデータなどの情報が含まれています。
bucketName
- メタデータを取得するオブジェクトを含むバケットの名前key
- メタデータを取得するオブジェクトのキーIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーgetObjectMetadata(GetObjectMetadataRequest)
ObjectMetadata getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest) throws IIJGIOClientException
これは唯一のオブジェクトメタデータを取得するのに便利ですし、 オブジェクトデータを取得する上で帯域幅を浪費することが回避されます。
オブジェクトメタデータはIIJ GIOストレージ&アナリシスサービスでオブジェクトに関連付けられる コンテンツタイプ、コンテンツの性質等だけでなく、 カスタムユーザーのメタデータなどの情報が含まれています。
getObjectMetadataRequest
- メタデータを取得するオブジェクトのバケット、オブジェクトキーと
オプションのバージョンIDを指定するリクエスト・オブジェクトIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーgetObjectMetadata(String, String)
void setObjectMetadata(String bucketName, String key, ObjectMetadata metadata) throws IIJGIOClientException
この操作は、内部でcopyObject(com.iijgio.dag.services.storage.model.CopyObjectRequest)
を呼び出します。
コピー元のバケットとキーがコピー先のバケットとキーが同じになります。
この操作は、メタデータの(一部の)更新ではなく、指定のメタデータに置き換わることにご注意ください。
一部を更新する場合は、以下のような操作を行う必要があります。
getObject(java.lang.String, java.lang.String)
または getObjectMetadata(java.lang.String, java.lang.String)
でオブジェクトのメタデータを取得する
オブジェクトのメタデータを変更するには、指定のバケットが既に存在し、対象バケットに対して
Permission.Write
権限を保持している必要があります。
この操作ではcopyObject(com.iijgio.dag.services.storage.model.CopyObjectRequest)
と異なり、
コピー元のバケットとキーがコピー先のバケットとキーが同じ場合で、かつメタデータがnullの場合でも
エラーになりません。
ただし、クライアントにイベントハンドラを設定している場合、エラーコードは400が設定されます。
bucketName
- Permission.Write
権限を持つ、既存のバケット名key
- メタデータを設定する指定されたバケット内のオブジェクトキーmetadata
- IIJ GIOストレージ&アナリシスサービス へ アップロードしたデータをどのように扱うかを知らせる
ための、追加メタデータ(カスタムのメタデータ など)IIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーStorageObject getObject(String bucketName, String key) throws IIJGIOClientException
このメソッドを使用する場合は気をつけてください:
戻り値で返されるオブジェクトは、HTTP接続のストリームを含んでいます。
HTTP接続は データを読み終わりストリームを閉じるまでクローズされません。
ですので、以下のことをお勧めします。
IIJ GIOストレージ&アナリシスサービス オブジェクトを取得する際には、このメソッドを呼び出す利用者は対象のオブジェクトに対して
Permission.Read
の権限を保持している必要があります。
もし対象のオブジェクトが public-readable になっている場合は、ブラウザから URL を指定して取得する ことも可能です。
高度なオプション(コンテンツの一部だけをダウンロードする、ダウンロード時に条件をつける など)を必要と
する場合は、getObject(GetObjectRequest)
メソッドを使用してください。
bucketName
- 所望のオブジェクトを保持する、バケット名key
- 所望オブジェクトのキーIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーgetObject(GetObjectRequest)
,
getObject(GetObjectRequest, File)
StorageObject getObject(GetObjectRequest getObjectRequest) throws IIJGIOClientException
指定の条件に合致するものがなかった場合は、null
を返します。
このメソッドを使用する場合は気をつけてください:
戻り値で返されるオブジェクトは、HTTP接続のストリームを含んでいます。
HTTP接続は データを読み終わりストリームを閉じるまでクローズされません。
ですので、以下のことをお勧めします。
上記を行わない場合、クライアントは「開かれているが使用されていない HTTP接続」のリソースが溜まってしまう 可能性があります。
IIJ GIOストレージ&アナリシスサービス オブジェクトを取得する際には、このメソッドを呼び出す利用者は対象のオブジェクトに対して
Permission.Read
の権限を保持している必要があります。
もし対象のオブジェクトが public-readable になっている場合は、ブラウザから URL を指定して取得する ことも可能です。
リクエスト・オブジェクトに条件を指定する場合、クライアント側では null
が返ってくる
ことを想定した処理を行う必要があります。
(指定の条件に合致しない場合、null
が返されます)
もし GetObjectRequest
に指定するような高度なオプションが必要でない場合は、
よりシンプルな getObject(String bucketName, String key)
メソッドを使用してください。
getObjectRequest
- オブジェクトをどのようにダウンロードするかのオプションを含む
リクエスト・オブジェクトnull
IIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーgetObject(String, String)
,
getObject(GetObjectRequest, File)
ObjectMetadata getObject(GetObjectRequest getObjectRequest, File destinationFile) throws IIJGIOClientException
指定の条件に一致しない場合は、null
を返します。
getObject(GetObjectRequest)
メソッドの代わりに使用することで、
HTTP ストリーム・リソースを できる限り早く、自動的に閉じることを保証します。
クライアントはオブジェクトのコンテンツを素早く指定のファイルへ保存します。
IIJ GIOストレージ&アナリシスサービス オブジェクトを取得する際には、このメソッドを呼び出す利用者は対象のオブジェクトに対して
Permission.Read
の権限を保持している必要があります。
もし対象のオブジェクトが public-readable になっている場合は、ブラウザから URL を指定して取得する ことも可能です。
リクエスト・オブジェクトに条件を指定する場合、クライアント側では null
が返ってくる
ことを想定した処理を行う必要があります。
(指定の条件に合致しない場合、null
が返されます)
getObjectRequest
- オブジェクトをどのようにダウンロードするかのオプションを含む
リクエスト・オブジェクトdestinationFile
- IIJ GIOストレージ&アナリシスサービス からダウンロードされたオブジェクトnコンテンツを保存
するためのファイルnull
を返す。IIJGIOClientException
- クライアントでリクエスト作成中、レスポンス処理中、
または指定された宛先ファイルに本サービスからの受信データを書き込む際に起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーgetObject(String, String)
,
getObject(GetObjectRequest)
void deleteBucket(DeleteBucketRequest deleteBucketRequest) throws IIJGIOClientException
バケットに設定されている ACL, policy に関係なく、バケットを削除することができるのは、 そのバケットの所有者のみです。
deleteBucketRequest
- IIJ GIOストレージ&アナリシスサービス バケットを削除するためのオプションを含むリクエスト・オブジェクトIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーdeleteBucket(String)
void deleteBucket(String bucketName) throws IIJGIOClientException
バケットに設定されている ACL, policy に関係なく、バケットを削除することができるのは、 そのバケットの所有者のみです。
bucketName
- 削除対象のバケット名IIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーPutObjectResult putObject(PutObjectRequest putObjectRequest) throws IIJGIOClientException
PutObjectRequest
はリクエストに関するすべての詳細情報を保持します。
アップロード先のバケット,オブジェクトのキー,アップロードするファイルまたは 入力ストリームなどを保持します。
IIJ GIOストレージ&アナリシスサービス は、オブジェクトの一部だけを保存することはしません:もしこの処理中に 例外が発生しなければ、オブジェクト全体が保存されたことになります。
アップロード対象として ファイルを指定するか 入力ストリームを指定するかにより、 若干の挙動の際があります。
ファイルをアップロードする場合:
入力ストリームを直接指定する場合:
既存の同一キーのオブジェクトに対してこの操作が行われた場合、IIJ GIOストレージ&アナリシスサービス はオブジェクト
を上書きします。IIJ GIOストレージ&アナリシスサービス は最後のリクエストのデータを保持します。
IIJ GIOストレージ&アナリシスサービス は、オブジェクト・ロックの機能は提供していません。
IIJ GIOストレージ&アナリシスサービス が同じキーのオブジェクトを書き込む複数のリクエストをほぼ同時に受けた場合、 全てのオブジェクトの保存処理を行おうとしますが、最後のリクエストのオブジェクトだけが 保存される形となります。
バケット作成時にロケーションを指定していた場合、そのバケットに追加されるすべての オブジェクトは、そのバケットのリージョンに保存されます。
オブジェクトをアップロードするには、指定のバケットが既に存在し、対象バケットに対して
Permission.Write
権限を保持している必要があります。
putObjectRequest
- 新しいオブジェクトを IIJ GIOストレージ&アナリシスサービス へアップロードするための すべての
パラメータを保持したリクエスト・オブジェクトPutObjectResult
オブジェクトIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーputObject(String, String, File)
,
putObject(String, String, InputStream, ObjectMetadata)
PutObjectResult putObject(String bucketName, String key, File file) throws IIJGIOClientException
IIJ GIOストレージ&アナリシスサービス は、オブジェクトの一部だけを保存することはしません:もしこの処理中に 例外が発生しなければ、オブジェクト全体が保存されたことになります。
クライアントは自動的にこのファイルのチェックサムを計算します。
IIJ GIOストレージ&アナリシスサービス は、このチェックサムをファイルの有効性確認に利用します。
ファイル拡張子を使用して、IIJ GIOストレージ&アナリシスサービス は このオブジェクトを使用するために 適切な Content-Type および Content-Disposition の特定を試みます。
既存の同一キーのオブジェクトに対してこの操作が行われた場合、IIJ GIOストレージ&アナリシスサービス はオブジェクト
を上書きします。IIJ GIOストレージ&アナリシスサービス は最後のリクエストのデータを保持します。
IIJ GIOストレージ&アナリシスサービス は、オブジェクト・ロックの機能は提供していません。
IIJ GIOストレージ&アナリシスサービス が同じキーのオブジェクトを書き込む複数のリクエストをほぼ同時に受けた場合、 全てのオブジェクトの保存処理を行おうとしますが、最後のリクエストのオブジェクトだけが 保存される形となります。
バケット作成時にロケーションを指定していた場合、そのバケットに追加されるすべての オブジェクトは、そのバケットのリージョンに保存されます。
オブジェクトをアップロードするには、指定のバケットが既に存在し、対象バケットに対して
Permission.Write
権限を保持している必要があります。
bucketName
- Permission.Write
権限を持つ、既存のバケット名key
- 指定のファイルを保存するために使用するキーfile
- IIJ GIOストレージ&アナリシスサービス へアップロードするファイルPutObjectResult
オブジェクトIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーputObject(PutObjectRequest)
,
putObject(String, String, InputStream, ObjectMetadata)
PutObjectResult putObject(String bucketName, String key, InputStream input, ObjectMetadata metadata) throws IIJGIOClientException
IIJ GIOストレージ&アナリシスサービス は、オブジェクトの一部だけを保存することはしません:もしこの処理中に 例外が発生しなければ、オブジェクト全体が保存されたことになります。
クライアントは自動的にファイルのチェックサムを計算します。このチェックサムは IIJ GIOストレージ&アナリシスサービス 側で計算されたもう1つのチェックサムとの確認で使用され、データが ネットワーク上で不正に操作されていないことを確認します。
ファイル拡張子を使用して、IIJ GIOストレージ&アナリシスサービス は このオブジェクトを使用するために 適切な Content-Type および Content-Disposition の特定を試みます。
データを IIJ GIOストレージ&アナリシスサービス へアップロードする前に、Content-Length を指定しなければなりません。
IIJ GIOストレージ&アナリシスサービス は、Content-Length が明示的に指定されることを想定しています。
もし長さが指定されなかった場合は、本ライブラリが計算するために入力ストリームのコンテンツを
バッファリングしなければなりません。
既存の同一キーのオブジェクトに対してこの操作が行われた場合、IIJ GIOストレージ&アナリシスサービス はオブジェクト
を上書きします。IIJ GIOストレージ&アナリシスサービス は最後のリクエストのデータを保持します。
IIJ GIOストレージ&アナリシスサービス は、オブジェクト・ロックの機能は提供していません。
IIJ GIOストレージ&アナリシスサービス が同じキーのオブジェクトを書き込む複数のリクエストをほぼ同時に受けた場合、
全てのオブジェクトの保存処理を行おうとしますが、最後のリクエストのオブジェクトだけが
保存される形となります。
バケット作成時にロケーションを指定していた場合、そのバケットに追加されるすべての
オブジェクトは、そのバケットのリージョンに保存されます。
オブジェクトをアップロードするには、指定のバケットが既に存在し、対象バケットに対して
Permission.Write
権限を保持している必要があります。
bucketName
- Permission.Write
権限を持つ、既存のバケット名key
- 指定のファイルを保存するために使用するキーinput
- IIJ GIOストレージ&アナリシスサービス へアップロードするデータの入力ストリームmetadata
- IIJ GIOストレージ&アナリシスサービス へ アップロードしたデータをどのように扱うかを知らせる
ための、追加メタデータ(カスタムのメタデータ など)PutObjectResult
オブジェクトIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーputObject(String, String, File)
,
putObject(PutObjectRequest)
CopyObjectResult copyObject(String sourceBucketName, String sourceKey, String destinationBucketName, String destinationKey) throws IIJGIOClientException
デフォルトでは、コピー元オブジェクトの全てのメタデータもコピーされるように
なっています。IIJ GIOストレージ&アナリシスサービス AccessControlList
(ACL) は、新しい
オブジェクトへは コピーされません。
新しいオブジェクトは、デフォルトの IIJ GIOストレージ&アナリシスサービス ACL である CannedAccessControlList.Private
が設定されます。
オブジェクトをコピーするには、操作者はコピー元オブジェクトの READ 権限、および コピー先
バケットの WRITE 権限を所有している必要があります。
このメソッドは、オブジェクトをコピーするための基本オプション
のみを用いたメソッドです。
コピーの際の条件,メタデータの上書き などの追加オプションの指定が可能な
StorageClient.copyObject(CopyObjectRequest)
メソッドも用意
されています。
sourceBucketName
- コピー対象のオブジェクトが存在するバケット名sourceKey
- コピー対象オブジェクトのキーdestinationBucketName
- 新しいオブジェクトを格納する先のバケット名。
コピー元と同じバケット名を指定することも可能です。destinationKey
- 新しいオブジェクトのキーPutObjectResult
オブジェクトIIJGIOClientException
- リクエスト生成時またはレスポンス操作時にクライアントで発生したエラー。IIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーStorageClient.copyObject(CopyObjectRequest)
CopyObjectResult copyObject(CopyObjectRequest copyObjectRequest) throws IIJGIOClientException
新しいオブジェクトのメタデータが CopyObjectRequest
内で指定
されていない限り、デフォルトでは コピー元オブジェクトの全てのメタデ
ータもコピーされるようになっています。
デフォルトでは、コピー元オブジェクトの全てのメタデータもコピーされるように
なっています。IIJ GIOストレージ&アナリシスサービス AccessControlList
(ACL) は、新しい
オブジェクトへは コピーされません。
CopyObjectRequest
内で明示的に指定されていない限り、新しいオブジェクト
は、デフォルトの IIJ GIOストレージ&アナリシスサービス ACL である CannedAccessControlList.Private
が設定されます。
オブジェクトをコピーするには、操作者はコピー元オブジェクトの READ 権限、および コピー先
バケットの WRITE 権限を所有している必要があります。
もし CopyObjectRequest
内に (CopyObjectRequest.setMatchingETagConstraints(List)
のような) 条件が指定されていた場合で、その条件を満たさなかった場合、
null
が返されます。
このメソッドでは、上記のケース以外では null ではない値を返します。
このメソッドは、オブジェクトをコピーするための基本オプション
のみを用いたメソッドです。
コピーの際の条件,メタデータの上書き などの追加オプションの指定が可能な
StorageClient.copyObject(CopyObjectRequest)
メソッドも用意
されています。
copyObjectRequest
- IIJ GIOストレージ&アナリシスサービス オブジェクトをコピーするための すべてのオプション
情報を含む リクエスト・オブジェクトCopyObjectResult
オブジェクト。
指定条件を満たさなかった場合は null
。IIJGIOClientException
- リクエスト生成時またはレスポンス操作時にクライアントで発生したエラー。IIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーStorageClient.copyObject(String, String, String, String)
CopyPartResult copyPart(CopyPartRequest copyPartRequest) throws IIJGIOClientException
オブジェクトをコピーするためには、呼び出しアカウントは既存オブジェクトに対する
読み込みアクセス権と宛先バケットに対する書き込みアクセス権を持つ必要があります。
もし制約がCopyPartRequest
(例えばCopyPartRequest.setMatchingETagConstraints(List)
)で
指定されて、かつ、IIJ GIOストレージ&アナリシスサービスがリクエストを受け取った際に制約を満たしていなければ、
このメソッドはnull
を返します。
それ以外のどのような場合でも、このメソッドは非null値を返します。
copyPartRequest
- IIJ GIOストレージ&アナリシスサービスのオブジェクトをコピーするための
全オプションをもつリクエスト・オブジェクトCopyPartResult
オブジェクト。
または、指定された制約が、IIJ GIOストレージ&アナリシスサービスがそのオブジェクトを
コピーしようとした際に満たされていなければ、null
.IIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーStorageClient.copyObject(CopyObjectRequest)
,
StorageClient.initiateMultipartUpload(InitiateMultipartUploadRequest)
void deleteObject(String bucketName, String key) throws IIJGIOClientException
削除対象のオブジェクトが存在しない場合、IIJ GIOストレージ&アナリシスサービス はエラーメッセージの 代わりに成功メッセージを返します。
bucketName
- 削除対象のオブジェクトを保持しているバケット名。key
- 削除対象のオブジェクトのキーIIJGIOClientException
- リクエスト生成時またはレスポンス操作時にクライアントで発生したエラー。IIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーStorageClient.deleteObject(DeleteObjectRequest)
void deleteObject(DeleteObjectRequest deleteObjectRequest) throws IIJGIOClientException
削除対象のオブジェクトが存在しない場合、IIJ GIOストレージ&アナリシスサービス はエラーメッセージの 代わりに成功メッセージを返します。
deleteObjectRequest
- IIJ GIOストレージ&アナリシスサービス オブジェクトを削除するためのすべてのオプション情報を
保持したリクエスト・オブジェクトIIJGIOClientException
- リクエスト生成時またはレスポンス操作時にクライアントで発生したエラー。IIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーStorageClient.deleteObject(String, String)
DeleteObjectsResult deleteObjects(DeleteObjectsRequest deleteObjectsRequest) throws IIJGIOClientException
正常に削除されるオブジェクトもありますが、
場合によってはエラーを引き起こすオブジェクトもあります。
もしリクエスト内のいかなるオブジェクトでも削除できなかった場合、
このメソッドはエラー詳細とともにMultiObjectDeleteException
を投げます。
deleteObjectsRequest
- 複数オブジェクト削除に必要な全てのオプションを持つリクエスト用オブジェクトMultiObjectDeleteException
- 1つまたは複数のオブジェクトが削除できなかった場合に起きるエラーIIJGIOClientException
- リクエスト生成時またはレスポンス操作時にクライアントで発生したエラー。IIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーBucketCrossOriginConfiguration getBucketCrossOriginConfiguration(String bucketName)
設定が定められていない場合はnullを返します。
bucketName
- CORS設定を読み出すバケット名void setBucketCrossOriginConfiguration(String bucketName, BucketCrossOriginConfiguration bucketCrossOriginConfiguration)
bucketName
- CORS設定を読み出すバケット名.bucketCrossOriginConfiguration
- 指定バケットの新しいCORS設定。既存の設定を完全に置き換えます。void deleteBucketCrossOriginConfiguration(String bucketName)
bucketName
- CORS設定を読み出すバケット名.BucketWebsiteConfiguration getBucketWebsiteConfiguration(String bucketName) throws IIJGIOClientException
バケットのウェブサイト設定を行うことで、IIJ GIO外にある静的ウェブサイトへホストさせることが可能になります。 IIJ GIOストレージ&アナリシスサービス内にあるウェブサイトへホストするには、バケットを作成し、ファイルをアップロードした後に、 それをウェブサイトととして設定してください。一旦バケットがウェブサイトとして設定されると IIJ GIOストレージ&アナリシスサービスのウェブサイトのエンドポイントを介して全てのコンテンツにアクセスすることができます。 バケットがウェブサイトへホストするように設定されているかどうかにかかわりなく、 既存のIIJ GIOストレージ&アナリシスサービスが同じように動作し続けることを保証するために、 設定したウェブサイトのコンテンツにアクセスできる新しいHTTPのエンドポイントを用意しました。 ウェブサイトを介して利用できるようにしたいバケットのコンテンツは一般的に読みやすくなければなりません。
ウェブサイトへホストするためのさらに詳しい情報は下記を参照してください。 http://docs.amazonwebservices.com/AmazonS3/latest/dev/WebsiteHosting.html.
この操作にはIIJ GIO:GetBucketWebsite
権限が必要です。
デフォルトでは、バケットのオーナーだけがバケットのウェブサイト設定を読み込むことができます。
さらにバケットのオーナーは、他のユーザにIIJ GIO:GetBucketWebsite
権限を付与するように
バケットポリシーを書き換えれば、他のユーザに対してウェブサイト設定の読み込みを許可することができます。
bucketName
- ウェブサイト設定を読み出すバケット名。IIJGIOClientException
- リクエスト生成時またはレスポンス操作時にクライアントで発生したエラー。IIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラー。BucketWebsiteConfiguration getBucketWebsiteConfiguration(GetBucketWebsiteConfigurationRequest getBucketWebsiteConfigurationRequest) throws IIJGIOClientException
バケットのウェブサイト設定を行うことで、IIJ GIO外にある静的ウェブサイトへホストさせることが可能になります。 IIJ GIOストレージ&アナリシスサービス内にあるウェブサイトへホストするには、バケットを作成し、ファイルをアップロードした後に、 それをウェブサイトととして設定してください。一旦バケットがウェブサイトとして設定されると IIJ GIOストレージ&アナリシスサービスのウェブサイトのエンドポイントを介して全てのコンテンツにアクセスすることができます。 バケットがウェブサイトへホストするように設定されているかどうかにかかわりなく、 既存のIIJ GIOストレージ&アナリシスサービスが同じように動作し続けることを保証するために、 設定したウェブサイトのコンテンツにアクセスできる新しいHTTPのエンドポイントを用意しました。 ウェブサイトを介して利用できるようにしたいバケットのコンテンツは一般的に読みやすくなければなりません。
ウェブサイトへホストするためのさらに詳しい情報は下記を参照してください。 http://docs.amazonwebservices.com/AmazonS3/latest/dev/WebsiteHosting.html.
この操作にはIIJ GIO:GetBucketWebsite
権限が必要です。
デフォルトでは、バケットのオーナーだけがバケットのウェブサイト設定を読み込むことができます。
さらにバケットのオーナーは、他のユーザにIIJ GIO:GetBucketWebsite
権限を付与するように
バケットポリシーを書き換えれば、他のユーザに対してウェブサイト設定の読み込みを許可することができます。
getBucketWebsiteConfigurationRequest
- ウェブサイト設定を読み出すバケットに関する情報が全て含まれているリクエスト用オブジェクト。IIJGIOClientException
- リクエスト生成時またはレスポンス操作時にクライアントで発生したエラー。IIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラー。void setBucketWebsiteConfiguration(String bucketName, BucketWebsiteConfiguration configuration) throws IIJGIOClientException
バケットのウェブサイト設定を行うことで、IIJ GIO外にある静的ウェブサイトへホストさせることが可能になります。 IIJ GIOストレージ&アナリシスサービス内にあるウェブサイトへホストするには、バケットを作成し、ファイルをアップロードした後に、 それをウェブサイトととして設定してください。一旦バケットがウェブサイトとして設定されると IIJ GIOストレージ&アナリシスサービスのウェブサイトのエンドポイントを介して全てのコンテンツにアクセスすることができます。 バケットがウェブサイトへホストするように設定されているかどうかにかかわりなく、 既存のIIJ GIOストレージ&アナリシスサービスが同じように動作し続けることを保証するために、 設定したウェブサイトのコンテンツにアクセスできる新しいHTTPのエンドポイントを用意しました。 ウェブサイトを介して利用できるようにしたいバケットのコンテンツは一般的に読みやすくなければなりません。
バケット操作のさらに詳しい情報は下記を参照してください。 http://docs.amazonwebservices.com/AmazonS3/latest/dev/WebsiteHosting.html.
この操作にはIIJ GIO:PutBucketWebsite
権限が必要です。
デフォルトでは、バケットのオーナーだけがバケットのウェブサイト設定を行うことができます。
さらにバケットのオーナーは、他のユーザにIIJ GIO:PutBucketWebsite
権限を付与するように
バケットポリシーを書き換えれば、他のユーザに対してウェブサイト設定を許可することができます。
bucketName
- ウェブサイト設定をセットするバケット名。configuration
- 指定バケットがどのようなWebリクエストを出すのかを記述した設定情報
(例えば、デフォルトのindexページやエラーページなど)IIJGIOClientException
- リクエスト生成時またはレスポンス操作時にクライアントで発生したエラー。IIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラー。void setBucketWebsiteConfiguration(SetBucketWebsiteConfigurationRequest setBucketWebsiteConfigurationRequest) throws IIJGIOClientException
バケットのウェブサイト設定を行うことで、IIJ GIO外にある静的ウェブサイトへホストさせることが可能になります。 IIJ GIOストレージ&アナリシスサービス内にあるウェブサイトへホストするには、バケットを作成し、ファイルをアップロードした後に、 それをウェブサイトととして設定してください。一旦バケットがウェブサイトとして設定されると IIJ GIOストレージ&アナリシスサービスのウェブサイトのエンドポイントを介して全てのコンテンツにアクセスすることができます。 バケットがウェブサイトへホストするように設定されているかどうかにかかわりなく、 既存のIIJ GIOストレージ&アナリシスサービスが同じように動作し続けることを保証するために、 設定したウェブサイトのコンテンツにアクセスできる新しいHTTPのエンドポイントを用意しました。 ウェブサイトを介して利用できるようにしたいバケットのコンテンツは一般的に読みやすくなければなりません。
バケット操作のさらに詳しい情報は下記を参照してください。 http://docs.amazonwebservices.com/AmazonS3/latest/dev/WebsiteHosting.html.
この操作にはIIJ GIO:PutBucketWebsite
権限が必要です。
デフォルトでは、バケットのオーナーだけがバケットのウェブサイト設定を行うことができます。
さらにバケットのオーナーは、他のユーザにIIJ GIO:PutBucketWebsite
権限を付与するように
バケットポリシーを書き換えれば、他のユーザに対してウェブサイト設定を許可することができます。
setBucketWebsiteConfigurationRequest
- 更新または新規の値がセットされたウェブサイト設定と
対象のバケット名を含んだリクエスト用オブジェクト。IIJGIOClientException
- リクエスト生成時またはレスポンス操作時にクライアントで発生したエラー。IIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラー。void deleteBucketWebsiteConfiguration(String bucketName) throws IIJGIOClientException
この操作をウェブサイト設定を持っていないバケットに対して行っても、例外は投げられません。 存在しないバケットに対してこの操作を行うと、例外が投げられます。
バケット操作のさらに詳しい情報は下記を参照してください。 http://docs.amazonwebservices.com/AmazonS3/latest/dev/WebsiteHosting.html.
この操作にはIIJ GIO:DeleteBucketWebsite
権限が必要です。
デフォルトでは、バケットのオーナーだけがバケットのウェブサイト設定を削除することができます。
さらにバケットのオーナーは、他のユーザにIIJ GIO:DeleteBucketWebsite
権限を付与するように
バケットポリシーを書き換えれば、他のユーザに対してウェブサイト設定の削除を許可することができます。
bucketName
- ウェブサイト設定を削除するバケット名。IIJGIOClientException
- リクエスト生成時またはレスポンス操作時にクライアントで発生したエラー。IIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラー。void deleteBucketWebsiteConfiguration(DeleteBucketWebsiteConfigurationRequest deleteBucketWebsiteConfigurationRequest) throws IIJGIOClientException
この操作をウェブサイト設定を持っていないバケットに対して行っても、例外は投げられません。 存在しないバケットに対してこの操作を行うと、例外が投げられます。
バケット操作のさらに詳しい情報は下記を参照してください。 http://docs.amazonwebservices.com/AmazonS3/latest/dev/WebsiteHosting.html.
この操作にはIIJ GIO:DeleteBucketWebsite
権限が必要です。
デフォルトでは、バケットのオーナーだけがバケットのウェブサイト設定を削除することができます。
さらにバケットのオーナーは、他のユーザにIIJ GIO:DeleteBucketWebsite
権限を付与するように
バケットポリシーを書き換えれば、他のユーザに対してウェブサイト設定の削除を許可することができます。
deleteBucketWebsiteConfigurationRequest
- ウェブサイト設定を削除するバケット名を含んだリクエスト用オブジェクト。IIJGIOClientException
- リクエスト生成時またはレスポンス操作時にクライアントで発生したエラー。IIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラー。BucketPolicy getBucketPolicy(String bucketName) throws IIJGIOClientException
バケットの所有者のみが、ポリシーを取得することが可能です。
対象のバケットにポリシーがセットされていない場合、null
のポリシー
フィールドを持った 空の結果オブジェクトが返されます。
バケット・ポリシーは、バケットおよびその中のオブジェクト の両リソースに 対するアクセス制御を提供します。 1つのバケットにつき、1つのポリシーだけが指定可能です。
bucketName
- ポリシー情報を取得する対象のバケット名IIJGIOClientException
- リクエスト生成時またはレスポンス操作時にクライアントで発生したエラー。IIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーsetBucketPolicy(String, String)
void setBucketPolicy(SetBucketPolicyRequest setBucketPolicyRequest) throws IIJGIOClientException
バケットの所有者のみが、ポリシーをセット可能です。 指定のバケットに既にポリシーがセットされている場合、新しいポリシーで 差し替えられます。
バケット・ポリシーは、バケットおよびその中のオブジェクト の両リソースに 対するアクセス制御を提供します。 1つのバケットにつき、1つのポリシーだけが指定可能です。
setBucketPolicyRequest
- 更新するバケットとポリシーの詳細を持つリクエスト・オブジェクトIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーBucketPolicy getBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest) throws IIJGIOClientException
バケットの所有者のみが、ポリシーを取得することが可能です。
対象のバケットにポリシーがセットされていない場合、null
のポリシー
フィールドを持った 空の結果オブジェクトが返されます。
バケット・ポリシーは、バケットおよびその中のオブジェクト の両リソースに 対するアクセス制御を提供します。 1つのバケットにつき、1つのポリシーだけが指定可能です。
getBucketPolicyRequest
- バケットのポリシーを読み出すための詳細を持つリクエスト・オブジェクトIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーsetBucketPolicy(String, String)
void setBucketPolicy(String bucketName, String policyText) throws IIJGIOClientException
バケットの所有者のみが、ポリシーをセット可能です。 指定のバケットに既にポリシーがセットされている場合、新しいポリシーで 差し替えられます。
バケット・ポリシーは、バケットおよびその中のオブジェクト の両リソースに 対するアクセス制御を提供します。 1つのバケットにつき、1つのポリシーだけが指定可能です。
bucketName
- ポリシー情報をセットする対象のバケット名policyText
- 指定バケットに適用するポリシーIIJGIOClientException
- リクエスト生成時またはレスポンス操作時にクライアントで発生したエラー。IIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーvoid deleteBucketPolicy(String bucketName) throws IIJGIOClientException
バケットの所有者のみが、ポリシーを削除可能です。
バケット・ポリシーは、バケットおよびその中のオブジェクト の両リソースに
対するアクセス制御を提供します。
1つのバケットにつき、1つのポリシーだけが指定可能です。
bucketName
- ポリシーを削除する対象のバケット名IIJGIOClientException
- リクエスト生成時またはレスポンス操作時にクライアントで発生したエラー。IIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーvoid deleteBucketPolicy(DeleteBucketPolicyRequest deleteBucketPolicyRequest) throws IIJGIOClientException
バケットの所有者のみが、ポリシーを削除可能です。
バケット・ポリシーは、バケットおよびその中のオブジェクト の両リソースに
対するアクセス制御を提供します。
1つのバケットにつき、1つのポリシーだけが指定可能です。
deleteBucketPolicyRequest
- バケットのポリシーを削除するための詳細を持つリクエスト・オブジェクトIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーStorageSpace getStorageSpace() throws IIJGIOClientException
IIJGIOClientException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーURL generatePresignedUrl(String bucketName, String key, Date expiration) throws IIJGIOClientException
サイン済みURLは クライアントに IIJ GIOストレージ&アナリシスサービス リソースへの URLを形成する
ことを可能にし、現在の IIJGIO セキュリティ証明書でサインします。
サイン済みURLは 他ユーザへセキュリティ証明書を配布することなしに
他ユーザとリソースへのアクセスを共有することができます。
サイン済みURLは、セキュリティ証明できないクライアントから IIJ GIOストレージ&アナリシスサービス
へリクエストを行いたい場合など、多くの場面で有用です。
例えば、アプリケーションの所有者のバケットに対してリモートユーザがファイルの
アップロードをさせる必要があるが アプリケーションのセキュリティ証明書を払い
出したくない場合などです。
所有者のバケットへオブジェクトを PUT する 所有者の証明書によるサイン済みURLを、
リモートで生成することができ、その URL でエンドユーザのアプリケーションから
使用することができます。
bucketName
- 対象のオブジェクトを持つバケット名key
- 対象オブジェクトのキーexpiration
- 戻り値で返す URL の期限切れ時刻IIJGIOClientException
- 指定オブジェクトへのリクエストにサインする際に何らかの問題
が発生した場合generatePresignedUrl(String, String, Date, HttpMethod)
,
generatePresignedUrl(GeneratePresignedUrlRequest)
URL generatePresignedUrl(String bucketName, String key, Date expiration, HttpMethod method) throws IIJGIOClientException
サイン済みURLは クライアントに IIJ GIOストレージ&アナリシスサービス リソースへの URLを形成する
ことを可能にし、現在の IIJGIO セキュリティ証明書でサインします。
サイン済みURLは 他ユーザへセキュリティ証明書を配布することなしに
他ユーザとリソースへのアクセスを共有することができます。
サイン済みURLは、セキュリティ証明できないクライアントから IIJ GIOストレージ&アナリシスサービス へリクエストを行いたい場合など、多くの場面で有用です。
例えば、アプリケーションの所有者のバケットに対してリモートユーザがファイルの
アップロードをさせる必要があるが アプリケーションのセキュリティ証明書を払い
出したくない場合などです。
所有者のバケットへオブジェクトを PUT する 所有者の証明書によるサイン済みURLを、
リモートで生成することができ、その URL でエンドユーザのアプリケーションから
使用することができます。
bucketName
- 対象のオブジェクトを持つバケット名key
- 対象のオブジェクトのキーexpiration
- 戻り値で返す URL の期限切れ時刻method
- URL で使用する HTTPメソッドIIJGIOClientException
- 指定オブジェクトへのリクエストにサインする際に何らかの問題
が発生した場合generatePresignedUrl(String, String, Date)
,
generatePresignedUrl(GeneratePresignedUrlRequest)
URL generatePresignedUrl(GeneratePresignedUrlRequest generatePresignedUrlRequest) throws IIJGIOClientException
サイン済みURLは クライアントに IIJ GIOストレージ&アナリシスサービス リソースへの URLを形成する
ことを可能にし、現在の IIJGIO セキュリティ証明書でサインします。
サイン済みURLは 他ユーザへセキュリティ証明書を配布することなしに
他ユーザとリソースへのアクセスを共有することができます。
サイン済みURLは、セキュリティ証明できないクライアントから IIJ GIOストレージ&アナリシスサービス
へリクエストを行いたい場合など、多くの場面で有用です。
例えば、アプリケーションの所有者のバケットに対してリモートユーザがファイルの
アップロードをさせる必要があるが アプリケーションのセキュリティ証明書を払い
出したくない場合などです。
所有者のバケットへオブジェクトを PUT する 所有者の証明書によるサイン済みURLを、
リモートで生成することができ、その URL でエンドユーザのアプリケーションから
使用することができます。
generatePresignedUrlRequest
- サイン済みURLを生成するために必要なすべてのオプション(バケット名、
キー、期限切れ時刻 など)IIJGIOClientException
- 指定オブジェクトへのリクエストにサインする際に何らかの問題
が発生した場合generatePresignedUrl(String, String, Date)
,
generatePresignedUrl(String, String, Date, HttpMethod)
InitiateMultipartUploadResult initiateMultipartUpload(InitiateMultipartUploadRequest request) throws IIJGIOClientException
このアップロードIDは特定のアップロードの全パートと関連付けられ、
それに続く各uploadPart(UploadPartRequest)
リクエストで使用されます。
このアップロードIDはマルチパートアップロードを完了するか中断するかどうかを決める
最後のリクエストまで使用されます。
request
- この操作に関する全パラメータを指定したInitiateMultipartUploadResultオブジェクトIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーUploadPartResult uploadPart(UploadPartRequest request) throws IIJGIOClientException
任意のパートをアップロードする前に必ずマルチパートアップロードの 事前設定を行ってください。
アップロード・パートのリクエストは必ずアップロードIDとパート番号が
含まれていなければなりません。アップロードIDはInitiate Multipart Upload
リクエストのレスポンス内にあるIIJ GIOストレージ&アナリシスサービスから返されるIDです。
パート番号は1から10,000までの任意の数値です。パート番号は
そのパートを一意に識別し、アップロードされるオブジェクト内の位置を定義します。
もし新しいパートをアップロードする際に、
前回のアップロードで指定したものと同じパート番号を使って行うと、
前回アップロードされたパートは上書きされます。
ネットワークを通過する際にデータが破損しないことを保証するために
Upload PartリクエストのContent-MD5ヘッダーを指定してください。
IIJ GIOストレージ&アナリシスサービスはパートのデータと与えられたMD5の値と照合します。
それらが合わない場合、IIJ GIOストレージ&アナリシスサービスはエラーを返します。
パートをアップロードした際、返却されたUploadPartResultはETagプロパティを
持っています。このETagの値とパート番号を記録してください。
全パートのアップロードが終わった後、CompleteMultipartUploadリクエストを
行ってください。その時に、IIJ GIOストレージ&アナリシスサービスはアップロードされた
全パートをパート番号の昇順で結合して完全なオブジェクトを生成します。
CompleteMultipartUploadリクエストでは全パート番号と一致するETagの値が必要になります。
request
- この操作に関する全パラメータを指定したUploadPartRequestオブジェクトIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーPartListing listParts(ListPartsRequest request) throws IIJGIOClientException
このメソッドにはinitiateMultipartUpload(InitiateMultipartUploadRequest)
操作で
返されるアップロードIDが含まれていなければなりません。
このリクエストはデフォルトで最大1,000個のアップロードされたパートを返します。
ListPartsRequestのMaxPartsプロパティを指定することで
返されるパート数を制限することができます。
マルチパートアップロードがListPartsレスポンスで許容されるよりも多いパート数で
構成されている場合、レスポンスはtrue値が設定されたIsTruncatedフィールドと
NextPartNumberMarkerプロパティを返します。それに続くListPartsリクエストでは
PartNumberMarkerプロパティを含め、前回のレスポンスから得られた
NextPartNumberMarkerプロパティの値を設定してください。
request
- この操作に関する全パラメータを指定したListPartsRequestオブジェクトIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーvoid abortMultipartUpload(AbortMultipartUploadRequest request) throws IIJGIOClientException
マルチパートアップロードが中断された後、同じアップロードIDを使って
さらなるパートのアップロードはできません。
以前にアップロードされたパートで使われていたストレージは開放されます。
しかしながらいずれかのパートのアップロードが現在進行中である場合、
そのパートのアップロードは成功するかもしれませんし、しないかもしれません。
結果的に全てのパートで使われている全ストレージを完全に開放するために、
行われたマルチパートアップロードを複数回中断する必要があるかもしれません。
request
- この操作に関する全パラメータを指定したAbortMultipartUploadRequestオブジェクトIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーCompleteMultipartUploadResult completeMultipartUpload(CompleteMultipartUploadRequest request) throws IIJGIOClientException
まずuploadPart(UploadPartRequest)
メソッドを用いて
全パートをアップロードしてください。全ての個々のパートのアップロードが
成功した後、アップロードを完了させるため、この操作を呼び出してください。
このリクエストを受け取るとすぐに、IIJ GIOストレージ&アナリシスサービスは
新しいオブジェクトを生成するために、パート番号の昇順で全パートを結合します。
CompleteMultipartUploadリクエスト時に、必ずパート・リストを設定してください。
そのリスト内のそれぞれのパートで、パートのアップロード後に返される
パート番号とETagヘッダーの値を設定してください。
CompleteMultipartUploadリクエストの処理には完了するまでに数分かかる場合もあります。
request
- この操作に関する全パート番号パラメータを指定したCompleteMultipartUploadRequestオブジェクトIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーMultipartUploadListing listMultipartUploads(ListMultipartUploadsRequest request) throws IIJGIOClientException
現在進行中のマルチパートアップロードとは、 InitiateMultipartUploadリクエストを使って事前設定がなされていて、かつ まだ完了または中断されていないマルチパートアップロードのことです。
この操作はデフォルトでレスポンス内に最大で1,000個のマルチパートアップロードを返します。
マルチパートアップロード数はリクエスト・パラメータのMaxUploadsプロパティを使うことで
さらに制限をかけることができます。リスト基準を満たす追加の
マルチパートアップロードが存在した場合、レスポンスにはtrueがセットされた
IsTruncatedプロパティが含まれます。追加のマルチパートアップロードをリストにするためには
リクエスト・パラメータのKeyMarkerプロパティとUploadIdMarkerプロパティを使用してください。
request
- この操作に関する全パラメータを指定したListMultipartUploadsRequestオブジェクトIIJGIOClientException
- クライアントでリクエスト作成中、またはレスポンス処理中起きたエラーIIJGIOServiceException
- IIJ GIOストレージ&アナリシスサービスでリクエスト処理中起きたエラーvoid addRequestEventListener(SendRequestEventListener requestEventListener)
void addResponseEventListener(ReceiveResponseEventListener responseEventListener)
Copyright © 2018. All rights reserved.