ManagementClientAsync Classe

Paquet:

com.microsoft.azure.servicebus.management

Artefact Maven:

com.microsoft.azure:azure-servicebus:3.6.7

• java.lang.Object
• • com.microsoft.azure.servicebus.management.ManagementClientAsync

public class ManagementClientAsync

Client asynchrone pour effectuer des opérations de gestion sur les entités Service Bus. Les opérations retournent CompletableFuture qui retourne de manière asynchrone les réponses.

Récapitulatif du constructeur

Constructeur	Description
ManagementClientAsync(ConnectionStringBuilder connectionStringBuilder)	Crée un ManagementClientAsync.
ManagementClientAsync(URI namespaceEndpointURI, ClientSettings clientSettings)	Crée un ManagementClientAsync.

Résumé de la méthode

Modificateur et type	Méthode et description
void	close() Supprime et ferme le client de gestion.
CompletableFuture<QueueDescription>	createQueueAsync(QueueDescription queueDescription) Crée une file d’attente dans l’espace de noms de service avec le nom donné.
CompletableFuture<QueueDescription>	createQueueAsync(String queuePath) Crée une file d’attente dans l’espace de noms de service avec le nom donné.
CompletableFuture<RuleDescription>	createRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription) Crée une règle pour une rubrique donnée - abonnement.
CompletableFuture<SubscriptionDescription>	createSubscriptionAsync(SubscriptionDescription subscriptionDescription) Crée un abonnement dans l’espace de noms de service avec le nom donné.
CompletableFuture<SubscriptionDescription>	createSubscriptionAsync(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule) Crée un abonnement dans l’espace de noms de service avec la règle par défaut fournie.
CompletableFuture<SubscriptionDescription>	createSubscriptionAsync(String topicPath, String subscriptionName) Crée un abonnement pour une rubrique donnée dans l’espace de noms de service avec le nom donné.
CompletableFuture<TopicDescription>	createTopicAsync(TopicDescription topicDescription) Crée une rubrique dans l’espace de noms de service avec le nom donné.
CompletableFuture<TopicDescription>	createTopicAsync(String topicPath) Crée une rubrique dans l’espace de noms de service avec le nom donné.
CompletableFuture<Void>	deleteQueueAsync(String path) Supprime la file d’attente décrite par le chemin d’accès relatif à l’adresse de base de l’espace de noms de service.
CompletableFuture<Void>	deleteRuleAsync(String topicPath, String subscriptionName, String ruleName) Supprime la règle pour un abonnement à une rubrique donnée.
CompletableFuture<Void>	deleteSubscriptionAsync(String topicPath, String subscriptionName) Supprime l’abonnement décrit par la rubriqueChemin d’accès et nom de l’abonnement.
CompletableFuture<Void>	deleteTopicAsync(String path) Supprime la rubrique décrite par le chemin d’accès relatif à l’adresse de base de l’espace de noms de service.
CompletableFuture<NamespaceInfo>	getNamespaceInfoAsync() Récupère les informations relatives à l’espace de noms.
CompletableFuture<QueueDescription>	getQueueAsync(String path) Récupère une file d’attente à partir de l’espace de noms de service
CompletableFuture<QueueRuntimeInfo>	getQueueRuntimeInfoAsync(String path) Récupère les informations d’exécution d’une file d’attente.
CompletableFuture<List<QueueDescription>>	getQueuesAsync() Récupère la liste des files d’attente présentes dans l’espace de noms.
CompletableFuture<List<QueueDescription>>	getQueuesAsync(int count, int skip) Récupère la liste des files d’attente présentes dans l’espace de noms.
CompletableFuture<RuleDescription>	getRuleAsync(String topicPath, String subscriptionName, String ruleName) Récupère une règle pour une rubrique et un abonnement donnés à partir de l’espace de noms de service
CompletableFuture<List<RuleDescription>>	getRulesAsync(String topicName, String subscriptionName) Récupère la liste des règles pour un abonnement à une rubrique donnée dans l’espace de noms.
CompletableFuture<List<RuleDescription>>	getRulesAsync(String topicName, String subscriptionName, int count, int skip) Récupère la liste des règles pour un abonnement à une rubrique donnée dans l’espace de noms.
CompletableFuture<SubscriptionDescription>	getSubscriptionAsync(String topicPath, String subscriptionName) Récupère un abonnement pour une rubrique donnée à partir de l’espace de noms de service
CompletableFuture<SubscriptionRuntimeInfo>	getSubscriptionRuntimeInfoAsync(String topicPath, String subscriptionName) Récupère les informations d’exécution d’un abonnement dans une rubrique donnée
CompletableFuture<List<SubscriptionDescription>>	getSubscriptionsAsync(String topicName) Récupère la liste des abonnements pour une rubrique donnée dans l’espace de noms.
CompletableFuture<List<SubscriptionDescription>>	getSubscriptionsAsync(String topicName, int count, int skip) Récupère la liste des abonnements pour une rubrique donnée dans l’espace de noms.
CompletableFuture<TopicDescription>	getTopicAsync(String path) Récupère une rubrique de l’espace de noms de service
CompletableFuture<TopicRuntimeInfo>	getTopicRuntimeInfoAsync(String path) Récupère les informations d’exécution d’une rubrique
CompletableFuture<List<TopicDescription>>	getTopicsAsync() Récupère la liste des rubriques présentes dans l’espace de noms.
CompletableFuture<List<TopicDescription>>	getTopicsAsync(int count, int skip) Récupère la liste des rubriques présentes dans l’espace de noms.
CompletableFuture<Boolean>	queueExistsAsync(String path) Vérifie si une file d’attente donnée existe ou non.
CompletableFuture<Boolean>	ruleExistsAsync(String topicPath, String subscriptionName, String ruleName) Vérifie si une règle donnée existe ou non pour un abonnement donné.
CompletableFuture<Boolean>	subscriptionExistsAsync(String topicPath, String subscriptionName) Vérifie si un abonnement donné existe ou non.
CompletableFuture<Boolean>	topicExistsAsync(String path) Vérifie si une rubrique donnée existe ou non.
CompletableFuture<QueueDescription>	updateQueueAsync(QueueDescription queueDescription) Mises à jour une file d’attente existante.
CompletableFuture<RuleDescription>	updateRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription) Mises à jour une règle existante.
CompletableFuture<SubscriptionDescription>	updateSubscriptionAsync(SubscriptionDescription subscriptionDescription) Mises à jour un abonnement existant.
CompletableFuture<TopicDescription>	updateTopicAsync(TopicDescription topicDescription) Mises à jour une rubrique existante.

