你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

ManagementClientAsync 类

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

public class ManagementClientAsync

异步客户端,用于对服务总线实体执行管理操作。 操作返回以异步方式返回响应的 CompletableFuture。

构造函数摘要

构造函数 说明
ManagementClientAsync(ConnectionStringBuilder connectionStringBuilder)

创建一个新的 ManagementClientAsync

ManagementClientAsync(URI namespaceEndpointURI, ClientSettings clientSettings)

创建一个新的 ManagementClientAsync

方法摘要

修饰符和类型 方法和描述
void close()

释放并关闭管理客户端。

CompletableFuture<QueueDescription> createQueueAsync(QueueDescription queueDescription)

使用给定名称在服务命名空间中创建一个新队列。

CompletableFuture<QueueDescription> createQueueAsync(String queuePath)

使用给定名称在服务命名空间中创建一个新队列。

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

为给定主题 - 订阅创建新规则。

CompletableFuture<SubscriptionDescription> createSubscriptionAsync(SubscriptionDescription subscriptionDescription)

使用给定名称在服务命名空间中创建一个新订阅。

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

使用提供的默认规则在服务命名空间中创建新订阅。

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

使用给定名称在服务命名空间中为给定主题创建一个新订阅。

CompletableFuture<TopicDescription> createTopicAsync(TopicDescription topicDescription)

使用给定名称在服务命名空间中创建一个新主题。

CompletableFuture<TopicDescription> createTopicAsync(String topicPath)

使用给定名称在服务命名空间中创建一个新主题。

CompletableFuture<Void> deleteQueueAsync(String path)

删除由相对于服务命名空间基址的路径描述的队列。

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

删除给定主题订阅的规则。

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

删除主题Path 和订阅名称描述的订阅

CompletableFuture<Void> deleteTopicAsync(String path)

删除由相对于服务命名空间基址的路径描述的主题。

CompletableFuture<NamespaceInfo> getNamespaceInfoAsync()

检索与命名空间相关的信息。

CompletableFuture<QueueDescription> getQueueAsync(String path)

从服务命名空间检索队列

CompletableFuture<QueueRuntimeInfo> getQueueRuntimeInfoAsync(String path)

检索队列的运行时信息。

CompletableFuture<List<QueueDescription>> getQueuesAsync()

检索命名空间中存在的队列列表。

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

检索命名空间中存在的队列列表。

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

从服务命名空间检索给定主题和订阅的规则

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

检索命名空间中给定主题订阅的规则列表。

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

检索命名空间中给定主题订阅的规则列表。

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

从服务命名空间检索给定主题的订阅

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

检索给定主题中订阅的运行时信息

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

检索命名空间中给定主题的订阅列表。

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

检索命名空间中给定主题的订阅列表。

CompletableFuture<TopicDescription> getTopicAsync(String path)

从服务命名空间检索主题

CompletableFuture<TopicRuntimeInfo> getTopicRuntimeInfoAsync(String path)

检索主题的运行时信息

CompletableFuture<List<TopicDescription>> getTopicsAsync()

检索命名空间中存在的主题列表。

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

检索命名空间中存在的主题列表。

CompletableFuture<Boolean> queueExistsAsync(String path)

检查给定队列是否存在。

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

检查给定订阅是否存在给定规则。

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

检查给定订阅是否存在。

CompletableFuture<Boolean> topicExistsAsync(String path)

检查给定主题是否存在。

CompletableFuture<QueueDescription> updateQueueAsync(QueueDescription queueDescription)

汇报现有队列。

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

汇报现有规则。

CompletableFuture<SubscriptionDescription> updateSubscriptionAsync(SubscriptionDescription subscriptionDescription)

汇报现有订阅。

CompletableFuture<TopicDescription> updateTopicAsync(TopicDescription topicDescription)

汇报现有主题。

方法继承自 java.lang.Object

构造函数详细信息

ManagementClientAsync

public ManagementClientAsync(ConnectionStringBuilder connectionStringBuilder)

