CloudQueue Clase

Paquete:

com.microsoft.azure.storage.queue

• java.lang.Object
• • com.microsoft.azure.storage.queue.CloudQueue

public class CloudQueue

Esta clase representa una cola en Microsoft Azure Queue Service.

Resumen del constructor

Constructor	Description
CloudQueue(final StorageUri uri)	Crea una instancia de la clase mediante la cola especificada. La cola debe incluir un token de SAS.
CloudQueue(final StorageUri uri, final StorageCredentials credentials)	Crea una instancia de la clase mediante la cola y las credenciales especificadas. Si contiene un token de SAS, las credenciales deben ser .
CloudQueue(final String queueName, final CloudQueueClient client)	Crea una instancia de la clase utilizando el nombre y el cliente especificados.
CloudQueue(final URI uri)	Crea una instancia de la clase mediante el URI de cola especificado. La cola debe incluir un token de SAS.
CloudQueue(final URI uri, final StorageCredentials credentials)	Crea una instancia de la clase mediante la cola y las credenciales especificadas. Si contiene un token de SAS, las credenciales deben ser .

Resumen del método

Modificador y tipo	Método y descripción
void	addMessage(final CloudQueueMessage message) Agrega un mensaje a la parte posterior de la cola.
void	addMessage(final CloudQueueMessage message, final int timeToLiveInSeconds, final int initialVisibilityDelayInSeconds, QueueRequestOptions options, OperationContext opContext) Agrega un mensaje a la parte posterior de la cola con las opciones especificadas.
void	clear() Borra todos los mensajes de la cola.
void	clear(QueueRequestOptions options, OperationContext opContext) Borra todos los mensajes de la cola mediante las opciones de solicitud y el contexto de operación especificados.
void	create() Crea la cola.
void	create(QueueRequestOptions options, OperationContext opContext) Crea la cola con las opciones de solicitud y el contexto de operación especificados.
boolean	createIfNotExists() Crea la cola si no existe todavía.
boolean	createIfNotExists(QueueRequestOptions options, OperationContext opContext) Crea la cola si aún no existe, con las opciones de solicitud y el contexto de operación especificados.
void	delete() Elimina la cola.
void	delete(QueueRequestOptions options, OperationContext opContext) Elimina la cola mediante las opciones de solicitud y el contexto de operación especificados.
boolean	deleteIfExists() Elimina la cola si existe.
boolean	deleteIfExists(QueueRequestOptions options, OperationContext opContext) Elimina la cola si existe, con las opciones de solicitud y el contexto de operación especificados.
void	deleteMessage(final CloudQueueMessage message) Elimina el mensaje especificado de la cola.
void	deleteMessage(final CloudQueueMessage message, QueueRequestOptions options, OperationContext opContext) Elimina el mensaje especificado de la cola mediante las opciones de solicitud y el contexto de operación especificados.
void	downloadAttributes() Descarga los metadatos de la cola y el valor aproximado del recuento de mensajes.
void	downloadAttributes(QueueRequestOptions options, OperationContext opContext) Descarga los metadatos de la cola y el valor aproximado del recuento de mensajes mediante las opciones de solicitud y el contexto de operación especificados.
QueuePermissions	downloadPermissions() Descarga la configuración de permisos de la cola.
QueuePermissions	downloadPermissions(QueueRequestOptions options, OperationContext opContext) Descarga la configuración de permisos de la cola mediante las opciones de solicitud y el contexto de operación especificados.
boolean	exists() Devuelve un valor que indica si existe la cola.
boolean	exists(QueueRequestOptions options, OperationContext opContext) Devuelve un valor que indica si la cola existe, utilizando las opciones de solicitud y el contexto de operación especificados.
String	generateSharedAccessSignature(final SharedAccessQueuePolicy policy, final String groupPolicyIdentifier) Devuelve una firma de acceso compartido para la cola.
String	generateSharedAccessSignature(final SharedAccessQueuePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols) Devuelve una firma de acceso compartido para la cola.
long	getApproximateMessageCount() Obtiene el recuento aproximado de mensajes de la cola. Este valor se inicializa mediante una solicitud a downloadAttributes() y representa el recuento aproximado de mensajes cuando se completa esa solicitud.
HashMap<String, String>	getMetadata() Obtiene la colección de metadatos de la cola como se almacena en este objeto. Este valor se inicializa con los metadatos de la cola mediante una llamada a downloadAttributes()y se establece en la cola con una llamada a uploadMetadata().
String	getName() Obtiene el nombre de la cola.
CloudQueueClient	getServiceClient() Obtiene el cliente del servicio de cola asociado a esta cola.
boolean	getShouldEncodeMessage() Obtiene el valor que indica si el mensaje debe estar codificado en base 64.
final StorageUri	getStorageUri() Devuelve la lista de URI para todas las ubicaciones.
URI	getUri() Obtiene el URI absoluto de esta cola.
CloudQueueMessage	peekMessage() Busca un mensaje de la cola. Una solicitud de inspección recupera un mensaje desde la parte frontal de la cola sin cambiar su visibilidad.
CloudQueueMessage	peekMessage(final QueueRequestOptions options, final OperationContext opContext) Busca un mensaje de la cola mediante las opciones de solicitud y el contexto de operación especificados. Una solicitud de inspección recupera un mensaje de la parte delantera de la cola sin cambiar su visibilidad.
Iterable<CloudQueueMessage>	peekMessages(final int numberOfMessages) Busca un número especificado de mensajes de la cola. Una solicitud de inspección recupera los mensajes de la parte delantera de la cola sin cambiar su visibilidad.
Iterable<CloudQueueMessage>	peekMessages(final int numberOfMessages, QueueRequestOptions options, OperationContext opContext) Busca un conjunto de mensajes de la cola mediante las opciones de solicitud y el contexto de operación especificados. Una solicitud de inspección recupera los mensajes de la parte delantera de la cola sin cambiar su visibilidad.
CloudQueueMessage	retrieveMessage() Recupera un mensaje de la parte delantera de la cola mediante las opciones de solicitud predeterminadas. Esta operación marca el mensaje recuperado como invisible en la cola para el período de tiempo de espera de visibilidad predeterminado.
CloudQueueMessage	retrieveMessage(final int visibilityTimeoutInSeconds, final QueueRequestOptions options, final OperationContext opContext) Recupera un mensaje de la parte delantera de la cola mediante las opciones de solicitud y el contexto de operación especificados. Esta operación marca el mensaje recuperado como invisible en la cola para el período de tiempo de espera de visibilidad especificado.
Iterable<CloudQueueMessage>	retrieveMessages(final int numberOfMessages) Recupera el número especificado de mensajes de la parte delantera de la cola mediante las opciones de solicitud predeterminadas. Esta operación marca los mensajes recuperados como invisibles en la cola para el período de tiempo de espera de visibilidad predeterminado.
Iterable<CloudQueueMessage>	retrieveMessages(final int numberOfMessages, final int visibilityTimeoutInSeconds, QueueRequestOptions options, OperationContext opContext) Recupera el número especificado de mensajes de la parte delantera de la cola mediante las opciones de solicitud y el contexto de operación especificados. Esta operación marca los mensajes recuperados como invisibles en la cola para el período de tiempo de espera de visibilidad predeterminado.
void	setMetadata(final HashMap<String, String> metadata) Establece la colección de metadatos de pares nombre-valor que se van a establecer en la cola con una uploadMetadata() llamada. Esta colección sobrescribirá los metadatos de cola existentes. Si se establece en una colección vacía, los metadatos de la cola se borrarán en una uploadMetadata() llamada.
void	setShouldEncodeMessage(final boolean shouldEncodeMessage) Establece la marca que indica si el mensaje debe estar codificado en base 64.
void	updateMessage(final CloudQueueMessage message, final int visibilityTimeoutInSeconds) Novedades el mensaje especificado en la cola con un nuevo valor de tiempo de espera de visibilidad en segundos.
void	updateMessage(final CloudQueueMessage message, final int visibilityTimeoutInSeconds, final EnumSet<MessageUpdateFields> messageUpdateFields, QueueRequestOptions options, OperationContext opContext) Novedades un mensaje de la cola, utilizando las opciones de solicitud y el contexto de operación especificados.
void	uploadMetadata() Carga los metadatos del objeto en la cola.
void	uploadMetadata(QueueRequestOptions options, OperationContext opContext) Carga los metadatos del objeto en la cola mediante las opciones de solicitud y el contexto de operación especificados.
void	uploadPermissions(final QueuePermissions permissions) Carga los permisos de la cola.
void	uploadPermissions(final QueuePermissions permissions, QueueRequestOptions options, OperationContext opContext) Carga los permisos de la cola mediante las opciones de solicitud y el contexto de operación especificados.

