CloudQueueClient Classe

Pacote:

com.microsoft.azure.storage.queue

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

public class CloudQueueClient extends ServiceClient

Fornece um cliente de serviço para acessar o serviço Fila do Microsoft Azure.

Resumo do Construtor

Construtor	Description
CloudQueueClient(final StorageUri baseUri, final StorageCredentials credentials)	Inicializa uma nova instância da classe usando o ponto de extremidade de serviço queue e as credenciais de conta especificadas.
CloudQueueClient(final URI baseUri, final StorageCredentials credentials)	Inicializa uma nova instância da classe usando o ponto de extremidade de serviço queue e as credenciais de conta especificadas.

Resumo do método

Modificador e tipo	Método e descrição
final ServiceProperties	downloadServiceProperties() Recupera o atual ServiceProperties para o serviço de armazenamento especificado. Isso inclui configurações de Log, HourMetrics, MinuteMetrics e CORS.
final ServiceProperties	downloadServiceProperties(QueueRequestOptions options, OperationContext opContext) Recupera o atual ServiceProperties para o serviço de armazenamento especificado. Isso inclui configurações de Log, HourMetrics, MinuteMetrics e CORS.
QueueRequestOptions	getDefaultRequestOptions() Obtém o QueueRequestOptions que é usado para solicitações associadas a este
CloudQueue	getQueueReference(final String queueName) Obtém um CloudQueue objeto com o nome especificado.
ServiceStats	getServiceStats() Consulta o serviço para o ServiceStats.
ServiceStats	getServiceStats(QueueRequestOptions options, OperationContext opContext) Consulta o serviço para o ServiceStats.
boolean	isUsePathStyleUris()
Iterable<CloudQueue>	listQueues() Obtém uma coleção iterável de filas para esse cliente de serviço de fila.
Iterable<CloudQueue>	listQueues(final String prefix) Retorna uma coleção iterável de filas cujos nomes começam com o prefixo especificado neste cliente de serviço Fila.
Iterable<CloudQueue>	listQueues(final String prefix, final QueueListingDetails detailsIncluded, QueueRequestOptions options, OperationContext opContext) Retorna uma coleção iterável de filas cujos nomes começam com o prefixo especificado para esse cliente de serviço fila, usando a configuração de detalhes especificada, as opções de solicitação e o contexto de operação.
ResultSegment<CloudQueue>	listQueuesSegmented() Obtém um segmento de resultado de uma coleção iterável de filas para esse cliente de serviço fila.
ResultSegment<CloudQueue>	listQueuesSegmented(final String prefix) Obtém um segmento de resultado de uma coleção iterável de filas cujos nomes começam com o prefixo especificado para esse cliente de serviço Queue.
ResultSegment<CloudQueue>	listQueuesSegmented(final String prefix, final QueueListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, QueueRequestOptions options, OperationContext opContext) Obtém um segmento de resultado de uma coleção iterável de filas cujos nomes começam com o prefixo especificado para essa fila, usando as opções de detalhes de listagem especificadas, opções de solicitação e contexto de operação.
void	setDefaultRequestOptions(QueueRequestOptions defaultRequestOptions) Define o QueueRequestOptions usado para qualquer fila acessada com esse objeto.
void	uploadServiceProperties(final ServiceProperties properties) Carrega uma nova ServiceProperties configuração para o serviço de armazenamento especificado. Isso inclui configurações de Log, HourMetrics, MinuteMetrics e CORS.
void	uploadServiceProperties(final ServiceProperties properties, QueueRequestOptions options, OperationContext opContext) Carrega uma nova ServiceProperties configuração para o serviço de armazenamento especificado. Isso inclui configurações de Log, HourMetrics, MinuteMetrics e CORS.

Membros herdados

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)

Detalhes do construtor

CloudQueueClient

public CloudQueueClient(final StorageUri baseUri, final StorageCredentials credentials)

Inicializa uma nova instância da classe usando o ponto de extremidade de serviço queue e as credenciais de conta especificadas.

Parameters:

baseUri - Um StorageUri objeto que representa o ponto de extremidade de serviço Queue usado para criar o cliente.

credentials - Um StorageCredentials objeto que representa as credenciais da conta.

CloudQueueClient

public CloudQueueClient(final URI baseUri, final StorageCredentials credentials)

Inicializa uma nova instância da classe usando o ponto de extremidade de serviço queue e as credenciais de conta especificadas.

Parameters:

baseUri - Um java.net.URI objeto que representa o ponto de extremidade de serviço Queue usado para criar o cliente.

credentials - Um StorageCredentials objeto que representa as credenciais da conta.

Detalhes do método

downloadServiceProperties

public final ServiceProperties downloadServiceProperties()

Recupera o atual ServiceProperties para o serviço de armazenamento especificado. Isso inclui configurações de Log, HourMetrics, MinuteMetrics e CORS.

Returns:

o ServiceProperties objeto que representa a configuração atual do serviço.

Throws:

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

downloadServiceProperties

public final ServiceProperties downloadServiceProperties(QueueRequestOptions options, OperationContext opContext)

