CloudQueue クラス

パッケージ:

com.microsoft.azure.storage.queue

• java.lang.Object
• • com.microsoft.azure.storage.queue.CloudQueue

public class CloudQueue

このクラスは、Microsoft Azure Queue サービスのキューを表します。

コンストラクターの概要

コンストラクター	説明
CloudQueue(final StorageUri uri)	指定したキュー を使用して、 クラスのインスタンスを作成します。 キューには SAS トークンを含める必要があります。
CloudQueue(final StorageUri uri, final StorageCredentials credentials)	指定したキューと資格情報を使用して、 クラスのインスタンスを作成します。 に SAS トークンが含まれている場合、資格情報は である必要があります。
CloudQueue(final String queueName, final CloudQueueClient client)	指定した名前とクライアントを使用して、 クラスのインスタンスを作成します。
CloudQueue(final URI uri)	指定したキュー URI を使用して、 クラスのインスタンスを作成します。 キューには SAS トークンを含める必要があります。
CloudQueue(final URI uri, final StorageCredentials credentials)	指定したキューと資格情報を使用して、 クラスのインスタンスを作成します。 に SAS トークンが含まれている場合、資格情報は である必要があります。

メソッドの概要

修飾子と型	メソッドと説明
void	addMessage(final CloudQueueMessage message) キューの背面にメッセージを追加します。
void	addMessage(final CloudQueueMessage message, final int timeToLiveInSeconds, final int initialVisibilityDelayInSeconds, QueueRequestOptions options, OperationContext opContext) 指定したオプションを使用して、キューの背面にメッセージを追加します。
void	clear() すべてのメッセージをキューからクリアします。
void	clear(QueueRequestOptions options, OperationContext opContext) 指定した要求オプションと操作コンテキストを使用して、キューからすべてのメッセージをクリアします。
void	create() キューを作成します。
void	create(QueueRequestOptions options, OperationContext opContext) 指定した要求オプションと操作コンテキストを使用して、キューを作成します。
boolean	createIfNotExists() キュー (まだ存在しない場合) を作成します。
boolean	createIfNotExists(QueueRequestOptions options, OperationContext opContext) 指定した要求オプションと操作コンテキストを使用して、キューがまだ存在しない場合は作成します。
void	delete() キューを削除します。
void	delete(QueueRequestOptions options, OperationContext opContext) 指定した要求オプションと操作コンテキストを使用して、キューを削除します。
boolean	deleteIfExists() キュー (存在する場合) を削除します。
boolean	deleteIfExists(QueueRequestOptions options, OperationContext opContext) 指定した要求オプションと操作コンテキストを使用して、キューが存在する場合は削除します。
void	deleteMessage(final CloudQueueMessage message) 指定したメッセージをキューから削除します。
void	deleteMessage(final CloudQueueMessage message, QueueRequestOptions options, OperationContext opContext) 指定した要求オプションと操作コンテキストを使用して、指定したメッセージをキューから削除します。
void	downloadAttributes() キューのメタデータとおおよそのメッセージ数の値をダウンロードします。
void	downloadAttributes(QueueRequestOptions options, OperationContext opContext) 指定した要求オプションと操作コンテキストを使用して、キューのメタデータとおおよそのメッセージ数の値をダウンロードします。
QueuePermissions	downloadPermissions() キューのアクセス許可設定をダウンロードします。
QueuePermissions	downloadPermissions(QueueRequestOptions options, OperationContext opContext) 指定した要求オプションと操作コンテキストを使用して、キューのアクセス許可設定をダウンロードします。
boolean	exists() キューが存在するかどうかを示す値を返します。
boolean	exists(QueueRequestOptions options, OperationContext opContext) 指定した要求オプションと操作コンテキストを使用して、キューが存在するかどうかを示す値を返します。
String	generateSharedAccessSignature(final SharedAccessQueuePolicy policy, final String groupPolicyIdentifier) キューの共有アクセス署名を返します。
String	generateSharedAccessSignature(final SharedAccessQueuePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols) キューの共有アクセス署名を返します。
long	getApproximateMessageCount() キューのおおよそのメッセージ数を取得します。 この値は に対する downloadAttributes() 要求によって初期化され、その要求が完了したときのおおよそのメッセージ数を表します。
HashMap<String, String>	getMetadata() このオブジェクトに格納されているキューのメタデータ コレクションを取得します。 この値は、 の呼び出しによってキューからのメタデータで初期化され、 を downloadAttributes()呼び出 uploadMetadata()してキューに設定されます。
String	getName() キューの名前を取得します。
CloudQueueClient	getServiceClient() このキューに関連付けられているキュー サービス クライアントを取得します。
boolean	getShouldEncodeMessage() メッセージを base-64 でエンコードする必要があるかどうかを示す値を取得します。
final StorageUri	getStorageUri() すべての場所の URI の一覧を返します。
URI	getUri() このキューの絶対 URI を取得します。
CloudQueueMessage	peekMessage() キューからのメッセージをピークします。 ピーク要求は、キューの可視性を変更せずに、キューの前面からメッセージを取得します。
CloudQueueMessage	peekMessage(final QueueRequestOptions options, final OperationContext opContext) 指定した要求オプションと操作コンテキストを使用して、キューからのメッセージをピークします。 ピーク要求は、キューの可視性を変更せずに、キューの前面からメッセージを取得します。
Iterable<CloudQueueMessage>	peekMessages(final int numberOfMessages) キューから指定した数のメッセージをピークします。 ピーク要求は、キューの可視性を変更せずに、キューの前面からメッセージを取得します。
Iterable<CloudQueueMessage>	peekMessages(final int numberOfMessages, QueueRequestOptions options, OperationContext opContext) 指定した要求オプションと操作コンテキストを使用して、キューからのメッセージのセットをピークします。 ピーク要求は、キューの可視性を変更せずに、キューの前面からメッセージを取得します。
CloudQueueMessage	retrieveMessage() 既定の要求オプションを使用して、キューの先頭からメッセージを取得します。 この操作により、既定の可視性タイムアウト期間に対して、取得したメッセージがキューで非表示としてマークされます。
CloudQueueMessage	retrieveMessage(final int visibilityTimeoutInSeconds, final QueueRequestOptions options, final OperationContext opContext) 指定した要求オプションと操作コンテキストを使用して、キューの先頭からメッセージを取得します。 この操作により、指定された可視性タイムアウト期間に対して、取得したメッセージがキューで非表示としてマークされます。
Iterable<CloudQueueMessage>	retrieveMessages(final int numberOfMessages) 既定の要求オプションを使用して、キューの先頭から指定した数のメッセージを取得します。 この操作により、既定の可視性タイムアウト期間に対して、取得したメッセージがキューで非表示としてマークされます。
Iterable<CloudQueueMessage>	retrieveMessages(final int numberOfMessages, final int visibilityTimeoutInSeconds, QueueRequestOptions options, OperationContext opContext) 指定した要求オプションと操作コンテキストを使用して、キューの先頭から指定した数のメッセージを取得します。 この操作により、既定の可視性タイムアウト期間に対して、取得したメッセージがキューで非表示としてマークされます。
void	setMetadata(final HashMap<String, String> metadata) 呼び出しでキューに設定する名前と値のペアのメタデータ コレクションを uploadMetadata() 設定します。 このコレクションは、既存のキュー メタデータを上書きします。 これが空のコレクションに設定されている場合、キューメタデータは呼び出し時 uploadMetadata() にクリアされます。
void	setShouldEncodeMessage(final boolean shouldEncodeMessage) メッセージを base-64 でエンコードする必要があるかどうかを示すフラグを設定します。
void	updateMessage(final CloudQueueMessage message, final int visibilityTimeoutInSeconds) 新しい可視性タイムアウト値を秒単位でキューに指定したメッセージを更新します。
void	updateMessage(final CloudQueueMessage message, final int visibilityTimeoutInSeconds, final EnumSet<MessageUpdateFields> messageUpdateFields, QueueRequestOptions options, OperationContext opContext) 指定した要求オプションと操作コンテキストを使用して、キューにメッセージを更新します。
void	uploadMetadata() オブジェクト内のメタデータをキューにアップロードします。
void	uploadMetadata(QueueRequestOptions options, OperationContext opContext) 指定した要求オプションと操作コンテキストを使用して、オブジェクト内のメタデータをキューにアップロードします。
void	uploadPermissions(final QueuePermissions permissions) キューのアクセス許可をアップロードします。
void	uploadPermissions(final QueuePermissions permissions, QueueRequestOptions options, OperationContext opContext) 指定した要求オプションと操作コンテキストを使用して、キューのアクセス許可をアップロードします。