Méthodes héritées de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Détails du constructeur

ManagementClientAsync

public ManagementClientAsync(ConnectionStringBuilder connectionStringBuilder)

Crée un ManagementClientAsync. L’utilisateur doit appeler close() à la fin de la vie du client.

Paramètres:

connectionStringBuilder -

• connectionStringBuilder contenant des informations d’espace de noms et des paramètres client.

ManagementClientAsync

public ManagementClientAsync(URI namespaceEndpointURI, ClientSettings clientSettings)

Crée un ManagementClientAsync. L’utilisateur doit appeler close() à la fin de la vie du client.

Paramètres:

namespaceEndpointURI -

• URI de l’espace de noms qui se connecte à.

clientSettings -

• paramètres du client.

Détails de la méthode

close

public void close()

Supprime et ferme le client de gestion.

Exception:

IOException

- si une erreur d’E/S se produit

createQueueAsync

public CompletableFuture createQueueAsync(QueueDescription queueDescription)

Crée une file d’attente dans l’espace de noms de service avec le nom donné. Consultez QueueDescription les valeurs par défaut des propriétés de file d’attente.

Paramètres:

queueDescription -

• Objet QueueDescription décrivant les attributs avec lesquels la nouvelle file d’attente sera créée.

Retours:

QueueDescription de la file d’attente nouvellement créée.

createQueueAsync

public CompletableFuture createQueueAsync(String queuePath)

Crée une file d’attente dans l’espace de noms de service avec le nom donné. Consultez pour connaître QueueDescription les valeurs par défaut des propriétés de file d’attente.

Paramètres:

queuePath -

• Nom de la file d’attente par rapport à l’adresse de base de l’espace de noms de service.

Retours:

QueueDescription de la file d’attente nouvellement créée.

createRuleAsync

public CompletableFuture createRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription)

Crée une règle pour une rubrique donnée - abonnement. Consultez pour connaître RuleDescription les valeurs par défaut des propriétés d’abonnement.

Paramètres:

topicName -

• Nom de la rubrique.

subscriptionName -

• Nom de l'abonnement.

ruleDescription -

• Objet RuleDescription décrivant les attributs avec lesquels la nouvelle règle sera créée.

Retours:

RuleDescription de la règle nouvellement créée.

createSubscriptionAsync

public CompletableFuture createSubscriptionAsync(SubscriptionDescription subscriptionDescription)

