Partager via

CloudQueueClient Classe

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

public class CloudQueueClient extends ServiceClient

Fournit un client de service pour accéder au service File d’attente Microsoft Azure.

Récapitulatif du constructeur

Constructeur Description
CloudQueueClient(final StorageUri baseUri, final StorageCredentials credentials)

Initialise une nouvelle instance de la classe à l’aide du point de terminaison de service file d’attente et des informations d’identification de compte spécifiés.
CloudQueueClient(final URI baseUri, final StorageCredentials credentials)

Initialise une nouvelle instance de la classe à l’aide du point de terminaison de service file d’attente et des informations d’identification de compte spécifiés.

Résumé de la méthode

Modificateur et type Méthode et description
final ServiceProperties downloadServiceProperties()

Récupère le actuel ServiceProperties pour le service de stockage donné. Cela inclut les configurations Logging, HourMetrics, MinuteMetrics et CORS.
final ServiceProperties downloadServiceProperties(QueueRequestOptions options, OperationContext opContext)

Récupère le actuel ServiceProperties pour le service de stockage donné. Cela inclut les configurations Logging, HourMetrics, MinuteMetrics et CORS.
QueueRequestOptions getDefaultRequestOptions()

Obtient le QueueRequestOptions qui est utilisé pour les requêtes associées à ce
CloudQueue getQueueReference(final String queueName)

Obtient un CloudQueue objet avec le nom spécifié.
ServiceStats getServiceStats()

Interroge le service pour le ServiceStats.
ServiceStats getServiceStats(QueueRequestOptions options, OperationContext opContext)

Interroge le service pour le ServiceStats.
boolean isUsePathStyleUris()
Iterable<CloudQueue> listQueues()

Obtient une collection itérable de files d’attente pour ce client de service de file d’attente.
Iterable<CloudQueue> listQueues(final String prefix)

Retourne une collection itérable de files d’attente dont le nom commence par le préfixe spécifié dans ce client de service de file d’attente.
Iterable<CloudQueue> listQueues(final String prefix, final QueueListingDetails detailsIncluded, QueueRequestOptions options, OperationContext opContext)

Renvoie une collection itérable de files d’attente dont les noms commencent par le préfixe spécifié pour ce client de service file d’attente, à l’aide du paramètre de détails, des options de demande et du contexte d’opération spécifiés.
ResultSegment<CloudQueue> listQueuesSegmented()

Obtient un segment de résultat d’une collection itérable de files d’attente pour ce client de service file d’attente.
ResultSegment<CloudQueue> listQueuesSegmented(final String prefix)

Obtient un segment de résultat d’une collection itérable de files d’attente dont les noms commencent par le préfixe spécifié pour ce client de service de file d’attente.
ResultSegment<CloudQueue> listQueuesSegmented(final String prefix, final QueueListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, QueueRequestOptions options, OperationContext opContext)

Obtient un segment de résultat d’une collection itérable de files d’attente dont les noms commencent par le préfixe spécifié pour cette file d’attente, à l’aide des options de détails de liste, des options de demande et du contexte d’opération spécifiés.
void setDefaultRequestOptions(QueueRequestOptions defaultRequestOptions)

Définit le QueueRequestOptions qui est utilisé pour toute file d’attente accessible avec cet objet.
void uploadServiceProperties(final ServiceProperties properties)

Charge une nouvelle ServiceProperties configuration dans le service de stockage donné. Cela inclut les configurations Journalisation, HourMetrics, MinuteMetrics et CORS.
void uploadServiceProperties(final ServiceProperties properties, QueueRequestOptions options, OperationContext opContext)

Charge une nouvelle ServiceProperties configuration dans le service de stockage donné. Cela inclut les configurations Journalisation, HourMetrics, MinuteMetrics et CORS.

Membres hérités

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)

Détails du constructeur

CloudQueueClient

public CloudQueueClient(final StorageUri baseUri, final StorageCredentials credentials)

Initialise une nouvelle instance de la classe à l’aide du point de terminaison de service file d’attente et des informations d’identification de compte spécifiés.

Parameters:

baseUri - Objet StorageUri qui représente le point de terminaison du service file d’attente utilisé pour créer le client.
credentials - Objet StorageCredentials qui représente les informations d’identification du compte.

CloudQueueClient

public CloudQueueClient(final URI baseUri, final StorageCredentials credentials)

Initialise une nouvelle instance de la classe à l’aide du point de terminaison de service file d’attente et des informations d’identification de compte spécifiés.

Parameters:

baseUri - Objet java.net.URI qui représente le point de terminaison du service file d’attente utilisé pour créer le client.
credentials - Objet StorageCredentials qui représente les informations d’identification du compte.

Détails de la méthode

downloadServiceProperties

public final ServiceProperties downloadServiceProperties()

Récupère le actuel ServiceProperties pour le service de stockage donné. Cela inclut les configurations Logging, HourMetrics, MinuteMetrics et CORS.

Returns:

objet ServiceProperties représentant la configuration actuelle du service.

Throws:

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

downloadServiceProperties

public final ServiceProperties downloadServiceProperties(QueueRequestOptions options, OperationContext opContext)