创建一个新的 ManagementClientAsync。 用户应在客户端生命周期结束时调用 close()

参数:

connectionStringBuilder -
  • connectionStringBuilder 包含命名空间信息和客户端设置。

ManagementClientAsync

public ManagementClientAsync(URI namespaceEndpointURI, ClientSettings clientSettings)

创建一个新的 ManagementClientAsync。 用户应在客户端生命周期结束时调用 close()

参数:

namespaceEndpointURI -
  • 连接到的命名空间的 URI。
clientSettings -
  • 客户端设置。

方法详细信息

close

public void close()

释放并关闭 managementClient。

引发:

IOException

- 如果发生 I/O 错误

createQueueAsync

public CompletableFuture createQueueAsync(QueueDescription queueDescription)

使用给定名称在服务命名空间中创建一个新队列。 有关队列属性的默认值,请参阅 QueueDescription

参数:

queueDescription -

返回:

QueueDescription 新创建的队列的 。

createQueueAsync

public CompletableFuture createQueueAsync(String queuePath)

使用给定名称在服务命名空间中创建一个新队列。 有关队列属性的默认值,请参阅 QueueDescription

参数:

queuePath -
  • 相对于服务命名空间基址的队列名称。

返回:

QueueDescription 新创建的队列的 。

createRuleAsync

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

为给定主题 - 订阅创建新规则。 有关订阅属性的默认值,请参阅 RuleDescription

参数:

topicName -
  • 主题名称。
subscriptionName -
  • 订阅的名称。
ruleDescription -
  • 一个 RuleDescription 对象,该对象描述将用于创建新规则的属性。

返回:

RuleDescription 新创建的规则的 。

createSubscriptionAsync

public CompletableFuture createSubscriptionAsync(SubscriptionDescription subscriptionDescription)

使用给定名称在服务命名空间中创建一个新订阅。 有关订阅属性的默认值,请参阅 SubscriptionDescription

参数:

subscriptionDescription -

返回:

SubscriptionDescription 新创建的订阅的 。

createSubscriptionAsync

public CompletableFuture createSubscriptionAsync(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)

使用提供的默认规则在服务命名空间中创建新订阅。 有关订阅属性的默认值,请参阅 SubscriptionDescription

参数:

subscriptionDescription -
defaultRule -
  • 描述 RuleDescription 默认规则的 对象。 如果为 null,则将创建直通筛选器。

返回:

SubscriptionDescription 新创建的订阅的 。

createSubscriptionAsync

public CompletableFuture createSubscriptionAsync(String topicPath, String subscriptionName)

使用给定名称在服务命名空间中为给定主题创建一个新订阅。 有关订阅属性的默认值,请参阅 SubscriptionDescription

参数:

topicPath -
  • 相对于服务命名空间基址的主题的名称。
subscriptionName -
  • 订阅的名称。

返回:

SubscriptionDescription 新创建的订阅的 。

createTopicAsync

public CompletableFuture createTopicAsync(TopicDescription topicDescription)

使用给定名称在服务命名空间中创建一个新主题。 有关主题属性的默认值,请参阅 TopicDescription

参数:

topicDescription -
  • 一个 QueueDescription 对象,该对象描述将用于创建新主题的属性。

返回:

TopicDescription 新创建的主题。

createTopicAsync

public CompletableFuture createTopicAsync(String topicPath)

使用给定名称在服务命名空间中创建一个新主题。 有关主题属性的默认值,请参阅 TopicDescription

参数:

topicPath -
  • 相对于服务命名空间基址的主题的名称。

返回:

TopicDescription 新创建的主题。

deleteQueueAsync

public CompletableFuture deleteQueueAsync(String path)

删除由相对于服务命名空间基址的路径描述的队列。

参数:

path -
  • 相对于服务命名空间基址的实体的名称。

返回:

删除队列时完成的可完成的未来。

deleteRuleAsync

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

删除给定主题订阅的规则。

参数:

topicPath -
  • 主题的名称。
subscriptionName -
  • 订阅的名称。
