Partilhar via

ManagementClientAsync Classe

  • Referência
Pacote:
com.microsoft.azure.servicebus.management
Artefato Maven:
com.microsoft.azure:azure-servicebus:3.6.7
  • java.lang.Object
    • com.microsoft.azure.servicebus.management.ManagementClientAsync

public class ManagementClientAsync

Cliente assíncrono para executar operações de gerenciamento em entidades do Barramento de Serviço. As operações retornam CompleteableFuture, que retorna as respostas de forma assíncrona.

Resumo do Construtor

Construtor Description
ManagementClientAsync(ConnectionStringBuilder connectionStringBuilder)

Cria um novo ManagementClientAsync.
ManagementClientAsync(URI namespaceEndpointURI, ClientSettings clientSettings)

Cria um novo ManagementClientAsync.

Resumo do método

Modificador e tipo Método e descrição
void close()

Descarta e fecha o cliente de gerenciamento.
CompletableFuture<QueueDescription> createQueueAsync(QueueDescription queueDescription)

Cria uma nova fila no namespace de serviço com o nome fornecido.
CompletableFuture<QueueDescription> createQueueAsync(String queuePath)

Cria uma nova fila no namespace de serviço com o nome fornecido.
CompletableFuture<RuleDescription> createRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription)

Cria uma nova regra para um determinado tópico – assinatura.
CompletableFuture<SubscriptionDescription> createSubscriptionAsync(SubscriptionDescription subscriptionDescription)

Cria uma nova assinatura no namespace do serviço com o nome fornecido.
CompletableFuture<SubscriptionDescription> createSubscriptionAsync(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)

Cria uma nova assinatura no namespace do serviço com a regra padrão fornecida.
CompletableFuture<SubscriptionDescription> createSubscriptionAsync(String topicPath, String subscriptionName)

Cria uma nova assinatura para um determinado tópico no namespace de serviço com o nome fornecido.
CompletableFuture<TopicDescription> createTopicAsync(TopicDescription topicDescription)

Cria um novo tópico no namespace de serviço com o nome fornecido.
CompletableFuture<TopicDescription> createTopicAsync(String topicPath)

Cria um novo tópico no namespace de serviço com o nome fornecido.
CompletableFuture<Void> deleteQueueAsync(String path)

Exclui a fila descrita pelo caminho em relação ao endereço base do namespace de serviço.
CompletableFuture<Void> deleteRuleAsync(String topicPath, String subscriptionName, String ruleName)

Exclui a regra de uma determinada assinatura de tópico.
CompletableFuture<Void> deleteSubscriptionAsync(String topicPath, String subscriptionName)

Exclui a assinatura descrita pelo tópicoCaminho e o Nome da assinatura.
CompletableFuture<Void> deleteTopicAsync(String path)

Exclui o tópico descrito pelo caminho relativo ao endereço base do namespace de serviço.
CompletableFuture<NamespaceInfo> getNamespaceInfoAsync()

Recupera informações relacionadas ao namespace.
CompletableFuture<QueueDescription> getQueueAsync(String path)

Recupera uma fila do namespace de serviço
CompletableFuture<QueueRuntimeInfo> getQueueRuntimeInfoAsync(String path)

Recupera as informações de runtime de uma fila.
CompletableFuture<List<QueueDescription>> getQueuesAsync()

Recupera a lista de filas presentes no namespace .
CompletableFuture<List<QueueDescription>> getQueuesAsync(int count, int skip)

Recupera a lista de filas presentes no namespace .
CompletableFuture<RuleDescription> getRuleAsync(String topicPath, String subscriptionName, String ruleName)

Recupera uma regra para um determinado tópico e assinatura do namespace de serviço
CompletableFuture<List<RuleDescription>> getRulesAsync(String topicName, String subscriptionName)

Recupera a lista de regras para uma determinada assinatura de tópico no namespace.
CompletableFuture<List<RuleDescription>> getRulesAsync(String topicName, String subscriptionName, int count, int skip)

Recupera a lista de regras para uma determinada assinatura de tópico no namespace.
CompletableFuture<SubscriptionDescription> getSubscriptionAsync(String topicPath, String subscriptionName)