Crée un abonnement dans l’espace de noms de service avec le nom donné. Consultez pour connaître SubscriptionDescription les valeurs par défaut des propriétés d’abonnement.

Paramètres:

subscriptionDescription -

• Objet SubscriptionDescription décrivant les attributs avec lesquels le nouvel abonnement sera créé.

Retours:

SubscriptionDescription de l’abonnement nouvellement créé.

createSubscriptionAsync

public CompletableFuture createSubscriptionAsync(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)

Crée un abonnement dans l’espace de noms de service avec la règle par défaut fournie. Consultez pour connaître SubscriptionDescription les valeurs par défaut des propriétés d’abonnement.

Paramètres:

subscriptionDescription -

• Objet SubscriptionDescription décrivant les attributs avec lesquels le nouvel abonnement sera créé.

defaultRule -

• Objet RuleDescription décrivant la règle par défaut. Si la valeur est null, le filtre direct est créé.

Retours:

SubscriptionDescription de l’abonnement nouvellement créé.

createSubscriptionAsync

public CompletableFuture createSubscriptionAsync(String topicPath, String subscriptionName)

Crée un abonnement pour une rubrique donnée dans l’espace de noms de service avec le nom donné. Consultez pour connaître SubscriptionDescription les valeurs par défaut des propriétés d’abonnement.

Paramètres:

topicPath -

• Nom de la rubrique relative à l’adresse de base de l’espace de noms de service.

subscriptionName -

• Nom de l'abonnement.

Retours:

SubscriptionDescription de l’abonnement nouvellement créé.

createTopicAsync

public CompletableFuture createTopicAsync(TopicDescription topicDescription)

Crée une rubrique dans l’espace de noms de service avec le nom donné. Consultez pour connaître TopicDescription les valeurs par défaut des propriétés de rubrique.

Paramètres:

topicDescription -

• Objet QueueDescription décrivant les attributs avec lesquels la nouvelle rubrique sera créée.

Retours:

TopicDescription de la rubrique nouvellement créée.

createTopicAsync

public CompletableFuture createTopicAsync(String topicPath)

Crée une rubrique dans l’espace de noms de service avec le nom donné. Consultez pour connaître TopicDescription les valeurs par défaut des propriétés de rubrique.

Paramètres:

topicPath -

• Nom de la rubrique relative à l’adresse de base de l’espace de noms de service.

Retours:

TopicDescription de la rubrique nouvellement créée.

deleteQueueAsync

public CompletableFuture deleteQueueAsync(String path)

Supprime la file d’attente décrite par le chemin d’accès relatif à l’adresse de base de l’espace de noms de service.

Paramètres:

path -

• Nom de l’entité relative à l’adresse de base de l’espace de noms de service.

Retours:

Un avenir complet qui se termine lorsque la file d’attente est supprimée.

deleteRuleAsync

public CompletableFuture deleteRuleAsync(String topicPath, String subscriptionName, String ruleName)

Supprime la règle pour un abonnement à une rubrique donnée.

Paramètres:

topicPath -

• Nom de la rubrique.

subscriptionName -

• Nom de l'abonnement.

ruleName -

• nom de la règle.

Retours:

Un avenir complet qui se termine lorsque la règle est supprimée.

deleteSubscriptionAsync

public CompletableFuture deleteSubscriptionAsync(String topicPath, String subscriptionName)

Supprime l’abonnement décrit par topicPath et subscriptionName.

Paramètres:

topicPath -

• Nom de la rubrique.

subscriptionName -

• Nom de l'abonnement.

Retours:

Un avenir complet qui se termine lorsque l’abonnement est supprimé.

deleteTopicAsync

public CompletableFuture deleteTopicAsync(String path)

Supprime la rubrique décrite par le chemin d’accès relatif à l’adresse de base de l’espace de noms de service.

Paramètres:

path -

• Nom de l’entité relative à l’adresse de base de l’espace de noms de service.

Retours:

Un avenir complet qui se termine lorsque la rubrique est supprimée.

getNamespaceInfoAsync

public CompletableFuture getNamespaceInfoAsync()

Récupère les informations relatives à l’espace de noms. Fonctionne avec n’importe quelle revendication (Envoyer/Écouter/Gérer).

Retours:

• NamespaceInfo contenant des informations d’espace de noms.

getQueueAsync

public CompletableFuture getQueueAsync(String path)

Récupère une file d’attente à partir de l’espace de noms de service

Paramètres:

path -