ruleName -
  • 规则的名称。

返回:

删除规则时完成的可完成的未来。

deleteSubscriptionAsync

public CompletableFuture deleteSubscriptionAsync(String topicPath, String subscriptionName)

删除 topicPath 和 subscriptionName 描述的订阅。

参数:

topicPath -
  • 主题的名称。
subscriptionName -
  • 订阅的名称。

返回:

删除订阅时完成的可完成的未来。

deleteTopicAsync

public CompletableFuture deleteTopicAsync(String path)

删除由相对于服务命名空间基址的路径描述的主题。

参数:

path -
  • 相对于服务命名空间基址的实体的名称。

返回:

删除主题时完成的可完成的未来。

getNamespaceInfoAsync

public CompletableFuture getNamespaceInfoAsync()

检索与命名空间相关的信息。 适用于任何声明 (发送/侦听/管理) 。

返回:

getQueueAsync

public CompletableFuture getQueueAsync(String path)

从服务命名空间检索队列

参数:

path -
  • 相对于服务总线命名空间的队列路径。

返回:

  • 包含有关队列信息的 QueueDescription。

getQueueRuntimeInfoAsync

public CompletableFuture getQueueRuntimeInfoAsync(String path)

检索队列的运行时信息。

参数:

path -
  • 相对于服务总线命名空间的队列路径。

返回:

  • 包含有关队列的运行时信息的 QueueRuntimeInfo。

getQueuesAsync

public CompletableFuture> getQueuesAsync()

检索命名空间中存在的队列列表。

返回:

前 100 个队列。

getQueuesAsync

public CompletableFuture> getQueuesAsync(int count, int skip)

检索命名空间中存在的队列列表。 可以通过操作计数和跳过参数来模拟实体列表的页面。 skip (0) +count (100) 提供前 100 个实体。 跳过 (100 个) +count (100) 提供接下来的 100 个实体。

参数:

count -
  • 要提取的队列数。 默认为 100。 允许的最大值为 100。
skip -
  • 要跳过的队列数。 默认值为 0。 不能为负数。

返回:

队列列表。

getRuleAsync

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

从服务命名空间检索给定主题和订阅的规则

参数:

topicPath -
  • 主题相对于服务总线命名空间的路径。
subscriptionName -
  • 订阅的名称。
ruleName -
  • 规则的名称。

返回:

  • 包含订阅相关信息的 RuleDescription。

getRulesAsync

public CompletableFuture> getRulesAsync(String topicName, String subscriptionName)

检索命名空间中给定主题订阅的规则列表。

参数:

topicName -
  • 主题的名称。
subscriptionName -
  • 订阅的名称。

返回:

前 100 条规则。

getRulesAsync

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

检索命名空间中给定主题订阅的规则列表。 可以通过操作计数和跳过参数来模拟实体列表的页面。 skip (0) +count (100) 提供前 100 个实体。 跳过 (100 个) +count (100) 提供接下来的 100 个实体。

参数:

topicName -
  • 主题的名称。
subscriptionName -
  • 订阅的名称。
count -
  • 要提取的规则数。 默认为 100。 允许的最大值为 100。
skip -
  • 要跳过的规则数量。 默认值为 0。 不能为负数。

返回:

规则列表。

getSubscriptionAsync

public CompletableFuture getSubscriptionAsync(String topicPath, String subscriptionName)

从服务命名空间检索给定主题的订阅

参数:

topicPath -
  • 主题相对于服务总线命名空间的路径。
subscriptionName -
  • 订阅的名称

返回:

  • 包含有关订阅信息的 SubscriptionDescription。

getSubscriptionRuntimeInfoAsync

public CompletableFuture getSubscriptionRuntimeInfoAsync(String topicPath, String subscriptionName)

检索给定主题中订阅的运行时信息

参数:

topicPath -
  • 主题相对于服务总线命名空间的路径。
subscriptionName -
  • 订阅的名称

返回:

  • 包含有关订阅的运行时信息的 SubscriptionRuntimeInfo。