Recupera uma assinatura para um determinado tópico do namespace de serviço
CompletableFuture<SubscriptionRuntimeInfo> getSubscriptionRuntimeInfoAsync(String topicPath, String subscriptionName)

Recupera as informações de runtime de uma assinatura em um determinado tópico
CompletableFuture<List<SubscriptionDescription>> getSubscriptionsAsync(String topicName)

Recupera a lista de assinaturas de um determinado tópico no namespace .
CompletableFuture<List<SubscriptionDescription>> getSubscriptionsAsync(String topicName, int count, int skip)

Recupera a lista de assinaturas de um determinado tópico no namespace .
CompletableFuture<TopicDescription> getTopicAsync(String path)

Recupera um tópico do namespace de serviço
CompletableFuture<TopicRuntimeInfo> getTopicRuntimeInfoAsync(String path)

Recupera as informações de runtime de um tópico
CompletableFuture<List<TopicDescription>> getTopicsAsync()

Recupera a lista de tópicos presentes no namespace .
CompletableFuture<List<TopicDescription>> getTopicsAsync(int count, int skip)

Recupera a lista de tópicos presentes no namespace .
CompletableFuture<Boolean> queueExistsAsync(String path)

Verifica se uma determinada fila existe ou não.
CompletableFuture<Boolean> ruleExistsAsync(String topicPath, String subscriptionName, String ruleName)

Verifica se uma determinada regra existe ou não para uma determinada assinatura.
CompletableFuture<Boolean> subscriptionExistsAsync(String topicPath, String subscriptionName)

Verifica se uma determinada assinatura existe ou não.
CompletableFuture<Boolean> topicExistsAsync(String path)

Verifica se um determinado tópico existe ou não.
CompletableFuture<QueueDescription> updateQueueAsync(QueueDescription queueDescription)

Atualizações uma fila existente.
CompletableFuture<RuleDescription> updateRuleAsync(String topicName, String subscriptionName, RuleDescription ruleDescription)

Atualizações uma regra existente.
CompletableFuture<SubscriptionDescription> updateSubscriptionAsync(SubscriptionDescription subscriptionDescription)

Atualizações uma assinatura existente.
CompletableFuture<TopicDescription> updateTopicAsync(TopicDescription topicDescription)

Atualizações um tópico existente.

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do construtor

ManagementClientAsync

public ManagementClientAsync(ConnectionStringBuilder connectionStringBuilder)

Cria um novo ManagementClientAsync. O usuário deve chamar close() no final da vida útil do cliente.

Parâmetros:

connectionStringBuilder -
  • connectionStringBuilder que contém informações de namespace e configurações do cliente.

ManagementClientAsync

public ManagementClientAsync(URI namespaceEndpointURI, ClientSettings clientSettings)

Cria um novo ManagementClientAsync. O usuário deve chamar close() no final da vida útil do cliente.

Parâmetros:

namespaceEndpointURI -
  • URI do namespace ao qual se conecta.
clientSettings -
  • configurações do cliente.

Detalhes do método

close

public void close()

Descarta e fecha o managementClient.

Gera:

IOException

 - se ocorrer um erro de E/S

createQueueAsync

public CompletableFuture createQueueAsync(QueueDescription queueDescription)

Cria uma nova fila no namespace de serviço com o nome fornecido. Consulte QueueDescription para ver os valores padrão das propriedades da fila.

Parâmetros:

queueDescription -
  • Um QueueDescription objeto que descreve os atributos com os quais a nova fila será criada.

Retornos:

QueueDescription da fila recém-criada.

createQueueAsync

public CompletableFuture createQueueAsync(String queuePath)

Cria uma nova fila no namespace de serviço com o nome fornecido. Consulte QueueDescription para ver os valores padrão das propriedades da fila.

Parâmetros:

queuePath -
  • O nome da fila em relação ao endereço base do namespace de serviço.

Retornos:

QueueDescription da fila recém-criada.

createRuleAsync

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

Cria uma nova regra para um determinado tópico – assinatura. Consulte RuleDescription para ver os valores padrão das propriedades da assinatura.

Parâmetros:

topicName -
  • Nome do tópico.