Recupera o atual ServiceProperties para o serviço de armazenamento especificado. Isso inclui configurações de Log, HourMetrics, MinuteMetrics e CORS.

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:

o ServiceProperties objeto que representa a configuração atual do serviço.

Throws:

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

getDefaultRequestOptions

public QueueRequestOptions getDefaultRequestOptions()

Obtém o QueueRequestOptions que é usado para solicitações associadas a este

Returns:

O QueueRequestOptions objeto que contém os valores usados por este CloudQueueClient

getQueueReference

public CloudQueue getQueueReference(final String queueName)

Obtém um CloudQueue objeto com o nome especificado.

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 (-).

Returns:

Uma referência a um objeto CloudQueue.

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.

getServiceStats

public ServiceStats getServiceStats()

Consulta o serviço para o ServiceStats.

Returns:

ServiceStats para o serviço de armazenamento especificado

Throws:

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

getServiceStats

public ServiceStats getServiceStats(QueueRequestOptions options, OperationContext opContext)

Consulta o serviço para o ServiceStats.

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:

ServiceStats para o serviço de armazenamento especificado

Throws:

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

isUsePathStyleUris

protected boolean isUsePathStyleUris()

Returns:

o usePathStyleUris

listQueues

public Iterable listQueues()

Obtém uma coleção iterável de filas para esse cliente de serviço de fila.

Returns:

Uma coleção iterável de CloudQueue objetos recuperados de forma preguiçosa que representam as filas neste cliente.

listQueues

public Iterable listQueues(final String prefix)

Retorna uma coleção iterável de filas cujos nomes começam com o prefixo especificado neste cliente de serviço Fila.

Parameters:

prefix - Um String que representa o prefixo de nome da fila.

Returns:

Uma coleção iterável de CloudQueue objetos recuperados de forma preguiçosa que representam as filas neste cliente cujos nomes começam com o prefixo especificado.

listQueues

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

Retorna uma coleção iterável de filas cujos nomes começam com o prefixo especificado para esse cliente de serviço fila, usando a configuração de detalhes especificada, as opções de solicitação e o contexto de operação.

Parameters:

prefix - Um String que representa o prefixo de nome da fila.

detailsIncluded - Um QueueListingDetails valor que indica se os metadados da fila serão retornados.

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.

Returns:

Uma coleção iterável de CloudQueue objetos recuperados de forma preguiçosa que representa as filas especificadas para esse cliente.

listQueuesSegmented

public ResultSegment listQueuesSegmented()

Obtém um segmento de resultado de uma coleção iterável de filas para esse cliente de serviço fila.

Returns:

Um ResultSegment<T> dos CloudQueue objetos que contém um segmento da coleção iterável de CloudQueue objetos que representam as filas solicitadas no serviço de armazenamento.

Throws:

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

listQueuesSegmented

public ResultSegment listQueuesSegmented(final String prefix)

Obtém um segmento de resultado de uma coleção iterável de filas cujos nomes começam com o prefixo especificado para esse cliente de serviço Queue.

Parameters:

prefix

Returns:

Um ResultSegment<T> dos CloudQueue objetos que contém um segmento da coleção iterável de CloudQueue objetos que representam as filas solicitadas no serviço de armazenamento.

Throws:

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

listQueuesSegmented

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

Obtém um segmento de resultado de uma coleção iterável de filas cujos nomes começam com o prefixo especificado para essa fila, usando as opções de detalhes de listagem especificadas, opções de solicitação e contexto de operação.

Parameters:

prefix - Um String que representa o prefixo do nome da fila a ser correspondido.

detailsIncluded - Um QueueListingDetails valor que indica se os metadados da fila serão retornados.

maxResults - O número máximo de resultados a serem recuperados. Se null ou maior que 5000, o servidor retornará até 5.000 itens. Deve ser pelo menos 1.

continuationToken - Um ResultContinuation objeto que representa um token de continuação retornado por uma operação de listagem anterior.

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.

Returns:

Um ResultSegment<T> dos CloudQueue objetos que contém um segmento da coleção iterável de CloudQueue objetos que representam as filas solicitadas no serviço de armazenamento.

Throws:

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

setDefaultRequestOptions

public void setDefaultRequestOptions(QueueRequestOptions defaultRequestOptions)

Define o QueueRequestOptions usado para qualquer fila acessada com esse objeto.

Parameters:

defaultRequestOptions - O QueueRequestOptions a ser usado.

uploadServiceProperties

public void uploadServiceProperties(final ServiceProperties properties)

Carrega uma nova ServiceProperties configuração para o serviço de armazenamento especificado. Isso inclui configurações de Log, HourMetrics, MinuteMetrics e CORS.

Parameters:

properties - O ServiceProperties a ser carregado.

Throws:

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

uploadServiceProperties

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

Carrega uma nova ServiceProperties configuração para o serviço de armazenamento especificado. Isso inclui configurações de Log, HourMetrics, MinuteMetrics e CORS.

Parameters:

properties - O ServiceProperties a ser carregado.

options - Um BlobRequestOptions 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 ( CloudBlobClient).

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.