CloudQueue Classe

  • Referência
Pacote:
com.microsoft.azure.storage.queue
  • java.lang.Object
    • com.microsoft.azure.storage.queue.CloudQueue

public class CloudQueue

Essa classe representa uma fila no serviço Fila do Microsoft Azure.

Resumo do Construtor

Construtor Description
CloudQueue(final StorageUri uri)

Cria uma instância da classe usando a fila especificada. A fila deve incluir um token SAS.
CloudQueue(final StorageUri uri, final StorageCredentials credentials)

Cria uma instância da classe usando a fila e as credenciais especificadas. Se o contiver um token SAS, as credenciais deverão ser .
CloudQueue(final String queueName, final CloudQueueClient client)

Cria uma instância da classe usando o nome e o cliente especificados.
CloudQueue(final URI uri)

Cria uma instância da classe usando o URI de fila especificado. A fila deve incluir um token SAS.
CloudQueue(final URI uri, final StorageCredentials credentials)

Cria uma instância da classe usando a fila e as credenciais especificadas. Se o contiver um token SAS, as credenciais deverão ser .

Resumo do método

Modificador e tipo Método e descrição
void addMessage(final CloudQueueMessage message)

Adiciona uma mensagem à parte de trás da fila.
void addMessage(final CloudQueueMessage message, final int timeToLiveInSeconds, final int initialVisibilityDelayInSeconds, QueueRequestOptions options, OperationContext opContext)

Adiciona uma mensagem à parte de trás da fila com as opções especificadas.
void clear()

Limpa todas as mensagens da fila.
void clear(QueueRequestOptions options, OperationContext opContext)

Limpa todas as mensagens da fila usando as opções de solicitação especificadas e o contexto de operação.
void create()

Cria a fila.
void create(QueueRequestOptions options, OperationContext opContext)

Cria a fila usando as opções de solicitação especificadas e o contexto de operação.
boolean createIfNotExists()

Cria a fila se ela ainda não existe.
boolean createIfNotExists(QueueRequestOptions options, OperationContext opContext)

Cria a fila se ela ainda não existir, usando as opções de solicitação especificadas e o contexto de operação.
void delete()

Exclui a fila.
void delete(QueueRequestOptions options, OperationContext opContext)

Exclui a fila, usando as opções de solicitação especificadas e o contexto de operação.
boolean deleteIfExists()

Exclui a fila se ela existe.
boolean deleteIfExists(QueueRequestOptions options, OperationContext opContext)

Exclui a fila se ela existir, usando as opções de solicitação especificadas e o contexto de operação.
void deleteMessage(final CloudQueueMessage message)

Exclui a mensagem especificada da fila.
void deleteMessage(final CloudQueueMessage message, QueueRequestOptions options, OperationContext opContext)

Exclui a mensagem especificada da fila, usando as opções de solicitação especificadas e o contexto de operação.
void downloadAttributes()

Baixa os metadados da fila e o valor aproximado da contagem de mensagens.
void downloadAttributes(QueueRequestOptions options, OperationContext opContext)

Baixa os metadados da fila e o valor aproximado da contagem de mensagens, usando as opções de solicitação especificadas e o contexto de operação.
QueuePermissions downloadPermissions()

Baixa as configurações de permissão para a fila.
QueuePermissions downloadPermissions(QueueRequestOptions options, OperationContext opContext)

Baixa as configurações de permissões para a fila usando as opções de solicitação especificadas e o contexto de operação.
boolean exists()

Retorna um valor que indica se a fila existe.
boolean exists(QueueRequestOptions options, OperationContext opContext)

Retorna um valor que indica se a fila existe, usando as opções de solicitação especificadas e o contexto de operação.
String generateSharedAccessSignature(final SharedAccessQueuePolicy policy, final String groupPolicyIdentifier)

Retorna uma assinatura de acesso compartilhado para a fila.
String generateSharedAccessSignature(final SharedAccessQueuePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)

