Share via


ManagementClientAsync Klasse

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

public class ManagementClientAsync

Asynchroner Client zum Ausführen von Verwaltungsvorgängen für Service Bus-Entitäten. Vorgänge geben CompletableFuture zurück, die die Antworten asynchron zurückgeben.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
ManagementClientAsync(ConnectionStringBuilder connectionStringBuilder)

Erstellt einen neuen ManagementClientAsync.

ManagementClientAsync(URI namespaceEndpointURI, ClientSettings clientSettings)

Erstellt einen neuen ManagementClientAsync.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
void close()

Veräußert und schließt den Verwaltungsclient.

CompletableFuture<QueueDescription> createQueueAsync(QueueDescription queueDescription)

Erstellt eine neue Warteschlange im Dienstnamespace mit dem angegebenen Namen.

CompletableFuture<QueueDescription> createQueueAsync(String queuePath)

Erstellt eine neue Warteschlange im Dienstnamespace mit dem angegebenen Namen.

CompletableFuture<RuleDescription> createRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription)

Erstellt eine neue Regel für ein bestimmtes Thema – Abonnement.

CompletableFuture<SubscriptionDescription> createSubscriptionAsync(SubscriptionDescription subscriptionDescription)

Erstellt ein neues Abonnement im Dienstnamespace mit dem angegebenen Namen.

CompletableFuture<SubscriptionDescription> createSubscriptionAsync(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)

Erstellt ein neues Abonnement im Dienstnamespace mit der bereitgestellten Standardregel.

CompletableFuture<SubscriptionDescription> createSubscriptionAsync(String topicPath, String subscriptionName)

Erstellt ein neues Abonnement für ein bestimmtes Thema im Dienstnamespace mit dem angegebenen Namen.

CompletableFuture<TopicDescription> createTopicAsync(TopicDescription topicDescription)

Erstellt ein neues Thema im Dienstnamespace mit dem angegebenen Namen.

CompletableFuture<TopicDescription> createTopicAsync(String topicPath)

Erstellt ein neues Thema im Dienstnamespace mit dem angegebenen Namen.

CompletableFuture<Void> deleteQueueAsync(String path)

Löscht die Warteschlange, die durch den Pfad relativ zur Basisadresse des Dienstnamespaces beschrieben wird.

CompletableFuture<Void> deleteRuleAsync(String topicPath, String subscriptionName, String ruleName)

Löscht die Regel für ein bestimmtes Themenabonnement.

CompletableFuture<Void> deleteSubscriptionAsync(String topicPath, String subscriptionName)

Löscht das Abonnement, das im ThemaPfad und Abonnementnamebeschrieben wird.

CompletableFuture<Void> deleteTopicAsync(String path)

Löscht das Thema, das durch den Pfad relativ zur Basisadresse des Dienstnamespaces beschrieben wird.

CompletableFuture<NamespaceInfo> getNamespaceInfoAsync()

Ruft Informationen im Zusammenhang mit dem Namespace ab.

CompletableFuture<QueueDescription> getQueueAsync(String path)

Ruft eine Warteschlange aus dem Dienstnamespace ab.

CompletableFuture<QueueRuntimeInfo> getQueueRuntimeInfoAsync(String path)

Ruft die Laufzeitinformationen einer Warteschlange ab.

CompletableFuture<List<QueueDescription>> getQueuesAsync()

Ruft die Liste der Warteschlangen ab, die im Namespace vorhanden sind.

CompletableFuture<List<QueueDescription>> getQueuesAsync(int count, int skip)

Ruft die Liste der Warteschlangen ab, die im Namespace vorhanden sind.

CompletableFuture<RuleDescription> getRuleAsync(String topicPath, String subscriptionName, String ruleName)

Ruft eine Regel für ein bestimmtes Thema und Abonnement aus dem Dienstnamespace ab.

CompletableFuture<List<RuleDescription>> getRulesAsync(String topicName, String subscriptionName)

