Partager via

CloudQueue Classe

  • Référence
Paquet:
com.microsoft.azure.storage.queue
  • java.lang.Object
    • com.microsoft.azure.storage.queue.CloudQueue

public class CloudQueue

Cette classe représente une file d’attente dans le service file d’attente Microsoft Azure.

Récapitulatif du constructeur

Constructeur Description
CloudQueue(final StorageUri uri)

Crée un instance de la classe à l’aide de la file d’attente spécifiée. La file d’attente doit inclure un jeton SAP.
CloudQueue(final StorageUri uri, final StorageCredentials credentials)

Crée un instance de la classe à l’aide de la file d’attente et des informations d’identification spécifiées. Si contient un jeton SAS, les informations d’identification doivent être .
CloudQueue(final String queueName, final CloudQueueClient client)

Crée un instance de la classe à l’aide du nom et du client spécifiés.
CloudQueue(final URI uri)

Crée un instance de la classe à l’aide de l’URI de file d’attente spécifié. La file d’attente doit inclure un jeton SAP.
CloudQueue(final URI uri, final StorageCredentials credentials)

Crée un instance de la classe à l’aide de la file d’attente et des informations d’identification spécifiées. Si contient un jeton SAS, les informations d’identification doivent être .

Résumé de la méthode

Modificateur et type Méthode et description
void addMessage(final CloudQueueMessage message)

Ajoute un message à l’arrière de la file d’attente.
void addMessage(final CloudQueueMessage message, final int timeToLiveInSeconds, final int initialVisibilityDelayInSeconds, QueueRequestOptions options, OperationContext opContext)

Ajoute un message à l’arrière de la file d’attente avec les options spécifiées.
void clear()

Efface tous les messages de la file d'attente.
void clear(QueueRequestOptions options, OperationContext opContext)

Efface tous les messages de la file d’attente à l’aide des options de requête et du contexte d’opération spécifiés.
void create()

Crée la file d'attente.
void create(QueueRequestOptions options, OperationContext opContext)

Crée la file d’attente à l’aide des options de requête et du contexte d’opération spécifiés.
boolean createIfNotExists()

Crée la file d'attente, si elle n'existe pas encore.
boolean createIfNotExists(QueueRequestOptions options, OperationContext opContext)

Crée la file d’attente si elle n’existe pas déjà, à l’aide des options de requête et du contexte d’opération spécifiés.
void delete()

Supprime la file d'attente.
void delete(QueueRequestOptions options, OperationContext opContext)

Supprime la file d’attente à l’aide des options de requête et du contexte d’opération spécifiés.
boolean deleteIfExists()

Supprime la file d'attente, si elle existe.
boolean deleteIfExists(QueueRequestOptions options, OperationContext opContext)

Supprime la file d’attente si elle existe, à l’aide des options de requête et du contexte d’opération spécifiés.
void deleteMessage(final CloudQueueMessage message)

Supprime le message spécifié de la file d’attente.
void deleteMessage(final CloudQueueMessage message, QueueRequestOptions options, OperationContext opContext)

Supprime le message spécifié de la file d’attente à l’aide des options de requête et du contexte d’opération spécifiés.
void downloadAttributes()

Télécharge les métadonnées de la file d’attente et la valeur approximative du nombre de messages.
void downloadAttributes(QueueRequestOptions options, OperationContext opContext)

Télécharge les métadonnées de la file d’attente et la valeur approximative du nombre de messages, à l’aide des options de requête et du contexte d’opération spécifiés.
QueuePermissions downloadPermissions()

Télécharge les paramètres d’autorisation pour la file d’attente.
QueuePermissions downloadPermissions(QueueRequestOptions options, OperationContext opContext)

Télécharge les paramètres d’autorisations pour la file d’attente à l’aide des options de requête et du contexte d’opération spécifiés.
boolean exists()

Retourne une valeur qui indique si la file d’attente existe.
boolean exists(QueueRequestOptions options, OperationContext opContext)

Retourne une valeur qui indique si la file d’attente existe, à l’aide des options de requête et du contexte d’opération spécifiés.
String generateSharedAccessSignature(final SharedAccessQueuePolicy policy, final String groupPolicyIdentifier)

Retourne une signature d'accès partagé pour la file d'attente.
String generateSharedAccessSignature(final SharedAccessQueuePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)

Retourne une signature d'accès partagé pour la file d'attente.
long getApproximateMessageCount()