コンストラクターの詳細

CloudQueue

public CloudQueue(final StorageUri uri)

指定したキュー を使用して、 クラスのインスタンスを作成します。 キューには SAS トークンを含める必要があります。

Parameters:

uri - StorageUriキューの絶対 URI を表す オブジェクト。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。

CloudQueue

public CloudQueue(final StorageUri uri, final StorageCredentials credentials)

指定したキューと資格情報を使用して、 クラスのインスタンスを作成します。 に SAS トークンが含まれている場合、資格情報は である必要があります。

Parameters:

uri - StorageUriキューの絶対 URI を表す オブジェクト。

credentials - StorageCredentialsアクセスを認証するために使用される オブジェクト。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。

CloudQueue

protected CloudQueue(final String queueName, final CloudQueueClient client)

指定した名前とクライアントを使用して、 クラスのインスタンスを作成します。

Parameters:

queueName - キューの名前。キューの名前付け規則に従う必要があります。 キュー名には、パス区切り文字 (/) を含めないようにしてください。 キュー名は、3 ~ 63 文字の小文字で、文字または数字で始まる必要があります。 キュー名には、文字、数字、ダッシュ (-) 文字のみを含むことができます。

client - CloudQueueClient関連付けられたサービス クライアントを表し、Queue サービスのエンドポイントを指定する オブジェクト。