Detalles del constructor

CloudQueue

public CloudQueue(final StorageUri uri)

Crea una instancia de la clase mediante la cola especificada. La cola debe incluir un token de SAS.

Parameters:

uri - Objeto StorageUri que representa el URI absoluto de la cola.

Throws:

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

CloudQueue

public CloudQueue(final StorageUri uri, final StorageCredentials credentials)

Crea una instancia de la clase mediante la cola y las credenciales especificadas. Si contiene un token de SAS, las credenciales deben ser .

Parameters:

uri - Objeto StorageUri que representa el URI absoluto de la cola.

credentials - Objeto StorageCredentials utilizado para autenticar el acceso.

Throws:

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

CloudQueue

protected CloudQueue(final String queueName, final CloudQueueClient client)

Crea una instancia de la clase utilizando el nombre y el cliente especificados.

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 guión (-).

client - Objeto CloudQueueClient que representa el cliente de servicio asociado y que especifica el punto de conexión del servicio Queue.

Throws:

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

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

CloudQueue

public CloudQueue(final URI uri)

Crea una instancia de la clase mediante el URI de cola especificado. La cola debe incluir un token de SAS.

Parameters:

uri - Objeto java.net.URI que representa el URI absoluto de la cola.

Throws:

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

CloudQueue

public CloudQueue(final URI uri, final StorageCredentials credentials)

