你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

CloudQueueClient 类

包:

com.microsoft.azure.storage.queue

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

public class CloudQueueClient extends ServiceClient

提供用于访问 Microsoft Azure 队列服务的服务客户端。

构造函数摘要

构造函数	说明
CloudQueueClient(final StorageUri baseUri, final StorageCredentials credentials)	使用指定的队列服务终结点和帐户凭据初始化 类的新实例。
CloudQueueClient(final URI baseUri, final StorageCredentials credentials)	使用指定的队列服务终结点和帐户凭据初始化 类的新实例。

方法摘要

修饰符和类型	方法和描述
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) 返回一个可迭代的队列集合，其名称以此队列服务客户端中的指定前缀开头。
Iterable<CloudQueue>	listQueues(final String prefix, final QueueListingDetails detailsIncluded, QueueRequestOptions options, OperationContext opContext) 使用指定的详细信息设置、请求选项和操作上下文返回队列的可迭代集合，这些队列的名称以此队列服务客户端的指定前缀开头。
ResultSegment<CloudQueue>	listQueuesSegmented() 获取此队列服务客户端的可迭代队列集合的结果段。
ResultSegment<CloudQueue>	listQueuesSegmented(final String prefix) 获取可迭代队列集合的结果段，这些队列的名称以此队列服务客户端的指定前缀开头。
ResultSegment<CloudQueue>	listQueuesSegmented(final String prefix, final QueueListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, QueueRequestOptions options, OperationContext opContext) 使用指定的列表详细信息选项、请求选项和操作上下文获取队列的可迭代集合的结果段，该集合的名称以此队列的指定前缀开头。
void	setDefaultRequestOptions(QueueRequestOptions defaultRequestOptions) QueueRequestOptions设置用于使用此 对象访问的任何队列的 。
void	uploadServiceProperties(final ServiceProperties properties) 将新 ServiceProperties 配置上传到给定的存储服务。 这包括日志记录、HourMetrics、MinuteMetrics 和 CORS 配置。
void	uploadServiceProperties(final ServiceProperties properties, QueueRequestOptions options, OperationContext opContext) 将新 ServiceProperties 配置上传到给定的存储服务。 这包括日志记录、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)

使用指定的队列服务终结点和帐户凭据初始化 类的新实例。

Parameters:

baseUri - 一个 StorageUri 对象，表示用于创建客户端的队列服务终结点。

credentials - 一个 StorageCredentials 表示帐户凭据的 对象。

CloudQueueClient

public CloudQueueClient(final URI baseUri, final StorageCredentials credentials)

使用指定的队列服务终结点和帐户凭据初始化 类的新实例。

Parameters:

baseUri - 一个 java.net.URI 对象，表示用于创建客户端的队列服务终结点。

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)

返回一个可迭代的队列集合，其名称以此队列服务客户端中的指定前缀开头。

Parameters:

prefix - 一个 String ，它表示队列名称前缀。

Returns:

延迟检索的 CloudQueue 对象的可迭代集合，表示此客户端中名称以指定前缀开头的队列。

listQueues

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

使用指定的详细信息设置、请求选项和操作上下文返回队列的可迭代集合，这些队列的名称以此队列服务客户端的指定前缀开头。

Parameters:

prefix - 一个 String ，它表示队列名称前缀。

detailsIncluded - 一个 QueueListingDetails 值，该值指示是否将返回队列元数据。

options - 一个 QueueRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudQueue 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

延迟检索的 CloudQueue 对象的可迭代集合，表示此客户端的指定队列。

listQueuesSegmented

public ResultSegment listQueuesSegmented()

获取此队列服务客户端的可迭代队列集合的结果段。

Returns:

CloudQueue对象的 ，ResultSegment<T>该对象包含表示存储服务中请求的队列的对象CloudQueue可迭代集合的段。

Throws:

StorageException - 如果在操作期间发生存储服务错误。

listQueuesSegmented

public ResultSegment listQueuesSegmented(final String prefix)

获取可迭代队列集合的结果段，这些队列的名称以此队列服务客户端的指定前缀开头。

Parameters:

prefix

Returns:

CloudQueue对象的 ，ResultSegment<T>该对象包含表示存储服务中请求的队列的对象CloudQueue可迭代集合的段。

Throws:

StorageException - 如果在操作期间发生存储服务错误。

listQueuesSegmented

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

使用指定的列表详细信息选项、请求选项和操作上下文获取队列的可迭代集合的结果段，该集合的名称以此队列的指定前缀开头。

Parameters:

prefix - 一个 String ，表示要匹配的队列名称的前缀。

detailsIncluded - 一个 QueueListingDetails 值，该值指示是否将返回队列元数据。

maxResults - 要检索的最大结果数。 如果 null 或大于 5000，服务器将返回最多 5,000 个项目。 必须至少为 1。

continuationToken - 一个 ResultContinuation 对象，表示上一个列表操作返回的继续标记。

options - 一个 QueueRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudQueue) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

CloudQueue对象的 ，ResultSegment<T>该对象包含表示存储服务中请求的队列的对象CloudQueue可迭代集合的段。

Throws:

StorageException - 如果在操作期间发生存储服务错误。

setDefaultRequestOptions

public void setDefaultRequestOptions(QueueRequestOptions defaultRequestOptions)

QueueRequestOptions设置用于使用此 对象访问的任何队列的 。

Parameters:

defaultRequestOptions - 要使用的 QueueRequestOptions。

uploadServiceProperties

public void uploadServiceProperties(final ServiceProperties properties)

将新 ServiceProperties 配置上传到给定的存储服务。 这包括日志记录、HourMetrics、MinuteMetrics 和 CORS 配置。

Parameters:

properties - 要 ServiceProperties 上传的 。

Throws:

StorageException - 如果发生存储服务错误。

uploadServiceProperties

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

将新 ServiceProperties 配置上传到给定的存储服务。 这包括日志记录、HourMetrics、MinuteMetrics 和 CORS 配置。

Parameters:

properties - 要 ServiceProperties 上传的 。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。