Data.Cloud.AmazonAPI.TAmazonQueueService.SetQueueProperty

提供: RAD Studio API Documentation
移動先: 案内検索

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

プロパティ

種類 可視性 ソース ユニット
function public
Data.Cloud.AmazonAPI.pas
Data.Cloud.AmazonAPI.hpp
Data.Cloud.AmazonAPI TAmazonQueueService

説明

警告: SetQueueProperty は非推奨になっています。 SetQueueAttributes を使用してください。

指定されたキューの属性を設定します。

設定可能なサポート属性は:

  • VisibilityTimeout—受信メッセージを他に対して非表示にしておく時間(秒)。
  • Policy—リソース(文字列形式の JSON オブジェクト)に対する、アクセス許可の正式説明。
  • MaximumMessageSize—Amazon SQS が拒否をするまでの、メッセージが保有できる最大バイト数。
  • MessageRetentionPeriod—Amazon SQS がメッセージを維持する秒数。

Policy 値の形式についてのさらなる情報については、Amazon のキュー サービスのドキュメントを参照してください。

SetQueueProperty は、オペレーションが成功した場合には True を、そうでない場合には False を返します。

次の表は、各パラメータの意味を示しています:

パラメータ 説明

QueueURL

属性を設定するキューの URL。

Key

設定する属性の名前。

Value

設定する属性の値。

ResponseInfo

レスポンス情報を保管するための、任意のクラス。

関連項目