Crea una instancia de la clase mediante la cola y las credenciales especificadas. Si contiene un token de SAS, las credenciales deben ser .

Parameters:

uri - Objeto java.net.URI que representa el URI absoluto de la cola.

credentials - Objeto StorageCredentials utilizado para autenticar el acceso.

Throws:

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

Detalles del método

addMessage

public void addMessage(final CloudQueueMessage message)

Agrega un mensaje a la parte posterior de la cola.

Parameters:

message - Objeto CloudQueueMessage que especifica el mensaje que se va a agregar. El objeto message se modifica para incluir el identificador de mensaje y la recepción pop, y se puede usar en llamadas posteriores para updateMessage y deleteMessage.

Throws:

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

addMessage

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

Agrega un mensaje a la parte posterior de la cola con las opciones especificadas.

Parameters:

message - Objeto CloudQueueMessage que especifica el mensaje que se va a agregar. El objeto message se modifica para incluir el identificador de mensaje y la recepción pop, y se puede usar en llamadas posteriores para updateMessage y deleteMessage.

timeToLiveInSeconds - Tiempo máximo que el mensaje puede estar en la cola. Un valor de cero establecerá el período de vida en el valor predeterminado del servicio de siete días. Un valor de negativo establecerá un período de vida infinito.

initialVisibilityDelayInSeconds - El período de tiempo durante el que el mensaje será invisible, empezando cuando se agrega a la cola o 0 para que el mensaje sea visible inmediatamente. Este valor debe ser mayor o igual que cero y menor que el valor de período de vida.

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

Throws:

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

clear

public void clear()

Borra todos los mensajes de la cola.

Throws:

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

clear

public void clear(QueueRequestOptions options, OperationContext opContext)

Borra todos los mensajes de la cola mediante las opciones de solicitud y el contexto de operación especificados.

