Data.Cloud.AmazonAPI.TAmazonStorageService.GetBucket
Delphi
function GetBucket(const BucketName: string; OptionalParams: TStrings; ResponseInfo: TCloudResponseInfo = nil; BucketRegion: TAmazonRegion = amzrNotSpecified): TAmazonBucketResult;
C++
TAmazonBucketResult* __fastcall GetBucket(const System::UnicodeString BucketName, System::Classes::TStrings* OptionalParams, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0), TAmazonRegion BucketRegion = (TAmazonRegion)(0x0));
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| function | public | Data.Cloud.AmazonAPI.pas Data.Cloud.AmazonAPI.hpp |
Data.Cloud.AmazonAPI | TAmazonStorageService |
説明
バケットのオブジェクトの一部またはすべてを返します。
GetBucket は、オブジェクト群を保有する TAmazonBucketResult オブジェクトを返します。
GetBucket は、次のパラメータを取ります：
BucketName： オブジェクトを取得するバケットの名前。OptionalParams： 任意のパラメータを定義する文字列のリスト。詳細については、以下の「表」 を参照してください。OptionalParamsをnilで指定することも可能です。ResponseInfo： 省略可能。 レスポンス情報を保持します。BucketRegion： 省略可能。 オブジェクトを取得するバケットのリージョン。デフォルトはamzrNotSpecifiedで、これは、このメソッドが、バケットの名前を基に、バケットのリージョンを自動的に検知することを意味します。
任意パラメータ
| パラメータ | 説明 |
|---|---|
|
|
ディレクトリを表す区切り文字を設定します（スラッシュ文字「/」が一般的に使用されます）。 |
|
|
レスポンスを、指定された接頭辞で始まるオブジェクト名に限定します。たとえば、ファイル システムでのフォルダに使用するのと同じように、接頭辞をグループを作るために使用することができます。 |
|
|
オブジェクトをリストにする際、オブジェクトの名前の開始部分。マーカーの後に始まっているオブジェクト群を保有する結果。 |
|
|
結果におけるオブジェクトの最大数。デフォルトは 1000 です。 |
応答
利用可能なオブジェクトが 1000 以上ある場合、または、max-keys 任意パラメータを指定した場合、ResponseInfo は、キー IsTruncated を値 True にします。切り詰められたオブジェクトに対してさらにリクエストをするためには、新しいメソッド呼び出しで、前回取得されたオブジェクトの Marker プロパティの値を、marker 任意パラメータとして渡します。