630 строки
62 KiB
YAML
630 строки
62 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync"
|
|
name: "ManagementClientAsync"
|
|
nameWithType: "ManagementClientAsync"
|
|
summary: "Asynchronous client to perform management operations on Service Bus entities."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public class **ManagementClientAsync**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.ManagementClientAsync(com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.ManagementClientAsync(ConnectionStringBuilder connectionStringBuilder)"
|
|
name: "ManagementClientAsync(ConnectionStringBuilder connectionStringBuilder)"
|
|
nameWithType: "ManagementClientAsync.ManagementClientAsync(ConnectionStringBuilder connectionStringBuilder)"
|
|
summary: "Creates a new <xref uid=\"com.microsoft.azure.servicebus.management.ManagementClientAsync\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ManagementClientAsync\"></xref>."
|
|
parameters:
|
|
- description: "- connectionStringBuilder containing namespace information and client settings."
|
|
name: "connectionStringBuilder"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder?alt=com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder&text=ConnectionStringBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ManagementClientAsync(ConnectionStringBuilder connectionStringBuilder)"
|
|
desc: "Creates a new <xref uid=\"com.microsoft.azure.servicebus.management.ManagementClientAsync\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ManagementClientAsync\"></xref>. User should call <xref uid=\"com.microsoft.azure.servicebus.management.ManagementClientAsync.close()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ManagementClientAsync#close()\"></xref> at the end of life of the client."
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.ManagementClientAsync(java.net.URI,com.microsoft.azure.servicebus.ClientSettings)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.ManagementClientAsync(URI namespaceEndpointURI, ClientSettings clientSettings)"
|
|
name: "ManagementClientAsync(URI namespaceEndpointURI, ClientSettings clientSettings)"
|
|
nameWithType: "ManagementClientAsync.ManagementClientAsync(URI namespaceEndpointURI, ClientSettings clientSettings)"
|
|
summary: "Creates a new <xref uid=\"com.microsoft.azure.servicebus.management.ManagementClientAsync\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ManagementClientAsync\"></xref>."
|
|
parameters:
|
|
- description: "- URI of the namespace connecting to."
|
|
name: "namespaceEndpointURI"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html\">URI</a>"
|
|
- description: "- client settings."
|
|
name: "clientSettings"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ManagementClientAsync(URI namespaceEndpointURI, ClientSettings clientSettings)"
|
|
desc: "Creates a new <xref uid=\"com.microsoft.azure.servicebus.management.ManagementClientAsync\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ManagementClientAsync\"></xref>. User should call <xref uid=\"com.microsoft.azure.servicebus.management.ManagementClientAsync.close()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ManagementClientAsync#close()\"></xref> at the end of life of the client."
|
|
methods:
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.close()"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.close()"
|
|
name: "close()"
|
|
nameWithType: "ManagementClientAsync.close()"
|
|
summary: "Disposes and closes the management<wbr>Client."
|
|
syntax: "public void close()"
|
|
exceptions:
|
|
- description: "if an I/O error occurs"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Disposes and closes the managementClient."
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.createQueueAsync(com.microsoft.azure.servicebus.management.QueueDescription)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.createQueueAsync(QueueDescription queueDescription)"
|
|
name: "createQueueAsync(QueueDescription queueDescription)"
|
|
nameWithType: "ManagementClientAsync.createQueueAsync(QueueDescription queueDescription)"
|
|
summary: "Creates a new queue in the service namespace with the given name."
|
|
parameters:
|
|
- description: "- A <xref uid=\"com.microsoft.azure.servicebus.management.QueueDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueDescription\"></xref> object describing the attributes with which the new queue will be created."
|
|
name: "queueDescription"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.management.QueueDescription?alt=com.microsoft.azure.servicebus.management.QueueDescription&text=QueueDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CompletableFuture<QueueDescription> createQueueAsync(QueueDescription queueDescription)"
|
|
desc: "Creates a new queue in the service namespace with the given name. See <xref uid=\"com.microsoft.azure.servicebus.management.QueueDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueDescription\"></xref> for default values of queue properties."
|
|
returns:
|
|
description: "<xref uid=\"com.microsoft.azure.servicebus.management.QueueDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueDescription\"></xref> of the newly created queue."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.management.QueueDescription?alt=com.microsoft.azure.servicebus.management.QueueDescription&text=QueueDescription\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.createQueueAsync(java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.createQueueAsync(String queuePath)"
|
|
name: "createQueueAsync(String queuePath)"
|
|
nameWithType: "ManagementClientAsync.createQueueAsync(String queuePath)"
|
|
summary: "Creates a new queue in the service namespace with the given name."
|
|
parameters:
|
|
- description: "- The name of the queue relative to the service namespace base address."
|
|
name: "queuePath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<QueueDescription> createQueueAsync(String queuePath)"
|
|
desc: "Creates a new queue in the service namespace with the given name. See <xref uid=\"com.microsoft.azure.servicebus.management.QueueDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueDescription\"></xref> for default values of queue properties."
|
|
returns:
|
|
description: "<xref uid=\"com.microsoft.azure.servicebus.management.QueueDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueDescription\"></xref> of the newly created queue."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.management.QueueDescription?alt=com.microsoft.azure.servicebus.management.QueueDescription&text=QueueDescription\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.createRuleAsync(java.lang.String,java.lang.String,com.microsoft.azure.servicebus.rules.RuleDescription)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.createRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription)"
|
|
name: "createRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription)"
|
|
nameWithType: "ManagementClientAsync.createRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription)"
|
|
summary: "Creates a new rule for a given topic - subscription."
|
|
parameters:
|
|
- description: "- Name of the topic."
|
|
name: "topicName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- Name of the subscription."
|
|
name: "subscriptionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- A <xref uid=\"com.microsoft.azure.servicebus.rules.RuleDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuleDescription\"></xref> object describing the attributes with which the new rule will be created."
|
|
name: "ruleDescription"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.rules.RuleDescription?alt=com.microsoft.azure.servicebus.rules.RuleDescription&text=RuleDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CompletableFuture<RuleDescription> createRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription)"
|
|
desc: "Creates a new rule for a given topic - subscription. See <xref uid=\"com.microsoft.azure.servicebus.rules.RuleDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuleDescription\"></xref> for default values of subscription properties."
|
|
returns:
|
|
description: "<xref uid=\"com.microsoft.azure.servicebus.rules.RuleDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuleDescription\"></xref> of the newly created rule."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.rules.RuleDescription?alt=com.microsoft.azure.servicebus.rules.RuleDescription&text=RuleDescription\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.createSubscriptionAsync(com.microsoft.azure.servicebus.management.SubscriptionDescription)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.createSubscriptionAsync(SubscriptionDescription subscriptionDescription)"
|
|
name: "createSubscriptionAsync(SubscriptionDescription subscriptionDescription)"
|
|
nameWithType: "ManagementClientAsync.createSubscriptionAsync(SubscriptionDescription subscriptionDescription)"
|
|
summary: "Creates a new subscription in the service namespace with the given name."
|
|
parameters:
|
|
- description: "- A <xref uid=\"com.microsoft.azure.servicebus.management.SubscriptionDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SubscriptionDescription\"></xref> object describing the attributes with which the new subscription will be created."
|
|
name: "subscriptionDescription"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.management.SubscriptionDescription?alt=com.microsoft.azure.servicebus.management.SubscriptionDescription&text=SubscriptionDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CompletableFuture<SubscriptionDescription> createSubscriptionAsync(SubscriptionDescription subscriptionDescription)"
|
|
desc: "Creates a new subscription in the service namespace with the given name. See <xref uid=\"com.microsoft.azure.servicebus.management.SubscriptionDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SubscriptionDescription\"></xref> for default values of subscription properties."
|
|
returns:
|
|
description: "<xref uid=\"com.microsoft.azure.servicebus.management.SubscriptionDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SubscriptionDescription\"></xref> of the newly created subscription."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.management.SubscriptionDescription?alt=com.microsoft.azure.servicebus.management.SubscriptionDescription&text=SubscriptionDescription\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.createSubscriptionAsync(com.microsoft.azure.servicebus.management.SubscriptionDescription,com.microsoft.azure.servicebus.rules.RuleDescription)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.createSubscriptionAsync(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)"
|
|
name: "createSubscriptionAsync(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)"
|
|
nameWithType: "ManagementClientAsync.createSubscriptionAsync(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)"
|
|
summary: "Creates a new subscription in the service namespace with the provided default rule."
|
|
parameters:
|
|
- description: "- A <xref uid=\"com.microsoft.azure.servicebus.management.SubscriptionDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SubscriptionDescription\"></xref> object describing the attributes with which the new subscription will be created."
|
|
name: "subscriptionDescription"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.management.SubscriptionDescription?alt=com.microsoft.azure.servicebus.management.SubscriptionDescription&text=SubscriptionDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "- A <xref uid=\"com.microsoft.azure.servicebus.rules.RuleDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuleDescription\"></xref> object describing the default rule. If null, then pass-through filter will be created."
|
|
name: "defaultRule"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.rules.RuleDescription?alt=com.microsoft.azure.servicebus.rules.RuleDescription&text=RuleDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CompletableFuture<SubscriptionDescription> createSubscriptionAsync(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)"
|
|
desc: "Creates a new subscription in the service namespace with the provided default rule. See <xref uid=\"com.microsoft.azure.servicebus.management.SubscriptionDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SubscriptionDescription\"></xref> for default values of subscription properties."
|
|
returns:
|
|
description: "<xref uid=\"com.microsoft.azure.servicebus.management.SubscriptionDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SubscriptionDescription\"></xref> of the newly created subscription."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.management.SubscriptionDescription?alt=com.microsoft.azure.servicebus.management.SubscriptionDescription&text=SubscriptionDescription\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.createSubscriptionAsync(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.createSubscriptionAsync(String topicPath, String subscriptionName)"
|
|
name: "createSubscriptionAsync(String topicPath, String subscriptionName)"
|
|
nameWithType: "ManagementClientAsync.createSubscriptionAsync(String topicPath, String subscriptionName)"
|
|
summary: "Creates a new subscription for a given topic in the service namespace with the given name."
|
|
parameters:
|
|
- description: "- The name of the topic relative to the service namespace base address."
|
|
name: "topicPath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- The name of the subscription."
|
|
name: "subscriptionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<SubscriptionDescription> createSubscriptionAsync(String topicPath, String subscriptionName)"
|
|
desc: "Creates a new subscription for a given topic in the service namespace with the given name. See <xref uid=\"com.microsoft.azure.servicebus.management.SubscriptionDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SubscriptionDescription\"></xref> for default values of subscription properties."
|
|
returns:
|
|
description: "<xref uid=\"com.microsoft.azure.servicebus.management.SubscriptionDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SubscriptionDescription\"></xref> of the newly created subscription."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.management.SubscriptionDescription?alt=com.microsoft.azure.servicebus.management.SubscriptionDescription&text=SubscriptionDescription\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.createTopicAsync(com.microsoft.azure.servicebus.management.TopicDescription)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.createTopicAsync(TopicDescription topicDescription)"
|
|
name: "createTopicAsync(TopicDescription topicDescription)"
|
|
nameWithType: "ManagementClientAsync.createTopicAsync(TopicDescription topicDescription)"
|
|
summary: "Creates a new topic in the service namespace with the given name."
|
|
parameters:
|
|
- description: "- A <xref uid=\"com.microsoft.azure.servicebus.management.QueueDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueDescription\"></xref> object describing the attributes with which the new topic will be created."
|
|
name: "topicDescription"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.management.TopicDescription?alt=com.microsoft.azure.servicebus.management.TopicDescription&text=TopicDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CompletableFuture<TopicDescription> createTopicAsync(TopicDescription topicDescription)"
|
|
desc: "Creates a new topic in the service namespace with the given name. See <xref uid=\"com.microsoft.azure.servicebus.management.TopicDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TopicDescription\"></xref> for default values of topic properties."
|
|
returns:
|
|
description: "<xref uid=\"com.microsoft.azure.servicebus.management.TopicDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TopicDescription\"></xref> of the newly created topic."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.management.TopicDescription?alt=com.microsoft.azure.servicebus.management.TopicDescription&text=TopicDescription\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.createTopicAsync(java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.createTopicAsync(String topicPath)"
|
|
name: "createTopicAsync(String topicPath)"
|
|
nameWithType: "ManagementClientAsync.createTopicAsync(String topicPath)"
|
|
summary: "Creates a new topic in the service namespace with the given name."
|
|
parameters:
|
|
- description: "- The name of the topic relative to the service namespace base address."
|
|
name: "topicPath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<TopicDescription> createTopicAsync(String topicPath)"
|
|
desc: "Creates a new topic in the service namespace with the given name. See <xref uid=\"com.microsoft.azure.servicebus.management.TopicDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TopicDescription\"></xref> for default values of topic properties."
|
|
returns:
|
|
description: "<xref uid=\"com.microsoft.azure.servicebus.management.TopicDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TopicDescription\"></xref> of the newly created topic."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.management.TopicDescription?alt=com.microsoft.azure.servicebus.management.TopicDescription&text=TopicDescription\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.deleteQueueAsync(java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.deleteQueueAsync(String path)"
|
|
name: "deleteQueueAsync(String path)"
|
|
nameWithType: "ManagementClientAsync.deleteQueueAsync(String path)"
|
|
summary: "Deletes the queue described by the path relative to the service namespace base address."
|
|
parameters:
|
|
- description: "- The name of the entity relative to the service namespace base address."
|
|
name: "path"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<Void> deleteQueueAsync(String path)"
|
|
desc: "Deletes the queue described by the path relative to the service namespace base address."
|
|
returns:
|
|
description: "A completable future that completes when the queue is deleted."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.deleteRuleAsync(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.deleteRuleAsync(String topicPath, String subscriptionName, String ruleName)"
|
|
name: "deleteRuleAsync(String topicPath, String subscriptionName, String ruleName)"
|
|
nameWithType: "ManagementClientAsync.deleteRuleAsync(String topicPath, String subscriptionName, String ruleName)"
|
|
summary: "Deletes the rule for a given topic-subscription."
|
|
parameters:
|
|
- description: "- The name of the topic."
|
|
name: "topicPath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- The name of the subscription."
|
|
name: "subscriptionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- The name of the rule."
|
|
name: "ruleName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<Void> deleteRuleAsync(String topicPath, String subscriptionName, String ruleName)"
|
|
desc: "Deletes the rule for a given topic-subscription."
|
|
returns:
|
|
description: "A completable future that completes when the rule is deleted."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.deleteSubscriptionAsync(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.deleteSubscriptionAsync(String topicPath, String subscriptionName)"
|
|
name: "deleteSubscriptionAsync(String topicPath, String subscriptionName)"
|
|
nameWithType: "ManagementClientAsync.deleteSubscriptionAsync(String topicPath, String subscriptionName)"
|
|
summary: "Deletes the subscription described by the topic<wbr>Path and the subscription<wbr>Name."
|
|
parameters:
|
|
- description: "- The name of the topic."
|
|
name: "topicPath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- The name of the subscription."
|
|
name: "subscriptionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<Void> deleteSubscriptionAsync(String topicPath, String subscriptionName)"
|
|
desc: "Deletes the subscription described by the topicPath and the subscriptionName."
|
|
returns:
|
|
description: "A completable future that completes when the subscription is deleted."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.deleteTopicAsync(java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.deleteTopicAsync(String path)"
|
|
name: "deleteTopicAsync(String path)"
|
|
nameWithType: "ManagementClientAsync.deleteTopicAsync(String path)"
|
|
summary: "Deletes the topic described by the path relative to the service namespace base address."
|
|
parameters:
|
|
- description: "- The name of the entity relative to the service namespace base address."
|
|
name: "path"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<Void> deleteTopicAsync(String path)"
|
|
desc: "Deletes the topic described by the path relative to the service namespace base address."
|
|
returns:
|
|
description: "A completable future that completes when the topic is deleted."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getNamespaceInfoAsync()"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getNamespaceInfoAsync()"
|
|
name: "getNamespaceInfoAsync()"
|
|
nameWithType: "ManagementClientAsync.getNamespaceInfoAsync()"
|
|
summary: "Retrieves information related to the namespace."
|
|
syntax: "public CompletableFuture<NamespaceInfo> getNamespaceInfoAsync()"
|
|
desc: "Retrieves information related to the namespace. Works with any claim (Send/Listen/Manage)."
|
|
returns:
|
|
description: "- <xref uid=\"com.microsoft.azure.servicebus.management.NamespaceInfo\" data-throw-if-not-resolved=\"false\" data-raw-source=\"NamespaceInfo\"></xref> containing namespace information."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.management.NamespaceInfo?alt=com.microsoft.azure.servicebus.management.NamespaceInfo&text=NamespaceInfo\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getQueueAsync(java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getQueueAsync(String path)"
|
|
name: "getQueueAsync(String path)"
|
|
nameWithType: "ManagementClientAsync.getQueueAsync(String path)"
|
|
summary: "Retrieves a queue from the service namespace"
|
|
parameters:
|
|
- description: "- The path of the queue relative to service bus namespace."
|
|
name: "path"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<QueueDescription> getQueueAsync(String path)"
|
|
desc: "Retrieves a queue from the service namespace"
|
|
returns:
|
|
description: "- QueueDescription containing information about the queue."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.management.QueueDescription?alt=com.microsoft.azure.servicebus.management.QueueDescription&text=QueueDescription\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getQueueRuntimeInfoAsync(java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getQueueRuntimeInfoAsync(String path)"
|
|
name: "getQueueRuntimeInfoAsync(String path)"
|
|
nameWithType: "ManagementClientAsync.getQueueRuntimeInfoAsync(String path)"
|
|
summary: "Retrieves the runtime information of a queue."
|
|
parameters:
|
|
- description: "- The path of the queue relative to service bus namespace."
|
|
name: "path"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<QueueRuntimeInfo> getQueueRuntimeInfoAsync(String path)"
|
|
desc: "Retrieves the runtime information of a queue."
|
|
returns:
|
|
description: "- QueueRuntimeInfo containing runtime information about the queue."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.management.QueueRuntimeInfo?alt=com.microsoft.azure.servicebus.management.QueueRuntimeInfo&text=QueueRuntimeInfo\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getQueuesAsync()"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getQueuesAsync()"
|
|
name: "getQueuesAsync()"
|
|
nameWithType: "ManagementClientAsync.getQueuesAsync()"
|
|
summary: "Retrieves the list of queues present in the namespace."
|
|
syntax: "public CompletableFuture<List<QueueDescription>> getQueuesAsync()"
|
|
desc: "Retrieves the list of queues present in the namespace."
|
|
returns:
|
|
description: "the first 100 queues."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.servicebus.management.QueueDescription?alt=com.microsoft.azure.servicebus.management.QueueDescription&text=QueueDescription\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getQueuesAsync(int,int)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getQueuesAsync(int count, int skip)"
|
|
name: "getQueuesAsync(int count, int skip)"
|
|
nameWithType: "ManagementClientAsync.getQueuesAsync(int count, int skip)"
|
|
summary: "Retrieves the list of queues present in the namespace."
|
|
parameters:
|
|
- description: "- The number of queues to fetch. Defaults to 100. Maximum value allowed is 100."
|
|
name: "count"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "- The number of queues to skip. Defaults to 0. Cannot be negative."
|
|
name: "skip"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CompletableFuture<List<QueueDescription>> getQueuesAsync(int count, int skip)"
|
|
desc: "Retrieves the list of queues present in the namespace. You can simulate pages of list of entities by manipulating count and skip parameters. skip(0)+count(100) gives first 100 entities. skip(100)+count(100) gives the next 100 entities."
|
|
returns:
|
|
description: "the list of queues."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.servicebus.management.QueueDescription?alt=com.microsoft.azure.servicebus.management.QueueDescription&text=QueueDescription\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getRuleAsync(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getRuleAsync(String topicPath, String subscriptionName, String ruleName)"
|
|
name: "getRuleAsync(String topicPath, String subscriptionName, String ruleName)"
|
|
nameWithType: "ManagementClientAsync.getRuleAsync(String topicPath, String subscriptionName, String ruleName)"
|
|
summary: "Retrieves a rule for a given topic and subscription from the service namespace"
|
|
parameters:
|
|
- description: "- The path of the topic relative to service bus namespace."
|
|
name: "topicPath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- The name of the subscription."
|
|
name: "subscriptionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- The name of the rule."
|
|
name: "ruleName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<RuleDescription> getRuleAsync(String topicPath, String subscriptionName, String ruleName)"
|
|
desc: "Retrieves a rule for a given topic and subscription from the service namespace"
|
|
returns:
|
|
description: "- RuleDescription containing information about the subscription."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.rules.RuleDescription?alt=com.microsoft.azure.servicebus.rules.RuleDescription&text=RuleDescription\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getRulesAsync(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getRulesAsync(String topicName, String subscriptionName)"
|
|
name: "getRulesAsync(String topicName, String subscriptionName)"
|
|
nameWithType: "ManagementClientAsync.getRulesAsync(String topicName, String subscriptionName)"
|
|
summary: "Retrieves the list of rules for a given topic-subscription in the namespace."
|
|
parameters:
|
|
- description: "- The name of the topic."
|
|
name: "topicName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- The name of the subscription."
|
|
name: "subscriptionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<List<RuleDescription>> getRulesAsync(String topicName, String subscriptionName)"
|
|
desc: "Retrieves the list of rules for a given topic-subscription in the namespace."
|
|
returns:
|
|
description: "the first 100 rules."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.servicebus.rules.RuleDescription?alt=com.microsoft.azure.servicebus.rules.RuleDescription&text=RuleDescription\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getRulesAsync(java.lang.String,java.lang.String,int,int)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getRulesAsync(String topicName, String subscriptionName, int count, int skip)"
|
|
name: "getRulesAsync(String topicName, String subscriptionName, int count, int skip)"
|
|
nameWithType: "ManagementClientAsync.getRulesAsync(String topicName, String subscriptionName, int count, int skip)"
|
|
summary: "Retrieves the list of rules for a given topic-subscription in the namespace."
|
|
parameters:
|
|
- description: "- The name of the topic."
|
|
name: "topicName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- The name of the subscription."
|
|
name: "subscriptionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- The number of rules to fetch. Defaults to 100. Maximum value allowed is 100."
|
|
name: "count"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "- The number of rules to skip. Defaults to 0. Cannot be negative."
|
|
name: "skip"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CompletableFuture<List<RuleDescription>> getRulesAsync(String topicName, String subscriptionName, int count, int skip)"
|
|
desc: "Retrieves the list of rules for a given topic-subscription in the namespace. You can simulate pages of list of entities by manipulating count and skip parameters. skip(0)+count(100) gives first 100 entities. skip(100)+count(100) gives the next 100 entities."
|
|
returns:
|
|
description: "the list of rules."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.servicebus.rules.RuleDescription?alt=com.microsoft.azure.servicebus.rules.RuleDescription&text=RuleDescription\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getSubscriptionAsync(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getSubscriptionAsync(String topicPath, String subscriptionName)"
|
|
name: "getSubscriptionAsync(String topicPath, String subscriptionName)"
|
|
nameWithType: "ManagementClientAsync.getSubscriptionAsync(String topicPath, String subscriptionName)"
|
|
summary: "Retrieves a subscription for a given topic from the service namespace"
|
|
parameters:
|
|
- description: "- The path of the topic relative to service bus namespace."
|
|
name: "topicPath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- The name of the subscription"
|
|
name: "subscriptionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<SubscriptionDescription> getSubscriptionAsync(String topicPath, String subscriptionName)"
|
|
desc: "Retrieves a subscription for a given topic from the service namespace"
|
|
returns:
|
|
description: "- SubscriptionDescription containing information about the subscription."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.management.SubscriptionDescription?alt=com.microsoft.azure.servicebus.management.SubscriptionDescription&text=SubscriptionDescription\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getSubscriptionRuntimeInfoAsync(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getSubscriptionRuntimeInfoAsync(String topicPath, String subscriptionName)"
|
|
name: "getSubscriptionRuntimeInfoAsync(String topicPath, String subscriptionName)"
|
|
nameWithType: "ManagementClientAsync.getSubscriptionRuntimeInfoAsync(String topicPath, String subscriptionName)"
|
|
summary: "Retrieves the runtime information of a subscription in a given topic"
|
|
parameters:
|
|
- description: "- The path of the topic relative to service bus namespace."
|
|
name: "topicPath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- The name of the subscription"
|
|
name: "subscriptionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<SubscriptionRuntimeInfo> getSubscriptionRuntimeInfoAsync(String topicPath, String subscriptionName)"
|
|
desc: "Retrieves the runtime information of a subscription in a given topic"
|
|
returns:
|
|
description: "- SubscriptionRuntimeInfo containing the runtime information about the subscription."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.management.SubscriptionRuntimeInfo?alt=com.microsoft.azure.servicebus.management.SubscriptionRuntimeInfo&text=SubscriptionRuntimeInfo\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getSubscriptionsAsync(java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getSubscriptionsAsync(String topicName)"
|
|
name: "getSubscriptionsAsync(String topicName)"
|
|
nameWithType: "ManagementClientAsync.getSubscriptionsAsync(String topicName)"
|
|
summary: "Retrieves the list of subscriptions for a given topic in the namespace."
|
|
parameters:
|
|
- description: "- The name of the topic."
|
|
name: "topicName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<List<SubscriptionDescription>> getSubscriptionsAsync(String topicName)"
|
|
desc: "Retrieves the list of subscriptions for a given topic in the namespace."
|
|
returns:
|
|
description: "the first 100 subscriptions."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.servicebus.management.SubscriptionDescription?alt=com.microsoft.azure.servicebus.management.SubscriptionDescription&text=SubscriptionDescription\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getSubscriptionsAsync(java.lang.String,int,int)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getSubscriptionsAsync(String topicName, int count, int skip)"
|
|
name: "getSubscriptionsAsync(String topicName, int count, int skip)"
|
|
nameWithType: "ManagementClientAsync.getSubscriptionsAsync(String topicName, int count, int skip)"
|
|
summary: "Retrieves the list of subscriptions for a given topic in the namespace."
|
|
parameters:
|
|
- description: "- The name of the topic."
|
|
name: "topicName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- The number of subscriptions to fetch. Defaults to 100. Maximum value allowed is 100."
|
|
name: "count"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "- The number of subscriptions to skip. Defaults to 0. Cannot be negative."
|
|
name: "skip"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CompletableFuture<List<SubscriptionDescription>> getSubscriptionsAsync(String topicName, int count, int skip)"
|
|
desc: "Retrieves the list of subscriptions for a given topic in the namespace. You can simulate pages of list of entities by manipulating count and skip parameters. skip(0)+count(100) gives first 100 entities. skip(100)+count(100) gives the next 100 entities."
|
|
returns:
|
|
description: "the list of subscriptions."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.servicebus.management.SubscriptionDescription?alt=com.microsoft.azure.servicebus.management.SubscriptionDescription&text=SubscriptionDescription\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getTopicAsync(java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getTopicAsync(String path)"
|
|
name: "getTopicAsync(String path)"
|
|
nameWithType: "ManagementClientAsync.getTopicAsync(String path)"
|
|
summary: "Retrieves a topic from the service namespace"
|
|
parameters:
|
|
- description: "- The path of the queue relative to service bus namespace."
|
|
name: "path"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<TopicDescription> getTopicAsync(String path)"
|
|
desc: "Retrieves a topic from the service namespace"
|
|
returns:
|
|
description: "- Description containing information about the topic."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.management.TopicDescription?alt=com.microsoft.azure.servicebus.management.TopicDescription&text=TopicDescription\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getTopicRuntimeInfoAsync(java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getTopicRuntimeInfoAsync(String path)"
|
|
name: "getTopicRuntimeInfoAsync(String path)"
|
|
nameWithType: "ManagementClientAsync.getTopicRuntimeInfoAsync(String path)"
|
|
summary: "Retrieves the runtime information of a topic"
|
|
parameters:
|
|
- description: "- The path of the queue relative to service bus namespace."
|
|
name: "path"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<TopicRuntimeInfo> getTopicRuntimeInfoAsync(String path)"
|
|
desc: "Retrieves the runtime information of a topic"
|
|
returns:
|
|
description: "- TopicRuntimeInfo containing runtime information about the topic."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.management.TopicRuntimeInfo?alt=com.microsoft.azure.servicebus.management.TopicRuntimeInfo&text=TopicRuntimeInfo\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getTopicsAsync()"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getTopicsAsync()"
|
|
name: "getTopicsAsync()"
|
|
nameWithType: "ManagementClientAsync.getTopicsAsync()"
|
|
summary: "Retrieves the list of topics present in the namespace."
|
|
syntax: "public CompletableFuture<List<TopicDescription>> getTopicsAsync()"
|
|
desc: "Retrieves the list of topics present in the namespace."
|
|
returns:
|
|
description: "the first 100 topics."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.servicebus.management.TopicDescription?alt=com.microsoft.azure.servicebus.management.TopicDescription&text=TopicDescription\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getTopicsAsync(int,int)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.getTopicsAsync(int count, int skip)"
|
|
name: "getTopicsAsync(int count, int skip)"
|
|
nameWithType: "ManagementClientAsync.getTopicsAsync(int count, int skip)"
|
|
summary: "Retrieves the list of topics present in the namespace."
|
|
parameters:
|
|
- description: "- The number of topics to fetch. Defaults to 100. Maximum value allowed is 100."
|
|
name: "count"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "- The number of topics to skip. Defaults to 0. Cannot be negative."
|
|
name: "skip"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CompletableFuture<List<TopicDescription>> getTopicsAsync(int count, int skip)"
|
|
desc: "Retrieves the list of topics present in the namespace. You can simulate pages of list of entities by manipulating count and skip parameters. skip(0)+count(100) gives first 100 entities. skip(100)+count(100) gives the next 100 entities."
|
|
returns:
|
|
description: "the list of topics."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.servicebus.management.TopicDescription?alt=com.microsoft.azure.servicebus.management.TopicDescription&text=TopicDescription\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.queueExistsAsync(java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.queueExistsAsync(String path)"
|
|
name: "queueExistsAsync(String path)"
|
|
nameWithType: "ManagementClientAsync.queueExistsAsync(String path)"
|
|
summary: "Checks whether a given queue exists or not."
|
|
parameters:
|
|
- description: "- Path of the entity to check"
|
|
name: "path"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<Boolean> queueExistsAsync(String path)"
|
|
desc: "Checks whether a given queue exists or not."
|
|
returns:
|
|
description: "- True if the entity exists. False otherwise."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.ruleExistsAsync(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.ruleExistsAsync(String topicPath, String subscriptionName, String ruleName)"
|
|
name: "ruleExistsAsync(String topicPath, String subscriptionName, String ruleName)"
|
|
nameWithType: "ManagementClientAsync.ruleExistsAsync(String topicPath, String subscriptionName, String ruleName)"
|
|
summary: "Checks whether a given rule exists or not for a given subscription."
|
|
parameters:
|
|
- description: "- Path of the topic"
|
|
name: "topicPath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- Name of the subscription."
|
|
name: "subscriptionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- Name of the rule"
|
|
name: "ruleName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<Boolean> ruleExistsAsync(String topicPath, String subscriptionName, String ruleName)"
|
|
desc: "Checks whether a given rule exists or not for a given subscription."
|
|
returns:
|
|
description: "- True if the entity exists. False otherwise."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.subscriptionExistsAsync(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.subscriptionExistsAsync(String topicPath, String subscriptionName)"
|
|
name: "subscriptionExistsAsync(String topicPath, String subscriptionName)"
|
|
nameWithType: "ManagementClientAsync.subscriptionExistsAsync(String topicPath, String subscriptionName)"
|
|
summary: "Checks whether a given subscription exists or not."
|
|
parameters:
|
|
- description: "- Path of the topic"
|
|
name: "topicPath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- Name of the subscription."
|
|
name: "subscriptionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<Boolean> subscriptionExistsAsync(String topicPath, String subscriptionName)"
|
|
desc: "Checks whether a given subscription exists or not."
|
|
returns:
|
|
description: "- True if the entity exists. False otherwise."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.topicExistsAsync(java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.topicExistsAsync(String path)"
|
|
name: "topicExistsAsync(String path)"
|
|
nameWithType: "ManagementClientAsync.topicExistsAsync(String path)"
|
|
summary: "Checks whether a given topic exists or not."
|
|
parameters:
|
|
- description: "- Path of the entity to check"
|
|
name: "path"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CompletableFuture<Boolean> topicExistsAsync(String path)"
|
|
desc: "Checks whether a given topic exists or not."
|
|
returns:
|
|
description: "- True if the entity exists. False otherwise."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.updateQueueAsync(com.microsoft.azure.servicebus.management.QueueDescription)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.updateQueueAsync(QueueDescription queueDescription)"
|
|
name: "updateQueueAsync(QueueDescription queueDescription)"
|
|
nameWithType: "ManagementClientAsync.updateQueueAsync(QueueDescription queueDescription)"
|
|
summary: "Updates an existing queue."
|
|
parameters:
|
|
- description: "- A <xref uid=\"com.microsoft.azure.servicebus.management.QueueDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueDescription\"></xref> object describing the attributes with which the queue will be updated."
|
|
name: "queueDescription"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.management.QueueDescription?alt=com.microsoft.azure.servicebus.management.QueueDescription&text=QueueDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CompletableFuture<QueueDescription> updateQueueAsync(QueueDescription queueDescription)"
|
|
desc: "Updates an existing queue."
|
|
returns:
|
|
description: "<xref uid=\"com.microsoft.azure.servicebus.management.QueueDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueDescription\"></xref> of the updated queue."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.management.QueueDescription?alt=com.microsoft.azure.servicebus.management.QueueDescription&text=QueueDescription\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.updateRuleAsync(java.lang.String,java.lang.String,com.microsoft.azure.servicebus.rules.RuleDescription)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.updateRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription)"
|
|
name: "updateRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription)"
|
|
nameWithType: "ManagementClientAsync.updateRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription)"
|
|
summary: "Updates an existing rule."
|
|
parameters:
|
|
- description: "- Name of the topic."
|
|
name: "topicName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- Name of the subscription."
|
|
name: "subscriptionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "- A <xref uid=\"com.microsoft.azure.servicebus.rules.RuleDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuleDescription\"></xref> object describing the attributes with which the rule will be updated."
|
|
name: "ruleDescription"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.rules.RuleDescription?alt=com.microsoft.azure.servicebus.rules.RuleDescription&text=RuleDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CompletableFuture<RuleDescription> updateRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription)"
|
|
desc: "Updates an existing rule."
|
|
returns:
|
|
description: "<xref uid=\"com.microsoft.azure.servicebus.rules.RuleDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuleDescription\"></xref> of the updated rule."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.rules.RuleDescription?alt=com.microsoft.azure.servicebus.rules.RuleDescription&text=RuleDescription\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.updateSubscriptionAsync(com.microsoft.azure.servicebus.management.SubscriptionDescription)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.updateSubscriptionAsync(SubscriptionDescription subscriptionDescription)"
|
|
name: "updateSubscriptionAsync(SubscriptionDescription subscriptionDescription)"
|
|
nameWithType: "ManagementClientAsync.updateSubscriptionAsync(SubscriptionDescription subscriptionDescription)"
|
|
summary: "Updates an existing subscription."
|
|
parameters:
|
|
- description: "- A <xref uid=\"com.microsoft.azure.servicebus.management.SubscriptionDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SubscriptionDescription\"></xref> object describing the attributes with which the subscription will be updated."
|
|
name: "subscriptionDescription"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.management.SubscriptionDescription?alt=com.microsoft.azure.servicebus.management.SubscriptionDescription&text=SubscriptionDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CompletableFuture<SubscriptionDescription> updateSubscriptionAsync(SubscriptionDescription subscriptionDescription)"
|
|
desc: "Updates an existing subscription."
|
|
returns:
|
|
description: "<xref uid=\"com.microsoft.azure.servicebus.management.SubscriptionDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SubscriptionDescription\"></xref> of the updated subscription."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.management.SubscriptionDescription?alt=com.microsoft.azure.servicebus.management.SubscriptionDescription&text=SubscriptionDescription\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.management.ManagementClientAsync.updateTopicAsync(com.microsoft.azure.servicebus.management.TopicDescription)"
|
|
fullName: "com.microsoft.azure.servicebus.management.ManagementClientAsync.updateTopicAsync(TopicDescription topicDescription)"
|
|
name: "updateTopicAsync(TopicDescription topicDescription)"
|
|
nameWithType: "ManagementClientAsync.updateTopicAsync(TopicDescription topicDescription)"
|
|
summary: "Updates an existing topic."
|
|
parameters:
|
|
- description: "- A <xref uid=\"com.microsoft.azure.servicebus.management.TopicDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TopicDescription\"></xref> object describing the attributes with which the topic will be updated."
|
|
name: "topicDescription"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.management.TopicDescription?alt=com.microsoft.azure.servicebus.management.TopicDescription&text=TopicDescription\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CompletableFuture<TopicDescription> updateTopicAsync(TopicDescription topicDescription)"
|
|
desc: "Updates an existing topic."
|
|
returns:
|
|
description: "<xref uid=\"com.microsoft.azure.servicebus.management.TopicDescription\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TopicDescription\"></xref> of the updated topic."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.management.TopicDescription?alt=com.microsoft.azure.servicebus.management.TopicDescription&text=TopicDescription\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "class"
|
|
desc: "Asynchronous client to perform management operations on Service Bus entities. Operations return CompletableFuture which asynchronously return the responses."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.servicebus.management"
|
|
artifact: com.microsoft.azure:azure-servicebus:3.6.7
|