Ruft die Liste der Regeln für ein bestimmtes Themenabonnement im Namespace ab.

CompletableFuture<List<RuleDescription>> getRulesAsync(String topicName, String subscriptionName, int count, int skip)

Ruft die Liste der Regeln für ein bestimmtes Themenabonnement im Namespace ab.

CompletableFuture<SubscriptionDescription> getSubscriptionAsync(String topicPath, String subscriptionName)

Ruft ein Abonnement für ein bestimmtes Thema aus dem Dienstnamespace ab.

CompletableFuture<SubscriptionRuntimeInfo> getSubscriptionRuntimeInfoAsync(String topicPath, String subscriptionName)

Ruft die Laufzeitinformationen eines Abonnements in einem bestimmten Thema ab.

CompletableFuture<List<SubscriptionDescription>> getSubscriptionsAsync(String topicName)

Ruft die Liste der Abonnements für ein bestimmtes Thema im Namespace ab.

CompletableFuture<List<SubscriptionDescription>> getSubscriptionsAsync(String topicName, int count, int skip)

Ruft die Liste der Abonnements für ein bestimmtes Thema im Namespace ab.

CompletableFuture<TopicDescription> getTopicAsync(String path)

Ruft ein Thema aus dem Dienstnamespace ab.

CompletableFuture<TopicRuntimeInfo> getTopicRuntimeInfoAsync(String path)

Ruft die Laufzeitinformationen eines Themas ab.

CompletableFuture<List<TopicDescription>> getTopicsAsync()

Ruft die Liste der im Namespace vorhandenen Themen ab.

CompletableFuture<List<TopicDescription>> getTopicsAsync(int count, int skip)

Ruft die Liste der im Namespace vorhandenen Themen ab.

CompletableFuture<Boolean> queueExistsAsync(String path)

Überprüft, ob eine bestimmte Warteschlange vorhanden ist oder nicht.

CompletableFuture<Boolean> ruleExistsAsync(String topicPath, String subscriptionName, String ruleName)

Überprüft, ob eine bestimmte Regel für ein bestimmtes Abonnement vorhanden ist.

CompletableFuture<Boolean> subscriptionExistsAsync(String topicPath, String subscriptionName)

Überprüft, ob ein bestimmtes Abonnement vorhanden ist.

CompletableFuture<Boolean> topicExistsAsync(String path)

Überprüft, ob ein bestimmtes Thema vorhanden ist.

CompletableFuture<QueueDescription> updateQueueAsync(QueueDescription queueDescription)

Updates einer vorhandenen Warteschlange.

CompletableFuture<RuleDescription> updateRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription)

Updates eine vorhandene Regel.

CompletableFuture<SubscriptionDescription> updateSubscriptionAsync(SubscriptionDescription subscriptionDescription)

Updates ein vorhandenes Abonnement.

CompletableFuture<TopicDescription> updateTopicAsync(TopicDescription topicDescription)

Updates ein vorhandenes Thema.

Geerbte Methoden von java.lang.Object

Details zum Konstruktor

ManagementClientAsync

public ManagementClientAsync(ConnectionStringBuilder connectionStringBuilder)

Erstellt einen neuen ManagementClientAsync. Der Benutzer sollte am Ende der Lebensdauer des Clients aufrufen close() .

Parameters:

connectionStringBuilder -
  • connectionStringBuilder mit Namespaceinformationen und Clienteinstellungen.

ManagementClientAsync

public ManagementClientAsync(URI namespaceEndpointURI, ClientSettings clientSettings)

Erstellt einen neuen ManagementClientAsync. Der Benutzer sollte am Ende der Lebensdauer des Clients aufrufen close() .

Parameters:

namespaceEndpointURI -
  • URI des Namespaces, mit dem eine Verbindung hergestellt wird.
clientSettings -
  • Clienteinstellungen.

Details zur Methode

close

public void close()

