你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
CloudQueue 类
- java.
lang. Object - com.
microsoft. azure. storage. queue. CloudQueue
- com.
public class CloudQueue
此类表示 Microsoft Azure 队列服务中的队列。
构造函数摘要
构造函数 | 说明 |
---|---|
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:
Throws:
clear
public void clear()
从队列中清除所有消息。
Throws:
clear
public void clear(QueueRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文清除队列中的所有消息。
Parameters:
Throws:
create
public void create()
创建队列。
Throws:
create
public void create(QueueRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文创建队列。
Parameters:
Throws:
createIfNotExists
public boolean createIfNotExists()
在队列尚未存在时创建它。
Returns:
true
,否则为 false
Throws:
createIfNotExists
public boolean createIfNotExists(QueueRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文创建队列(如果不存在)。
Parameters:
Returns:
true
,否则为 false
Throws:
delete
public void delete()
删除队列。
Throws:
delete
public void delete(QueueRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文删除队列。
Parameters:
Throws:
deleteIfExists
public boolean deleteIfExists()
在队列存在时删除它。
Returns:
true
,否则 false
为 。Throws:
deleteIfExists
public boolean deleteIfExists(QueueRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文删除队列(如果存在)。
Parameters:
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:
Throws:
downloadAttributes
public void downloadAttributes()
下载队列的元数据和近似消息计数值。
Throws:
downloadAttributes
public void downloadAttributes(QueueRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文下载队列的元数据和近似消息计数值。
Parameters:
Throws:
downloadPermissions
public QueuePermissions downloadPermissions()
下载队列的权限设置。
Returns:
Throws:
downloadPermissions
public QueuePermissions downloadPermissions(QueueRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文下载队列的权限设置。
Parameters:
Returns:
Throws:
exists
public boolean exists()
返回一个值,该值指示队列是否存在。
Returns:
true
如果存储服务中存在队列,则为 ;否则为 false
。
Throws:
exists
public boolean exists(QueueRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文返回一个值,该值指示队列是否存在。
Parameters:
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:
Returns:
Throws:
peekMessages
public Iterable
从队列中速览指定数量的消息。 速览请求从队列前面检索消息,而不会更改其可见性。
Parameters:
Returns:
Throws:
peekMessages
public Iterable
使用指定的请求选项和操作上下文从队列中速览一组消息。 速览请求从队列前面检索消息,而不会更改其可见性。
Parameters:
Returns:
Throws:
retrieveMessage
public CloudQueueMessage retrieveMessage()
使用默认请求选项从队列前面检索消息。 此操作会将检索到的消息标记为在默认可见性超时期间在队列中不可见。
Returns:
Throws:
retrieveMessage
public CloudQueueMessage retrieveMessage(final int visibilityTimeoutInSeconds, final QueueRequestOptions options, final OperationContext opContext)
使用指定的请求选项和操作上下文从队列的前面检索消息。 此操作会将检索到的消息标记为在指定的可见性超时期限内在队列中不可见。
Parameters:
Returns:
Throws:
retrieveMessages
public Iterable
使用默认请求选项从队列前面检索指定数量的消息。 此操作会将检索到的消息标记为在默认可见性超时期限内在队列中不可见。
Parameters:
Returns:
Throws:
retrieveMessages
public Iterable
使用指定的请求选项和操作上下文从队列前面检索指定数量的消息。 此操作会将检索到的消息标记为在默认可见性超时期限内在队列中不可见。
Parameters:
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:
Throws:
uploadMetadata
public void uploadMetadata()
将 对象中的元数据上传到队列。
Throws:
uploadMetadata
public void uploadMetadata(QueueRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文将 对象中的元数据上传到队列。
Parameters:
Throws:
uploadPermissions
public void uploadPermissions(final QueuePermissions permissions)
上传队列的权限。
Parameters:
Throws:
uploadPermissions
public void uploadPermissions(final QueuePermissions permissions, QueueRequestOptions options, OperationContext opContext)
使用指定的请求选项和操作上下文上传队列的权限。
Parameters:
Throws:
适用于
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