Throws:

URISyntaxException - queueName に基づいて構築されたリソース URI が無効な場合。

StorageException - ストレージ サービス エラーが発生した場合。

CloudQueue

public CloudQueue(final URI uri)

指定したキュー URI を使用して、 クラスのインスタンスを作成します。 キューには SAS トークンを含める必要があります。

Parameters:

uri - java.net.URIキューの絶対 URI を表す オブジェクト。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。

CloudQueue

public CloudQueue(final URI uri, final StorageCredentials credentials)

指定したキューと資格情報を使用して、 クラスのインスタンスを作成します。 に SAS トークンが含まれている場合、資格情報は である必要があります。

Parameters:

uri - java.net.URIキューの絶対 URI を表す オブジェクト。

credentials - StorageCredentialsアクセスを認証するために使用される オブジェクト。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。

メソッドの詳細

addMessage

public void addMessage(final CloudQueueMessage message)

キューの背面にメッセージを追加します。

Parameters:

message - CloudQueueMessage追加するメッセージを指定する オブジェクト。 メッセージ オブジェクトは、メッセージ ID とポップレシートを含むように変更され、それ以降の updateMessage と deleteMessage の呼び出しで使用できます。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

addMessage

public void addMessage(final CloudQueueMessage message, final int timeToLiveInSeconds, final int initialVisibilityDelayInSeconds, QueueRequestOptions options, OperationContext opContext)

指定したオプションを使用して、キューの背面にメッセージを追加します。

Parameters:

message - CloudQueueMessage追加するメッセージを指定する オブジェクト。 メッセージ オブジェクトは、メッセージ ID とポップレシートを含むように変更され、それ以降の updateMessage と deleteMessage の呼び出しで使用できます。

timeToLiveInSeconds - メッセージをキューに保持できる最大時間です。 値が 0 の場合、有効期間はサービスの既定値の 7 日間に設定されます。 負の値を指定すると、無限の有効期間が設定されます。

initialVisibilityDelayInSeconds - メッセージが非表示になる時間の長さ(キューに追加された時点から開始)、またはメッセージをすぐに表示する場合は 0。 この値は、0 以上で、有効期間の値より小さくする必要があります。

options - QueueRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

clear

public void clear()

すべてのメッセージをキューからクリアします。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

clear

public void clear(QueueRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、キューからすべてのメッセージをクリアします。

Parameters:

options - QueueRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

create

public void create()

キューを作成します。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

create

public void create(QueueRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、キューを作成します。

Parameters:

options - QueueRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

createIfNotExists

public boolean createIfNotExists()

キュー (まだ存在しない場合) を作成します。

Returns:

キューがストレージ サービスに作成される場合は の値 true 。それ以外の場合は 。 false

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

createIfNotExists

public boolean createIfNotExists(QueueRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、キューがまだ存在しない場合は作成します。

Parameters:

options - QueueRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられているサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

キューがストレージ サービスに作成される場合は の true 値。それ以外の場合は false

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

delete

public void delete()

キューを削除します。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

delete

public void delete(QueueRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、キューを削除します。

Parameters:

options - QueueRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

deleteIfExists

public boolean deleteIfExists()

キュー (存在する場合) を削除します。

Returns:

キューがストレージ サービスに存在し、削除されている場合は の値 true 。それ以外の場合 falseは 。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

deleteIfExists

public boolean deleteIfExists(QueueRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、キューが存在する場合は削除します。

Parameters:

options - QueueRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

キューがストレージ サービスに存在し、削除されている場合は の値 true 。それ以外の場合 falseは 。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

deleteMessage

public void deleteMessage(final CloudQueueMessage message)

指定したメッセージをキューから削除します。

Parameters:

message - CloudQueueMessage削除するメッセージを指定する オブジェクト。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

deleteMessage

public void deleteMessage(final CloudQueueMessage message, QueueRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、指定したメッセージをキューから削除します。

Parameters:

message - CloudQueueMessage削除するメッセージを指定する オブジェクト。

options - QueueRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

downloadAttributes

public void downloadAttributes()

キューのメタデータとおおよそのメッセージ数の値をダウンロードします。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

downloadAttributes

public void downloadAttributes(QueueRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、キューのメタデータとおおよそのメッセージ数の値をダウンロードします。

Parameters:

options - QueueRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられたサービス クライアント ( CloudQueue) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

downloadPermissions

public QueuePermissions downloadPermissions()

キューのアクセス許可設定をダウンロードします。

Returns:

キューの QueuePermissions アクセス許可を表す オブジェクト。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。

downloadPermissions

public QueuePermissions downloadPermissions(QueueRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、キューのアクセス許可設定をダウンロードします。

Parameters:

options - QueueRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

QueuePermissionsコンテナーのアクセス許可を表す オブジェクト。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。

exists

public boolean exists()

キューが存在するかどうかを示す値を返します。

Returns:

true キューがストレージ サービスに存在する場合は 。それ以外の場合 falseは 。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

exists

public boolean exists(QueueRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、キューが存在するかどうかを示す値を返します。

Parameters:

options - QueueRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

true キューがストレージ サービスに存在する場合は 。それ以外の場合 falseは 。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

generateSharedAccessSignature

public String generateSharedAccessSignature(final SharedAccessQueuePolicy policy, final String groupPolicyIdentifier)

キューの共有アクセス署名を返します。

Parameters:

policy - 共有アクセス署名のアクセス ポリシーです。

groupPolicyIdentifier - キュー レベルのアクセス ポリシーです。

Returns:

キューの共有アクセス署名。

Throws:

InvalidKeyException - 無効なキーが渡された場合。

StorageException - ストレージ サービス エラーが発生した場合。

IllegalArgumentException - 予期しない値が渡された場合。

generateSharedAccessSignature

public String generateSharedAccessSignature(final SharedAccessQueuePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)

キューの共有アクセス署名を返します。

Parameters:

policy - 共有アクセス署名のアクセス ポリシーです。

groupPolicyIdentifier - キュー レベルのアクセス ポリシーです。

ipRange - IPRange許可される IP アドレスの範囲を含む オブジェクト。

protocols - SharedAccessProtocols許可されているインターネット プロトコルを表す 。

Returns:

キューの共有アクセス署名。

Throws:

InvalidKeyException - 無効なキーが渡された場合。

StorageException - ストレージ サービス エラーが発生した場合。

IllegalArgumentException - 予期しない値が渡された場合。

getApproximateMessageCount

public long getApproximateMessageCount()

キューのおおよそのメッセージ数を取得します。 この値は に対する downloadAttributes() 要求によって初期化され、その要求が完了したときのおおよそのメッセージ数を表します。

Returns:

キューの Long おおよそのメッセージ数を表す オブジェクト。

getMetadata

public HashMap getMetadata()

このオブジェクトに格納されているキューのメタデータ コレクションを取得します。 この値は、 の呼び出しによってキューからのメタデータで初期化され、 を downloadAttributes()呼び出 uploadMetadata()してキューに設定されます。

Returns:

キューの java.util.HashMap メタデータを表す オブジェクト。

getName

public String getName()

キューの名前を取得します。

Returns:

キューの String 名前を表す オブジェクト。

getServiceClient

public CloudQueueClient getServiceClient()

このキューに関連付けられているキュー サービス クライアントを取得します。

Returns:

CloudQueueClientこのキューに関連付けられているサービス クライアントを表す オブジェクト。

getShouldEncodeMessage

public boolean getShouldEncodeMessage()

メッセージを base-64 でエンコードする必要があるかどうかを示す値を取得します。

Returns:

Booleanメッセージを base-64 でエンコードする必要があるかどうかを表す 。

getStorageUri

public final StorageUri getStorageUri()

すべての場所の URI の一覧を返します。

Returns:

StorageUriすべての場所の URI の一覧を表す 。

getUri

public URI getUri()

このキューの絶対 URI を取得します。

Returns:

java.net.URIこのキューの URI を表す オブジェクト。

peekMessage

public CloudQueueMessage peekMessage()

キューからのメッセージをピークします。 ピーク要求は、キューの可視性を変更せずに、キューの前面からメッセージを取得します。

Returns:

CloudQueueMessageこのキュー内のメッセージを表す オブジェクト。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

peekMessage

public CloudQueueMessage peekMessage(final QueueRequestOptions options, final OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、キューからのメッセージをピークします。 ピーク要求は、キューの可視性を変更せずに、キューの前面からメッセージを取得します。

Parameters:

options - QueueRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

CloudQueueMessageキューから要求されたメッセージを表す オブジェクト。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

peekMessages

public Iterable peekMessages(final int numberOfMessages)

キューから指定した数のメッセージをピークします。 ピーク要求は、キューの可視性を変更せずに、キューの前面からメッセージを取得します。

Parameters:

numberOfMessages - 取得するメッセージの数です。

Returns:

キューから要求されたメッセージを表すオブジェクトの列挙可能なコレクション CloudQueueMessage 。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

peekMessages

public Iterable peekMessages(final int numberOfMessages, QueueRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、キューからのメッセージのセットをピークします。 ピーク要求は、キューの可視性を変更せずに、キューの前面からメッセージを取得します。

Parameters:

numberOfMessages - 取得するメッセージの数です。

options - QueueRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

キューから要求されたメッセージを表すオブジェクトの列挙可能なコレクション CloudQueueMessage 。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

retrieveMessage

public CloudQueueMessage retrieveMessage()

既定の要求オプションを使用して、キューの先頭からメッセージを取得します。 この操作により、既定の可視性タイムアウト期間に対して、取得したメッセージがキューで非表示としてマークされます。

Returns:

CloudQueueMessageこのキュー内のメッセージを表す オブジェクト。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

retrieveMessage

public CloudQueueMessage retrieveMessage(final int visibilityTimeoutInSeconds, final QueueRequestOptions options, final OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、キューの先頭からメッセージを取得します。 この操作により、指定された可視性タイムアウト期間に対して、取得したメッセージがキューで非表示としてマークされます。

Parameters:

visibilityTimeoutInSeconds - メッセージの可視性タイムアウトを秒単位で指定します。

options - QueueRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

CloudQueueMessageこのキュー内のメッセージを表す オブジェクト。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

retrieveMessages

public Iterable retrieveMessages(final int numberOfMessages)

既定の要求オプションを使用して、キューの先頭から指定した数のメッセージを取得します。 この操作により、既定の可視性タイムアウト期間に対して、取得したメッセージがキューで非表示としてマークされます。

Parameters:

numberOfMessages - 取得するメッセージの数です。

Returns:

キューから取得したメッセージを表すオブジェクトの列挙可能なコレクション CloudQueueMessage 。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

retrieveMessages

public Iterable retrieveMessages(final int numberOfMessages, final int visibilityTimeoutInSeconds, QueueRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、キューの先頭から指定した数のメッセージを取得します。 この操作により、既定の可視性タイムアウト期間に対して、取得したメッセージがキューで非表示としてマークされます。

Parameters:

numberOfMessages - 取得するメッセージの数です。

visibilityTimeoutInSeconds - 取得したメッセージの可視性タイムアウトを秒単位で指定します。

options - QueueRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Returns:

キューから取得されたメッセージを表すオブジェクトの列挙可能なコレクション CloudQueueMessage 。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

setMetadata

public void setMetadata(final HashMap metadata)

呼び出しでキューに設定する名前と値のペアのメタデータ コレクションを uploadMetadata() 設定します。 このコレクションは、既存のキュー メタデータを上書きします。 これが空のコレクションに設定されている場合、キューメタデータは呼び出し時 uploadMetadata() にクリアされます。

Parameters:

metadata - java.util.HashMapキューに割り当てられているメタデータを表す オブジェクト。

setShouldEncodeMessage

public void setShouldEncodeMessage(final boolean shouldEncodeMessage)

メッセージを base-64 でエンコードする必要があるかどうかを示すフラグを設定します。

Parameters:

shouldEncodeMessage - 値は、メッセージを base-64 でエンコードする必要があるかどうかを示します。

updateMessage

public void updateMessage(final CloudQueueMessage message, final int visibilityTimeoutInSeconds)

新しい可視性タイムアウト値を秒単位でキューに指定したメッセージを更新します。

Parameters:

message - CloudQueueMessageキューで更新する 。

visibilityTimeoutInSeconds - メッセージの新しい可視性タイムアウトを秒単位で指定します。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

updateMessage

public void updateMessage(final CloudQueueMessage message, final int visibilityTimeoutInSeconds, final EnumSet messageUpdateFields, QueueRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、キューにメッセージを更新します。

Parameters:

message - CloudQueueMessageキューで更新する 。

visibilityTimeoutInSeconds - メッセージの新しい可視性タイムアウトを秒単位で指定します。

messageUpdateFields - EnumSetメッセージのどのMessageUpdateFields部分を更新するかを指定する 値の 。

options - QueueRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

uploadMetadata

public void uploadMetadata()

オブジェクト内のメタデータをキューにアップロードします。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

uploadMetadata

public void uploadMetadata(QueueRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、オブジェクト内のメタデータをキューにアップロードします。

Parameters:

options - QueueRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Throws:

StorageException - 操作中にストレージ サービス エラーが発生した場合。

uploadPermissions

public void uploadPermissions(final QueuePermissions permissions)

キューのアクセス許可をアップロードします。

Parameters:

permissions - QueuePermissionsアップロードするアクセス許可を表す オブジェクト。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。

uploadPermissions

public void uploadPermissions(final QueuePermissions permissions, QueueRequestOptions options, OperationContext opContext)

指定した要求オプションと操作コンテキストを使用して、キューのアクセス許可をアップロードします。

Parameters:

permissions - QueuePermissionsアップロードするアクセス許可を表す オブジェクト。

options - QueueRequestOptions要求の追加オプションを指定する オブジェクト。 を null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。

opContext - 現在の操作のコンテキストを表す OperationContext オブジェクトです。 このオブジェクトを使用して、ストレージ サービスへの要求を追跡したり、操作に関する追加のランタイム情報を渡したりします。

Throws:

StorageException - ストレージ サービス エラーが発生した場合。