ServiceBusAdministrationAsyncClient クラス
- java.
lang. Object - com.
azure. messaging. servicebus. administration. ServiceBusAdministrationAsyncClient
- com.
public final class ServiceBusAdministrationAsyncClient
Service Bus 名前空間を管理するための 非同期 クライアント。 を使用して ServiceBusAdministrationClientBuilderインスタンス化されます。
サンプル: 非同期クライアントを作成する
次のコード サンプルは、非同期管理クライアントの作成を示しています。 次の例で使用する資格情報は、認証用です DefaultAzureCredential 。 これは、ローカルの開発環境や運用環境など、ほとんどのシナリオに適しています。 さらに、運用環境での認証に マネージド ID を 使用することをお勧めします。 さまざまな認証方法とそれに対応する資格情報の種類の詳細については、 Azure ID のドキュメントを参照してください。
// DefaultAzureCredential creates a credential based on the environment it is executed in.
TokenCredential credential = new DefaultAzureCredentialBuilder().build();
// 'fullyQualifiedNamespace' will look similar to "{your-namespace}.servicebus.windows.net"
ServiceBusAdministrationAsyncClient client = new ServiceBusAdministrationClientBuilder()
.credential(fullyQualifiedNamespace, new DefaultAzureCredentialBuilder().build())
.buildAsyncClient();
サンプル: キューを作成する
次の例では、既定値を使用してキューを作成します。 既定値は に CreateQueueOptions()一覧表示されます。
// `.subscribe()` is a non-blocking call. It'll move onto the next
// instruction after setting up the `consumer` and `errorConsumer` callbacks.
client.createQueue("my-new-queue").subscribe(queue -> {
System.out.printf("Queue created. Name: %s. Lock Duration: %s.%n",
queue.getName(), queue.getLockDuration());
}, error -> {
System.err.println("Error creating queue: " + error);
});
サンプル: 既存のサブスクリプションを編集する
次のコード サンプルは、既存のサブスクリプションを更新する方法を示しています。 ユーザーは、サブスクリプションのプロパティをフェッチし、プロパティを変更してから、 オブジェクトを update メソッドに渡す必要があります。
// To update the subscription we have to:
// 1. Get the subscription info from the service.
// 2. Update the SubscriptionProperties we want to change.
// 3. Call the updateSubscription() with the updated object.
// `.subscribe()` is a non-blocking call. It'll move onto the next
// instruction after setting up the `consumer` and `errorConsumer` callbacks.
client.getSubscription("my-topic", "my-subscription")
.flatMap(subscription -> {
System.out.println("Original delivery count: " + subscription.getMaxDeliveryCount());
// Updating it to a new value.
subscription.setMaxDeliveryCount(5);
// Persisting the updates to the subscription object.
return client.updateSubscription(subscription);
})
.subscribe(subscription -> {
System.out.printf("Subscription updated. Name: %s. Delivery count: %s.%n",
subscription.getSubscriptionName(), subscription.getMaxDeliveryCount());
}, error -> {
System.err.println("Error updating subscription: " + error);
});
サンプル: すべてのキューを一覧表示する
次のコード サンプルでは、Service Bus 名前空間内のすべてのキューを一覧表示します。
// `.subscribe()` is a non-blocking call. It'll move onto the next
// instruction after setting up the `consumer` and `errorConsumer` callbacks.
client.listQueues().subscribe(queue -> {
System.out.printf("Queue [%s]. Lock Duration: %s.%n",
queue.getName(), queue.getLockDuration());
}, error -> {
System.err.println("Error fetching queues: " + error);
});
サンプル: キューの削除
次のコード サンプルは、既存のキューを削除する方法を示しています。
// `.subscribe()` is a non-blocking call. It'll move onto the next
// instruction after setting up the `consumer`, `errorConsumer`, `completeConsumer` callbacks.
asyncClient.deleteQueue("my-existing-queue").subscribe(unused -> {
}, error -> {
System.err.println("Error deleting queue: " + error);
}, () -> {
System.out.println("Deleted queue.");
});
メソッドの概要
メソッドの継承元: java.lang.Object
メソッドの詳細
createQueue
public Mono
指定した名前のキューを作成します。
Parameters:
Returns:
createQueue
public Mono
および指定されたキュー名を CreateQueueOptions 持つキューを作成します。
Parameters:
Returns:
createQueueWithResponse
public Mono
キューを作成し、HTTP 応答に加えて作成されたキューを返します。
Parameters:
Returns:
createRule
public Mono
指定されたトピックとサブスクリプションの下にルールを作成します
Parameters:
Returns:
createRule
public Mono
を使用してルールを作成します CreateRuleOptions。
Parameters:
Returns:
createRuleWithResponse
public Mono
ルールを作成し、HTTP 応答に加えて作成されたルールを返します。
Parameters:
Returns:
createSubscription
public Mono
指定されたトピックとサブスクリプション名を持つサブスクリプションを作成します。
Parameters:
Returns:
createSubscription
public Mono
を使用してサブスクリプションを作成します CreateSubscriptionOptions。
Parameters:
Returns:
createSubscription
public Mono
と CreateRuleOptionsを使用して、既定の規則を使用してサブスクリプションをCreateSubscriptionOptions作成します。
Parameters:
Returns:
createSubscriptionWithResponse
public Mono
サブスクリプションを作成し、HTTP 応答に加えて作成されたサブスクリプションを返します。
Parameters:
Returns:
createSubscriptionWithResponse
public Mono
既定の規則を使用してサブスクリプションを作成し、HTTP 応答に加えて作成されたサブスクリプションを返します。
Parameters:
Returns:
createTopic
public Mono
指定した名前のトピックを作成します。
Parameters:
Returns:
createTopic
public Mono
を使用してトピックを作成します CreateTopicOptions。
Parameters:
Returns:
createTopicWithResponse
public Mono
トピックを作成し、HTTP 応答に加えて作成されたトピックを返します。
Parameters:
Returns:
deleteQueue
public Mono
一致 queueNameする キューを削除します。
Parameters:
Returns:
deleteQueueWithResponse
public Mono
一致 queueName するキューを削除し、HTTP 応答を返します。
Parameters:
Returns:
deleteRule
public Mono
一致 ruleNameする ルールを削除します。
Parameters:
Returns:
deleteRuleWithResponse
public Mono
一致 ruleName するルールを削除し、HTTP 応答を返します。
Parameters:
Returns:
deleteSubscription
public Mono
一致 subscriptionNameする サブスクリプションを削除します。
Parameters:
Returns:
deleteSubscriptionWithResponse
public Mono
一致 subscriptionName するサブスクリプションを削除し、HTTP 応答を返します。
Parameters:
Returns:
deleteTopic
public Mono
一致 topicNameする トピックを削除します。
Parameters:
Returns:
deleteTopicWithResponse
public Mono
一致 topicName するトピックを削除し、HTTP 応答を返します。
Parameters:
Returns:
getNamespaceProperties
public Mono
Service Bus 名前空間に関する情報を取得します。
Returns:
getNamespacePropertiesWithResponse
public Mono
Service Bus 名前空間に関する情報とその HTTP 応答を取得します。
Returns:
getQueue
public Mono
キューに関する情報を取得します。
Parameters:
Returns:
getQueueExists
public Mono
のキュー queueName が Service Bus 名前空間に存在するかどうかを取得します。
Parameters:
Returns:
getQueueExistsWithResponse
public Mono
のキュー queueName が Service Bus 名前空間に存在するかどうかを取得します。
Parameters:
Returns:
getQueueRuntimeProperties
public Mono
キューに関するランタイム プロパティを取得します。
Parameters:
Returns:
getQueueRuntimePropertiesWithResponse
public Mono
キューに関するランタイム プロパティとその HTTP 応答を取得します。
Parameters:
Returns:
getQueueWithResponse
public Mono
HTTP 応答と共にキューに関する情報を取得します。
Parameters:
Returns:
getRule
public Mono
サービス名前空間からルールを取得します。 フィルターパラメーターとアクション パラメーター (string、int、long、boolean、double、OffsetDateTime) では、次のデータ型のみが逆シリアル化されます。 その他のデータ型は、その文字列値を返します。
Parameters:
Returns:
getRuleWithResponse
public Mono
サービス名前空間からルールを取得します。 フィルターパラメーターとアクション パラメーター (string、int、long、bool、double、OffsetDateTime) では、次のデータ型のみが逆シリアル化されます。 その他のデータ型は、その文字列値を返します。
Parameters:
Returns:
getSubscription
public Mono
キューに関する情報を取得します。
Parameters:
Returns:
getSubscriptionExists
public Mono
トピック内のサブスクリプションが存在するかどうかを取得します。
Parameters:
Returns:
getSubscriptionExistsWithResponse
public Mono
トピック内のサブスクリプションが存在するかどうかを取得します。
Parameters:
Returns:
getSubscriptionRuntimeProperties
public Mono
サブスクリプションに関するランタイム プロパティを取得します。
Parameters:
Returns:
getSubscriptionRuntimePropertiesWithResponse
public Mono
サブスクリプションに関するランタイム プロパティを取得します。
Parameters:
Returns:
getSubscriptionWithResponse
public Mono
サブスクリプションに関する情報とその HTTP 応答を取得します。
Parameters:
Returns:
getTopic
public Mono
トピックに関する情報を取得します。
Parameters:
Returns:
getTopicExists
public Mono
のトピック topicName が Service Bus 名前空間に存在するかどうかを取得します。
Parameters:
Returns:
getTopicExistsWithResponse
public Mono
のトピック topicName が Service Bus 名前空間に存在するかどうかを取得します。
Parameters:
Returns:
getTopicRuntimeProperties
public Mono
トピックに関するランタイム プロパティを取得します。
Parameters:
Returns:
getTopicRuntimePropertiesWithResponse
public Mono
HTTP 応答を使用して、トピックに関するランタイム プロパティを取得します。
Parameters:
Returns:
getTopicWithResponse
public Mono
HTTP 応答と共にトピックに関する情報を取得します。
Parameters:
Returns:
listQueues
public PagedFlux
Service Bus 名前空間内のすべてのキューをフェッチします。
Returns:
listRules
public PagedFlux
トピックとサブスクリプションのすべてのルールをフェッチします。
Parameters:
Returns:
listSubscriptions
public PagedFlux
トピックのすべてのサブスクリプションをフェッチします。
Parameters:
Returns:
topicName。listTopics
public PagedFlux
Service Bus 名前空間内のすべてのトピックをフェッチします。
Returns:
updateQueue
public Mono
指定QueuePropertiesした を使用してキューを更新します。 QueuePropertiesすべてのプロパティが置き換えられるので、 は完全に設定する必要があります。 プロパティが設定されていない場合は、サービスの既定値が使用されます。 推奨されるフローは次のとおりです。
- getQueue(String queueName)
- 必要な要素を更新します。
- 更新された説明をこのメソッドに渡します。
更新できるプロパティのサブセットがあります。 詳細については、以下のリンクを参照してください。 これらは次のとおりです。
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
- setMaxDeliveryCount(Integer maxDeliveryCount)
Parameters:
Returns:
updateQueueWithResponse
public Mono
指定QueuePropertiesした を使用してキューを更新します。 QueuePropertiesすべてのプロパティが置き換えられるので、 は完全に設定する必要があります。 プロパティが設定されていない場合は、サービスの既定値が使用されます。 推奨されるフローは次のとおりです。
- getQueue(String queueName)
- 必要な要素を更新します。
- 更新された説明をこのメソッドに渡します。
更新できるプロパティのサブセットがあります。 詳細については、以下のリンクを参照してください。 これらは次のとおりです。
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
- setMaxDeliveryCount(Integer maxDeliveryCount)
Parameters:
Returns:
updateRule
public Mono
指定RulePropertiesした を使用してルールを更新します。 RulePropertiesすべてのプロパティが置き換えられるので、 は完全に設定する必要があります。 プロパティが設定されていない場合は、サービスの既定値が使用されます。 推奨されるフローは次のとおりです。
- getRule(String topicName, String subscriptionName, String ruleName)
- 必要な要素を更新します。
- 更新された説明をこのメソッドに渡します。
Parameters:
Returns:
updateRuleWithResponse
public Mono
指定RulePropertiesした を使用してルールを更新します。 RulePropertiesすべてのプロパティが置き換えられるので、 は完全に設定する必要があります。 プロパティが設定されていない場合は、サービスの既定値が使用されます。 推奨されるフローは次のとおりです。
- getRule(String topicName, String subscriptionName, String ruleName)
- 必要な要素を更新します。
- 更新された説明をこのメソッドに渡します。
Parameters:
Returns:
updateSubscription
public Mono
指定SubscriptionPropertiesした を使用してサブスクリプションを更新します。 SubscriptionPropertiesすべてのプロパティが置き換えられるので、 は完全に設定する必要があります。 プロパティが設定されていない場合は、サービスの既定値が使用されます。 推奨されるフローは次のとおりです。
- getSubscription(String topicName, String subscriptionName)
- 必要な要素を更新します。
- 更新された説明をこのメソッドに渡します。
更新できるプロパティのサブセットがあります。 詳細については、以下のリンクを参照してください。 これらは次のとおりです。
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setMaxDeliveryCount(int maxDeliveryCount)
Parameters:
Returns:
updateSubscriptionWithResponse
public Mono
指定SubscriptionPropertiesした を使用してサブスクリプションを更新します。 SubscriptionPropertiesすべてのプロパティが置き換えられるので、 は完全に設定する必要があります。 プロパティが設定されていない場合は、サービスの既定値が使用されます。 推奨されるフローは次のとおりです。
- getSubscription(String topicName, String subscriptionName)
- 必要な要素を更新します。
- 更新された説明をこのメソッドに渡します。
更新できるプロパティのサブセットがあります。 詳細については、以下のリンクを参照してください。 これらは次のとおりです。
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setMaxDeliveryCount(int maxDeliveryCount)
Parameters:
Returns:
updateTopic
public Mono
指定TopicPropertiesした を使用してトピックを更新します。 TopicPropertiesすべてのプロパティが置き換えられるので、 は完全に設定する必要があります。 プロパティが設定されていない場合は、サービスの既定値が使用されます。 推奨されるフローは次のとおりです。
- getTopic(String topicName)
- 必要な要素を更新します。
- 更新された説明をこのメソッドに渡します。
更新できるプロパティのサブセットがあります。 詳細については、以下のリンクを参照してください。 これらは次のとおりです。
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
Parameters:
Returns:
updateTopicWithResponse
public Mono
指定TopicPropertiesした を使用してトピックを更新します。 TopicPropertiesすべてのプロパティが置き換えられるので、 は完全に設定する必要があります。 プロパティが設定されていない場合は、サービスの既定値が使用されます。 推奨されるフローは次のとおりです。
- getTopic(String topicName)
- 必要な要素を更新します。
- 更新された説明をこのメソッドに渡します。
更新できるプロパティのサブセットがあります。 詳細については、以下のリンクを参照してください。 これらは次のとおりです。
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
Parameters:
Returns:
適用対象
Azure SDK for Java