Parameters:

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

Throws:

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

create

public void create()

Crea la cola.

Throws:

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

create

public void create(QueueRequestOptions options, OperationContext opContext)

Crea la cola con las opciones de solicitud y el contexto de operación especificados.

Parameters:

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

Throws:

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

createIfNotExists

public boolean createIfNotExists()

Crea la cola si no existe todavía.

Returns:

Valor de true si la cola se crea en el servicio de almacenamiento; de lo contrario, false

Throws:

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

createIfNotExists

public boolean createIfNotExists(QueueRequestOptions options, OperationContext opContext)

Crea la cola si aún no existe, con las opciones de solicitud y el contexto de operación especificados.

Parameters:

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 ( 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:

Valor de true si la cola se crea en el servicio de almacenamiento; de lo contrario, false

Throws:

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

delete

public void delete()

Elimina la cola.

Throws:

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

delete

public void delete(QueueRequestOptions options, OperationContext opContext)

Elimina la cola mediante las opciones de solicitud y el contexto de operación especificados.

Parameters:

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

Throws:

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

deleteIfExists

public boolean deleteIfExists()

Elimina la cola si existe.

Returns:

Valor de true si la cola existía en el servicio de almacenamiento y se ha eliminado; de lo contrario false, .

Throws:

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

deleteIfExists

public boolean deleteIfExists(QueueRequestOptions options, OperationContext opContext)

Elimina la cola si existe, con las opciones de solicitud y el contexto de operación especificados.

Parameters:

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 ( 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:

Valor de true si la cola existía en el servicio de almacenamiento y se ha eliminado; de lo contrario false, .

Throws:

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

deleteMessage

public void deleteMessage(final CloudQueueMessage message)

Elimina el mensaje especificado de la cola.

Parameters:

message - Objeto CloudQueueMessage que especifica el mensaje que se va a eliminar.

Throws:

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

deleteMessage

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

Elimina el mensaje especificado de la cola mediante las opciones de solicitud y el contexto de operación especificados.

Parameters:

message - Objeto CloudQueueMessage que especifica el mensaje que se va a eliminar.

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

Throws:

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

downloadAttributes

public void downloadAttributes()

Descarga los metadatos de la cola y el valor aproximado del recuento de mensajes.

Throws:

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

downloadAttributes

public void downloadAttributes(QueueRequestOptions options, OperationContext opContext)

Descarga los metadatos de la cola y el valor aproximado del recuento de mensajes mediante las opciones de solicitud y el contexto de operación especificados.

Parameters:

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.

Throws:

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

downloadPermissions

public QueuePermissions downloadPermissions()

Descarga la configuración de permisos de la cola.

Returns:

Objeto QueuePermissions que representa los permisos de la cola.

Throws:

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

downloadPermissions

public QueuePermissions downloadPermissions(QueueRequestOptions options, OperationContext opContext)

Descarga la configuración de permisos de la cola mediante las opciones de solicitud y el contexto de operación especificados.

Parameters:

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 ( 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 QueuePermissions que representa los permisos del contenedor.

Throws:

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

exists

public boolean exists()

Devuelve un valor que indica si existe la cola.

Returns:

true si la cola existe en el servicio de almacenamiento; de lo contrario false, .

Throws:

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

exists

public boolean exists(QueueRequestOptions options, OperationContext opContext)

Devuelve un valor que indica si la cola existe, utilizando las opciones de solicitud y el contexto de operación especificados.

Parameters:

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 ( 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:

true si la cola existe en el servicio de almacenamiento; de lo contrario false, .

Throws:

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

generateSharedAccessSignature

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

Devuelve una firma de acceso compartido para la cola.

Parameters:

policy - Directiva de acceso para la firma de acceso compartido.

groupPolicyIdentifier - Directiva de acceso de nivel de cola.

Returns:

Firma de acceso compartido para la cola.

Throws:

InvalidKeyException - Si se pasó una clave no válida.

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

IllegalArgumentException - Si se pasa un valor inesperado.

generateSharedAccessSignature

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

Devuelve una firma de acceso compartido para la cola.

Parameters:

policy - Directiva de acceso para la firma de acceso compartido.

groupPolicyIdentifier - Directiva de acceso de nivel de cola.

ipRange - Objeto IPRange que contiene el intervalo de direcciones IP permitidas.

protocols - que SharedAccessProtocols representa los protocolos de Internet permitidos.

Returns:

Firma de acceso compartido para la cola.

Throws:

InvalidKeyException - Si se pasó una clave no válida.

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

IllegalArgumentException - Si se pasa un valor inesperado.

getApproximateMessageCount

public long getApproximateMessageCount()

Obtiene el recuento aproximado de mensajes de la cola. Este valor se inicializa mediante una solicitud a downloadAttributes() y representa el recuento aproximado de mensajes cuando se completa esa solicitud.

Returns:

Objeto Long que representa el recuento aproximado de mensajes de la cola.

getMetadata

public HashMap getMetadata()

Obtiene la colección de metadatos de la cola como se almacena en este objeto. Este valor se inicializa con los metadatos de la cola mediante una llamada a downloadAttributes()y se establece en la cola con una llamada a uploadMetadata().

Returns:

Objeto java.util.HashMap que representa los metadatos de la cola.

getName

public String getName()

Obtiene el nombre de la cola.

Returns:

Objeto String que representa el nombre de la cola.

getServiceClient

public CloudQueueClient getServiceClient()

Obtiene el cliente del servicio de cola asociado a esta cola.

Returns:

Objeto CloudQueueClient que representa el cliente de servicio asociado a esta cola.

getShouldEncodeMessage

public boolean getShouldEncodeMessage()

Obtiene el valor que indica si el mensaje debe estar codificado en base 64.

Returns:

que Boolean representa si el mensaje debe estar codificado en base 64.

getStorageUri

public final StorageUri getStorageUri()

Devuelve la lista de URI para todas las ubicaciones.

Returns:

que StorageUri representa la lista de URI para todas las ubicaciones.

getUri

public URI getUri()

Obtiene el URI absoluto de esta cola.

Returns:

Objeto java.net.URI que representa el URI de esta cola.

peekMessage

public CloudQueueMessage peekMessage()

Busca un mensaje de la cola. Una solicitud de inspección recupera un mensaje desde la parte frontal de la cola sin cambiar su visibilidad.

Returns:

Objeto CloudQueueMessage que representa un mensaje en esta cola.

Throws:

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

peekMessage

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

Busca un mensaje de la cola mediante las opciones de solicitud y el contexto de operación especificados. Una solicitud de inspección recupera un mensaje de la parte delantera de la cola sin cambiar su visibilidad.

Parameters:

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 ( 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 CloudQueueMessage que representa el mensaje solicitado de la cola.

Throws:

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

peekMessages

public Iterable peekMessages(final int numberOfMessages)

Busca un número especificado de mensajes de la cola. Una solicitud de inspección recupera los mensajes de la parte delantera de la cola sin cambiar su visibilidad.

Parameters:

numberOfMessages - Número de mensajes que se van a recuperar.

Returns:

Colección enumerable de CloudQueueMessage objetos que representa los mensajes solicitados de la cola.

Throws:

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

peekMessages

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

Busca un conjunto de mensajes de la cola mediante las opciones de solicitud y el contexto de operación especificados. Una solicitud de inspección recupera los mensajes de la parte delantera de la cola sin cambiar su visibilidad.

Parameters:

numberOfMessages - Número de mensajes que se van a recuperar.

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:

Colección enumerable de CloudQueueMessage objetos que representa los mensajes solicitados de la cola.

Throws:

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

retrieveMessage

public CloudQueueMessage retrieveMessage()

Recupera un mensaje de la parte delantera de la cola mediante las opciones de solicitud predeterminadas. Esta operación marca el mensaje recuperado como invisible en la cola para el período de tiempo de espera de visibilidad predeterminado.

Returns:

Objeto CloudQueueMessage que representa un mensaje en esta cola.

Throws:

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

retrieveMessage

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

Recupera un mensaje de la parte delantera de la cola mediante las opciones de solicitud y el contexto de operación especificados. Esta operación marca el mensaje recuperado como invisible en la cola para el período de tiempo de espera de visibilidad especificado.

Parameters:

visibilityTimeoutInSeconds - Especifica el tiempo de espera de visibilidad del mensaje, en segundos.

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 CloudQueueMessage que representa un mensaje en esta cola.

Throws:

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

retrieveMessages

public Iterable retrieveMessages(final int numberOfMessages)

Recupera el número especificado de mensajes de la parte delantera de la cola mediante las opciones de solicitud predeterminadas. Esta operación marca los mensajes recuperados como invisibles en la cola para el período de tiempo de espera de visibilidad predeterminado.

Parameters:

numberOfMessages - Número de mensajes que se van a recuperar.

Returns:

Colección enumerable de CloudQueueMessage objetos que representa los mensajes recuperados de la cola.

Throws:

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

retrieveMessages

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

Recupera el número especificado de mensajes de la parte delantera de la cola mediante las opciones de solicitud y el contexto de operación especificados. Esta operación marca los mensajes recuperados como invisibles en la cola para el período de tiempo de espera de visibilidad predeterminado.

Parameters:

numberOfMessages - Número de mensajes que se van a recuperar.

visibilityTimeoutInSeconds - Especifica el tiempo de espera de visibilidad de los mensajes recuperados, en segundos.

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:

Colección enumerable de CloudQueueMessage objetos que representa los mensajes recuperados de la cola.

Throws:

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

setMetadata

public void setMetadata(final HashMap metadata)

Establece la colección de metadatos de pares nombre-valor que se van a establecer en la cola con una uploadMetadata() llamada. Esta colección sobrescribirá los metadatos de cola existentes. Si se establece en una colección vacía, los metadatos de la cola se borrarán en una uploadMetadata() llamada.

Parameters:

metadata - Objeto java.util.HashMap que representa los metadatos que se asignan a la cola.

setShouldEncodeMessage

public void setShouldEncodeMessage(final boolean shouldEncodeMessage)

Establece la marca que indica si el mensaje debe estar codificado en base 64.

Parameters:

shouldEncodeMessage - El valor indica si el mensaje debe estar codificado en base 64.

updateMessage

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

Novedades el mensaje especificado en la cola con un nuevo valor de tiempo de espera de visibilidad en segundos.

Parameters:

message - que CloudQueueMessage se va a actualizar en la cola.

visibilityTimeoutInSeconds - Especifica el nuevo tiempo de espera de visibilidad para el mensaje, en segundos.

Throws:

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

updateMessage

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

Novedades un mensaje de la cola, utilizando las opciones de solicitud y el contexto de operación especificados.

Parameters:

message - que CloudQueueMessage se va a actualizar en la cola.

visibilityTimeoutInSeconds - Especifica el nuevo tiempo de espera de visibilidad para el mensaje, en segundos.

messageUpdateFields - de EnumSetMessageUpdateFields valores que especifica qué partes del mensaje se van a actualizar.

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.

Throws:

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

uploadMetadata

public void uploadMetadata()

Carga los metadatos del objeto en la cola.

Throws:

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

uploadMetadata

public void uploadMetadata(QueueRequestOptions options, OperationContext opContext)

Carga los metadatos del objeto en la cola mediante las opciones de solicitud y el contexto de operación especificados.

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.

Throws:

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

uploadPermissions

public void uploadPermissions(final QueuePermissions permissions)

Carga los permisos de la cola.

Parameters:

permissions - Objeto QueuePermissions que representa los permisos para cargar.

Throws:

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

uploadPermissions

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

Carga los permisos de la cola mediante las opciones de solicitud y el contexto de operación especificados.

Parameters:

permissions - Objeto QueuePermissions que representa los permisos para cargar.

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.

Throws:

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