Retorna uma assinatura de acesso compartilhado para a fila.
long getApproximateMessageCount()

Obtém a contagem aproximada de mensagens da fila. Esse valor é inicializado por uma solicitação para downloadAttributes() e representa a contagem aproximada de mensagens quando essa solicitação é concluída.
HashMap<String, String> getMetadata()

Obtém a coleção de metadados da fila, conforme armazenado neste objeto. Esse valor é inicializado com os metadados da fila por uma chamada para downloadAttributes()e é definido na fila com uma chamada para uploadMetadata().
String getName()

Obtém o nome da fila.
CloudQueueClient getServiceClient()

Obtém o cliente de serviço de fila associado a essa fila.
boolean getShouldEncodeMessage()

Obtém o valor que indica se a mensagem deve ser codificada em base 64.
final StorageUri getStorageUri()

Retorna a lista de URIs para todos os locais.
URI getUri()

Obtém o URI absoluto para essa fila.
CloudQueueMessage peekMessage()

Espia uma mensagem da fila. Uma solicitação de espiada recupera uma mensagem da frente da fila sem alterar sua visibilidade.
CloudQueueMessage peekMessage(final QueueRequestOptions options, final OperationContext opContext)

Espia uma mensagem da fila, usando as opções de solicitação e o contexto de operação especificados. Uma solicitação de espiada recupera uma mensagem da frente da fila sem alterar sua visibilidade.
Iterable<CloudQueueMessage> peekMessages(final int numberOfMessages)

Espia um número especificado de mensagens da fila. Uma solicitação de espiada recupera mensagens da frente da fila sem alterar sua visibilidade.
Iterable<CloudQueueMessage> peekMessages(final int numberOfMessages, QueueRequestOptions options, OperationContext opContext)

Espia um conjunto de mensagens da fila, usando as opções de solicitação e o contexto de operação especificados. Uma solicitação de espiada recupera mensagens da frente da fila sem alterar sua visibilidade.
CloudQueueMessage retrieveMessage()

Recupera uma mensagem da frente da fila usando as opções de solicitação padrão. Essa operação marca a mensagem recuperada como invisível na fila para o período de tempo limite de visibilidade padrão.
CloudQueueMessage retrieveMessage(final int visibilityTimeoutInSeconds, final QueueRequestOptions options, final OperationContext opContext)

Recupera uma mensagem da frente da fila, usando as opções de solicitação e o contexto de operação especificados. Essa operação marca a mensagem recuperada como invisível na fila para o período de tempo limite de visibilidade especificado.
Iterable<CloudQueueMessage> retrieveMessages(final int numberOfMessages)

Recupera o número especificado de mensagens da frente da fila usando as opções de solicitação padrão. Essa operação marca as mensagens recuperadas como invisíveis na fila para o período de tempo limite de visibilidade padrão.
Iterable<CloudQueueMessage> retrieveMessages(final int numberOfMessages, final int visibilityTimeoutInSeconds, QueueRequestOptions options, OperationContext opContext)

Recupera o número especificado de mensagens da frente da fila usando as opções de solicitação e o contexto de operação especificados. Essa operação marca as mensagens recuperadas como invisíveis na fila para o período de tempo limite de visibilidade padrão.
void setMetadata(final HashMap<String, String> metadata)

Define a coleção de metadados de pares nome-valor a ser definida na fila com uma uploadMetadata() chamada. Essa coleção substituirá todos os metadados de fila existentes. Se isso for definido como uma coleção vazia, os metadados da fila serão limpos em uma uploadMetadata() chamada.
void setShouldEncodeMessage(final boolean shouldEncodeMessage)

Define o sinalizador que indica se a mensagem deve ser codificada em base 64.
void updateMessage(final CloudQueueMessage message, final int visibilityTimeoutInSeconds)

