CloudQueueClient Clase

Paquete:

com.microsoft.azure.storage.queue

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

public class CloudQueueClient extends ServiceClient

Proporciona un cliente de servicio para acceder al servicio De cola de Microsoft Azure.

Resumen del constructor

Constructor	Description
CloudQueueClient(final StorageUri baseUri, final StorageCredentials credentials)	Inicializa una nueva instancia de la clase utilizando el punto de conexión de Queue Service y las credenciales de cuenta especificados.
CloudQueueClient(final URI baseUri, final StorageCredentials credentials)	Inicializa una nueva instancia de la clase utilizando el punto de conexión de Queue Service y las credenciales de cuenta especificados.

Resumen del método

Modificador y tipo	Método y descripción
final ServiceProperties	downloadServiceProperties() Recupera el actual ServiceProperties para el servicio de almacenamiento especificado. Esto incluye las configuraciones Logging, HourMetrics, MinuteMetrics y CORS.
final ServiceProperties	downloadServiceProperties(QueueRequestOptions options, OperationContext opContext) Recupera el actual ServiceProperties para el servicio de almacenamiento especificado. Esto incluye las configuraciones Logging, HourMetrics, MinuteMetrics y CORS.
QueueRequestOptions	getDefaultRequestOptions() Obtiene el QueueRequestOptions objeto que se usa para las solicitudes asociadas a este objeto.
CloudQueue	getQueueReference(final String queueName) Obtiene un CloudQueue objeto con el nombre especificado.
ServiceStats	getServiceStats() Consulta el servicio para .ServiceStats
ServiceStats	getServiceStats(QueueRequestOptions options, OperationContext opContext) Consulta el servicio para .ServiceStats
boolean	isUsePathStyleUris()
Iterable<CloudQueue>	listQueues() Obtiene una colección iterable de colas para este cliente de queue service.
Iterable<CloudQueue>	listQueues(final String prefix) Devuelve una colección iterable de colas cuyos nombres comienzan por el prefijo especificado en este cliente de Queue Service.
Iterable<CloudQueue>	listQueues(final String prefix, final QueueListingDetails detailsIncluded, QueueRequestOptions options, OperationContext opContext) Devuelve una colección iterable de colas cuyos nombres comienzan con el prefijo especificado para este cliente de Queue Service, utilizando la configuración de detalles, las opciones de solicitud y el contexto de operación especificados.
ResultSegment<CloudQueue>	listQueuesSegmented() Obtiene un segmento de resultado de una colección iterable de colas para este cliente de Queue Service.
ResultSegment<CloudQueue>	listQueuesSegmented(final String prefix) Obtiene un segmento de resultado de una colección iterable de colas cuyos nombres comienzan con el prefijo especificado para este cliente de Queue Service.
ResultSegment<CloudQueue>	listQueuesSegmented(final String prefix, final QueueListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, QueueRequestOptions options, OperationContext opContext) Obtiene un segmento de resultado de una colección iterable de colas cuyos nombres comienzan con el prefijo especificado para esta cola, utilizando las opciones de detalles de lista especificadas, las opciones de solicitud y el contexto de operación.
void	setDefaultRequestOptions(QueueRequestOptions defaultRequestOptions) Establece el QueueRequestOptions objeto que se usa para cualquier cola a la que se tiene acceso con este objeto.
void	uploadServiceProperties(final ServiceProperties properties) Carga una nueva ServiceProperties configuración en el servicio de almacenamiento determinado. Esto incluye las configuraciones registro, HourMetrics, MinuteMetrics y CORS.
void	uploadServiceProperties(final ServiceProperties properties, QueueRequestOptions options, OperationContext opContext) Carga una nueva ServiceProperties configuración en el servicio de almacenamiento determinado. Esto incluye las configuraciones registro, HourMetrics, MinuteMetrics y CORS.

Miembros heredados

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)

Detalles del constructor

CloudQueueClient

public CloudQueueClient(final StorageUri baseUri, final StorageCredentials credentials)

Inicializa una nueva instancia de la clase utilizando el punto de conexión de Queue Service y las credenciales de cuenta especificados.

Parameters:

baseUri - Objeto StorageUri que representa el punto de conexión de Queue Service usado para crear el cliente.

