Data.Cloud.AmazonAPI.TAmazonStorageService.GetBucket
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());
Propriétés
Type | Visibilité | Source | Unité | Parent |
---|---|---|---|---|
function | public | Data.Cloud.AmazonAPI.pas Data.Cloud.AmazonAPI.hpp |
Data.Cloud.AmazonAPI | TAmazonStorageService |
Description
Renvoie certains ou tous les objets d'un compartiment.
GetBucket renvoie un objet TAmazonBucketResult qui contient les objets.
GetBucket accepte les paramètres suivants :
BucketName
: le nom du compartiment pour lequel les objets sont obtenus.OptionalParams
: une liste de chaînes qui définit les paramètres facultatifs. Voir le tableau #Paramètres optionnels ci-dessous pour davantage d'informations. Vous pouvez spécifier la valeur deOptionalParams
surnil
.ResponseInfo
: facultatif. Contient l'information de la réponse.BucketRegion
: facultatif. La région (EN) du compartiment pour laquelle les objets sont obtenus. La valeur par défaut estamzrNotSpecified
, ce qui veut dire que cette méthode détecte automatiquement la région de ce compartiment en fonction du nom du compartiment.
Paramètres optionnels
Paramètre | Description |
---|---|
|
Définit le caractère délimitant permettant de désigner un répertoire (habituellement, le caractère barre oblique - slash ('/') est utilisé). |
|
Limite la réponse à des noms d'objets qui commencent par le préfixe spécifié. Par exemple, vous pouvez utiliser un préfixe pour créer des groupes de la même manière que vous utilisez un dossier dans un système de fichiers. |
|
Le nom d'un objet à partir duquel commencer le listage d'objets. Le résultat contient des objets qui commencent après le marqueur. |
|
Le nombre maximal d'objets dans le résultat. La valeur par défaut est 1000. |
Réponse
S'il y a plus de 1000 objets disponibles, ou si vous spécifiez le paramètre facultatif max-keys
, le ResponseInfo
contient une clé IsTruncated
ayant la valeur True
. Afin d'exécuter une autre requête pour les objets qui ont été tronqués, transmettez la valeur de la propriété Marker
du dernier objet récupéré en tant que paramètre facultatif marker
dans le nouvel appel de méthode.