Entsorgt und schließt den managementClient.

Throws:

IOException

- wenn ein E/A-Fehler auftritt

createQueueAsync

public CompletableFuture createQueueAsync(QueueDescription queueDescription)

Erstellt eine neue Warteschlange im Dienstnamespace mit dem angegebenen Namen. Standardwerte für Warteschlangeneigenschaften finden Sie unter QueueDescription .

Parameters:

queueDescription -
  • Ein QueueDescription Objekt, das die Attribute beschreibt, mit denen die neue Warteschlange erstellt wird.

Returns:

QueueDescription der neu erstellten Warteschlange.

createQueueAsync

public CompletableFuture createQueueAsync(String queuePath)

Erstellt eine neue Warteschlange im Dienstnamespace mit dem angegebenen Namen. Die Standardwerte der Warteschlangeneigenschaften finden Sie QueueDescription unter .

Parameters:

queuePath -
  • Der Name der Warteschlange relativ zur Basisadresse des Dienstnamespaces.

Returns:

QueueDescription der neu erstellten Warteschlange.

createRuleAsync

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

Erstellt eine neue Regel für ein bestimmtes Thema – Abonnement. Die Standardwerte der Abonnementeigenschaften finden Sie unter RuleDescription .

Parameters:

topicName -
  • Name des Themas.
subscriptionName -
  • Name des Abonnements.
ruleDescription -
  • Ein RuleDescription -Objekt, das die Attribute beschreibt, mit denen die neue Regel erstellt wird.

Returns:

RuleDescription der neu erstellten Regel.

createSubscriptionAsync

public CompletableFuture createSubscriptionAsync(SubscriptionDescription subscriptionDescription)

Erstellt ein neues Abonnement im Dienstnamespace mit dem angegebenen Namen. Die Standardwerte der Abonnementeigenschaften finden Sie unter SubscriptionDescription .

Parameters:

subscriptionDescription -

Returns:

SubscriptionDescription des neu erstellten Abonnements.

createSubscriptionAsync

public CompletableFuture createSubscriptionAsync(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)

Erstellt ein neues Abonnement im Dienstnamespace mit der bereitgestellten Standardregel. Die Standardwerte der Abonnementeigenschaften finden Sie unter SubscriptionDescription .

Parameters:

subscriptionDescription -
defaultRule -
  • Ein RuleDescription Objekt, das die Standardregel beschreibt. Wenn NULL, wird ein Passthroughfilter erstellt.

Returns:

SubscriptionDescription des neu erstellten Abonnements.

createSubscriptionAsync

public CompletableFuture createSubscriptionAsync(String topicPath, String subscriptionName)

Erstellt ein neues Abonnement für ein bestimmtes Thema im Dienstnamespace mit dem angegebenen Namen. Die Standardwerte der Abonnementeigenschaften finden Sie unter SubscriptionDescription .

Parameters:

topicPath -
  • Der Name des Themas relativ zur Basisadresse des Dienstnamespaces.
subscriptionName -
  • Der Name des Abonnements.

Returns:

SubscriptionDescription des neu erstellten Abonnements.

createTopicAsync

public CompletableFuture createTopicAsync(TopicDescription topicDescription)

Erstellt ein neues Thema im Dienstnamespace mit dem angegebenen Namen. Die Standardwerte der Themeneigenschaften finden Sie TopicDescription unter.

Parameters:

topicDescription -
  • Ein QueueDescription Objekt, das die Attribute beschreibt, mit denen das neue Thema erstellt wird.

Returns:

TopicDescription des neu erstellten Themas.

createTopicAsync

public CompletableFuture createTopicAsync(String topicPath)

Erstellt ein neues Thema im Dienstnamespace mit dem angegebenen Namen. Die Standardwerte der Themeneigenschaften finden Sie TopicDescription unter.

Parameters:

topicPath -
  • Der Name des Themas relativ zur Basisadresse des Dienstnamespaces.