Atualizações a mensagem especificada na fila com um novo valor de tempo limite de visibilidade em segundos.
void updateMessage(final CloudQueueMessage message, final int visibilityTimeoutInSeconds, final EnumSet<MessageUpdateFields> messageUpdateFields, QueueRequestOptions options, OperationContext opContext)

Atualizações uma mensagem na fila, usando as opções de solicitação e o contexto de operação especificados.
void uploadMetadata()

Carrega os metadados no objeto para a fila.
void uploadMetadata(QueueRequestOptions options, OperationContext opContext)

Carrega os metadados no objeto para a fila, usando as opções de solicitação e o contexto de operação especificados.
void uploadPermissions(final QueuePermissions permissions)

Carrega as permissões da fila.
void uploadPermissions(final QueuePermissions permissions, QueueRequestOptions options, OperationContext opContext)

Carrega as permissões da fila usando as opções de solicitação e o contexto de operação especificados.

Detalhes do construtor

CloudQueue

public CloudQueue(final StorageUri uri)

Cria uma instância da classe usando a fila especificada. A fila deve incluir um token SAS.

Parameters:

uri - Um StorageUri objeto que representa o URI absoluto da fila.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento.

CloudQueue

public CloudQueue(final StorageUri uri, final StorageCredentials credentials)

Cria uma instância da classe usando a fila e as credenciais especificadas. Se o contiver um token SAS, as credenciais deverão ser .

Parameters:

uri - Um StorageUri objeto que representa o URI absoluto da fila.
credentials - Um StorageCredentials objeto usado para autenticar o acesso.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento.

CloudQueue

protected CloudQueue(final String queueName, final CloudQueueClient client)

Cria uma instância da classe usando o nome e o cliente especificados.

Parameters:

queueName - O nome da fila, que deve seguir as regras de nomenclatura de fila. O nome da fila não deve incluir nenhum caractere separador de caminho (/). Os nomes de fila devem ser minúsculos, entre 3 e 63 caracteres e devem começar com uma letra ou número. Os nomes de fila podem conter apenas letras, números e o caractere de traço (-).
client - Um CloudQueueClient objeto que representa o cliente de serviço associado e que especifica o ponto de extremidade para o serviço Queue.

Throws:

URISyntaxException - Se o URI do recurso construído com base no queueName for inválido.
StorageException - Se ocorreu um erro de serviço de armazenamento.

CloudQueue

public CloudQueue(final URI uri)

Cria uma instância da classe usando o URI de fila especificado. A fila deve incluir um token SAS.

Parameters:

uri - Um java.net.URI objeto que representa o URI absoluto da fila.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento.

CloudQueue

public CloudQueue(final URI uri, final StorageCredentials credentials)

Cria uma instância da classe usando a fila e as credenciais especificadas. Se o contiver um token SAS, as credenciais deverão ser .

Parameters:

uri - Um java.net.URI objeto que representa o URI absoluto da fila.
credentials - Um StorageCredentials objeto usado para autenticar o acesso.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento.

Detalhes do método

addMessage

public void addMessage(final CloudQueueMessage message)

Adiciona uma mensagem à parte de trás da fila.

Parameters:

message - Um CloudQueueMessage objeto que especifica a mensagem a ser adicionada. O objeto de mensagem é modificado para incluir a ID da mensagem e o recibo pop e pode ser usado em chamadas subsequentes para updateMessage e deleteMessage.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

addMessage

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

Adiciona uma mensagem à parte de trás da fila com as opções especificadas.

Parameters:

message - Um CloudQueueMessage objeto que especifica a mensagem a ser adicionada. O objeto de mensagem é modificado para incluir a ID da mensagem e o recibo pop e pode ser usado em chamadas subsequentes para updateMessage e deleteMessage.
timeToLiveInSeconds - O tempo máximo de permissão de permanência da mensagem na fila. Um valor zero definirá o tempo de vida útil para o valor padrão do serviço de sete dias. Um valor negativo definirá um tempo de vida infinito.
initialVisibilityDelayInSeconds - O período durante o qual a mensagem será invisível, começando quando ela é adicionada à fila ou 0 para tornar a mensagem visível imediatamente. Esse valor deve ser maior ou igual a zero e menor que o valor de vida útil.
options - Um QueueRequestOptions objeto que especifica as opções adicionais para a solicitação. A especificação null usará as opções de solicitação padrão do cliente de serviço associado ( CloudQueueClient).
opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

clear

public void clear()

Limpa todas as mensagens da fila.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

clear

public void clear(QueueRequestOptions options, OperationContext opContext)

Limpa todas as mensagens da fila usando as opções de solicitação especificadas e o contexto de operação.

Parameters:

options - Um QueueRequestOptions objeto que especifica as opções adicionais para a solicitação. A especificação null usará as opções de solicitação padrão do cliente de serviço associado ( CloudQueueClient).
opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

create

public void create()

Cria a fila.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

create

public void create(QueueRequestOptions options, OperationContext opContext)

Cria a fila usando as opções de solicitação especificadas e o contexto de operação.

Parameters:

options - Um QueueRequestOptions objeto que especifica as opções adicionais para a solicitação. A especificação null usará as opções de solicitação padrão do cliente de serviço associado ( CloudQueueClient).
opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

createIfNotExists

public boolean createIfNotExists()

Cria a fila se ela ainda não existe.

Returns:

Um valor de true se a fila for criada no serviço de armazenamento, caso contrário, false

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

createIfNotExists

public boolean createIfNotExists(QueueRequestOptions options, OperationContext opContext)

Cria a fila se ela ainda não existir, usando as opções de solicitação especificadas e o contexto de operação.

Parameters:

options - Um QueueRequestOptions objeto que especifica as opções adicionais para a solicitação. A especificação null usará as opções de solicitação padrão do cliente de serviço associado ( CloudQueueClient).
opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Returns:

Um valor de true se a fila for criada no serviço de armazenamento, caso contrário, false

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

delete

public void delete()

Exclui a fila.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

delete

public void delete(QueueRequestOptions options, OperationContext opContext)

Exclui a fila, usando as opções de solicitação especificadas e o contexto de operação.

Parameters:

options - Um QueueRequestOptions objeto que especifica as opções adicionais para a solicitação. A especificação null usará as opções de solicitação padrão do cliente de serviço associado ( CloudQueueClient).
opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

deleteIfExists

public boolean deleteIfExists()

Exclui a fila se ela existe.

Returns:

Um valor de true se a fila existia no serviço de armazenamento e foi excluída, caso contrário false, .

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

deleteIfExists

public boolean deleteIfExists(QueueRequestOptions options, OperationContext opContext)

Exclui a fila se ela existir, usando as opções de solicitação especificadas e o contexto de operação.

Parameters:

options - Um QueueRequestOptions objeto que especifica as opções adicionais para a solicitação. A especificação null usará as opções de solicitação padrão do cliente de serviço associado ( CloudQueueClient).
opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Returns:

Um valor de true se a fila existia no serviço de armazenamento e foi excluída, caso contrário false, .

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

deleteMessage

public void deleteMessage(final CloudQueueMessage message)

Exclui a mensagem especificada da fila.

Parameters:

message - Um CloudQueueMessage objeto que especifica a mensagem a ser excluída.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

deleteMessage

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

Exclui a mensagem especificada da fila, usando as opções de solicitação especificadas e o contexto de operação.

Parameters:

message - Um CloudQueueMessage objeto que especifica a mensagem a ser excluída.
options - Um QueueRequestOptions objeto que especifica as opções adicionais para a solicitação. A especificação null usará as opções de solicitação padrão do cliente de serviço associado ( CloudQueueClient).
opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

downloadAttributes

public void downloadAttributes()

Baixa os metadados da fila e o valor aproximado da contagem de mensagens.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

