Share via


ManagementClientAsync クラス

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

public class ManagementClientAsync

Service Bus エンティティに対して管理操作を実行する非同期クライアント。 操作は、応答を非同期的に返す 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)

トピック「パス」と「サブスクリプション名」で説明されているサブスクリプションを削除します。

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() す必要があります。

Parameters:

connectionStringBuilder -
  • 名前空間情報とクライアント設定を含む connectionStringBuilder。

ManagementClientAsync

public ManagementClientAsync(URI namespaceEndpointURI, ClientSettings clientSettings)

新しい ManagementClientAsync を作成します。 ユーザーは、クライアントの有効期間の終了時に を呼び出 close() す必要があります。

Parameters:

namespaceEndpointURI -
  • 接続先の名前空間の URI。
clientSettings -
  • クライアント設定。

メソッドの詳細

close

public void close()

managementClient を破棄して閉じます。

Throws:

IOException

- I/O エラーが発生した場合

createQueueAsync

public CompletableFuture createQueueAsync(QueueDescription queueDescription)

指定した名前を使用して、サービス名前空間に新しいキューを作成します。 キューのプロパティの既定値については、「」を参照してください QueueDescription

Parameters:

queueDescription -
  • QueueDescription新しいキューを作成する属性を記述する オブジェクト。

Returns:

QueueDescription 新しく作成されたキューの 。

createQueueAsync

public CompletableFuture createQueueAsync(String queuePath)

指定した名前を使用して、サービス名前空間に新しいキューを作成します。 キュー のプロパティの既定値については、「」を参照してください QueueDescription

Parameters:

queuePath -
  • サービス名前空間のベース アドレスに対する相対的なキューの名前。

Returns:

QueueDescription 新しく作成されたキューの 。

createRuleAsync

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

特定のトピック (サブスクリプション) の新しいルールを作成します。 サブスクリプション プロパティの既定値については、「」を参照してください RuleDescription

Parameters:

topicName -
  • トピックの名前。
subscriptionName -
  • サブスクリプションの名前。
ruleDescription -
  • RuleDescription新しいルールを作成する属性を記述する オブジェクト。

Returns:

RuleDescription 新しく作成されたルールの。

createSubscriptionAsync

public CompletableFuture createSubscriptionAsync(SubscriptionDescription subscriptionDescription)

指定した名前のサービス名前空間に新しいサブスクリプションを作成します。 サブスクリプション プロパティの既定値については、「」を参照してください SubscriptionDescription

Parameters:

subscriptionDescription -
  • SubscriptionDescription新しいサブスクリプションを作成する属性を記述する オブジェクト。

Returns:

SubscriptionDescription 新しく作成されたサブスクリプションの 。

createSubscriptionAsync

public CompletableFuture createSubscriptionAsync(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)

指定された既定の規則を使用して、サービス名前空間に新しいサブスクリプションを作成します。 サブスクリプション プロパティの既定値については、「」を参照してください SubscriptionDescription

Parameters:

subscriptionDescription -
  • SubscriptionDescription新しいサブスクリプションを作成する属性を記述する オブジェクト。
defaultRule -
  • 既定の RuleDescription 規則を記述する オブジェクト。 null の場合、パススルー フィルターが作成されます。

Returns:

SubscriptionDescription 新しく作成されたサブスクリプションの 。

createSubscriptionAsync

public CompletableFuture createSubscriptionAsync(String topicPath, String subscriptionName)

指定した名前のサービス名前空間に、特定のトピックの新しいサブスクリプションを作成します。 サブスクリプション プロパティの既定値については、「」を参照してください SubscriptionDescription

Parameters:

topicPath -
  • サービス名前空間のベース アドレスに対する相対トピックの名前。
subscriptionName -
  • サブスクリプションの名前です。

Returns:

SubscriptionDescription 新しく作成されたサブスクリプションの 。

createTopicAsync

public CompletableFuture createTopicAsync(TopicDescription topicDescription)

指定した名前を使用して、サービス名前空間に新しいトピックを作成します。 トピック プロパティの既定値については、「」を参照してください TopicDescription

Parameters:

topicDescription -
  • QueueDescription新しいトピックを作成する属性を記述する オブジェクト。

Returns:

TopicDescription 新しく作成されたトピックの 。

createTopicAsync

public CompletableFuture createTopicAsync(String topicPath)

指定した名前を使用して、サービス名前空間に新しいトピックを作成します。 トピック プロパティの既定値については、「」を参照してください TopicDescription

Parameters:

topicPath -
  • サービス名前空間のベース アドレスに対する相対トピックの名前。

Returns:

TopicDescription 新しく作成されたトピックの 。

deleteQueueAsync

public CompletableFuture deleteQueueAsync(String path)

サービス名前空間のベース アドレスに対する相対パスで記述されているキューを削除します。

Parameters:

path -
  • サービス名前空間のベース アドレスを基準とするエンティティの名前。

Returns:

キューが削除されたときに完了する完了可能な未来。

deleteRuleAsync

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

特定のトピック サブスクリプションのルールを削除します。

Parameters:

topicPath -
  • トピックの名前。
subscriptionName -
  • サブスクリプションの名前です。
ruleName -
  • ルールの名前です。

Returns:

ルールが削除されたときに完了できる未来。

deleteSubscriptionAsync

public CompletableFuture deleteSubscriptionAsync(String topicPath, String subscriptionName)

topicPath と subscriptionName によって記述されているサブスクリプションを削除します。

Parameters:

topicPath -
  • トピックの名前。
subscriptionName -
  • サブスクリプションの名前です。

Returns:

サブスクリプションが削除されたときに完了する完了可能な未来。

deleteTopicAsync

public CompletableFuture deleteTopicAsync(String path)

サービス名前空間のベース アドレスに対する相対パスで記述されているトピックを削除します。

Parameters:

path -
  • サービス名前空間のベース アドレスを基準とするエンティティの名前。

Returns:

トピックが削除されたときに完了する、完了可能な未来。

getNamespaceInfoAsync

public CompletableFuture getNamespaceInfoAsync()

名前空間に関連する情報を取得します。 任意の要求 (送信/リッスン/管理) で動作します。

Returns:

getQueueAsync

public CompletableFuture getQueueAsync(String path)

サービス名前空間からキューを取得します

Parameters:

path -
  • Service Bus 名前空間に対する相対的なキューのパス。

Returns:

  • キューに関する情報を含む QueueDescription。

getQueueRuntimeInfoAsync

public CompletableFuture getQueueRuntimeInfoAsync(String path)

キューのランタイム情報を取得します。

Parameters:

path -
  • Service Bus 名前空間に対する相対的なキューのパス。

Returns:

  • キューに関するランタイム情報を含む QueueRuntimeInfo。

getQueuesAsync

public CompletableFuture<>> getQueuesAsync()

名前空間に存在するキューの一覧を取得します。

Returns:

最初の 100 個のキュー。

getQueuesAsync

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

名前空間に存在するキューの一覧を取得します。 count パラメーターと skip パラメーターを操作することで、エンティティの一覧のページをシミュレートできます。 skip(0)+count(100) は、最初の 100 個のエンティティを提供します。 skip(100)+count(100) は、次の 100 個のエンティティを提供します。

Parameters:

count -
  • フェッチするキューの数。 既定値は 100 です。 使用できる最大値は 100 です。
skip -
  • スキップするキューの数。 既定値は 0 です。 負の値にすることはできません。

Returns:

キューの一覧。

getRuleAsync

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

サービス名前空間から特定のトピックとサブスクリプションのルールを取得します

Parameters:

topicPath -
  • Service Bus 名前空間に対するトピックの相対パス。
subscriptionName -
  • サブスクリプションの名前です。
ruleName -
  • ルールの名前です。

Returns:

  • サブスクリプションに関する情報を含む RuleDescription。

getRulesAsync

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

名前空間内の特定のトピック サブスクリプションのルールの一覧を取得します。

Parameters:

topicName -
  • トピックの名前。
subscriptionName -
  • サブスクリプションの名前です。

Returns:

最初の 100 個のルール。

getRulesAsync

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

名前空間内の特定のトピック サブスクリプションのルールの一覧を取得します。 count パラメーターと skip パラメーターを操作することで、エンティティの一覧のページをシミュレートできます。 skip(0)+count(100) は、最初の 100 個のエンティティを提供します。 skip(100)+count(100) は、次の 100 個のエンティティを提供します。

Parameters:

topicName -
  • トピックの名前。
subscriptionName -
  • サブスクリプションの名前です。
count -
  • フェッチするルールの数。 既定値は 100 です。 使用できる最大値は 100 です。
skip -
  • スキップするルールの数。 既定値は 0 です。 負の値にすることはできません。

Returns:

ルールの一覧。

getSubscriptionAsync

public CompletableFuture getSubscriptionAsync(String topicPath, String subscriptionName)

サービス名前空間から特定のトピックのサブスクリプションを取得します

Parameters:

topicPath -
  • Service Bus 名前空間に対するトピックの相対パス。
subscriptionName -
  • サブスクリプションの名前

Returns:

  • サブスクリプションに関する情報を含む SubscriptionDescription。

getSubscriptionRuntimeInfoAsync

public CompletableFuture getSubscriptionRuntimeInfoAsync(String topicPath, String subscriptionName)

特定のトピックのサブスクリプションのランタイム情報を取得します

Parameters:

topicPath -
  • Service Bus 名前空間に対するトピックの相対パス。
subscriptionName -
  • サブスクリプションの名前

Returns:

  • サブスクリプションに関するランタイム情報を含む SubscriptionRuntimeInfo。

getSubscriptionsAsync

public CompletableFuture<>> getSubscriptionsAsync(String topicName)

名前空間内の特定のトピックのサブスクリプションの一覧を取得します。

Parameters:

topicName -
  • トピックの名前。

Returns:

最初の 100 個のサブスクリプション。

getSubscriptionsAsync

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

名前空間内の特定のトピックのサブスクリプションの一覧を取得します。 count パラメーターと skip パラメーターを操作することで、エンティティの一覧のページをシミュレートできます。 skip(0)+count(100) は、最初の 100 個のエンティティを提供します。 skip(100)+count(100) は、次の 100 個のエンティティを提供します。

Parameters:

topicName -
  • トピックの名前。
count -
  • フェッチするサブスクリプションの数。 既定値は 100 です。 使用できる最大値は 100 です。
skip -
  • スキップするサブスクリプションの数。 既定値は 0 です。 負の値にすることはできません。

Returns:

サブスクリプションの一覧。

getTopicAsync

public CompletableFuture getTopicAsync(String path)

サービス名前空間からトピックを取得します

Parameters:

path -
  • Service Bus 名前空間に対する相対的なキューのパス。

Returns:

  • トピックに関する情報を含む説明。

getTopicRuntimeInfoAsync

public CompletableFuture getTopicRuntimeInfoAsync(String path)

トピックのランタイム情報を取得します

Parameters:

path -
  • Service Bus 名前空間に対する相対的なキューのパス。

Returns:

  • トピックに関するランタイム情報を含む TopicRuntimeInfo。

getTopicsAsync

public CompletableFuture<>> getTopicsAsync()

名前空間に存在するトピックの一覧を取得します。

Returns:

最初の 100 トピック。

getTopicsAsync

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

名前空間に存在するトピックの一覧を取得します。 count パラメーターと skip パラメーターを操作することで、エンティティの一覧のページをシミュレートできます。 skip(0)+count(100) は、最初の 100 個のエンティティを提供します。 skip(100)+count(100) は、次の 100 個のエンティティを提供します。

Parameters:

count -
  • フェッチするトピックの数。 既定値は 100 です。 使用できる最大値は 100 です。
skip -
  • スキップするトピックの数。 既定値は 0 です。 負の値にすることはできません。

Returns:

トピックの一覧。

queueExistsAsync

public CompletableFuture queueExistsAsync(String path)

特定のキューが存在するかどうかを確認します。

Parameters:

path -
  • チェックへのエンティティのパス

Returns:

  • True を指定すると、エンティティが存在します。 それ以外の場合は false です。

ruleExistsAsync

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

特定のサブスクリプションに対して特定のルールが存在するかどうかを確認します。

Parameters:

topicPath -
  • トピックのパス
subscriptionName -
  • サブスクリプションの名前。
ruleName -
  • ルールの名前

Returns:

  • True を指定すると、エンティティが存在します。 それ以外の場合は false です。

subscriptionExistsAsync

public CompletableFuture subscriptionExistsAsync(String topicPath, String subscriptionName)

特定のサブスクリプションが存在するかどうかを確認します。

Parameters:

topicPath -
  • トピックのパス
subscriptionName -
  • サブスクリプションの名前。

Returns:

  • True を指定すると、エンティティが存在します。 それ以外の場合は false です。

topicExistsAsync

public CompletableFuture topicExistsAsync(String path)

特定のトピックが存在するかどうかを確認します。

Parameters:

path -
  • チェックへのエンティティのパス

Returns:

  • True を指定すると、エンティティが存在します。 それ以外の場合は false です。

updateQueueAsync

public CompletableFuture updateQueueAsync(QueueDescription queueDescription)

既存のキューを更新します。

Parameters:

queueDescription -
  • QueueDescriptionキューが更新される属性を記述する オブジェクト。

Returns:

QueueDescription 更新されたキューの。

updateRuleAsync

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

既存のルールを更新します。

Parameters:

topicName -
  • トピックの名前。
subscriptionName -
  • サブスクリプションの名前。
ruleDescription -
  • RuleDescriptionルールが更新される属性を記述する オブジェクト。

Returns:

RuleDescription 更新されたルールの。

updateSubscriptionAsync

public CompletableFuture updateSubscriptionAsync(SubscriptionDescription subscriptionDescription)

既存のサブスクリプションを更新します。

Parameters:

subscriptionDescription -

Returns:

SubscriptionDescription 更新されたサブスクリプションの。

updateTopicAsync

public CompletableFuture updateTopicAsync(TopicDescription topicDescription)

既存のトピックを更新します。

Parameters:

topicDescription -
  • TopicDescriptionトピックが更新される属性を記述する オブジェクト。

Returns:

TopicDescription 更新されたトピックの。

適用対象