credentials - Objeto StorageCredentials que representa las credenciales de la cuenta.

CloudQueueClient

public CloudQueueClient(final URI baseUri, final StorageCredentials credentials)

Inicializa una nueva instancia de la clase utilizando el punto de conexión de Queue Service y las credenciales de cuenta especificados.

Parameters:

baseUri - Objeto java.net.URI que representa el punto de conexión de Queue Service usado para crear el cliente.

credentials - Objeto StorageCredentials que representa las credenciales de la cuenta.

Detalles del método

downloadServiceProperties

public final ServiceProperties downloadServiceProperties()

Recupera el actual ServiceProperties para el servicio de almacenamiento especificado. Esto incluye las configuraciones Logging, HourMetrics, MinuteMetrics y CORS.

Returns:

objeto ServiceProperties que representa la configuración actual del servicio.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

downloadServiceProperties

public final ServiceProperties downloadServiceProperties(QueueRequestOptions options, OperationContext opContext)

Recupera el actual ServiceProperties para el servicio de almacenamiento especificado. Esto incluye las configuraciones Logging, HourMetrics, MinuteMetrics y CORS.

Parameters:

options - Objeto QueueRequestOptions que especifica las opciones adicionales para la solicitud. Al especificar null se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudQueueClient).

opContext - Objeto OperationContext que representa el contexto para la operación actual. Este objeto se utiliza para hacer un seguimiento de las solicitudes al servicio de almacenamiento y para proporcionar información adicional en tiempo de ejecución sobre la operación.

Returns:

objeto ServiceProperties que representa la configuración actual del servicio.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

getDefaultRequestOptions

public QueueRequestOptions getDefaultRequestOptions()

Obtiene el QueueRequestOptions objeto que se usa para las solicitudes asociadas a este objeto.

Returns:

Objeto QueueRequestOptions que contiene los valores utilizados por este objeto. CloudQueueClient

getQueueReference

public CloudQueue getQueueReference(final String queueName)

Obtiene un CloudQueue objeto con el nombre especificado.

Parameters:

queueName - Nombre de la cola, que debe cumplir las reglas de nomenclatura de cola. El nombre de la cola no debe incluir ningún carácter separador de ruta de acceso (/). Los nombres de cola deben estar en minúsculas, entre 3 y 63 caracteres y deben comenzar con una letra o un número. Los nombres de cola solo pueden contener letras, números y el carácter de guion (-).

Returns:

Referencia a un objeto CloudQueue.

Throws:

URISyntaxException - Si el URI del recurso construido basado en queueName no es válido.

StorageException - Si se produjo un error en el servicio de almacenamiento.

getServiceStats

public ServiceStats getServiceStats()

Consulta el servicio para .ServiceStats

Returns:

ServiceStats para el servicio de almacenamiento especificado

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

getServiceStats

public ServiceStats getServiceStats(QueueRequestOptions options, OperationContext opContext)

Consulta el servicio para .ServiceStats

Parameters:

options - Objeto QueueRequestOptions que especifica las opciones adicionales para la solicitud. Al especificar null se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudQueueClient).

opContext - Objeto OperationContext que representa el contexto para la operación actual. Este objeto se utiliza para hacer un seguimiento de las solicitudes al servicio de almacenamiento y para proporcionar información adicional en tiempo de ejecución sobre la operación.

Returns:

ServiceStats para el servicio de almacenamiento especificado

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

isUsePathStyleUris

protected boolean isUsePathStyleUris()

Returns:

usePathStyleUris

listQueues

public Iterable listQueues()

Obtiene una colección iterable de colas para este cliente de queue service.

Returns:

Colección iterable de CloudQueue objetos recuperados de forma diferida que representan las colas de este cliente.

listQueues

public Iterable listQueues(final String prefix)

Devuelve una colección iterable de colas cuyos nombres comienzan por el prefijo especificado en este cliente de Queue Service.

Parameters:

prefix - que String representa el prefijo de nombre de cola.

Returns:

Colección iterable de CloudQueue objetos recuperados de forma diferida que representan las colas de este cliente cuyos nombres comienzan por el prefijo especificado.

listQueues

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

Devuelve una colección iterable de colas cuyos nombres comienzan con el prefijo especificado para este cliente de Queue Service, utilizando la configuración de detalles, las opciones de solicitud y el contexto de operación especificados.