downloadAttributes

public void downloadAttributes(QueueRequestOptions options, OperationContext opContext)

Baixa os metadados da fila e o valor aproximado da contagem de mensagens, usando as opções de solicitação especificadas e o contexto de operação.

Parameters:

options - Um QueueRequestOptions objeto que especifica as opções adicionais para a solicitação. A especificação null usará as opções de solicitação padrão do cliente de serviço associado ( CloudQueue).
opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

downloadPermissions

public QueuePermissions downloadPermissions()

Baixa as configurações de permissão para a fila.

Returns:

Um QueuePermissions objeto que representa as permissões da fila.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento.

downloadPermissions

public QueuePermissions downloadPermissions(QueueRequestOptions options, OperationContext opContext)

Baixa as configurações de permissões para a fila usando as opções de solicitação especificadas e o contexto de operação.

Parameters:

options - Um QueueRequestOptions objeto que especifica as opções adicionais para a solicitação. A especificação null usará as opções de solicitação padrão do cliente de serviço associado ( CloudQueueClient).
opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Returns:

Um QueuePermissions objeto que representa as permissões do contêiner.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento.

exists

public boolean exists()

Retorna um valor que indica se a fila existe.

Returns:

true se a fila existir no serviço de armazenamento, caso contrário false, .

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

exists

public boolean exists(QueueRequestOptions options, OperationContext opContext)

Retorna um valor que indica se a fila existe, usando as opções de solicitação especificadas e o contexto de operação.

Parameters:

options - Um QueueRequestOptions objeto que especifica as opções adicionais para a solicitação. A especificação null usará as opções de solicitação padrão do cliente de serviço associado ( CloudQueueClient).
opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Returns:

true se a fila existir no serviço de armazenamento, caso contrário false, .

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

generateSharedAccessSignature

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

Retorna uma assinatura de acesso compartilhado para a fila.

Parameters:

policy - A política de acesso para a assinatura de acesso compartilhado.
groupPolicyIdentifier - Uma política de acesso em nível de fila.

Returns:

Uma assinatura de acesso compartilhado para a fila.

Throws:

InvalidKeyException - Se uma chave inválida foi passada.
StorageException - Se ocorreu um erro de serviço de armazenamento.
IllegalArgumentException - Se um valor inesperado for passado.

generateSharedAccessSignature

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

Retorna uma assinatura de acesso compartilhado para a fila.

Parameters:

policy - A política de acesso para a assinatura de acesso compartilhado.
groupPolicyIdentifier - Uma política de acesso em nível de fila.
ipRange - Um IPRange objeto que contém o intervalo de endereços IP permitidos.
protocols - Um SharedAccessProtocols que representa os protocolos de Internet permitidos.

Returns:

Uma assinatura de acesso compartilhado para a fila.

Throws:

InvalidKeyException - Se uma chave inválida foi passada.
StorageException - Se ocorreu um erro de serviço de armazenamento.
IllegalArgumentException - Se um valor inesperado for passado.

getApproximateMessageCount

public long getApproximateMessageCount()

Obtém a contagem aproximada de mensagens da fila. Esse valor é inicializado por uma solicitação para downloadAttributes() e representa a contagem aproximada de mensagens quando essa solicitação é concluída.

Returns:

Um Long objeto que representa a contagem aproximada de mensagens da fila.

getMetadata

public HashMap getMetadata()

Obtém a coleção de metadados da fila, conforme armazenado neste objeto. Esse valor é inicializado com os metadados da fila por uma chamada para downloadAttributes()e é definido na fila com uma chamada para uploadMetadata().

Returns:

Um java.util.HashMap objeto que representa os metadados da fila.

getName

public String getName()

Obtém o nome da fila.

Returns:

Um String objeto que representa o nome da fila.

getServiceClient

public CloudQueueClient getServiceClient()

Obtém o cliente de serviço de fila associado a essa fila.

