CloudQueue クラス
- java.
lang. Object - com.
microsoft. azure. storage. queue. CloudQueue
- com.
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 トークンが含まれている場合、資格情報は である必要があります。 |
メソッドの概要
コンストラクターの詳細
CloudQueue
public CloudQueue(final StorageUri uri)
指定したキュー を使用して、 クラスのインスタンスを作成します。 キューには SAS トークンを含める必要があります。
Parameters:
StorageUriキューの絶対 URI を表す オブジェクト。
Throws:
CloudQueue
public CloudQueue(final StorageUri uri, final StorageCredentials credentials)
指定したキューと資格情報を使用して、 クラスのインスタンスを作成します。 に SAS トークンが含まれている場合、資格情報は である必要があります。
Parameters:
StorageUriキューの絶対 URI を表す オブジェクト。
Throws:
CloudQueue
protected CloudQueue(final String queueName, final CloudQueueClient client)
指定した名前とクライアントを使用して、 クラスのインスタンスを作成します。
Parameters:
Throws:
CloudQueue
public CloudQueue(final URI uri)
指定したキュー URI を使用して、 クラスのインスタンスを作成します。 キューには SAS トークンを含める必要があります。
Parameters:
java.net.URIキューの絶対 URI を表す オブジェクト。
Throws:
CloudQueue
public CloudQueue(final URI uri, final StorageCredentials credentials)
指定したキューと資格情報を使用して、 クラスのインスタンスを作成します。 に SAS トークンが含まれている場合、資格情報は である必要があります。
Parameters:
java.net.URIキューの絶対 URI を表す オブジェクト。
Throws:
メソッドの詳細
addMessage
public void addMessage(final CloudQueueMessage message)
キューの背面にメッセージを追加します。
Parameters:
Throws:
addMessage
public void addMessage(final CloudQueueMessage message, final int timeToLiveInSeconds, final int initialVisibilityDelayInSeconds, QueueRequestOptions options, OperationContext opContext)
指定したオプションを使用して、キューの背面にメッセージを追加します。
Parameters:
null 指定すると、関連付けられているサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。
Throws:
clear
public void clear()
すべてのメッセージをキューからクリアします。
Throws:
clear
public void clear(QueueRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、キューからすべてのメッセージをクリアします。
Parameters:
null 指定すると、関連付けられているサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。
Throws:
create
public void create()
キューを作成します。
Throws:
create
public void create(QueueRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、キューを作成します。
Parameters:
null 指定すると、関連付けられているサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。
Throws:
createIfNotExists
public boolean createIfNotExists()
キュー (まだ存在しない場合) を作成します。
Returns:
true 。それ以外の場合は 。 falseThrows:
createIfNotExists
public boolean createIfNotExists(QueueRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、キューがまだ存在しない場合は作成します。
Parameters:
null 指定すると、関連付けられているサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。
Returns:
true 値。それ以外の場合は falseThrows:
delete
public void delete()
キューを削除します。
Throws:
delete
public void delete(QueueRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、キューを削除します。
Parameters:
null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。
Throws:
deleteIfExists
public boolean deleteIfExists()
キュー (存在する場合) を削除します。
Returns:
true 。それ以外の場合 falseは 。Throws:
deleteIfExists
public boolean deleteIfExists(QueueRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、キューが存在する場合は削除します。
Parameters:
null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。
Returns:
true 。それ以外の場合 falseは 。Throws:
deleteMessage
public void deleteMessage(final CloudQueueMessage message)
指定したメッセージをキューから削除します。
Parameters:
Throws:
deleteMessage
public void deleteMessage(final CloudQueueMessage message, QueueRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、指定したメッセージをキューから削除します。
Parameters:
null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。
Throws:
downloadAttributes
public void downloadAttributes()
キューのメタデータとおおよそのメッセージ数の値をダウンロードします。
Throws:
downloadAttributes
public void downloadAttributes(QueueRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、キューのメタデータとおおよそのメッセージ数の値をダウンロードします。
Parameters:
null 指定すると、関連付けられたサービス クライアント ( CloudQueue) からの既定の要求オプションが使用されます。
Throws:
downloadPermissions
public QueuePermissions downloadPermissions()
キューのアクセス許可設定をダウンロードします。
Returns:
Throws:
downloadPermissions
public QueuePermissions downloadPermissions(QueueRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、キューのアクセス許可設定をダウンロードします。
Parameters:
null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。
Returns:
Throws:
exists
public boolean exists()
キューが存在するかどうかを示す値を返します。
Returns:
true キューがストレージ サービスに存在する場合は 。それ以外の場合 falseは 。
Throws:
exists
public boolean exists(QueueRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、キューが存在するかどうかを示す値を返します。
Parameters:
null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。
Returns:
true キューがストレージ サービスに存在する場合は 。それ以外の場合 falseは 。
Throws:
generateSharedAccessSignature
public String generateSharedAccessSignature(final SharedAccessQueuePolicy policy, final String groupPolicyIdentifier)
キューの共有アクセス署名を返します。
Parameters:
Returns:
Throws:
generateSharedAccessSignature
public String generateSharedAccessSignature(final SharedAccessQueuePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)
キューの共有アクセス署名を返します。
Parameters:
Returns:
Throws:
getApproximateMessageCount
public long getApproximateMessageCount()
キューのおおよそのメッセージ数を取得します。 この値は に対する downloadAttributes() 要求によって初期化され、その要求が完了したときのおおよそのメッセージ数を表します。
Returns:
Long おおよそのメッセージ数を表す オブジェクト。getMetadata
public HashMap
このオブジェクトに格納されているキューのメタデータ コレクションを取得します。 この値は、 の呼び出しによってキューからのメタデータで初期化され、 を downloadAttributes()呼び出 uploadMetadata()してキューに設定されます。
Returns:
java.util.HashMap メタデータを表す オブジェクト。getName
public String getName()
キューの名前を取得します。
Returns:
String 名前を表す オブジェクト。getServiceClient
public CloudQueueClient getServiceClient()
このキューに関連付けられているキュー サービス クライアントを取得します。
Returns:
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:
Throws:
peekMessage
public CloudQueueMessage peekMessage(final QueueRequestOptions options, final OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、キューからのメッセージをピークします。 ピーク要求は、キューの可視性を変更せずに、キューの前面からメッセージを取得します。
Parameters:
null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。
Returns:
Throws:
peekMessages
public Iterable
キューから指定した数のメッセージをピークします。 ピーク要求は、キューの可視性を変更せずに、キューの前面からメッセージを取得します。
Parameters:
Returns:
Throws:
peekMessages
public Iterable
指定した要求オプションと操作コンテキストを使用して、キューからのメッセージのセットをピークします。 ピーク要求は、キューの可視性を変更せずに、キューの前面からメッセージを取得します。
Parameters:
null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。
Returns:
Throws:
retrieveMessage
public CloudQueueMessage retrieveMessage()
既定の要求オプションを使用して、キューの先頭からメッセージを取得します。 この操作により、既定の可視性タイムアウト期間に対して、取得したメッセージがキューで非表示としてマークされます。
Returns:
Throws:
retrieveMessage
public CloudQueueMessage retrieveMessage(final int visibilityTimeoutInSeconds, final QueueRequestOptions options, final OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、キューの先頭からメッセージを取得します。 この操作により、指定された可視性タイムアウト期間に対して、取得したメッセージがキューで非表示としてマークされます。
Parameters:
null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。
Returns:
Throws:
retrieveMessages
public Iterable
既定の要求オプションを使用して、キューの先頭から指定した数のメッセージを取得します。 この操作により、既定の可視性タイムアウト期間に対して、取得したメッセージがキューで非表示としてマークされます。
Parameters:
Returns:
Throws:
retrieveMessages
public Iterable
指定した要求オプションと操作コンテキストを使用して、キューの先頭から指定した数のメッセージを取得します。 この操作により、既定の可視性タイムアウト期間に対して、取得したメッセージがキューで非表示としてマークされます。
Parameters:
null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。
Returns:
Throws:
setMetadata
public void setMetadata(final HashMap
呼び出しでキューに設定する名前と値のペアのメタデータ コレクションを uploadMetadata() 設定します。 このコレクションは、既存のキュー メタデータを上書きします。 これが空のコレクションに設定されている場合、キューメタデータは呼び出し時 uploadMetadata() にクリアされます。
Parameters:
java.util.HashMapキューに割り当てられているメタデータを表す オブジェクト。
setShouldEncodeMessage
public void setShouldEncodeMessage(final boolean shouldEncodeMessage)
メッセージを base-64 でエンコードする必要があるかどうかを示すフラグを設定します。
Parameters:
updateMessage
public void updateMessage(final CloudQueueMessage message, final int visibilityTimeoutInSeconds)
新しい可視性タイムアウト値を秒単位でキューに指定したメッセージを更新します。
Parameters:
Throws:
updateMessage
public void updateMessage(final CloudQueueMessage message, final int visibilityTimeoutInSeconds, final EnumSet
指定した要求オプションと操作コンテキストを使用して、キューにメッセージを更新します。
Parameters:
null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。
Throws:
uploadMetadata
public void uploadMetadata()
オブジェクト内のメタデータをキューにアップロードします。
Throws:
uploadMetadata
public void uploadMetadata(QueueRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、オブジェクト内のメタデータをキューにアップロードします。
Parameters:
null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。
Throws:
uploadPermissions
public void uploadPermissions(final QueuePermissions permissions)
キューのアクセス許可をアップロードします。
Parameters:
Throws:
uploadPermissions
public void uploadPermissions(final QueuePermissions permissions, QueueRequestOptions options, OperationContext opContext)
指定した要求オプションと操作コンテキストを使用して、キューのアクセス許可をアップロードします。
Parameters:
null 指定すると、関連付けられたサービス クライアント ( CloudQueueClient) からの既定の要求オプションが使用されます。
Throws:
適用対象
Azure SDK for Java