Parameters:

prefix - que String representa el prefijo de nombre de cola.

detailsIncluded - Valor QueueListingDetails que indica si se devolverán los metadatos de la cola.

options - Objeto QueueRequestOptions que especifica las opciones adicionales para la solicitud. Al especificar null se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudQueue).

opContext - Objeto OperationContext que representa el contexto para la operación actual. Este objeto se utiliza para hacer un seguimiento de las solicitudes al servicio de almacenamiento y para proporcionar información adicional en tiempo de ejecución sobre la operación.

Returns:

Colección iterable de CloudQueue objetos recuperados de forma diferida que representa las colas especificadas para este cliente.

listQueuesSegmented

public ResultSegment listQueuesSegmented()

Obtiene un segmento de resultado de una colección iterable de colas para este cliente de Queue Service.

Returns:

de ResultSegment<T>CloudQueue objetos que contiene un segmento de la colección iterable de CloudQueue objetos que representan las colas solicitadas en el servicio de almacenamiento.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento durante la operación.

listQueuesSegmented

public ResultSegment listQueuesSegmented(final String prefix)

Obtiene un segmento de resultado de una colección iterable de colas cuyos nombres comienzan con el prefijo especificado para este cliente de Queue Service.

Parameters:

prefix

Returns:

de ResultSegment<T>CloudQueue objetos que contiene un segmento de la colección iterable de CloudQueue objetos que representan las colas solicitadas en el servicio de almacenamiento.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento durante la operación.

listQueuesSegmented

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

Obtiene un segmento de resultado de una colección iterable de colas cuyos nombres comienzan con el prefijo especificado para esta cola, utilizando las opciones de detalles de lista especificadas, las opciones de solicitud y el contexto de operación.

Parameters:

prefix - que String representa el prefijo del nombre de la cola que debe coincidir.

detailsIncluded - Valor QueueListingDetails que indica si se devolverán metadatos de cola.

maxResults - Número máximo de resultados que se van a recuperar. Si null o superior a 5000, el servidor devolverá hasta 5000 elementos. Debe ser 1 como mínimo.

continuationToken - Objeto ResultContinuation que representa un token de continuación devuelto por una operación de lista anterior.

options - Objeto QueueRequestOptions que especifica las opciones adicionales de la solicitud. Al especificar null , se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudQueue).

opContext - Objeto OperationContext que representa el contexto para la operación actual. Este objeto se utiliza para hacer un seguimiento de las solicitudes al servicio de almacenamiento y para proporcionar información adicional en tiempo de ejecución sobre la operación.

Returns:

de ResultSegment<T>CloudQueue objetos que contiene un segmento de la colección iterable de CloudQueue objetos que representan las colas solicitadas en el servicio de almacenamiento.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento durante la operación.

setDefaultRequestOptions

public void setDefaultRequestOptions(QueueRequestOptions defaultRequestOptions)

Establece el QueueRequestOptions objeto que se usa para cualquier cola a la que se tiene acceso con este objeto.

Parameters:

defaultRequestOptions - QueueRequestOptions que se va a usar.

uploadServiceProperties

public void uploadServiceProperties(final ServiceProperties properties)

Carga una nueva ServiceProperties configuración en el servicio de almacenamiento determinado. Esto incluye las configuraciones registro, HourMetrics, MinuteMetrics y CORS.

Parameters:

properties - que ServiceProperties se va a cargar.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.

uploadServiceProperties

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

Carga una nueva ServiceProperties configuración en el servicio de almacenamiento determinado. Esto incluye las configuraciones registro, HourMetrics, MinuteMetrics y CORS.

Parameters:

properties - que ServiceProperties se va a cargar.

options - Objeto BlobRequestOptions que especifica las opciones adicionales de la solicitud. Al especificar null , se usarán las opciones de solicitud predeterminadas del cliente de servicio asociado ( CloudBlobClient).

opContext - Objeto OperationContext que representa el contexto para la operación actual. Este objeto se utiliza para hacer un seguimiento de las solicitudes al servicio de almacenamiento y para proporcionar información adicional en tiempo de ejecución sobre la operación.

Throws:

StorageException - Si se produjo un error en el servicio de almacenamiento.