Returns:

TopicDescription des neu erstellten Themas.

deleteQueueAsync

public CompletableFuture deleteQueueAsync(String path)

Löscht die Warteschlange, die durch den Pfad relativ zur Basisadresse des Dienstnamespaces beschrieben wird.

Parameters:

path -
  • Der Name der Entität relativ zur Basisadresse des Dienstnamespaces.

Returns:

Eine abgeschlossene Zukunft, die abgeschlossen wird, wenn die Warteschlange gelöscht wird.

deleteRuleAsync

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

Löscht die Regel für ein bestimmtes Themenabonnement.

Parameters:

topicPath -
  • Der Name des Themas.
subscriptionName -
  • Der Name des Abonnements.
ruleName -
  • Der Name der Regel.

Returns:

Eine abgeschlossene Zukunft, die abgeschlossen wird, wenn die Regel gelöscht wird.

deleteSubscriptionAsync

public CompletableFuture deleteSubscriptionAsync(String topicPath, String subscriptionName)

Löscht das abonnement, das von topicPath und subscriptionName beschrieben wird.

Parameters:

topicPath -
  • Der Name des Themas.
subscriptionName -
  • Der Name des Abonnements.

Returns:

Eine abgeschlossene Zukunft, die abgeschlossen wird, wenn das Abonnement gelöscht wird.

deleteTopicAsync

public CompletableFuture deleteTopicAsync(String path)

Löscht das Thema, das durch den Pfad relativ zur Basisadresse des Dienstnamespaces beschrieben wird.

Parameters:

path -
  • Der Name der Entität relativ zur Basisadresse des Dienstnamespaces.

Returns:

Eine abgeschlossene Zukunft, die abgeschlossen wird, wenn das Thema gelöscht wird.

getNamespaceInfoAsync

public CompletableFuture getNamespaceInfoAsync()

Ruft Informationen im Zusammenhang mit dem Namespace ab. Funktioniert mit jedem Anspruch (Senden/Lauschen/Verwalten).

Returns:

getQueueAsync

public CompletableFuture getQueueAsync(String path)

Ruft eine Warteschlange aus dem Dienstnamespace ab.

Parameters:

path -
  • Der Pfad der Warteschlange relativ zum Service Bus-Namespace.

Returns:

  • QueueDescription mit Informationen zur Warteschlange.

getQueueRuntimeInfoAsync

public CompletableFuture getQueueRuntimeInfoAsync(String path)

Ruft die Laufzeitinformationen einer Warteschlange ab.

Parameters:

path -
  • Der Pfad der Warteschlange relativ zum Service Bus-Namespace.

Returns:

  • QueueRuntimeInfo mit Laufzeitinformationen zur Warteschlange.

getQueuesAsync

public CompletableFuture<>> getQueuesAsync()

Ruft die Liste der Warteschlangen ab, die im Namespace vorhanden sind.

Returns:

die ersten 100 Warteschlangen.

getQueuesAsync

public CompletableFuture<>> getQueuesAsync(int count, int skip)

Ruft die Liste der Warteschlangen ab, die im Namespace vorhanden sind. Sie können Seiten mit einer Liste von Entitäten simulieren, indem Sie die Anzahl und die Überspringen von Parametern bearbeiten. skip(0)+count(100) gibt die ersten 100 Entitäten an. skip(100)+count(100) gibt die nächsten 100 Entitäten an.

Parameters:

count -
  • Die Anzahl der abzurufenden Warteschlangen. Der Standardwert ist 100. Maximal zulässiger Wert ist 100.
skip -
  • Die Anzahl der zu überspringenden Warteschlangen. Der Standardwert ist 0. Kann nicht negativ sein.

Returns:

die Liste der Warteschlangen.

getRuleAsync

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

Ruft eine Regel für ein bestimmtes Thema und Abonnement aus dem Dienstnamespace ab.

Parameters:

