CloudQueueClient クラス

パッケージ:

com.microsoft.azure.storage.queue

• java.lang.Object
• • ServiceClient
  • • com.microsoft.azure.storage.queue.CloudQueueClient

public class CloudQueueClient extends ServiceClient

Microsoft Azure Queue サービスにアクセスするためのサービス クライアントを提供します。

コンストラクターの概要

コンストラクター	説明
CloudQueueClient(final StorageUri baseUri, final StorageCredentials credentials)	指定した Queue サービス エンドポイントとアカウント資格情報を使用して、 クラスの新しいインスタンスを初期化します。
CloudQueueClient(final URI baseUri, final StorageCredentials credentials)	指定した Queue サービス エンドポイントとアカウント資格情報を使用して、 クラスの新しいインスタンスを初期化します。

メソッドの概要

修飾子と型	メソッドと説明
final ServiceProperties	downloadServiceProperties() 指定されたストレージ サービスの現在 ServiceProperties の を取得します。 これには、ログ記録、HourMetrics、MinuteMetrics、CORS 構成が含まれます。
final ServiceProperties	downloadServiceProperties(QueueRequestOptions options, OperationContext opContext) 指定されたストレージ サービスの現在 ServiceProperties の を取得します。 これには、ログ記録、HourMetrics、MinuteMetrics、CORS 構成が含まれます。
QueueRequestOptions	getDefaultRequestOptions() これに関連付けられている要求に使用される を取得します。QueueRequestOptions
CloudQueue	getQueueReference(final String queueName) 指定した名前の CloudQueue オブジェクトを取得します。
ServiceStats	getServiceStats() のサービスに対してクエリを実行します ServiceStats。
ServiceStats	getServiceStats(QueueRequestOptions options, OperationContext opContext) のサービスに対してクエリを実行します ServiceStats。
boolean	isUsePathStyleUris()
Iterable<CloudQueue>	listQueues() このキュー サービス クライアントのキューの格納可能なコレクションを取得します。
Iterable<CloudQueue>	listQueues(final String prefix) この Queue サービス クライアントで指定されたプレフィックスで始まる名前を持つキューの、許容されるコレクションを返します。
Iterable<CloudQueue>	listQueues(final String prefix, final QueueListingDetails detailsIncluded, QueueRequestOptions options, OperationContext opContext) 指定した詳細設定、要求オプション、および操作コンテキストを使用して、この Queue サービス クライアントの指定したプレフィックスで始まる名前を持つキューの許容されるコレクションを返します。
ResultSegment<CloudQueue>	listQueuesSegmented() この Queue サービス クライアントのキューの格納可能なコレクションの結果セグメントを取得します。
ResultSegment<CloudQueue>	listQueuesSegmented(final String prefix) この Queue サービス クライアントの指定したプレフィックスで始まる名前を持つキューの、読み取り可能なキュー のコレクションの結果セグメントを取得します。
ResultSegment<CloudQueue>	listQueuesSegmented(final String prefix, final QueueListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, QueueRequestOptions options, OperationContext opContext) 指定したリストの詳細オプション、要求オプション、および操作コンテキストを使用して、このキューの指定したプレフィックスで始まる名前を持つキューの iterable コレクションの結果セグメントを取得します。
void	setDefaultRequestOptions(QueueRequestOptions defaultRequestOptions) このオブジェクトで QueueRequestOptions アクセスされるキューに使用される を設定します。
void	uploadServiceProperties(final ServiceProperties properties) 指定されたストレージ サービスに新しい ServiceProperties 構成をアップロードします。 これには、Logging、HourMetrics、MinuteMetrics、CORS の構成が含まれます。
void	uploadServiceProperties(final ServiceProperties properties, QueueRequestOptions options, OperationContext opContext) 指定されたストレージ サービスに新しい ServiceProperties 構成をアップロードします。 これには、Logging、HourMetrics、MinuteMetrics、CORS の構成が含まれます。

継承メンバー

ServiceClient.credentials ServiceClient.downloadServicePropertiesImpl(final RequestOptions options, final boolean signAsTable) ServiceClient.getCredentials() ServiceClient.getEndpoint() ServiceClient.getServiceStatsImpl(final RequestOptions options, final boolean signAsTable) ServiceClient.getStorageUri() ServiceClient.ServiceClient(final StorageUri storageUri, final StorageCredentials credentials) ServiceClient.setCredentials(final StorageCredentials credentials) ServiceClient.setStorageUri(final StorageUri storageUri) ServiceClient.uploadServicePropertiesImpl(final ServiceProperties properties, final RequestOptions options, final OperationContext opContext, final boolean signAsTable)

コンストラクターの詳細

CloudQueueClient

public CloudQueueClient(final StorageUri baseUri, final StorageCredentials credentials)

指定した Queue サービス エンドポイントとアカウント資格情報を使用して、 クラスの新しいインスタンスを初期化します。

Parameters:

baseUri - クライアントの StorageUri 作成に使用される Queue サービス エンドポイントを表す オブジェクト。

credentials - StorageCredentialsアカウントの資格情報を表す オブジェクト。

CloudQueueClient

public CloudQueueClient(final URI baseUri, final StorageCredentials credentials)

指定した Queue サービス エンドポイントとアカウント資格情報を使用して、 クラスの新しいインスタンスを初期化します。

Parameters:

baseUri - クライアントの java.net.URI 作成に使用される Queue サービス エンドポイントを表す オブジェクト。

credentials - StorageCredentialsアカウントの資格情報を表す オブジェクト。

メソッドの詳細

downloadServiceProperties

public final ServiceProperties downloadServiceProperties()

指定されたストレージ サービスの現在 ServiceProperties の を取得します。 これには、ログ記録、HourMetrics、MinuteMetrics、CORS 構成が含まれます。