Obtient le nombre approximatif de messages de la file d’attente. Cette valeur est initialisée par une demande adressée à downloadAttributes() et représente le nombre approximatif de messages lorsque cette demande est terminée.
HashMap<String, String> getMetadata()

Obtient la collection de métadonnées de la file d’attente telle qu’elle est stockée dans cet objet. Cette valeur est initialisée avec les métadonnées de la file d’attente par un appel à downloadAttributes(), et est définie sur la file d’attente avec un appel à uploadMetadata().
String getName()

Obtient le nom de la file d'attente.
CloudQueueClient getServiceClient()

Obtient le client du service de file d’attente associé à cette file d’attente.
boolean getShouldEncodeMessage()

Obtient la valeur indiquant si le message doit être encodé en base 64.
final StorageUri getStorageUri()

Retourne la liste des URI pour tous les emplacements.
URI getUri()

Obtient l’URI absolu pour cette file d’attente.
CloudQueueMessage peekMessage()

Affiche un message de la file d’attente. Une demande d’aperçu récupère un message à l’avant de la file d’attente sans modifier sa visibilité.
CloudQueueMessage peekMessage(final QueueRequestOptions options, final OperationContext opContext)

Affiche un message de la file d’attente à l’aide des options de requête et du contexte d’opération spécifiés. Une demande d’aperçu récupère un message à l’avant de la file d’attente sans modifier sa visibilité.
Iterable<CloudQueueMessage> peekMessages(final int numberOfMessages)

Affiche un nombre spécifié de messages de la file d’attente. Une demande d’aperçu récupère les messages à l’avant de la file d’attente sans modifier leur visibilité.
Iterable<CloudQueueMessage> peekMessages(final int numberOfMessages, QueueRequestOptions options, OperationContext opContext)

Affiche un ensemble de messages de la file d’attente à l’aide des options de requête et du contexte d’opération spécifiés. Une demande d’aperçu récupère les messages à l’avant de la file d’attente sans modifier leur visibilité.
CloudQueueMessage retrieveMessage()

Récupère un message à l’avant de la file d’attente à l’aide des options de requête par défaut. Cette opération marque le message récupéré comme invisible dans la file d’attente pour la période de visibilité par défaut.
CloudQueueMessage retrieveMessage(final int visibilityTimeoutInSeconds, final QueueRequestOptions options, final OperationContext opContext)

Récupère un message à partir de l’avant de la file d’attente, à l’aide des options de requête et du contexte d’opération spécifiés. Cette opération marque le message récupéré comme invisible dans la file d’attente pour la période de visibilité spécifiée.
Iterable<CloudQueueMessage> retrieveMessages(final int numberOfMessages)

Récupère le nombre spécifié de messages à l’avant de la file d’attente à l’aide des options de requête par défaut. Cette opération marque les messages récupérés comme invisibles dans la file d’attente pour la période de visibilité par défaut.
Iterable<CloudQueueMessage> retrieveMessages(final int numberOfMessages, final int visibilityTimeoutInSeconds, QueueRequestOptions options, OperationContext opContext)

Récupère le nombre spécifié de messages à partir de l’avant de la file d’attente à l’aide des options de requête et du contexte d’opération spécifiés. Cette opération marque les messages récupérés comme invisibles dans la file d’attente pour la période de visibilité par défaut.
void setMetadata(final HashMap<String, String> metadata)

Définit la collection de métadonnées des paires nom-valeur à définir dans la file d’attente avec un uploadMetadata() appel. Cette collection remplacera toutes les métadonnées de file d’attente existantes. Si cette valeur est définie sur une collection vide, les métadonnées de la file d’attente sont effacées lors d’un uploadMetadata() appel.
void setShouldEncodeMessage(final boolean shouldEncodeMessage)

Définit l’indicateur indiquant si le message doit être encodé en base 64.
void updateMessage(final CloudQueueMessage message, final int visibilityTimeoutInSeconds)

Mises à jour le message spécifié dans la file d’attente avec une nouvelle valeur de délai d’expiration de visibilité en secondes.
void updateMessage(final CloudQueueMessage message, final int visibilityTimeoutInSeconds, final EnumSet<MessageUpdateFields> messageUpdateFields, QueueRequestOptions options, OperationContext opContext)

Mises à jour un message dans la file d’attente, à l’aide des options de requête et du contexte d’opération spécifiés.
void uploadMetadata()

Charge les métadonnées de l’objet dans la file d’attente.
void uploadMetadata(QueueRequestOptions options, OperationContext opContext)