getSubscriptionsAsync

public CompletableFuture> getSubscriptionsAsync(String topicName)

检索命名空间中给定主题的订阅列表。

参数:

topicName -
  • 主题的名称。

返回:

前 100 个订阅。

getSubscriptionsAsync

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

检索命名空间中给定主题的订阅列表。 可以通过操作计数和跳过参数来模拟实体列表的页面。 skip (0) +count (100) 提供前 100 个实体。 跳过 (100 个) +count (100) 提供接下来的 100 个实体。

参数:

topicName -
  • 主题的名称。
count -
  • 要提取的订阅数。 默认为 100。 允许的最大值为 100。
skip -
  • 要跳过的订阅数。 默认值为 0。 不能为负数。

返回:

订阅列表。

getTopicAsync

public CompletableFuture getTopicAsync(String path)

从服务命名空间检索主题

参数:

path -
  • 相对于服务总线命名空间的队列路径。

返回:

  • 包含有关主题的信息的说明。

getTopicRuntimeInfoAsync

public CompletableFuture getTopicRuntimeInfoAsync(String path)

检索主题的运行时信息

参数:

path -
  • 相对于服务总线命名空间的队列路径。

返回:

  • 包含有关主题的运行时信息的 TopicRuntimeInfo。

getTopicsAsync

public CompletableFuture> getTopicsAsync()

检索命名空间中存在的主题列表。

返回:

前 100 个主题。

getTopicsAsync

public CompletableFuture> getTopicsAsync(int count, int skip)

检索命名空间中存在的主题列表。 可以通过操作计数和跳过参数来模拟实体列表的页面。 skip (0) +count (100) 提供前 100 个实体。 跳过 (100 个) +count (100) 提供接下来的 100 个实体。

参数:

count -
  • 要提取的主题数。 默认为 100。 允许的最大值为 100。
skip -
  • 要跳过的主题数。 默认值为 0。 不能为负数。

返回:

主题列表。

queueExistsAsync

public CompletableFuture queueExistsAsync(String path)

检查给定队列是否存在。

参数:

path -
  • 要检查实体的路径

返回:

  • 如果实体存在,则为 True。 否则为 False。

ruleExistsAsync

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

检查给定订阅是否存在给定规则。

参数:

topicPath -
  • 主题的路径
subscriptionName -
  • 订阅的名称。
ruleName -
  • 规则名称

返回:

  • 如果实体存在,则为 True。 否则为 False。

subscriptionExistsAsync

public CompletableFuture subscriptionExistsAsync(String topicPath, String subscriptionName)

检查给定订阅是否存在。

参数:

topicPath -
  • 主题的路径
subscriptionName -
  • 订阅的名称。

返回:

  • 如果实体存在,则为 True。 否则为 False。

topicExistsAsync

public CompletableFuture topicExistsAsync(String path)

检查给定主题是否存在。

参数:

path -
  • 要检查实体的路径

返回:

  • 如果实体存在,则为 True。 否则为 False。

updateQueueAsync

public CompletableFuture updateQueueAsync(QueueDescription queueDescription)

汇报现有队列。

参数:

queueDescription -
  • 一个 QueueDescription 对象,该对象描述将用于更新队列的属性。

返回:

QueueDescription 已更新队列的 。

updateRuleAsync

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

汇报现有规则。

参数:

topicName -
  • 主题名称。
subscriptionName -
  • 订阅的名称。
ruleDescription -

返回:

RuleDescription 更新后的规则。

updateSubscriptionAsync

public CompletableFuture updateSubscriptionAsync(SubscriptionDescription subscriptionDescription)

汇报现有订阅。

参数:

subscriptionDescription -

返回:

SubscriptionDescription 更新的订阅。

updateTopicAsync

public CompletableFuture updateTopicAsync(TopicDescription topicDescription)

汇报现有主题。

参数:

topicDescription -
  • 一个 TopicDescription 对象,该对象描述将用于更新主题的属性。

返回:

TopicDescription 已更新主题的 。

适用于