Returns:

Um CloudQueueClient objeto que representa o cliente de serviço associado a essa fila.

getShouldEncodeMessage

public boolean getShouldEncodeMessage()

Obtém o valor que indica se a mensagem deve ser codificada em base 64.

Returns:

Um Boolean que representa se a mensagem deve ser codificada em base 64.

getStorageUri

public final StorageUri getStorageUri()

Retorna a lista de URIs para todos os locais.

Returns:

Um StorageUri que representa a lista de URIs para todos os locais..

getUri

public URI getUri()

Obtém o URI absoluto para essa fila.

Returns:

Um java.net.URI objeto que representa o URI dessa fila.

peekMessage

public CloudQueueMessage peekMessage()

Espia uma mensagem da fila. Uma solicitação de espiada recupera uma mensagem da frente da fila sem alterar sua visibilidade.

Returns:

Um CloudQueueMessage objeto que representa uma mensagem nessa fila.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

peekMessage

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

Espia uma mensagem da fila, usando as opções de solicitação e o contexto de operação especificados. Uma solicitação de espiada recupera uma mensagem da frente da fila sem alterar sua visibilidade.

Parameters:

options - Um QueueRequestOptions objeto que especifica as opções adicionais para a solicitação. A especificação null usará as opções de solicitação padrão do cliente de serviço associado ( CloudQueueClient).
opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Returns:

Um CloudQueueMessage objeto que representa a mensagem solicitada da fila.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

peekMessages

public Iterable peekMessages(final int numberOfMessages)

Espia um número especificado de mensagens da fila. Uma solicitação de espiada recupera mensagens da frente da fila sem alterar sua visibilidade.

Parameters:

numberOfMessages - O número de mensagens a serem recuperadas.

Returns:

Uma coleção enumerável de CloudQueueMessage objetos que representa as mensagens solicitadas da fila.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

peekMessages

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

Espia um conjunto de mensagens da fila, usando as opções de solicitação e o contexto de operação especificados. Uma solicitação de espiada recupera mensagens da frente da fila sem alterar sua visibilidade.

Parameters:

numberOfMessages - O número de mensagens a serem recuperadas.
options - Um QueueRequestOptions objeto que especifica as opções adicionais para a solicitação. Especificar null usará as opções de solicitação padrão do cliente de serviço associado ( CloudQueueClient).
opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Returns:

Uma coleção enumerável de CloudQueueMessage objetos que representa as mensagens solicitadas da fila.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

retrieveMessage

public CloudQueueMessage retrieveMessage()

Recupera uma mensagem da frente da fila usando as opções de solicitação padrão. Essa operação marca a mensagem recuperada como invisível na fila para o período de tempo limite de visibilidade padrão.

Returns:

Um CloudQueueMessage objeto que representa uma mensagem nessa fila.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

retrieveMessage

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

Recupera uma mensagem da frente da fila, usando as opções de solicitação e o contexto de operação especificados. Essa operação marca a mensagem recuperada como invisível na fila para o período de tempo limite de visibilidade especificado.

Parameters:

visibilityTimeoutInSeconds - Especifica o tempo limite de visibilidade da mensagem, em segundos.
options - Um QueueRequestOptions objeto que especifica as opções adicionais para a solicitação. Especificar null usará as opções de solicitação padrão do cliente de serviço associado ( CloudQueueClient).
opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Returns:

Um CloudQueueMessage objeto que representa uma mensagem nessa fila.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

retrieveMessages

public Iterable retrieveMessages(final int numberOfMessages)

Recupera o número especificado de mensagens da frente da fila usando as opções de solicitação padrão. Essa operação marca as mensagens recuperadas como invisíveis na fila para o período de tempo limite de visibilidade padrão.

Parameters:

numberOfMessages - O número de mensagens a serem recuperadas.

Returns:

Uma coleção enumerável de CloudQueueMessage objetos que representa as mensagens recuperadas da fila.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