topicPath -
  • Der Pfad des Themas relativ zum Service Bus-Namespace.
subscriptionName -
  • Der Name des Abonnements.
ruleName -
  • Der Name der Regel.

Returns:

  • RuleDescription mit Informationen zum Abonnement.

getRulesAsync

public CompletableFuture<>> getRulesAsync(String topicName, String subscriptionName)

Ruft die Liste der Regeln für ein bestimmtes Themenabonnement im Namespace ab.

Parameters:

topicName -
  • Der Name des Themas.
subscriptionName -
  • Der Name des Abonnements.

Returns:

die ersten 100 Regeln.

getRulesAsync

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

Ruft die Liste der Regeln für ein bestimmtes Themenabonnement im Namespace ab. Sie können Seiten mit einer Liste von Entitäten simulieren, indem Sie die Anzahl und die Überspringen von Parametern bearbeiten. skip(0)+count(100) gibt die ersten 100 Entitäten an. skip(100)+count(100) gibt die nächsten 100 Entitäten an.

Parameters:

topicName -
  • Der Name des Themas.
subscriptionName -
  • Der Name des Abonnements.
count -
  • Die Anzahl der abzurufenden Regeln. Der Standardwert ist 100. Maximal zulässiger Wert ist 100.
skip -
  • Die Anzahl der auszulassenden Regeln. Der Standardwert ist 0. Kann nicht negativ sein.

Returns:

die Liste der Regeln.

getSubscriptionAsync

public CompletableFuture getSubscriptionAsync(String topicPath, String subscriptionName)

Ruft ein Abonnement für ein bestimmtes Thema aus dem Dienstnamespace ab.

Parameters:

topicPath -
  • Der Pfad des Themas relativ zum Service Bus-Namespace.
subscriptionName -
  • Der Name des Abonnements

Returns:

  • SubscriptionDescription mit Informationen zum Abonnement.

getSubscriptionRuntimeInfoAsync

public CompletableFuture getSubscriptionRuntimeInfoAsync(String topicPath, String subscriptionName)

Ruft die Laufzeitinformationen eines Abonnements in einem bestimmten Thema ab.

Parameters:

topicPath -
  • Der Pfad des Themas relativ zum Service Bus-Namespace.
subscriptionName -
  • Der Name des Abonnements

Returns:

  • SubscriptionRuntimeInfo mit den Laufzeitinformationen zum Abonnement.

getSubscriptionsAsync

public CompletableFuture<>> getSubscriptionsAsync(String topicName)

Ruft die Liste der Abonnements für ein bestimmtes Thema im Namespace ab.

Parameters:

topicName -
  • Der Name des Themas.

Returns:

die ersten 100 Abonnements.

getSubscriptionsAsync

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

Ruft die Liste der Abonnements für ein bestimmtes Thema im Namespace ab. Sie können Seiten mit einer Liste von Entitäten simulieren, indem Sie die Anzahl und die Überspringen von Parametern bearbeiten. skip(0)+count(100) gibt die ersten 100 Entitäten an. skip(100)+count(100) gibt die nächsten 100 Entitäten an.

Parameters:

topicName -
  • Der Name des Themas.
count -
  • Die Anzahl der abzurufenden Abonnements. Der Standardwert ist 100. Maximal zulässiger Wert ist 100.
skip -
  • Die Anzahl der zu überspringenden Abonnements. Der Standardwert ist 0. Kann nicht negativ sein.

Returns:

die Liste der Abonnements.

getTopicAsync

public CompletableFuture getTopicAsync(String path)

Ruft ein Thema aus dem Dienstnamespace ab.

Parameters:

path -
  • Der Pfad der Warteschlange relativ zum Service Bus-Namespace.

Returns:

  • Beschreibung mit Informationen zum Thema.

getTopicRuntimeInfoAsync

public CompletableFuture getTopicRuntimeInfoAsync(String path)

Ruft die Laufzeitinformationen eines Themas ab.

