Data.Cloud.AmazonAPI.TAmazonQueueService.SetQueueProperty

From RAD Studio API Documentation
Jump to: navigation, search

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));

Properties

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

Description

Warning: SetQueueProperty is deprecated. Please use SetQueueAttributes.

Sets the given queue's attributes.

The supported attributes that can be set are:

  • VisibilityTimeout—The time (in seconds) that a received message will be hidden from others.
  • Policy—The formal description of the permissions for a resource (JSON object as string).
  • MaximumMessageSize—How many bytes a message can contain before Amazon SQS rejects it.
  • MessageRetentionPeriod—The number of seconds Amazon SQS retains a message.

For more information on the format of the Policy value, view Amazon's Queue Service documentation.

SetQueueProperty returns True if the operation was successful, False otherwise.

The following table shows the significance of the parameters:

Parameter Description

QueueURL

The URL of the queue to set the attributes for.

Key

The name of the attribute to set.

Value

The value of the attribute to set.

ResponseInfo

The optional class for storing response info into.

See Also

Retrieved from "https://docwiki.embarcadero.com/Libraries/Alexandria/e/index.php?title=Data.Cloud.AmazonAPI.TAmazonQueueService.SetQueueProperty&oldid=771195"