Data.Cloud.AmazonAPI.TAmazonStorageService.GetBucket

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

function GetBucket(const BucketName: string; OptionalParams: TStrings;
ResponseInfo: TCloudResponseInfo = nil;
const 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), const System::UnicodeString BucketRegion = System::UnicodeString());

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
function public
Data.Cloud.AmazonAPI.pas
Data.Cloud.AmazonAPI.hpp
Data.Cloud.AmazonAPI TAmazonStorageService


Beschreibung

Gibt einige oder alle Objekte eines Bucket zurück.

GetBucket gibt ein TAmazonBucketResult-Objekt zurück, das die Objekte enthält.

GetBucket akzeptiert die folgenden Parameter:

  • BucketName: Der Name des Bucket, für das die Objekte ermittelt werden sollen.
  • OptionalParams: Eine Liste mit Strings, die optionale Parameter festlegen. Weitere Informationen finden Sie in der #Optionale Parameter weiter unten. Sie können für OptionalParams nil angeben.
  • ResponseInfo: Optional. Enthält die Antwortinformationen.
  • BucketRegion: Optional. Die Region des Bucket, für das die Objekte ermittelt werden soll. Vorgabe ist amzrNotSpecified, was bedeutet, dass diese Methode automatisch die Region des Bucket anhand des Namens des Bucket ermittelt.

Optionale Parameter

Parameter Beschreibung

delimiter

Legt das Begrenzungszeichen fest, mit dem ein Verzeichnis angegeben wird (häufig wird der Schrägstrich ('/') verwendet).

Präfix

Schränkt die Antwort auf Objektnamen ein, die mit dem angegebenen Präfix beginnen. Sie können zum Beispiel ein Präfix verwenden, um Gruppen auf dieselbe Art und Weise zu erstellen, wie Sie einen Ordner in einem Dateisystem verwenden.

marker

Der Name eines Objekts, mit dem die Liste der Objekte beginnen soll. Das Ergebnis enthält Objekte, die nach dem Marker kommen.

max-keys

Die maximale Anzahl von im Ergebnis enthaltenen Objekten. Vorgabe ist 1000.

Antwort

Wenn mehr als 1000 Objekte verfügbar sind oder wenn Sie den optionalen Parameter max-keys angeben, enthält die ResponseInfo einen IsTruncated-Schlüssel mit dem Wert True. Um eine andere Anforderung für die abgeschnittenen Objekte zu stellen, übergeben Sie den Wert der Eigenschaft Marker des zuletzt abgerufenen Objekts als optionalen Parameter marker im neuen Methodenaufruf.

Siehe auch