Charge les métadonnées de l’objet dans la file d’attente, à l’aide des options de requête et du contexte d’opération spécifiés.
void uploadPermissions(final QueuePermissions permissions)

Charge les autorisations de la file d’attente.
void uploadPermissions(final QueuePermissions permissions, QueueRequestOptions options, OperationContext opContext)

Charge les autorisations de la file d’attente à l’aide des options de requête et du contexte d’opération spécifiés.

Détails du constructeur

CloudQueue

public CloudQueue(final StorageUri uri)

Crée un instance de la classe à l’aide de la file d’attente spécifiée. La file d’attente doit inclure un jeton SAP.

Parameters:

uri - Objet StorageUri qui représente l’URI absolu de la file d’attente.

Throws:

StorageException - Si une erreur de service de stockage s’est produite.

CloudQueue

public CloudQueue(final StorageUri uri, final StorageCredentials credentials)

Crée un instance de la classe à l’aide de la file d’attente et des informations d’identification spécifiées. Si contient un jeton SAS, les informations d’identification doivent être .

Parameters:

uri - Objet StorageUri qui représente l’URI absolu de la file d’attente.
credentials - Objet StorageCredentials utilisé pour authentifier l’accès.

Throws:

StorageException - Si une erreur de service de stockage s’est produite.

CloudQueue

protected CloudQueue(final String queueName, final CloudQueueClient client)

Crée un instance de la classe à l’aide du nom et du client spécifiés.

Parameters:

queueName - Nom de la file d’attente, qui doit respecter les règles de nommage de file d’attente. Le nom de la file d’attente ne doit pas inclure de caractères séparateurs de chemin (/). Les noms de file d’attente doivent être en minuscules, entre 3 et 63 caractères et doivent commencer par une lettre ou un chiffre. Les noms de file d’attente peuvent contenir uniquement des lettres, des chiffres et le tiret (-).
client - Objet CloudQueueClient qui représente le client de service associé et qui spécifie le point de terminaison du service file d’attente.

Throws:

URISyntaxException - Si l’URI de ressource construit en fonction de queueName n’est pas valide.
StorageException - Si une erreur de service de stockage s’est produite.

CloudQueue

public CloudQueue(final URI uri)

Crée un instance de la classe à l’aide de l’URI de file d’attente spécifié. La file d’attente doit inclure un jeton SAP.

Parameters:

uri - Objet java.net.URI qui représente l’URI absolu de la file d’attente.

Throws:

StorageException - Si une erreur de service de stockage s’est produite.

CloudQueue

public CloudQueue(final URI uri, final StorageCredentials credentials)

Crée un instance de la classe à l’aide de la file d’attente et des informations d’identification spécifiées. Si contient un jeton SAS, les informations d’identification doivent être .

Parameters:

uri - Objet java.net.URI qui représente l’URI absolu de la file d’attente.
credentials - Objet StorageCredentials utilisé pour authentifier l’accès.

Throws:

StorageException - Si une erreur de service de stockage s’est produite.

Détails de la méthode

addMessage

public void addMessage(final CloudQueueMessage message)

Ajoute un message à l’arrière de la file d’attente.

Parameters:

message - Objet CloudQueueMessage qui spécifie le message à ajouter. L’objet message est modifié pour inclure l’ID de message et la réception contextuelle, et peut être utilisé dans les appels suivants pour updateMessage et deleteMessage.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

addMessage

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

Ajoute un message à l’arrière de la file d’attente avec les options spécifiées.

Parameters:

message - Objet CloudQueueMessage qui spécifie le message à ajouter. L’objet message est modifié pour inclure l’ID de message et la réception contextuelle, et peut être utilisé dans les appels suivants pour updateMessage et deleteMessage.
timeToLiveInSeconds - Temps maximum pendant lequel le message reste dans la file d'attente. Une valeur de zéro définit la durée de vie sur la valeur par défaut du service de sept jours. Une valeur négative définit une durée de vie infinie.
initialVisibilityDelayInSeconds - Durée pendant laquelle le message sera invisible, à compter de son ajout à la file d’attente, ou 0 pour rendre le message visible immédiatement. Cette valeur doit être supérieure ou égale à zéro et inférieure à la valeur de durée de vie.
options - Objet QueueRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé ( CloudQueueClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

clear

public void clear()

Efface tous les messages de la file d'attente.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

clear

public void clear(QueueRequestOptions options, OperationContext opContext)

Efface tous les messages de la file d’attente à l’aide des options de requête et du contexte d’opération spécifiés.

Parameters:

options - Objet QueueRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé ( CloudQueueClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

create

public void create()

Crée la file d'attente.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

create

public void create(QueueRequestOptions options, OperationContext opContext)

Crée la file d’attente à l’aide des options de requête et du contexte d’opération spécifiés.

Parameters:

options - Objet QueueRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé ( CloudQueueClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

createIfNotExists

public boolean createIfNotExists()

Crée la file d'attente, si elle n'existe pas encore.

Returns:

Valeur si la file d’attente true est créée dans le service de stockage ; sinon, false

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

createIfNotExists

public boolean createIfNotExists(QueueRequestOptions options, OperationContext opContext)

Crée la file d’attente si elle n’existe pas déjà, à l’aide des options de requête et du contexte d’opération spécifiés.

Parameters:

options - Objet QueueRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé ( CloudQueueClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Returns:

Valeur si la file d’attente true est créée dans le service de stockage ; sinon, false

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

delete

public void delete()

Supprime la file d'attente.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

delete

public void delete(QueueRequestOptions options, OperationContext opContext)

Supprime la file d’attente à l’aide des options de requête et du contexte d’opération spécifiés.

Parameters:

options - Objet QueueRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé ( CloudQueueClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

deleteIfExists

public boolean deleteIfExists()

Supprime la file d'attente, si elle existe.

Returns:

Valeur de si la file d’attente true existait dans le service de stockage et a été supprimée ; sinon false.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

deleteIfExists

public boolean deleteIfExists(QueueRequestOptions options, OperationContext opContext)

Supprime la file d’attente si elle existe, à l’aide des options de requête et du contexte d’opération spécifiés.

Parameters:

options - Objet QueueRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé ( CloudQueueClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Returns:

Valeur de si la file d’attente true existait dans le service de stockage et a été supprimée ; sinon false.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

deleteMessage

public void deleteMessage(final CloudQueueMessage message)

Supprime le message spécifié de la file d’attente.

Parameters:

message - Objet CloudQueueMessage qui spécifie le message à supprimer.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

deleteMessage

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

Supprime le message spécifié de la file d’attente à l’aide des options de requête et du contexte d’opération spécifiés.

Parameters:

message - Objet CloudQueueMessage qui spécifie le message à supprimer.
options - Objet QueueRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé ( CloudQueueClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

downloadAttributes

public void downloadAttributes()

Télécharge les métadonnées de la file d’attente et la valeur approximative du nombre de messages.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

downloadAttributes

public void downloadAttributes(QueueRequestOptions options, OperationContext opContext)

Télécharge les métadonnées de la file d’attente et la valeur approximative du nombre de messages, à l’aide des options de requête et du contexte d’opération spécifiés.

Parameters:

options - Objet QueueRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé ( CloudQueue).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

downloadPermissions

public QueuePermissions downloadPermissions()

Télécharge les paramètres d’autorisation pour la file d’attente.

Returns:

Objet QueuePermissions qui représente les autorisations de la file d’attente.

Throws:

StorageException - Si une erreur de service de stockage s’est produite.

downloadPermissions

public QueuePermissions downloadPermissions(QueueRequestOptions options, OperationContext opContext)

Télécharge les paramètres d’autorisations pour la file d’attente à l’aide des options de requête et du contexte d’opération spécifiés.

Parameters:

options - Objet QueueRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé ( CloudQueueClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Returns:

Objet QueuePermissions qui représente les autorisations du conteneur.

Throws:

StorageException - Si une erreur de service de stockage s’est produite.

exists

public boolean exists()

Retourne une valeur qui indique si la file d’attente existe.

Returns:

true si la file d’attente existe dans le service de stockage , sinon false.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

exists

public boolean exists(QueueRequestOptions options, OperationContext opContext)

Retourne une valeur qui indique si la file d’attente existe, à l’aide des options de requête et du contexte d’opération spécifiés.

Parameters:

options - Objet QueueRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé ( CloudQueueClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Returns:

true si la file d’attente existe dans le service de stockage , sinon false.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

generateSharedAccessSignature

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

Retourne une signature d'accès partagé pour la file d'attente.

Parameters:

policy - Stratégie d'accès pour la signature d'accès partagé.
groupPolicyIdentifier - Stratégie d'accès au niveau de la file d'attente.

Returns:

Signature d’accès partagé pour la file d’attente.

Throws:

InvalidKeyException - Si une clé non valide a été passée.
StorageException - Si une erreur de service de stockage s’est produite.
IllegalArgumentException - Si une valeur inattendue est passée.

generateSharedAccessSignature

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

Retourne une signature d'accès partagé pour la file d'attente.

Parameters:

policy - Stratégie d'accès pour la signature d'accès partagé.
groupPolicyIdentifier - Stratégie d'accès au niveau de la file d'attente.
ipRange - Objet IPRange contenant la plage d’adresses IP autorisées.
protocols - SharedAccessProtocols représentant les protocoles Internet autorisés.

Returns:

Signature d’accès partagé pour la file d’attente.

Throws:

InvalidKeyException - Si une clé non valide a été passée.
StorageException - Si une erreur de service de stockage s’est produite.
IllegalArgumentException - Si une valeur inattendue est passée.

getApproximateMessageCount

public long getApproximateMessageCount()

Obtient le nombre approximatif de messages de la file d’attente. Cette valeur est initialisée par une demande adressée à downloadAttributes() et représente le nombre approximatif de messages lorsque cette demande est terminée.

Returns:

Objet Long qui représente le nombre approximatif de messages de la file d’attente.

getMetadata

public HashMap getMetadata()

Obtient la collection de métadonnées de la file d’attente telle qu’elle est stockée dans cet objet. Cette valeur est initialisée avec les métadonnées de la file d’attente par un appel à downloadAttributes(), et est définie sur la file d’attente avec un appel à uploadMetadata().

Returns:

Objet java.util.HashMap qui représente les métadonnées de la file d’attente.

getName

public String getName()

Obtient le nom de la file d'attente.

Returns:

Objet String qui représente le nom de la file d’attente.

getServiceClient

public CloudQueueClient getServiceClient()

Obtient le client du service de file d’attente associé à cette file d’attente.

Returns:

Objet CloudQueueClient qui représente le client de service associé à cette file d’attente.

getShouldEncodeMessage

public boolean getShouldEncodeMessage()

Obtient la valeur indiquant si le message doit être encodé en base 64.

Returns:

Boolean qui indique si le message doit être encodé en base 64.

getStorageUri

public final StorageUri getStorageUri()

Retourne la liste des URI pour tous les emplacements.

Returns:

StorageUri qui représente la liste des URI pour tous les emplacements.

getUri

public URI getUri()

Obtient l’URI absolu pour cette file d’attente.

Returns:

Objet java.net.URI qui représente l’URI de cette file d’attente.

peekMessage

public CloudQueueMessage peekMessage()

Affiche un message de la file d’attente. Une demande d’aperçu récupère un message à l’avant de la file d’attente sans modifier sa visibilité.

Returns:

Objet CloudQueueMessage qui représente un message dans cette file d’attente.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

peekMessage

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

Affiche un message de la file d’attente à l’aide des options de requête et du contexte d’opération spécifiés. Une demande d’aperçu récupère un message à l’avant de la file d’attente sans modifier sa visibilité.

Parameters:

options - Objet QueueRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé ( CloudQueueClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Returns:

Objet CloudQueueMessage qui représente le message demandé à partir de la file d’attente.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

peekMessages

public Iterable peekMessages(final int numberOfMessages)

Affiche un nombre spécifié de messages de la file d’attente. Une demande d’aperçu récupère les messages à l’avant de la file d’attente sans modifier leur visibilité.

Parameters:

numberOfMessages - Nombre de messages à récupérer.

Returns:

Collection énumérable d’objets CloudQueueMessage qui représente les messages demandés à partir de la file d’attente.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

peekMessages

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

Affiche un ensemble de messages de la file d’attente à l’aide des options de requête et du contexte d’opération spécifiés. Une demande d’aperçu récupère les messages à l’avant de la file d’attente sans modifier leur visibilité.

Parameters:

numberOfMessages - Nombre de messages à récupérer.
options - Objet QueueRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé ( CloudQueueClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Returns:

Collection énumérable d’objets CloudQueueMessage qui représente les messages demandés à partir de la file d’attente.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

retrieveMessage

public CloudQueueMessage retrieveMessage()

Récupère un message à l’avant de la file d’attente à l’aide des options de requête par défaut. Cette opération marque le message récupéré comme invisible dans la file d’attente pour la période de visibilité par défaut.

Returns:

Objet CloudQueueMessage qui représente un message dans cette file d’attente.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

retrieveMessage

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

Récupère un message à partir de l’avant de la file d’attente, à l’aide des options de requête et du contexte d’opération spécifiés. Cette opération marque le message récupéré comme invisible dans la file d’attente pour la période de visibilité spécifiée.

Parameters:

visibilityTimeoutInSeconds - Spécifie le délai de visibilité du message, en secondes.
options - Objet QueueRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé ( CloudQueueClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Returns:

Objet CloudQueueMessage qui représente un message dans cette file d’attente.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

retrieveMessages

public Iterable retrieveMessages(final int numberOfMessages)

Récupère le nombre spécifié de messages à l’avant de la file d’attente à l’aide des options de requête par défaut. Cette opération marque les messages récupérés comme invisibles dans la file d’attente pour la période de visibilité par défaut.

Parameters:

numberOfMessages - Nombre de messages à récupérer.

Returns:

Collection énumérable d’objets CloudQueueMessage qui représente les messages récupérés de la file d’attente.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

retrieveMessages

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

Récupère le nombre spécifié de messages à partir de l’avant de la file d’attente à l’aide des options de requête et du contexte d’opération spécifiés. Cette opération marque les messages récupérés comme invisibles dans la file d’attente pour la période de visibilité par défaut.

Parameters:

numberOfMessages - Nombre de messages à récupérer.
visibilityTimeoutInSeconds - Spécifie le délai de visibilité pour les messages récupérés, en secondes.
options - Objet QueueRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé ( CloudQueueClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Returns:

Collection énumérable d’objets CloudQueueMessage qui représente les messages récupérés dans la file d’attente.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

setMetadata

public void setMetadata(final HashMap metadata)

Définit la collection de métadonnées des paires nom-valeur à définir dans la file d’attente avec un uploadMetadata() appel. Cette collection remplacera toutes les métadonnées de file d’attente existantes. Si cette valeur est définie sur une collection vide, les métadonnées de la file d’attente sont effacées lors d’un uploadMetadata() appel.

Parameters:

metadata - Objet java.util.HashMap qui représente les métadonnées affectées à la file d’attente.

setShouldEncodeMessage

public void setShouldEncodeMessage(final boolean shouldEncodeMessage)

Définit l’indicateur indiquant si le message doit être encodé en base 64.

Parameters:

shouldEncodeMessage - La valeur indique si le message doit être encodé en base 64.

updateMessage

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

Mises à jour le message spécifié dans la file d’attente avec une nouvelle valeur de délai d’expiration de visibilité en secondes.

Parameters:

message - CloudQueueMessage à mettre à jour dans la file d’attente.
visibilityTimeoutInSeconds - Spécifie le nouveau délai de visibilité pour le message, en secondes.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

updateMessage

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

Mises à jour un message dans la file d’attente, à l’aide des options de requête et du contexte d’opération spécifiés.

Parameters:

message - CloudQueueMessage à mettre à jour dans la file d’attente.
visibilityTimeoutInSeconds - Spécifie le nouveau délai de visibilité pour le message, en secondes.
messageUpdateFields - de EnumSetMessageUpdateFields valeurs qui spécifie les parties du message à mettre à jour.
options - Objet QueueRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé ( CloudQueueClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

uploadMetadata

public void uploadMetadata()

Charge les métadonnées de l’objet dans la file d’attente.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

uploadMetadata

public void uploadMetadata(QueueRequestOptions options, OperationContext opContext)

Charge les métadonnées de l’objet dans la file d’attente, à l’aide des options de requête et du contexte d’opération spécifiés.

Parameters:

options - Objet QueueRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé ( CloudQueueClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Throws:

StorageException - Si une erreur de service de stockage s’est produite pendant l’opération.

uploadPermissions

public void uploadPermissions(final QueuePermissions permissions)

Charge les autorisations de la file d’attente.

Parameters:

permissions - Objet QueuePermissions qui représente les autorisations à charger.

Throws:

StorageException - Si une erreur de service de stockage s’est produite.

uploadPermissions

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

Charge les autorisations de la file d’attente à l’aide des options de requête et du contexte d’opération spécifiés.

Parameters:

permissions - Objet QueuePermissions qui représente les autorisations à charger.
options - Objet QueueRequestOptions qui spécifie toutes les options supplémentaires pour la demande. La spécification null utilise les options de requête par défaut du client de service associé ( CloudQueueClient).
opContext - Objet OperationContext qui représente le contexte de l'opération actuelle. Cet objet est utilisé pour suivre les demandes au service de stockage, et fournir des informations d'exécution supplémentaires sur l'opération.

Throws:

StorageException - Si une erreur de service de stockage s’est produite.

S’applique à