ManagementClient クラス
- java.
lang. Object - com.
microsoft. azure. servicebus. management. ManagementClient
- com.
public class ManagementClient
Service Bus エンティティに対して管理操作を実行する同期クライアント。 非同期操作には を使用 ManagementClientAsync します。
コンストラクターの概要
| コンストラクター | 説明 | |
|---|---|---|
| ManagementClient(ConnectionStringBuilder connectionStringBuilder) | ||
| ManagementClient(URI namespaceEndpointURI, ClientSettings clientSettings) | ||
メソッドの概要
メソッドの継承元: java.lang.Object
コンストラクターの詳細
ManagementClient
public ManagementClient(ConnectionStringBuilder connectionStringBuilder)
Parameters:
ManagementClient
public ManagementClient(URI namespaceEndpointURI, ClientSettings clientSettings)
Parameters:
メソッドの詳細
close
createQueue
public QueueDescription createQueue(QueueDescription queueDescription)
指定した名前を使用して、サービス名前空間に新しいキューを作成します。 キュー のプロパティの既定値については、「」を参照してください QueueDescription 。
Parameters:
- QueueDescription新しいキューを作成する属性を記述する オブジェクト。
Returns:
Throws:
- 同じ名前のエンティティは、同じサービス名前空間の下に存在します。
- 同じ名前のエンティティは、同じサービス名前空間の下に存在します。
createQueue
public QueueDescription createQueue(String queuePath)
指定した名前を使用して、サービス名前空間に新しいキューを作成します。 キュー のプロパティの既定値については、「」を参照してください QueueDescription 。
Parameters:
- サービス名前空間のベース アドレスに対する相対的なキューの名前。
Returns:
Throws:
- エンティティ名が null、空、長すぎる、または無効な文字を使用しています。
- エンティティ名が null、空、長すぎる、または無効な文字を使用しています。
createRule
public RuleDescription createRule(String topicName, String subscriptionName, RuleDescription ruleDescription)
特定のトピック (サブスクリプション) の新しいルールを作成します。 サブスクリプション プロパティの既定値については、「」を参照してください RuleDescription 。
Parameters:
- トピックの名前。
- サブスクリプションの名前。
- RuleDescription新しいルールを作成する属性を記述する オブジェクト。
Returns:
Throws:
- 同じ名前のエンティティは、同じサービス名前空間の下に存在します。
- 同じ名前のエンティティは、同じサービス名前空間の下に存在します。
createSubscription
public SubscriptionDescription createSubscription(SubscriptionDescription subscriptionDescription)
指定した名前のサービス名前空間に新しいサブスクリプションを作成します。 サブスクリプション プロパティの既定値については、「」を参照してください SubscriptionDescription 。
Parameters:
- SubscriptionDescription新しいサブスクリプションを作成する属性を記述する オブジェクト。
Returns:
Throws:
- 同じ名前のエンティティは、同じサービス名前空間の下に存在します。
- 同じ名前のエンティティは、同じサービス名前空間の下に存在します。
createSubscription
public SubscriptionDescription createSubscription(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)
指定された既定の規則を使用して、サービス名前空間に新しいサブスクリプションを作成します。 サブスクリプション プロパティの既定値については、「」を参照してください SubscriptionDescription 。
Parameters:
- SubscriptionDescription新しいサブスクリプションを作成する属性を記述する オブジェクト。
- 既定の RuleDescription 規則を記述する オブジェクト。 null の場合、パススルー フィルターが作成されます。
Returns:
Throws:
- 同じ名前のエンティティは、同じサービス名前空間の下に存在します。
- 同じ名前のエンティティは、同じサービス名前空間の下に存在します。
createSubscription
public SubscriptionDescription createSubscription(String topicPath, String subscriptionName)
指定した名前のサービス名前空間に、特定のトピックの新しいサブスクリプションを作成します。 サブスクリプション プロパティの既定値については、「」を参照してください SubscriptionDescription 。
Parameters:
- サービス名前空間のベース アドレスに対する相対トピックの名前。
- サブスクリプションの名前です。
Returns:
Throws:
- エンティティ名が null、空、長すぎる、または無効な文字を使用しています。
- エンティティ名が null、空、長すぎる、または無効な文字を使用しています。
createTopic
public TopicDescription createTopic(TopicDescription topicDescription)
指定した名前を使用して、サービス名前空間に新しいトピックを作成します。 トピック プロパティの既定値については、「」を参照してください TopicDescription 。
Parameters:
- QueueDescription新しいトピックを作成する属性を記述する オブジェクト。
Returns:
Throws:
- 同じ名前のエンティティは、同じサービス名前空間の下に存在します。
- 同じ名前のエンティティは、同じサービス名前空間の下に存在します。
createTopic
public TopicDescription createTopic(String topicPath)
指定した名前を使用して、サービス名前空間に新しいトピックを作成します。 トピック プロパティの既定値については、「」を参照してください TopicDescription 。
Parameters:
- サービス名前空間のベース アドレスに対する相対トピックの名前。
Returns:
Throws:
- エンティティ名が null、空、長すぎる、または無効な文字を使用しています。
- エンティティ名が null、空、長すぎる、または無効な文字を使用しています。
deleteQueue
public Void deleteQueue(String path)
サービス名前空間のベース アドレスに対する相対パスで記述されているキューを削除します。
Parameters:
- サービス名前空間のベース アドレスを基準とするエンティティの名前。
Throws:
- path が null/空/長すぎる/無効ではありません。
- path が null/空/長すぎる/無効ではありません。
deleteRule
public Void deleteRule(String topicPath, String subscriptionName, String ruleName)
特定のトピック サブスクリプションのルールを削除します。
Parameters:
- トピックの名前。
- サブスクリプションの名前です。
- ルールの名前です。
Throws:
- path が null/空/長すぎる/無効ではありません。
- path が null/空/長すぎる/無効ではありません。
deleteSubscription
public Void deleteSubscription(String topicPath, String subscriptionName)
topicPath と subscriptionName によって記述されているサブスクリプションを削除します。
Parameters:
- トピックの名前。
- サブスクリプションの名前です。
Throws:
- path が null/空/長すぎる/無効ではありません。
- path が null/空/長すぎる/無効ではありません。
deleteTopic
public Void deleteTopic(String path)
サービス名前空間のベース アドレスに対する相対パスで記述されているトピックを削除します。
Parameters:
- サービス名前空間のベース アドレスを基準とするエンティティの名前。
Throws:
- path が null/空/長すぎる/無効ではありません。
- path が null/空/長すぎる/無効ではありません。
getNamespaceInfo
public NamespaceInfo getNamespaceInfo()
名前空間に関連する情報を取得します。 任意の要求 (送信/リッスン/管理) で動作します。
Returns:
- NamespaceInfo 名前空間情報を含む。
Throws:
- 内部エラーまたは予期しない例外が発生しました。
- 内部エラーまたは予期しない例外が発生しました。
getQueue
public QueueDescription getQueue(String path)
サービス名前空間からキューを取得します
Parameters:
- Service Bus 名前空間に対する相対的なキューのパス。
Returns:
- キューに関する情報を含む QueueDescription。
Throws:
- path が null、空、または正しい形式または長さでない場合にスローされます。
- path が null、空、または正しい形式または長さでない場合にスローされます。
getQueueRuntimeInfo
public QueueRuntimeInfo getQueueRuntimeInfo(String path)
キューのランタイム情報を取得します。
Parameters:
- Service Bus 名前空間に対する相対的なキューのパス。
Returns:
- キューに関するランタイム情報を含む QueueRuntimeInfo。
Throws:
- path が null、空、または正しい形式または長さでない場合にスローされます。
- path が null、空、または正しい形式または長さでない場合にスローされます。
getQueues
public List
名前空間に存在するキューの一覧を取得します。
Returns:
Throws:
- 操作がタイムアウトします。タイムアウト期間は ClientSettings.operationTimeout によって開始されます
- 操作がタイムアウトします。タイムアウト期間は ClientSettings.operationTimeout によって開始されます
getQueues
public List
名前空間に存在するキューの一覧を取得します。 count パラメーターと skip パラメーターを操作することで、エンティティの一覧のページをシミュレートできます。 skip(0)+count(100) は、最初の 100 個のエンティティを提供します。 skip(100)+count(100) は、次の 100 個のエンティティを提供します。
Parameters:
- フェッチするキューの数。 既定値は 100 です。 使用できる最大値は 100 です。
- スキップするキューの数。 既定値は 0 です。 負の値にすることはできません。
Returns:
Throws:
- 操作がタイムアウトします。タイムアウト期間は ClientSettings.operationTimeout によって開始されます
- 操作がタイムアウトします。タイムアウト期間は ClientSettings.operationTimeout によって開始されます
getRule
public RuleDescription getRule(String topicPath, String subscriptionName, String ruleName)
サービス名前空間から特定のトピックとサブスクリプションのルールを取得します
Parameters:
- Service Bus 名前空間に対するトピックの相対パス。
- サブスクリプションの名前です。
- ルールの名前です。
Returns:
- サブスクリプションに関する情報を含む RuleDescription。
Throws:
- path が null、空、または正しい形式または長さでない場合にスローされます。
- path が null、空、または正しい形式または長さでない場合にスローされます。
getRules
public List
名前空間内の特定のトピック サブスクリプションのルールの一覧を取得します。
Parameters:
- トピックの名前。
- サブスクリプションの名前です。
Returns:
Throws:
- 操作がタイムアウトします。タイムアウト期間は ClientSettings.operationTimeout によって開始されます
- 操作がタイムアウトします。タイムアウト期間は ClientSettings.operationTimeout によって開始されます
getRules
public List
名前空間内の特定のトピック サブスクリプションのルールの一覧を取得します。 count パラメーターと skip パラメーターを操作することで、エンティティの一覧のページをシミュレートできます。 skip(0)+count(100) は、最初の 100 個のエンティティを提供します。 skip(100)+count(100) は、次の 100 個のエンティティを提供します。
Parameters:
- トピックの名前。
- サブスクリプションの名前です。
- フェッチするルールの数。 既定値は 100 です。 使用できる最大値は 100 です。
- スキップするルールの数。 既定値は 0 です。 負の値にすることはできません。
Returns:
Throws:
- 操作がタイムアウトします。タイムアウト期間は ClientSettings.operationTimeout によって開始されます
- 操作がタイムアウトします。タイムアウト期間は ClientSettings.operationTimeout によって開始されます
getSubscription
public SubscriptionDescription getSubscription(String topicPath, String subscriptionName)
サービス名前空間から特定のトピックのサブスクリプションを取得します
Parameters:
- Service Bus 名前空間に対するトピックの相対パス。
- サブスクリプションの名前
Returns:
- サブスクリプションに関する情報を含む SubscriptionDescription。
Throws:
- path が null、空、または正しい形式または長さでない場合にスローされます。
- path が null、空、または正しい形式または長さでない場合にスローされます。
getSubscriptionRuntimeInfo
public SubscriptionRuntimeInfo getSubscriptionRuntimeInfo(String topicPath, String subscriptionName)
特定のトピックのサブスクリプションのランタイム情報を取得します
Parameters:
- Service Bus 名前空間に対するトピックの相対パス。
- サブスクリプションの名前
Returns:
- サブスクリプションに関するランタイム情報を含む SubscriptionRuntimeInfo。
Throws:
- path が null、空、または正しい形式または長さでない場合にスローされます。
- path が null、空、または正しい形式または長さでない場合にスローされます。
getSubscriptions
public List
名前空間内の特定のトピックのサブスクリプションの一覧を取得します。
Parameters:
- トピックの名前。
Returns:
Throws:
- 操作がタイムアウトします。タイムアウト期間は ClientSettings.operationTimeout によって開始されます
- 操作がタイムアウトします。タイムアウト期間は ClientSettings.operationTimeout によって開始されます
getSubscriptions
public List
名前空間内の特定のトピックのサブスクリプションの一覧を取得します。 count パラメーターと skip パラメーターを操作することで、エンティティの一覧のページをシミュレートできます。 skip(0)+count(100) は、最初の 100 個のエンティティを提供します。 skip(100)+count(100) は、次の 100 個のエンティティを提供します。
Parameters:
- トピックの名前。
- フェッチするサブスクリプションの数。 既定値は 100 です。 使用できる最大値は 100 です。
- スキップするサブスクリプションの数。 既定値は 0 です。 負の値にすることはできません。
Returns:
Throws:
- 操作がタイムアウトします。タイムアウト期間は ClientSettings.operationTimeout によって開始されます
- 操作がタイムアウトします。タイムアウト期間は ClientSettings.operationTimeout によって開始されます
getTopic
public TopicDescription getTopic(String path)
サービス名前空間からトピックを取得します
Parameters:
- Service Bus 名前空間に対する相対的なキューのパス。
Returns:
- トピックに関する情報を含む説明。
Throws:
- path が null、空、または正しい形式または長さでない場合にスローされます。
- path が null、空、または正しい形式または長さでない場合にスローされます。
getTopicRuntimeInfo
public TopicRuntimeInfo getTopicRuntimeInfo(String path)
トピックのランタイム情報を取得します
Parameters:
- Service Bus 名前空間に対する相対的なキューのパス。
Returns:
- トピックに関するランタイム情報を含む TopicRuntimeInfo。
Throws:
- path が null、空、または正しい形式または長さでない場合にスローされます。
- path が null、空、または正しい形式または長さでない場合にスローされます。
getTopics
public List
名前空間に存在するトピックの一覧を取得します。
Returns:
Throws:
- 操作がタイムアウトします。タイムアウト期間は ClientSettings.operationTimeout によって開始されます
- 操作がタイムアウトします。タイムアウト期間は ClientSettings.operationTimeout によって開始されます
getTopics
public List
名前空間に存在するトピックの一覧を取得します。 count パラメーターと skip パラメーターを操作することで、エンティティの一覧のページをシミュレートできます。 skip(0)+count(100) は、最初の 100 個のエンティティを提供します。 skip(100)+count(100) は、次の 100 個のエンティティを提供します。
Parameters:
- フェッチするトピックの数。 既定値は 100 です。 使用できる最大値は 100 です。
- スキップするトピックの数。 既定値は 0 です。 負の値にすることはできません。
Returns:
Throws:
- 操作がタイムアウトします。タイムアウト期間は ClientSettings.operationTimeout によって開始されます
- 操作がタイムアウトします。タイムアウト期間は ClientSettings.operationTimeout によって開始されます
queueExists
public Boolean queueExists(String path)
特定のキューが存在するかどうかを確認します。
Parameters:
- チェックへのエンティティのパス
Returns:
- True を指定すると、エンティティが存在します。 それ以外の場合は false です。
Throws:
- path が null/空/長すぎる/無効ではありません。
- path が null/空/長すぎる/無効ではありません。
ruleExists
public Boolean ruleExists(String topicPath, String subscriptionName, String ruleName)
特定のサブスクリプションに対して特定のルールが存在するかどうかを確認します。
Parameters:
- トピックのパス
- サブスクリプションの名前。
- ルールの名前
Returns:
- True を指定すると、エンティティが存在します。 それ以外の場合は false です。
Throws:
- path が null/空/長すぎる/無効ではありません。
- path が null/空/長すぎる/無効ではありません。
subscriptionExists
public Boolean subscriptionExists(String topicPath, String subscriptionName)
特定のサブスクリプションが存在するかどうかを確認します。
Parameters:
- トピックのパス
- サブスクリプションの名前。
Returns:
- True を指定すると、エンティティが存在します。 それ以外の場合は false です。
Throws:
- path が null/空/長すぎる/無効ではありません。
- path が null/空/長すぎる/無効ではありません。
topicExists
public Boolean topicExists(String path)
特定のトピックが存在するかどうかを確認します。
Parameters:
- チェックへのエンティティのパス
Returns:
- True を指定すると、エンティティが存在します。 それ以外の場合は false です。
Throws:
- path が null/空/長すぎる/無効ではありません。
- path が null/空/長すぎる/無効ではありません。
updateQueue
public QueueDescription updateQueue(QueueDescription queueDescription)
既存のキューを更新します。
Parameters:
- QueueDescriptionキューが更新される属性を記述する オブジェクト。
Returns:
Throws:
- 記述されたエンティティが見つかりませんでした。
- 記述されたエンティティが見つかりませんでした。
updateRule
public RuleDescription updateRule(String topicName, String subscriptionName, RuleDescription ruleDescription)
既存のルールを更新します。
Parameters:
- トピックの名前。
- サブスクリプションの名前。
- RuleDescriptionルールが更新される属性を記述する オブジェクト。
Returns:
Throws:
- 記述されたエンティティが見つかりませんでした。
- 記述されたエンティティが見つかりませんでした。
updateSubscription
public SubscriptionDescription updateSubscription(SubscriptionDescription subscriptionDescription)
既存のサブスクリプションを更新します。
Parameters:
- SubscriptionDescriptionサブスクリプションが更新される属性を記述する オブジェクト。
Returns:
Throws:
- 記述されたエンティティが見つかりませんでした。
- 記述されたエンティティが見つかりませんでした。
updateTopic
public TopicDescription updateTopic(TopicDescription topicDescription)
既存のトピックを更新します。
Parameters:
- TopicDescriptionトピックが更新される属性を記述する オブジェクト。
Returns:
Throws:
- 記述されたエンティティが見つかりませんでした。
- 記述されたエンティティが見つかりませんでした。
適用対象
Azure SDK for Java
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示