Récupère le actuel ServiceProperties pour le service de stockage donné. Cela inclut les configurations Logging, HourMetrics, MinuteMetrics et CORS.

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 ServiceProperties représentant la configuration actuelle du service.

Throws:

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

getDefaultRequestOptions

public QueueRequestOptions getDefaultRequestOptions()

Obtient le QueueRequestOptions qui est utilisé pour les requêtes associées à ce

Returns:

Objet QueueRequestOptions contenant les valeurs utilisées par ce CloudQueueClient

getQueueReference

public CloudQueue getQueueReference(final String queueName)

Obtient un CloudQueue objet avec le nom spécifié.

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

Returns:

Référence à un objet CloudQueue.

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.

getServiceStats

public ServiceStats getServiceStats()

Interroge le service pour le ServiceStats.

Returns:

ServiceStats pour le service de stockage donné

Throws:

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

getServiceStats

public ServiceStats getServiceStats(QueueRequestOptions options, OperationContext opContext)

Interroge le service pour le ServiceStats.

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:

ServiceStats pour le service de stockage donné

Throws:

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

isUsePathStyleUris

protected boolean isUsePathStyleUris()

Returns:

usePathStyleUris

listQueues

public Iterable listQueues()

Obtient une collection itérable de files d’attente pour ce client de service de file d’attente.

Returns:

Collection itérable d’objets CloudQueue récupérés tardivement qui représentent les files d’attente dans ce client.

listQueues

public Iterable listQueues(final String prefix)

Retourne une collection itérable de files d’attente dont le nom commence par le préfixe spécifié dans ce client de service de file d’attente.

Parameters:

prefix - String qui représente le préfixe de nom de file d’attente.

Returns:

Collection itérable d’objets CloudQueue récupérés de manière différée qui représentent les files d’attente dans ce client dont les noms commencent par le préfixe spécifié.

listQueues

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

Renvoie une collection itérable de files d’attente dont les noms commencent par le préfixe spécifié pour ce client de service file d’attente, à l’aide du paramètre de détails, des options de demande et du contexte d’opération spécifiés.

Parameters:

prefix - String qui représente le préfixe de nom de file d’attente.
detailsIncluded - Valeur QueueListingDetails qui indique si les métadonnées de file d’attente seront retournées.
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.

Returns:

Collection itérable d’objets CloudQueue récupérés paresseusement qui représente les files d’attente spécifiées pour ce client.

listQueuesSegmented

public ResultSegment listQueuesSegmented()

Obtient un segment de résultat d’une collection itérable de files d’attente pour ce client de service file d’attente.

Returns:

d’objets ResultSegment<T>CloudQueue qui contient un segment de la collection itérable d’objets CloudQueue qui représentent les files d’attente demandées dans le service de stockage.

Throws:

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

listQueuesSegmented

public ResultSegment listQueuesSegmented(final String prefix)

Obtient un segment de résultat d’une collection itérable de files d’attente dont les noms commencent par le préfixe spécifié pour ce client de service de file d’attente.

Parameters:

prefix

Returns:

d’objets ResultSegment<T>CloudQueue qui contient un segment de la collection itérable d’objets CloudQueue qui représentent les files d’attente demandées dans le service de stockage.

Throws:

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

listQueuesSegmented

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

Obtient un segment de résultat d’une collection itérable de files d’attente dont les noms commencent par le préfixe spécifié pour cette file d’attente, à l’aide des options de détails de liste, des options de demande et du contexte d’opération spécifiés.

Parameters:

prefix - String qui représente le préfixe du nom de la file d’attente à correspondre.
detailsIncluded - Valeur QueueListingDetails qui indique si les métadonnées de file d’attente seront retournées.
maxResults - Nombre maximal de résultats à récupérer. Si null ou supérieur à 5 000, le serveur retourne jusqu’à 5 000 éléments. Doit être au moins égal à 1.
continuationToken - Objet ResultContinuation qui représente un jeton de continuation retourné par une opération de référencement précédente.
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.

Returns:

d’objets ResultSegment<T>CloudQueue qui contient un segment de la collection itérable d’objets CloudQueue qui représentent les files d’attente demandées dans le service de stockage.

Throws:

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

setDefaultRequestOptions

public void setDefaultRequestOptions(QueueRequestOptions defaultRequestOptions)

Définit le QueueRequestOptions qui est utilisé pour toute file d’attente accessible avec cet objet.

Parameters:

defaultRequestOptions - QueueRequestOptions à utiliser.

uploadServiceProperties

public void uploadServiceProperties(final ServiceProperties properties)

Charge une nouvelle ServiceProperties configuration dans le service de stockage donné. Cela inclut les configurations Journalisation, HourMetrics, MinuteMetrics et CORS.

Parameters:

properties - ServiceProperties à charger.

Throws:

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

uploadServiceProperties

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

Charge une nouvelle ServiceProperties configuration dans le service de stockage donné. Cela inclut les configurations Journalisation, HourMetrics, MinuteMetrics et CORS.

Parameters:

properties - ServiceProperties à charger.
options - Objet BlobRequestOptions 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é ( CloudBlobClient).
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 à