subscriptionName -
  • O nome da assinatura.
ruleDescription -
  • Um RuleDescription objeto que descreve os atributos com os quais a nova regra será criada.

Retornos:

RuleDescription da regra recém-criada.

createSubscriptionAsync

public CompletableFuture createSubscriptionAsync(SubscriptionDescription subscriptionDescription)

Cria uma nova assinatura no namespace do serviço com o nome fornecido. Consulte SubscriptionDescription para ver os valores padrão das propriedades da assinatura.

Parâmetros:

subscriptionDescription -

Retornos:

SubscriptionDescription da assinatura recém-criada.

createSubscriptionAsync

public CompletableFuture createSubscriptionAsync(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)

Cria uma nova assinatura no namespace do serviço com a regra padrão fornecida. Consulte SubscriptionDescription para ver os valores padrão das propriedades da assinatura.

Parâmetros:

subscriptionDescription -
defaultRule -
  • Um RuleDescription objeto que descreve a regra padrão. Se for nulo, o filtro de passagem será criado.

Retornos:

SubscriptionDescription da assinatura recém-criada.

createSubscriptionAsync

public CompletableFuture createSubscriptionAsync(String topicPath, String subscriptionName)

Cria uma nova assinatura para um determinado tópico no namespace de serviço com o nome fornecido. Consulte SubscriptionDescription para ver os valores padrão das propriedades da assinatura.

Parâmetros:

topicPath -
  • O nome do tópico relativo ao endereço base do namespace de serviço.
subscriptionName -
  • O nome da assinatura.

Retornos:

SubscriptionDescription da assinatura recém-criada.

createTopicAsync

public CompletableFuture createTopicAsync(TopicDescription topicDescription)

Cria um novo tópico no namespace de serviço com o nome fornecido. Consulte TopicDescription para obter valores padrão das propriedades do tópico.

Parâmetros:

topicDescription -
  • Um QueueDescription objeto que descreve os atributos com os quais o novo tópico será criado.

Retornos:

TopicDescription do tópico recém-criado.

createTopicAsync

public CompletableFuture createTopicAsync(String topicPath)

Cria um novo tópico no namespace de serviço com o nome fornecido. Consulte TopicDescription para obter valores padrão das propriedades do tópico.

Parâmetros:

topicPath -
  • O nome do tópico relativo ao endereço base do namespace de serviço.

Retornos:

TopicDescription do tópico recém-criado.

deleteQueueAsync

public CompletableFuture deleteQueueAsync(String path)

Exclui a fila descrita pelo caminho em relação ao endereço base do namespace de serviço.

Parâmetros:

path -
  • O nome da entidade em relação ao endereço base do namespace de serviço.

Retornos:

Um futuro completo que é concluído quando a fila é excluída.

deleteRuleAsync

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

Exclui a regra de uma determinada assinatura de tópico.

Parâmetros:

topicPath -
  • O nome do tópico.
subscriptionName -
  • O nome da assinatura.
ruleName -
  • O nome da regra.

Retornos:

Um futuro completo que é concluído quando a regra é excluída.

deleteSubscriptionAsync

public CompletableFuture deleteSubscriptionAsync(String topicPath, String subscriptionName)

Exclui a assinatura descrita pelo topicPath e pelo subscriptionName.

Parâmetros:

topicPath -
  • O nome do tópico.
subscriptionName -
  • O nome da assinatura.

Retornos:

Um futuro completo que é concluído quando a assinatura é excluída.

deleteTopicAsync

public CompletableFuture deleteTopicAsync(String path)

Exclui o tópico descrito pelo caminho relativo ao endereço base do namespace de serviço.

Parâmetros:

path -
  • O nome da entidade em relação ao endereço base do namespace de serviço.

Retornos:

Um futuro completo que é concluído quando o tópico é excluído.

getNamespaceInfoAsync

public CompletableFuture getNamespaceInfoAsync()

Recupera informações relacionadas ao namespace. Funciona com qualquer declaração (Enviar/Escutar/Gerenciar).

Retornos:

getQueueAsync

public CompletableFuture getQueueAsync(String path)

Recupera uma fila do namespace de serviço