• Chemin de la file d’attente relatif à l’espace de noms Service Bus.

Retours:

• QueueDescription contenant des informations sur la file d’attente.

getQueueRuntimeInfoAsync

public CompletableFuture getQueueRuntimeInfoAsync(String path)

Récupère les informations d’exécution d’une file d’attente.

Paramètres:

path -

• Chemin de la file d’attente relatif à l’espace de noms Service Bus.

Retours:

• QueueRuntimeInfo contenant des informations d’exécution sur la file d’attente.

getQueuesAsync

public CompletableFuture> getQueuesAsync()

Récupère la liste des files d’attente présentes dans l’espace de noms.

Retours:

les 100 premières files d’attente.

getQueuesAsync

public CompletableFuture> getQueuesAsync(int count, int skip)

Récupère la liste des files d’attente présentes dans l’espace de noms. Vous pouvez simuler des pages de liste d’entités en manipulant les paramètres count et skip. skip(0)+count(100) donne les 100 premières entités. skip(100)+count(100) donne les 100 entités suivantes.

Paramètres:

count -

• Nombre de files d’attente à extraire. La valeur par défaut est 100. La valeur maximale autorisée est 100.

skip -

• Nombre de files d’attente à ignorer. La valeur par défaut est 0. Ne peut pas être négatif.

Retours:

liste des files d’attente.

getRuleAsync

public CompletableFuture getRuleAsync(String topicPath, String subscriptionName, String ruleName)

Récupère une règle pour une rubrique et un abonnement donnés à partir de l’espace de noms de service

Paramètres:

topicPath -

• Chemin d’accès de la rubrique relative à l’espace de noms Service Bus.

subscriptionName -

• Nom de l'abonnement.

ruleName -

• nom de la règle.

Retours:

• RuleDescription contenant des informations sur l’abonnement.

getRulesAsync

public CompletableFuture> getRulesAsync(String topicName, String subscriptionName)

Récupère la liste des règles pour un abonnement à une rubrique donnée dans l’espace de noms.

Paramètres:

topicName -

• Nom de la rubrique.

subscriptionName -

• Nom de l'abonnement.

Retours:

les 100 premières règles.

getRulesAsync

public CompletableFuture> getRulesAsync(String topicName, String subscriptionName, int count, int skip)

Récupère la liste des règles pour un abonnement à une rubrique donnée dans l’espace de noms. Vous pouvez simuler des pages de liste d’entités en manipulant les paramètres count et skip. skip(0)+count(100) donne les 100 premières entités. skip(100)+count(100) donne les 100 entités suivantes.

Paramètres:

topicName -

• Nom de la rubrique.

subscriptionName -

• Nom de l'abonnement.

count -

• Nombre de règles à récupérer. La valeur par défaut est 100. La valeur maximale autorisée est 100.

skip -

• Le nombre de règles à ignorer. La valeur par défaut est 0. Ne peut pas être négatif.

Retours:

liste des règles.

getSubscriptionAsync

public CompletableFuture getSubscriptionAsync(String topicPath, String subscriptionName)

Récupère un abonnement pour une rubrique donnée à partir de l’espace de noms de service

Paramètres:

topicPath -

• Chemin d’accès de la rubrique relative à l’espace de noms Service Bus.

subscriptionName -

• Nom de l’abonnement

Retours:

• SubscriptionDescription contenant des informations sur l’abonnement.

getSubscriptionRuntimeInfoAsync

public CompletableFuture getSubscriptionRuntimeInfoAsync(String topicPath, String subscriptionName)

Récupère les informations d’exécution d’un abonnement dans une rubrique donnée

Paramètres:

topicPath -

• Chemin d’accès de la rubrique relative à l’espace de noms Service Bus.

subscriptionName -

• Nom de l’abonnement

Retours:

• SubscriptionRuntimeInfo contenant les informations d’exécution sur l’abonnement.

getSubscriptionsAsync

public CompletableFuture> getSubscriptionsAsync(String topicName)

Récupère la liste des abonnements pour une rubrique donnée dans l’espace de noms.

Paramètres:

topicName -

• Nom de la rubrique.

Retours:

les 100 premiers abonnements.

getSubscriptionsAsync

public CompletableFuture> getSubscriptionsAsync(String topicName, int count, int skip)

Récupère la liste des abonnements pour une rubrique donnée dans l’espace de noms. Vous pouvez simuler des pages de liste d’entités en manipulant les paramètres count et skip. skip(0)+count(100) donne les 100 premières entités. skip(100)+count(100) donne les 100 entités suivantes.