Returns:

サービスの ServiceProperties 現在の構成を表す オブジェクト。

Throws:

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

downloadServiceProperties

public final ServiceProperties downloadServiceProperties(QueueRequestOptions options, OperationContext opContext)

指定されたストレージ サービスの現在 ServiceProperties の を取得します。 これには、ログ記録、HourMetrics、MinuteMetrics、CORS 構成が含まれます。

Parameters:

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

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

Returns:

サービスの ServiceProperties 現在の構成を表す オブジェクト。

Throws:

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

getDefaultRequestOptions

public QueueRequestOptions getDefaultRequestOptions()

これに関連付けられている要求に使用される を取得します。QueueRequestOptions

Returns:

この QueueRequestOptions で使用される値を含む オブジェクト CloudQueueClient

getQueueReference

public CloudQueue getQueueReference(final String queueName)

指定した名前の CloudQueue オブジェクトを取得します。

Parameters:

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

Returns:

CloudQueue オブジェクトへの参照です。

Throws:

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

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

getServiceStats

public ServiceStats getServiceStats()

のサービスに対してクエリを実行します ServiceStats。

Returns:

ServiceStats 指定されたストレージ サービスの

Throws:

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

getServiceStats

public ServiceStats getServiceStats(QueueRequestOptions options, OperationContext opContext)

のサービスに対してクエリを実行します ServiceStats。

Parameters:

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

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

Returns:

ServiceStats 指定されたストレージ サービスの

Throws:

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

isUsePathStyleUris

protected boolean isUsePathStyleUris()

Returns:

usePathStyleUris

listQueues

public Iterable listQueues()

このキュー サービス クライアントのキューの格納可能なコレクションを取得します。

Returns:

このクライアント内の CloudQueue キューを表す遅延取得されたオブジェクトの繰り出し可能なコレクション。

listQueues

public Iterable listQueues(final String prefix)

この Queue サービス クライアントで指定されたプレフィックスで始まる名前を持つキューの、許容されるコレクションを返します。

Parameters:

prefix - Stringキュー名プレフィックスを表す 。

Returns:

指定したプレフィックスで始まる、このクライアント内の CloudQueue キューを表す遅延取得されたオブジェクトの繰り返し可能なコレクション。

listQueues

public Iterable listQueues(final String prefix, final QueueListingDetails detailsIncluded, QueueRequestOptions options, OperationContext opContext)

指定した詳細設定、要求オプション、および操作コンテキストを使用して、この Queue サービス クライアントの指定したプレフィックスで始まる名前を持つキューの許容されるコレクションを返します。

Parameters:

prefix - Stringキュー名プレフィックスを表す 。

detailsIncluded - キュー メタデータ QueueListingDetails が返されるかどうかを示す値。

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

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

Returns:

このクライアントの CloudQueue 指定されたキューを表す遅延で取得されたオブジェクトの繰り返し可能なコレクション。

listQueuesSegmented

public ResultSegment listQueuesSegmented()

この Queue サービス クライアントのキューの格納可能なコレクションの結果セグメントを取得します。

Returns:

ResultSegment<T>ストレージ サービス内のCloudQueue要求されたキューを表すオブジェクトの iterable コレクションのCloudQueueセグメントを含む オブジェクトの 。

Throws:

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

listQueuesSegmented

public ResultSegment listQueuesSegmented(final String prefix)

この Queue サービス クライアントの指定したプレフィックスで始まる名前を持つキューの、読み取り可能なキュー のコレクションの結果セグメントを取得します。

Parameters:

prefix

Returns:

ResultSegment<T>ストレージ サービス内のCloudQueue要求されたキューを表すオブジェクトの iterable コレクションのCloudQueueセグメントを含む オブジェクトの 。

Throws:

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

listQueuesSegmented

public ResultSegment listQueuesSegmented(final String prefix, final QueueListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, QueueRequestOptions options, OperationContext opContext)

指定したリストの詳細オプション、要求オプション、および操作コンテキストを使用して、このキューの指定したプレフィックスで始まる名前を持つキューの iterable コレクションの結果セグメントを取得します。

Parameters:

prefix - String一致するキュー名のプレフィックスを表す 。

detailsIncluded - キュー メタデータ QueueListingDetails が返されるかどうかを示す 値。

maxResults - 取得する結果の最大数。 5000 を超える場合 null 、サーバーは最大 5,000 個の項目を返します。 1 以上を指定してください。

continuationToken - 前の ResultContinuation 一覧表示操作によって返された継続トークンを表す オブジェクト。

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

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

Returns:

ResultSegment<T>ストレージ サービス内のCloudQueue要求されたキューを表すオブジェクトの iterable コレクションのCloudQueueセグメントを含む オブジェクトの 。

Throws:

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

setDefaultRequestOptions

public void setDefaultRequestOptions(QueueRequestOptions defaultRequestOptions)

このオブジェクトで QueueRequestOptions アクセスされるキューに使用される を設定します。

Parameters:

defaultRequestOptions - 使用する QueueRequestOptions。

uploadServiceProperties

public void uploadServiceProperties(final ServiceProperties properties)

指定されたストレージ サービスに新しい ServiceProperties 構成をアップロードします。 これには、Logging、HourMetrics、MinuteMetrics、CORS の構成が含まれます。

Parameters:

properties - ServicePropertiesアップロードする 。

Throws:

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

uploadServiceProperties

public void uploadServiceProperties(final ServiceProperties properties, QueueRequestOptions options, OperationContext opContext)

指定されたストレージ サービスに新しい ServiceProperties 構成をアップロードします。 これには、Logging、HourMetrics、MinuteMetrics、CORS の構成が含まれます。

Parameters:

properties - ServicePropertiesアップロードする 。

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

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

Throws:

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