Data.Cloud.AmazonAPI.TAmazonQueueService.SetQueueProperty

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

function SetQueueProperty(const QueueURL, Key, Value: string;
ResponseInfo: TCloudResponseInfo = nil): Boolean; deprecated;

C++

bool __fastcall SetQueueProperty _DEPRECATED_ATTRIBUTE0 (const System::UnicodeString QueueURL, const System::UnicodeString Key, const System::UnicodeString Value, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0));

Propriétés

Type Visibilité  Source Unité  Parent
function public
Data.Cloud.AmazonAPI.pas
Data.Cloud.AmazonAPI.hpp
Data.Cloud.AmazonAPI TAmazonQueueService

Description

Avertissement : SetQueueProperty est obsolète. Veuillez utiliser SetQueueAttributes.

Définit les attributs de la file d'attente donnée.

Les attributs supportés qui peuvent être définis sont :

  • VisibilityTimeout—Le temps (en secondes) pendant lequel un message reçu sera caché des autres.
  • Policy—La description formelle des permissions d'une ressource (objet JSON sous forme de chaîne).
  • MaximumMessageSize—Le nombre d'octets qu'un message peut contenir avant d'être rejeté par Amazon SQS.
  • MessageRetentionPeriod—Le nombre de secondes que Amazon SQS retient un message.

Pour plus d'informations sur le format de la valeur de Policy, voir la documentation sur le service de files Amazon.

SetQueueProperty renvoie True si l'opération a réussi, False sinon.

Le tableau suivant présente la signification des paramètres :

Paramètre Description

QueueURL

L'URL de la file d'attente pour laquelle définir les attributs.

Key

Le nom de l'attribut à définir.

Value

La valeur de l'attribut à définir.

ResponseInfo

La classe facultative où stocker les informations sur la réponse.

Voir aussi