Paramètres:

topicName -

• Nom de la rubrique.

count -

• Nombre d’abonnements à récupérer. La valeur par défaut est 100. La valeur maximale autorisée est 100.

skip -

• Nombre d’abonnements à ignorer. La valeur par défaut est 0. Ne peut pas être négatif.

Retours:

liste des abonnements.

getTopicAsync

public CompletableFuture getTopicAsync(String path)

Récupère une rubrique de l’espace de noms de service

Paramètres:

path -

• Chemin de la file d’attente relatif à l’espace de noms Service Bus.

Retours:

• Description contenant des informations sur le sujet.

getTopicRuntimeInfoAsync

public CompletableFuture getTopicRuntimeInfoAsync(String path)

Récupère les informations d’exécution d’une rubrique

Paramètres:

path -

• Chemin de la file d’attente relatif à l’espace de noms Service Bus.

Retours:

• TopicRuntimeInfo contenant des informations d’exécution sur la rubrique.

getTopicsAsync

public CompletableFuture> getTopicsAsync()

Récupère la liste des rubriques présentes dans l’espace de noms.

Retours:

les 100 premières rubriques.

getTopicsAsync

public CompletableFuture> getTopicsAsync(int count, int skip)

Récupère la liste des rubriques présentes dans l’espace de noms. Vous pouvez simuler des pages de liste d’entités en manipulant les paramètres count et skip. skip(0)+count(100) donne les 100 premières entités. skip(100)+count(100) donne les 100 entités suivantes.

Paramètres:

count -

• Nombre de rubriques à extraire. La valeur par défaut est 100. La valeur maximale autorisée est 100.

skip -

• Nombre de rubriques à ignorer. La valeur par défaut est 0. Ne peut pas être négatif.

Retours:

liste des rubriques.

queueExistsAsync

public CompletableFuture queueExistsAsync(String path)

Vérifie si une file d’attente donnée existe ou non.

Paramètres:

path -

• Chemin de l’entité à case activée

Retours:

• True si l’entité existe. Sinon, false.

ruleExistsAsync

public CompletableFuture ruleExistsAsync(String topicPath, String subscriptionName, String ruleName)

Vérifie si une règle donnée existe ou non pour un abonnement donné.

Paramètres:

topicPath -

• Chemin d’accès de la rubrique

subscriptionName -

• Nom de l'abonnement.

ruleName -

• Nom de la règle

Retours:

• True si l’entité existe. Sinon, false.

subscriptionExistsAsync

public CompletableFuture subscriptionExistsAsync(String topicPath, String subscriptionName)

Vérifie si un abonnement donné existe ou non.

Paramètres:

topicPath -

• Chemin d’accès de la rubrique

subscriptionName -

• Nom de l'abonnement.

Retours:

• True si l’entité existe. Sinon, false.

topicExistsAsync

public CompletableFuture topicExistsAsync(String path)

Vérifie si une rubrique donnée existe ou non.

Paramètres:

path -

• Chemin de l’entité à case activée

Retours:

• True si l’entité existe. Sinon, false.

updateQueueAsync

public CompletableFuture updateQueueAsync(QueueDescription queueDescription)

Mises à jour une file d’attente existante.

Paramètres:

queueDescription -

• Objet QueueDescription décrivant les attributs avec lesquels la file d’attente sera mise à jour.

Retours:

QueueDescription de la file d’attente mise à jour.

updateRuleAsync

public CompletableFuture updateRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription)

Mises à jour une règle existante.

Paramètres:

topicName -

• Nom de la rubrique.

subscriptionName -

• Nom de l'abonnement.

ruleDescription -

• Objet RuleDescription décrivant les attributs avec lesquels la règle sera mise à jour.

Retours:

RuleDescription de la règle mise à jour.

updateSubscriptionAsync

public CompletableFuture updateSubscriptionAsync(SubscriptionDescription subscriptionDescription)

Mises à jour un abonnement existant.

Paramètres:

subscriptionDescription -

• Objet SubscriptionDescription décrivant les attributs avec lesquels l’abonnement sera mis à jour.

Retours:

SubscriptionDescription de l’abonnement mis à jour.

updateTopicAsync

public CompletableFuture updateTopicAsync(TopicDescription topicDescription)

Mises à jour une rubrique existante.

Paramètres:

topicDescription -

• Objet TopicDescription décrivant les attributs avec lesquels la rubrique sera mise à jour.

Retours:

TopicDescription de la rubrique mise à jour.