Parâmetros:

path -
  • O caminho da fila em relação ao namespace do barramento de serviço.

Retornos:

  • QueueDescription que contém informações sobre a fila.

getQueueRuntimeInfoAsync

public CompletableFuture getQueueRuntimeInfoAsync(String path)

Recupera as informações de runtime de uma fila.

Parâmetros:

path -
  • O caminho da fila em relação ao namespace do barramento de serviço.

Retornos:

  • QueueRuntimeInfo que contém informações de runtime sobre a fila.

getQueuesAsync

public CompletableFuture> getQueuesAsync()

Recupera a lista de filas presentes no namespace .

Retornos:

as primeiras 100 filas.

getQueuesAsync

public CompletableFuture> getQueuesAsync(int count, int skip)

Recupera a lista de filas presentes no namespace . Você pode simular páginas de lista de entidades manipulando os parâmetros count e skip. skip(0)+count(100) fornece as primeiras 100 entidades. skip(100)+count(100) fornece as próximas 100 entidades.

Parâmetros:

count -
  • O número de filas a serem buscadas. O padrão é 100. O valor máximo permitido é 100.
skip -
  • O número de filas a serem ignoradas. Assume o padrão de 0. Não pode ser negativo.

Retornos:

a lista de filas.

getRuleAsync

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

Recupera uma regra para um determinado tópico e assinatura do namespace de serviço

Parâmetros:

topicPath -
  • O caminho do tópico em relação ao namespace do barramento de serviço.
subscriptionName -
  • O nome da assinatura.
ruleName -
  • O nome da regra.

Retornos:

  • RuleDescription que contém informações sobre a assinatura.

getRulesAsync

public CompletableFuture> getRulesAsync(String topicName, String subscriptionName)

Recupera a lista de regras para uma determinada assinatura de tópico no namespace.

Parâmetros:

topicName -
  • O nome do tópico.
subscriptionName -
  • O nome da assinatura.

Retornos:

as primeiras 100 regras.

getRulesAsync

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

Recupera a lista de regras para uma determinada assinatura de tópico no namespace. Você pode simular páginas de lista de entidades manipulando os parâmetros count e skip. skip(0)+count(100) fornece as primeiras 100 entidades. skip(100)+count(100) fornece as próximas 100 entidades.

Parâmetros:

topicName -
  • O nome do tópico.
subscriptionName -
  • O nome da assinatura.
count -
  • O número de regras a serem buscadas. O padrão é 100. O valor máximo permitido é 100.
skip -
  • O número de regras a serem ignoradas. Assume o padrão de 0. Não pode ser negativo.

Retornos:

a lista de regras.

getSubscriptionAsync

public CompletableFuture getSubscriptionAsync(String topicPath, String subscriptionName)

Recupera uma assinatura para um determinado tópico do namespace de serviço

Parâmetros:

topicPath -
  • O caminho do tópico em relação ao namespace do barramento de serviço.
subscriptionName -
  • O nome da assinatura

Retornos:

  • SubscriptionDescription que contém informações sobre a assinatura.

getSubscriptionRuntimeInfoAsync

public CompletableFuture getSubscriptionRuntimeInfoAsync(String topicPath, String subscriptionName)

Recupera as informações de runtime de uma assinatura em um determinado tópico

Parâmetros:

topicPath -
  • O caminho do tópico em relação ao namespace do barramento de serviço.
subscriptionName -
  • O nome da assinatura

Retornos:

  • SubscriptionRuntimeInfo que contém as informações de runtime sobre a assinatura.

getSubscriptionsAsync

public CompletableFuture> getSubscriptionsAsync(String topicName)

Recupera a lista de assinaturas de um determinado tópico no namespace .

Parâmetros:

topicName -
  • O nome do tópico.

Retornos:

as primeiras 100 assinaturas.

getSubscriptionsAsync

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

Recupera a lista de assinaturas de um determinado tópico no namespace . Você pode simular páginas de lista de entidades manipulando os parâmetros count e skip. skip(0)+count(100) fornece as primeiras 100 entidades. skip(100)+count(100) fornece as próximas 100 entidades.

Parâmetros:

topicName -
  • O nome do tópico.
count -
  • O número de assinaturas a serem buscadas. O padrão é 100. O valor máximo permitido é 100.
skip -
  • O número de assinaturas a serem ignoradas. Assume o padrão de 0. Não pode ser negativo.

Retornos:

a lista de assinaturas.

getTopicAsync

public CompletableFuture getTopicAsync(String path)

Recupera um tópico do namespace de serviço

Parâmetros:

path -
  • O caminho da fila em relação ao namespace do barramento de serviço.

Retornos:

  • Descrição que contém informações sobre o tópico.

getTopicRuntimeInfoAsync

public CompletableFuture getTopicRuntimeInfoAsync(String path)

Recupera as informações de runtime de um tópico

Parâmetros:

path -
  • O caminho da fila em relação ao namespace do barramento de serviço.

Retornos:

  • TopicRuntimeInfo contendo informações de runtime sobre o tópico.

getTopicsAsync

public CompletableFuture> getTopicsAsync()

Recupera a lista de tópicos presentes no namespace .

Retornos:

os primeiros 100 tópicos.

getTopicsAsync

public CompletableFuture> getTopicsAsync(int count, int skip)

Recupera a lista de tópicos presentes no namespace . Você pode simular páginas de lista de entidades manipulando os parâmetros count e skip. skip(0)+count(100) fornece as primeiras 100 entidades. skip(100)+count(100) fornece as próximas 100 entidades.

Parâmetros:

count -
  • O número de tópicos a serem buscados. O padrão é 100. O valor máximo permitido é 100.
skip -
  • O número de tópicos a serem ignoradas. Assume o padrão de 0. Não pode ser negativo.

Retornos:

a lista de tópicos.

queueExistsAsync

public CompletableFuture queueExistsAsync(String path)

Verifica se uma determinada fila existe ou não.

Parâmetros:

path -
  • Caminho da entidade para marcar

Retornos:

  • True se a entidade existir. De outra forma, falso.

ruleExistsAsync

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

Verifica se uma determinada regra existe ou não para uma determinada assinatura.

Parâmetros:

topicPath -
  • Caminho do tópico
subscriptionName -
  • O nome da assinatura.
ruleName -
  • Nome da regra

Retornos:

  • True se a entidade existir. De outra forma, falso.

subscriptionExistsAsync

public CompletableFuture subscriptionExistsAsync(String topicPath, String subscriptionName)

Verifica se uma determinada assinatura existe ou não.

Parâmetros:

topicPath -
  • Caminho do tópico
subscriptionName -
  • O nome da assinatura.

Retornos:

  • True se a entidade existir. De outra forma, falso.

topicExistsAsync

public CompletableFuture topicExistsAsync(String path)

Verifica se um determinado tópico existe ou não.

Parâmetros:

path -
  • Caminho da entidade para marcar

Retornos:

  • True se a entidade existir. De outra forma, falso.

updateQueueAsync

public CompletableFuture updateQueueAsync(QueueDescription queueDescription)

Atualizações uma fila existente.

Parâmetros:

queueDescription -
  • Um QueueDescription objeto que descreve os atributos com os quais a fila será atualizada.

Retornos:

QueueDescription da fila atualizada.

updateRuleAsync

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

Atualizações uma regra existente.

Parâmetros:

topicName -
  • Nome do tópico.
subscriptionName -
  • O nome da assinatura.
ruleDescription -
  • Um RuleDescription objeto que descreve os atributos com os quais a regra será atualizada.

Retornos:

RuleDescription da regra atualizada.

updateSubscriptionAsync

public CompletableFuture updateSubscriptionAsync(SubscriptionDescription subscriptionDescription)

Atualizações uma assinatura existente.

Parâmetros:

subscriptionDescription -

Retornos:

SubscriptionDescription da assinatura atualizada.

updateTopicAsync

public CompletableFuture updateTopicAsync(TopicDescription topicDescription)

Atualizações um tópico existente.

Parâmetros:

topicDescription -
  • Um TopicDescription objeto que descreve os atributos com os quais o tópico será atualizado.

Retornos:

TopicDescription do tópico atualizado.

Aplica-se a