Parameters:

path -
  • Der Pfad der Warteschlange relativ zum Service Bus-Namespace.

Returns:

  • TopicRuntimeInfo mit Laufzeitinformationen zum Thema.

getTopicsAsync

public CompletableFuture<>> getTopicsAsync()

Ruft die Liste der im Namespace vorhandenen Themen ab.

Returns:

die ersten 100 Themen.

getTopicsAsync

public CompletableFuture<>> getTopicsAsync(int count, int skip)

Ruft die Liste der im Namespace vorhandenen Themen ab. Sie können Seiten mit einer Liste von Entitäten simulieren, indem Sie die Anzahl und die Überspringen von Parametern bearbeiten. skip(0)+count(100) gibt die ersten 100 Entitäten an. skip(100)+count(100) gibt die nächsten 100 Entitäten an.

Parameters:

count -
  • Die Anzahl der abzurufenden Themen. Der Standardwert ist 100. Maximal zulässiger Wert ist 100.
skip -
  • Die Anzahl der zu überspringenden Themen. Der Standardwert ist 0. Kann nicht negativ sein.

Returns:

die Liste der Themen.

queueExistsAsync

public CompletableFuture queueExistsAsync(String path)

Überprüft, ob eine bestimmte Warteschlange vorhanden ist oder nicht.

Parameters:

path -
  • Pfad der zu überprüfenden Entität

Returns:

  • True, wenn die Entität vorhanden ist. Andernfalls FALSE.

ruleExistsAsync

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

Überprüft, ob eine bestimmte Regel für ein bestimmtes Abonnement vorhanden ist.

Parameters:

topicPath -
  • Pfad des Themas
subscriptionName -
  • Name des Abonnements.
ruleName -
  • Name der Regel

Returns:

  • True, wenn die Entität vorhanden ist. Andernfalls FALSE.

subscriptionExistsAsync

public CompletableFuture subscriptionExistsAsync(String topicPath, String subscriptionName)

Überprüft, ob ein bestimmtes Abonnement vorhanden ist.

Parameters:

topicPath -
  • Pfad des Themas
subscriptionName -
  • Name des Abonnements.

Returns:

  • True, wenn die Entität vorhanden ist. Andernfalls FALSE.

topicExistsAsync

public CompletableFuture topicExistsAsync(String path)

Überprüft, ob ein bestimmtes Thema vorhanden ist.

Parameters:

path -
  • Pfad der zu überprüfenden Entität

Returns:

  • True, wenn die Entität vorhanden ist. Andernfalls FALSE.

updateQueueAsync

public CompletableFuture updateQueueAsync(QueueDescription queueDescription)

Updates einer vorhandenen Warteschlange.

Parameters:

queueDescription -
  • Ein QueueDescription Objekt, das die Attribute beschreibt, mit denen die Warteschlange aktualisiert wird.

Returns:

QueueDescription der aktualisierten Warteschlange.

updateRuleAsync

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

Updates eine vorhandene Regel.

Parameters:

topicName -
  • Name des Themas.
subscriptionName -
  • Name des Abonnements.
ruleDescription -
  • Ein RuleDescription -Objekt, das die Attribute beschreibt, mit denen die Regel aktualisiert wird.

Returns:

RuleDescription der aktualisierten Regel.

updateSubscriptionAsync

public CompletableFuture updateSubscriptionAsync(SubscriptionDescription subscriptionDescription)

Updates ein vorhandenes Abonnement.

Parameters:

subscriptionDescription -

Returns:

SubscriptionDescription des aktualisierten Abonnements.

updateTopicAsync

public CompletableFuture updateTopicAsync(TopicDescription topicDescription)

Updates ein vorhandenes Thema.

Parameters:

topicDescription -
  • Ein TopicDescription -Objekt, das die Attribute beschreibt, mit denen das Thema aktualisiert wird.

Returns:

TopicDescription des aktualisierten Themas.

Gilt für: