ServiceBusAdministrationAsyncClient Classe
- java.
lang. Object - com.
azure. messaging. servicebus. administration. ServiceBusAdministrationAsyncClient
- com.
public final class ServiceBusAdministrationAsyncClient
Um cliente assíncrono para gerenciar um namespace do Barramento de Serviço. Instanciado por meio de ServiceBusAdministrationClientBuilder.
Exemplo: criar o cliente assíncrono
O exemplo de código a seguir demonstra a criação do cliente de administração assíncrona. A credencial usada no exemplo a seguir é DefaultAzureCredential para autenticação. É apropriado para a maioria dos cenários, incluindo ambientes locais de desenvolvimento e produção. Além disso, recomendamos usar a identidade gerenciada para autenticação em ambientes de produção. Você pode encontrar mais informações sobre diferentes maneiras de autenticação e seus tipos de credencial correspondentes na documentação da Identidade do Azure.
// 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();
Exemplo: Criar uma fila
O exemplo a seguir cria uma fila com valores padrão. Os valores padrão são listados em 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);
});
Exemplo: Editar uma assinatura existente
O exemplo de código a seguir demonstra a atualização de uma assinatura existente. Os usuários devem buscar as propriedades da assinatura, modificar as propriedades e, em seguida, passar o objeto para atualizar o método.
// 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);
});
Exemplo: listar todas as filas
O exemplo de código abaixo lista todas as filas no namespace do Barramento de Serviço.
// `.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);
});
Exemplo: Excluir fila
O exemplo de código abaixo demonstra a exclusão de uma fila existente.
// `.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.");
});
Resumo do método
Métodos herdados de java.lang.Object
Detalhes do método
createQueue
public Mono
Cria uma fila com o nome fornecido.
Parameters:
Returns:
createQueue
public Mono
Cria uma fila com o nome da CreateQueueOptions fila fornecido e.
Parameters:
Returns:
createQueueWithResponse
public Mono<>
Cria uma fila e retorna a fila criada além da resposta HTTP.
Parameters:
Returns:
createRule
public Mono
Cria uma regra sob o tópico e a assinatura especificados
Parameters:
Returns:
createRule
public Mono
Cria uma regra com o CreateRuleOptions.
Parameters:
Returns:
createRuleWithResponse
public Mono<>
Cria uma regra e retorna a regra criada além da resposta HTTP.
Parameters:
Returns:
createSubscription
public Mono
Cria uma assinatura com os nomes de tópico e assinatura fornecidos.
Parameters:
Returns:
createSubscription
public Mono
Cria uma assinatura com o CreateSubscriptionOptions.
Parameters:
Returns:
createSubscription
public Mono
Cria uma assinatura com uma regra padrão usando CreateSubscriptionOptions e CreateRuleOptions.
Parameters:
Returns:
createSubscriptionWithResponse
public Mono<>
Cria uma assinatura e retorna a assinatura criada além da resposta HTTP.
Parameters:
Returns:
createSubscriptionWithResponse
public Mono<>
Cria uma assinatura com a regra padrão e retorna a assinatura criada além da resposta HTTP.
Parameters:
Returns:
createTopic
public Mono
Cria um tópico com o nome fornecido.
Parameters:
Returns:
createTopic
public Mono
Cria um tópico com o CreateTopicOptions.
Parameters:
Returns:
createTopicWithResponse
public Mono<>
Cria um tópico e retorna o tópico criado além da resposta HTTP.
Parameters:
Returns:
deleteQueue
public Mono
Exclui uma fila da correspondência queueName.
Parameters:
Returns:
deleteQueueWithResponse
public Mono<>
Exclui uma fila da correspondência queueName e retorna a resposta HTTP.
Parameters:
Returns:
deleteRule
public Mono
Exclui uma regra da correspondência ruleName.
Parameters:
Returns:
deleteRuleWithResponse
public Mono<>
Exclui uma regra da correspondência ruleName e retorna a resposta HTTP.
Parameters:
Returns:
deleteSubscription
public Mono
Exclui uma assinatura do correspondente subscriptionName.
Parameters:
Returns:
deleteSubscriptionWithResponse
public Mono<>
Exclui uma assinatura da correspondência subscriptionName e retorna a resposta HTTP.
Parameters:
Returns:
deleteTopic
public Mono
Exclui um tópico do correspondente topicName.
Parameters:
Returns:
deleteTopicWithResponse
public Mono<>
Exclui um tópico da correspondência topicName e retorna a resposta HTTP.
Parameters:
Returns:
getNamespaceProperties
public Mono
Obtém informações sobre o namespace do Barramento de Serviço.
Returns:
getNamespacePropertiesWithResponse
public Mono<>
Obtém informações sobre o namespace do Barramento de Serviço junto com sua resposta HTTP.
Returns:
getQueue
public Mono
Obtém informações sobre a fila.
Parameters:
Returns:
getQueueExists
public Mono
Obtém se existe ou não uma fila com queueName no namespace do Barramento de Serviço.
Parameters:
Returns:
getQueueExistsWithResponse
public Mono<>
Obtém se existe ou não uma fila com queueName no namespace do Barramento de Serviço.
Parameters:
Returns:
getQueueRuntimeProperties
public Mono
Obtém propriedades de runtime sobre a fila.
Parameters:
Returns:
getQueueRuntimePropertiesWithResponse
public Mono<>
Obtém propriedades de runtime sobre a fila junto com sua resposta HTTP.
Parameters:
Returns:
getQueueWithResponse
public Mono<>
Obtém informações sobre a fila junto com sua resposta HTTP.
Parameters:
Returns:
getRule
public Mono
Obtém uma regra do namespace de serviço. Somente os tipos de dados a seguir são desserializados nos parâmetros Filters e Action – string, int, long, boolean, double e OffsetDateTime. Outros tipos de dados retornariam seu valor de cadeia de caracteres.
Parameters:
Returns:
getRuleWithResponse
public Mono<>
Obtém uma regra do namespace de serviço. Somente os tipos de dados a seguir são desserializados nos parâmetros Filters e Action – string, int, long, bool, double e OffsetDateTime. Outros tipos de dados retornariam seu valor de cadeia de caracteres.
Parameters:
Returns:
getSubscription
public Mono
Obtém informações sobre a fila.
Parameters:
Returns:
getSubscriptionExists
public Mono
Obtém se existe ou não uma assinatura dentro de um tópico.
Parameters:
Returns:
getSubscriptionExistsWithResponse
public Mono<>
Obtém se existe ou não uma assinatura dentro de um tópico.
Parameters:
Returns:
getSubscriptionRuntimeProperties
public Mono
Obtém propriedades de runtime sobre a assinatura.
Parameters:
Returns:
getSubscriptionRuntimePropertiesWithResponse
public Mono<>
Obtém propriedades de runtime sobre a assinatura.
Parameters:
Returns:
getSubscriptionWithResponse
public Mono<>
Obtém informações sobre a assinatura junto com sua resposta HTTP.
Parameters:
Returns:
getTopic
public Mono
Obtém informações sobre o tópico.
Parameters:
Returns:
getTopicExists
public Mono
Obtém se um tópico com topicName existe ou não no namespace do Barramento de Serviço.
Parameters:
Returns:
getTopicExistsWithResponse
public Mono<>
Obtém se um tópico com topicName existe ou não no namespace do Barramento de Serviço.
Parameters:
Returns:
getTopicRuntimeProperties
public Mono
Obtém propriedades de runtime sobre o tópico.
Parameters:
Returns:
getTopicRuntimePropertiesWithResponse
public Mono<>
Obtém propriedades de runtime sobre o tópico com sua resposta HTTP.
Parameters:
Returns:
getTopicWithResponse
public Mono<>
Obtém informações sobre o tópico junto com sua resposta HTTP.
Parameters:
Returns:
listQueues
public PagedFlux
Busca todas as filas no namespace do Barramento de Serviço.
Returns:
listRules
public PagedFlux
Busca todas as regras para um tópico e uma assinatura.
Parameters:
Returns:
listSubscriptions
public PagedFlux
Busca todas as assinaturas de um tópico.
Parameters:
Returns:
topicName.listTopics
public PagedFlux
Busca todos os tópicos no namespace do Barramento de Serviço.
Returns:
updateQueue
public Mono
Atualizações uma fila com o determinado QueueProperties. O QueueProperties deve ser totalmente preenchido, pois todas as propriedades são substituídas. Se uma propriedade não for definida, o valor padrão do serviço será usado. O fluxo sugerido é:
- getQueue(String queueName)
- Atualizar os elementos necessários.
- Passe a descrição atualizada para esse método.
Há um subconjunto de propriedades que podem ser atualizadas. Mais informações podem ser encontradas nos links abaixo. Eles são:
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
- setMaxDeliveryCount(Integer maxDeliveryCount)
Parameters:
Returns:
updateQueueWithResponse
public Mono<>
Atualizações uma fila com o determinado QueueProperties. O QueueProperties deve ser totalmente preenchido, pois todas as propriedades são substituídas. Se uma propriedade não for definida, o valor padrão do serviço será usado. O fluxo sugerido é:
- getQueue(String queueName)
- Atualizar os elementos necessários.
- Passe a descrição atualizada para esse método.
Há um subconjunto de propriedades que podem ser atualizadas. Mais informações podem ser encontradas nos links abaixo. Eles são:
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
- setMaxDeliveryCount(Integer maxDeliveryCount)
Parameters:
Returns:
updateRule
public Mono
Atualizações uma regra com o fornecidoRuleProperties. O RuleProperties deve ser totalmente preenchido à medida que todas as propriedades são substituídas. Se uma propriedade não for definida, o valor padrão do serviço será usado. O fluxo sugerido é:
- getRule(String topicName, String subscriptionName, String ruleName)
- Atualizar os elementos necessários.
- Passe a descrição atualizada para esse método.
Parameters:
Returns:
updateRuleWithResponse
public Mono<>
Atualizações uma regra com o fornecidoRuleProperties. O RuleProperties deve ser totalmente preenchido, pois todas as propriedades são substituídas. Se uma propriedade não estiver definida, o valor padrão do serviço será usado. O fluxo sugerido é:
- getRule(String topicName, String subscriptionName, String ruleName)
- Atualizar os elementos necessários.
- Passe a descrição atualizada para esse método.
Parameters:
Returns:
updateSubscription
public Mono
Atualizações uma assinatura com o fornecidoSubscriptionProperties. O SubscriptionProperties deve ser totalmente preenchido, pois todas as propriedades são substituídas. Se uma propriedade não estiver definida, o valor padrão do serviço será usado. O fluxo sugerido é:
- getSubscription(String topicName, String subscriptionName)
- Atualizar os elementos necessários.
- Passe a descrição atualizada para esse método.
Há um subconjunto de propriedades que podem ser atualizadas. Mais informações podem ser encontradas nos links abaixo. Eles são:
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setMaxDeliveryCount(int maxDeliveryCount)
Parameters:
Returns:
updateSubscriptionWithResponse
public Mono<>
Atualizações uma assinatura com o fornecidoSubscriptionProperties. O SubscriptionProperties deve ser totalmente preenchido, pois todas as propriedades são substituídas. Se uma propriedade não estiver definida, o valor padrão do serviço será usado. O fluxo sugerido é:
- getSubscription(String topicName, String subscriptionName)
- Atualizar os elementos necessários.
- Passe a descrição atualizada para esse método.
Há um subconjunto de propriedades que podem ser atualizadas. Mais informações podem ser encontradas nos links abaixo. Eles são:
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setMaxDeliveryCount(int maxDeliveryCount)
Parameters:
Returns:
updateTopic
public Mono
Atualizações um tópico com o fornecidoTopicProperties. O TopicProperties deve ser totalmente preenchido, pois todas as propriedades são substituídas. Se uma propriedade não estiver definida, o valor padrão do serviço será usado. O fluxo sugerido é:
- getTopic(String topicName)
- Atualizar os elementos necessários.
- Passe a descrição atualizada para esse método.
Há um subconjunto de propriedades que podem ser atualizadas. Mais informações podem ser encontradas nos links abaixo. Eles são:
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
Parameters:
Returns:
updateTopicWithResponse
public Mono<>
Atualizações um tópico com o fornecidoTopicProperties. O TopicProperties deve ser totalmente preenchido, pois todas as propriedades são substituídas. Se uma propriedade não estiver definida, o valor padrão do serviço será usado. O fluxo sugerido é:
- getTopic(String topicName)
- Atualizar os elementos necessários.
- Passe a descrição atualizada para esse método.
Há um subconjunto de propriedades que podem ser atualizadas. Mais informações podem ser encontradas nos links abaixo. Eles são:
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
Parameters:
Returns:
Aplica-se a
Azure SDK for Java