retrieveMessages

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

Recupera o número especificado de mensagens da frente da fila usando as opções de solicitação e o contexto de operação especificados. Essa operação marca as mensagens recuperadas como invisíveis na fila para o período de tempo limite de visibilidade padrão.

Parameters:

numberOfMessages - O número de mensagens a serem recuperadas.
visibilityTimeoutInSeconds - Especifica o tempo limite de visibilidade para as mensagens recuperadas, em segundos.
options - Um QueueRequestOptions objeto que especifica as opções adicionais para a solicitação. Especificar null usará as opções de solicitação padrão do cliente de serviço associado ( CloudQueueClient).
opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Returns:

Uma coleção enumerável de CloudQueueMessage objetos que representa as mensagens recuperadas da fila.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

setMetadata

public void setMetadata(final HashMap metadata)

Define a coleção de metadados de pares nome-valor a ser definida na fila com uma uploadMetadata() chamada. Essa coleção substituirá todos os metadados de fila existentes. Se isso for definido como uma coleção vazia, os metadados da fila serão limpos em uma uploadMetadata() chamada.

Parameters:

metadata - Um java.util.HashMap objeto que representa os metadados que estão sendo atribuídos à fila.

setShouldEncodeMessage

public void setShouldEncodeMessage(final boolean shouldEncodeMessage)

Define o sinalizador que indica se a mensagem deve ser codificada em base 64.

Parameters:

shouldEncodeMessage - O valor indica se a mensagem deve ser codificada em base 64.

updateMessage

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

Atualizações a mensagem especificada na fila com um novo valor de tempo limite de visibilidade em segundos.

Parameters:

message - O CloudQueueMessage a ser atualizado na fila.
visibilityTimeoutInSeconds - Especifica o novo tempo limite de visibilidade para a mensagem, em segundos.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

updateMessage

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

Atualizações uma mensagem na fila, usando as opções de solicitação e o contexto de operação especificados.

Parameters:

message - O CloudQueueMessage a ser atualizado na fila.
visibilityTimeoutInSeconds - Especifica o novo tempo limite de visibilidade para a mensagem, em segundos.
messageUpdateFields - Um EnumSet de MessageUpdateFields valores que especifica quais partes da mensagem devem ser atualizadas.
options - Um QueueRequestOptions objeto que especifica as opções adicionais para a solicitação. Especificar null usará as opções de solicitação padrão do cliente de serviço associado ( CloudQueueClient).
opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

uploadMetadata

public void uploadMetadata()

Carrega os metadados no objeto para a fila.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

uploadMetadata

public void uploadMetadata(QueueRequestOptions options, OperationContext opContext)

Carrega os metadados no objeto para a fila, usando as opções de solicitação e o contexto de operação especificados.

Parameters:

options - Um QueueRequestOptions objeto que especifica as opções adicionais para a solicitação. Especificar null usará as opções de solicitação padrão do cliente de serviço associado ( CloudQueueClient).
opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento durante a operação.

uploadPermissions

public void uploadPermissions(final QueuePermissions permissions)

Carrega as permissões da fila.

Parameters:

permissions - Um QueuePermissions objeto que representa as permissões para carregar.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento.

uploadPermissions

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

Carrega as permissões da fila usando as opções de solicitação e o contexto de operação especificados.

Parameters:

permissions - Um QueuePermissions objeto que representa as permissões para carregar.
options - Um QueueRequestOptions objeto que especifica as opções adicionais para a solicitação. Especificar null usará as opções de solicitação padrão do cliente de serviço associado ( CloudQueueClient).
opContext - Um objeto OperationContext que representa o contexto da operação atual. Esse objeto é usado para controlar solicitações para o serviço de armazenamento, e para fornecer informações adicionais de tempo de execução sobre a operação.

Throws:

StorageException - Se ocorreu um erro de serviço de armazenamento.

Aplica-se a