ManagementClient Classe
- java.
lang. Object - com.
microsoft. azure. servicebus. management. ManagementClient
- com.
public class ManagementClient
Cliente síncrono para executar operações de gerenciamento em entidades do Barramento de Serviço. Use ManagementClientAsync para operações assíncronas.
Resumo do Construtor
Construtor | Description | |
---|---|---|
ManagementClient(ConnectionStringBuilder connectionStringBuilder) | ||
ManagementClient(URI namespaceEndpointURI, ClientSettings clientSettings) |
Resumo do método
Modificador e tipo | Método e descrição |
---|---|
void |
close()
Descarta e fecha o cliente de gerenciamento |
Queue |
createQueue(QueueDescription queueDescription)
Cria uma nova fila no namespace de serviço com o nome fornecido. |
Queue |
createQueue(String queuePath)
Cria uma nova fila no namespace de serviço com o nome fornecido. |
Rule |
createRule(String topicName, String subscriptionName, RuleDescription ruleDescription)
Cria uma nova regra para um determinado tópico – assinatura. |
Subscription |
createSubscription(SubscriptionDescription subscriptionDescription)
Cria uma nova assinatura no namespace de serviço com o nome fornecido. |
Subscription |
createSubscription(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)
Cria uma nova assinatura no namespace de serviço com a regra padrão fornecida. |
Subscription |
createSubscription(String topicPath, String subscriptionName)
Cria uma nova assinatura para um determinado tópico no namespace de serviço com o nome fornecido. |
Topic |
createTopic(TopicDescription topicDescription)
Cria um novo tópico no namespace de serviço com o nome fornecido. |
Topic |
createTopic(String topicPath)
Cria um novo tópico no namespace de serviço com o nome fornecido. |
Void |
deleteQueue(String path)
Exclui a fila descrita pelo caminho em relação ao endereço base do namespace de serviço. |
Void |
deleteRule(String topicPath, String subscriptionName, String ruleName)
Exclui a regra de um determinado tópico-assinatura. |
Void |
deleteSubscription(String topicPath, String subscriptionName)
Exclui a assinatura descrita pelo tópico |
Void |
deleteTopic(String path)
Exclui o tópico descrito pelo caminho relativo ao endereço base do namespace de serviço. |
Namespace |
getNamespaceInfo()
Recupera informações relacionadas ao namespace. |
Queue |
getQueue(String path)
Recupera uma fila do namespace de serviço |
Queue |
getQueueRuntimeInfo(String path)
Recupera as informações de runtime de uma fila. |
List<Queue |
getQueues()
Recupera a lista de filas presentes no namespace. |
List<Queue |
getQueues(int count, int skip)
Recupera a lista de filas presentes no namespace . |
Rule |
getRule(String topicPath, String subscriptionName, String ruleName)
Recupera uma regra para um determinado tópico e assinatura do namespace de serviço |
List<Rule |
getRules(String topicName, String subscriptionName)
Recupera a lista de regras para uma determinada assinatura de tópico no namespace. |
List<Rule |
getRules(String topicName, String subscriptionName, int count, int skip)
Recupera a lista de regras para uma determinada assinatura de tópico no namespace. |
Subscription |
getSubscription(String topicPath, String subscriptionName)
Recupera uma assinatura para um determinado tópico do namespace de serviço |
Subscription |
getSubscriptionRuntimeInfo(String topicPath, String subscriptionName)
Recupera as informações de runtime de uma assinatura em um determinado tópico |
List<Subscription |
getSubscriptions(String topicName)
Recupera a lista de assinaturas de um determinado tópico no namespace . |
List<Subscription |
getSubscriptions(String topicName, int count, int skip)
Recupera a lista de assinaturas de um determinado tópico no namespace . |
Topic |
getTopic(String path)
Recupera um tópico do namespace de serviço |
Topic |
getTopicRuntimeInfo(String path)
Recupera as informações de runtime de um tópico |
List<Topic |
getTopics()
Recupera a lista de tópicos presentes no namespace . |
List<Topic |
getTopics(int count, int skip)
Recupera a lista de tópicos presentes no namespace . |
Boolean |
queueExists(String path)
Verifica se uma determinada fila existe ou não. |
Boolean |
ruleExists(String topicPath, String subscriptionName, String ruleName)
Verifica se uma determinada regra existe ou não para uma determinada assinatura. |
Boolean |
subscriptionExists(String topicPath, String subscriptionName)
Verifica se uma determinada assinatura existe ou não. |
Boolean |
topicExists(String path)
Verifica se um determinado tópico existe ou não. |
Queue |
updateQueue(QueueDescription queueDescription)
Atualizações uma fila existente. |
Rule |
updateRule(String topicName, String subscriptionName, RuleDescription ruleDescription)
Atualizações uma regra existente. |
Subscription |
updateSubscription(SubscriptionDescription subscriptionDescription)
Atualizações uma assinatura existente. |
Topic |
updateTopic(TopicDescription topicDescription)
Atualizações um tópico existente. |
Métodos herdados de java.lang.Object
Detalhes do construtor
ManagementClient
public ManagementClient(ConnectionStringBuilder connectionStringBuilder)
Parâmetros:
ManagementClient
public ManagementClient(URI namespaceEndpointURI, ClientSettings clientSettings)
Parâmetros:
Detalhes do método
close
public void close()
Descarta e fecha o managementClient.
Gera:
createQueue
public QueueDescription createQueue(QueueDescription queueDescription)
Cria uma nova fila no namespace de serviço com o nome fornecido. Confira QueueDescription os valores padrão das propriedades da fila.
Parâmetros:
- Um QueueDescription objeto que descreve os atributos com os quais a nova fila será criada.
Retornos:
Gera:
- Uma entidade com o mesmo nome existe no mesmo namespace de serviço.
- Uma entidade com o mesmo nome existe no mesmo namespace de serviço.
createQueue
public QueueDescription createQueue(String queuePath)
Cria uma nova fila no namespace de serviço com o nome fornecido. Confira QueueDescription os valores padrão das propriedades da fila.
Parâmetros:
- O nome da fila em relação ao endereço base do namespace de serviço.
Retornos:
Gera:
- O nome da entidade é nulo, vazio, muito longo ou usa caracteres ilegais.
- O nome da entidade é nulo, vazio, muito longo ou usa caracteres ilegais.
createRule
public RuleDescription createRule(String topicName, String subscriptionName, RuleDescription ruleDescription)
Cria uma nova regra para um determinado tópico – assinatura. Confira RuleDescription os valores padrão das propriedades da assinatura.
Parâmetros:
- Nome do tópico.
- O nome da assinatura.
- Um RuleDescription objeto que descreve os atributos com os quais a nova regra será criada.
Retornos:
Gera:
- Uma entidade com o mesmo nome existe no mesmo namespace de serviço.
- Uma entidade com o mesmo nome existe no mesmo namespace de serviço.
createSubscription
public SubscriptionDescription createSubscription(SubscriptionDescription subscriptionDescription)
Cria uma nova assinatura no namespace de serviço com o nome fornecido. Confira SubscriptionDescription os valores padrão das propriedades da assinatura.
Parâmetros:
- Um SubscriptionDescription objeto que descreve os atributos com os quais a nova assinatura será criada.
Retornos:
Gera:
- Uma entidade com o mesmo nome existe no mesmo namespace de serviço.
- Uma entidade com o mesmo nome existe no mesmo namespace de serviço.
createSubscription
public SubscriptionDescription createSubscription(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)
Cria uma nova assinatura no namespace de serviço com a regra padrão fornecida. Confira SubscriptionDescription os valores padrão das propriedades da assinatura.
Parâmetros:
- Um SubscriptionDescription objeto que descreve os atributos com os quais a nova assinatura será criada.
- Um RuleDescription objeto que descreve a regra padrão. Se for nulo, o filtro de passagem será criado.
Retornos:
Gera:
- Uma entidade com o mesmo nome existe no mesmo namespace de serviço.
- Uma entidade com o mesmo nome existe no mesmo namespace de serviço.
createSubscription
public SubscriptionDescription createSubscription(String topicPath, String subscriptionName)
Cria uma nova assinatura para um determinado tópico no namespace de serviço com o nome fornecido. Confira SubscriptionDescription os valores padrão das propriedades da assinatura.
Parâmetros:
- O nome do tópico relativo ao endereço base do namespace de serviço.
- O nome da assinatura.
Retornos:
Gera:
- O nome da entidade é nulo, vazio, muito longo ou usa caracteres ilegais.
- O nome da entidade é nulo, vazio, muito longo ou usa caracteres ilegais.
createTopic
public TopicDescription createTopic(TopicDescription topicDescription)
Cria um novo tópico no namespace de serviço com o nome fornecido. Confira TopicDescription os valores padrão das propriedades do tópico.
Parâmetros:
- Um QueueDescription objeto que descreve os atributos com os quais o novo tópico será criado.
Retornos:
Gera:
- Uma entidade com o mesmo nome existe no mesmo namespace de serviço.
- Uma entidade com o mesmo nome existe no mesmo namespace de serviço.
createTopic
public TopicDescription createTopic(String topicPath)
Cria um novo tópico no namespace de serviço com o nome fornecido. Confira TopicDescription os valores padrão das propriedades do tópico.
Parâmetros:
- O nome do tópico relativo ao endereço base do namespace de serviço.
Retornos:
Gera:
- O nome da entidade é nulo, vazio, muito longo ou usa caracteres ilegais.
- O nome da entidade é nulo, vazio, muito longo ou usa caracteres ilegais.
deleteQueue
public Void deleteQueue(String path)
Exclui a fila descrita pelo caminho em relação ao endereço base do namespace de serviço.
Parâmetros:
- O nome da entidade em relação ao endereço base do namespace de serviço.
Gera:
- path não é nulo/ vazio / muito longo / inválido.
- path não é nulo/ vazio / muito longo / inválido.
deleteRule
public Void deleteRule(String topicPath, String subscriptionName, String ruleName)
Exclui a regra de um determinado tópico-assinatura.
Parâmetros:
- O nome do tópico.
- O nome da assinatura.
- O nome da regra.
Gera:
- path não é nulo/ vazio / muito longo / inválido.
- path não é nulo/ vazio / muito longo / inválido.
deleteSubscription
public Void deleteSubscription(String topicPath, String subscriptionName)
Exclui a assinatura descrita pelo topicPath e pelo subscriptionName.
Parâmetros:
- O nome do tópico.
- O nome da assinatura.
Gera:
- path não é nulo/ vazio / muito longo / inválido.
- path não é nulo/ vazio / muito longo / inválido.
deleteTopic
public Void deleteTopic(String path)
Exclui o tópico descrito pelo caminho relativo ao endereço base do namespace de serviço.
Parâmetros:
- O nome da entidade em relação ao endereço base do namespace de serviço.
Gera:
- path não é nulo/ vazio / muito longo / inválido.
- path não é nulo/ vazio / muito longo / inválido.
getNamespaceInfo
public NamespaceInfo getNamespaceInfo()
Recupera informações relacionadas ao namespace. Funciona com qualquer declaração (Enviar/Escutar/Gerenciar).
Retornos:
- NamespaceInfo que contém informações de namespace.
Gera:
- Ocorreu um erro interno ou uma exceção inesperada.
- Ocorreu um erro interno ou uma exceção inesperada.
getQueue
public QueueDescription getQueue(String path)
Recupera uma fila do namespace de serviço
Parâmetros:
- O caminho da fila em relação ao namespace do barramento de serviço.
Retornos:
- QueueDescription que contém informações sobre a fila.
Gera:
- Gerado se o caminho for nulo, vazio ou não no formato ou comprimento correto.
- Gerado se o caminho for nulo, vazio ou não no formato ou comprimento correto.
getQueueRuntimeInfo
public QueueRuntimeInfo getQueueRuntimeInfo(String path)
Recupera as informações de runtime de uma fila.
Parâmetros:
- O caminho da fila em relação ao namespace do barramento de serviço.
Retornos:
- QueueRuntimeInfo contendo informações de runtime sobre a fila.
Gera:
- Gerado se o caminho for nulo, vazio ou não no formato ou comprimento correto.
- Gerado se o caminho for nulo, vazio ou não no formato ou comprimento correto.
getQueues
public List
Recupera a lista de filas presentes no namespace.
Retornos:
Gera:
- A operação atinge o tempo limite. O período de tempo limite é iniciado por meio de ClientSettings.operationTimeout
- A operação atinge o tempo limite. O período de tempo limite é iniciado por meio de ClientSettings.operationTimeout
getQueues
public List
Recupera a lista de filas presentes no namespace. Você pode simular páginas da lista de entidades manipulando parâmetros de contagem e ignorar. skip(0)+count(100) fornece as primeiras 100 entidades. skip(100)+count(100) fornece as próximas 100 entidades.
Parâmetros:
- O número de filas a serem buscadas. O padrão é 100. O valor máximo permitido é 100.
- O número de filas a serem ignoradas. Assume o padrão de 0. Não pode ser negativo.
Retornos:
Gera:
- A operação atinge o tempo limite. O período de tempo limite é iniciado por meio de ClientSettings.operationTimeout
- A operação atinge o tempo limite. O período de tempo limite é iniciado por meio de ClientSettings.operationTimeout
getRule
public RuleDescription getRule(String topicPath, String subscriptionName, String ruleName)
Recupera uma regra para um determinado tópico e assinatura do namespace de serviço
Parâmetros:
- O caminho do tópico em relação ao namespace do barramento de serviço.
- O nome da assinatura.
- O nome da regra.
Retornos:
- RuleDescription que contém informações sobre a assinatura.
Gera:
- Gerado se path for nulo, vazio ou não no formato ou comprimento correto.
- Gerado se path for nulo, vazio ou não no formato ou comprimento correto.
getRules
public List
Recupera a lista de regras para uma determinada assinatura de tópico no namespace.
Parâmetros:
- O nome do tópico.
- O nome da assinatura.
Retornos:
Gera:
- A operação atinge o tempo limite. O período de tempo limite é iniciado por meio de ClientSettings.operationTimeout
- A operação atinge o tempo limite. O período de tempo limite é iniciado por meio de ClientSettings.operationTimeout
getRules
public List
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:
- O nome do tópico.
- O nome da assinatura.
- O número de regras a serem buscadas. O padrão é 100. O valor máximo permitido é 100.
- O número de regras a serem ignoradas. Assume o padrão de 0. Não pode ser negativo.
Retornos:
Gera:
- A operação atinge o tempo limite. O período de tempo limite é iniciado por meio de ClientSettings.operationTimeout
- A operação atinge o tempo limite. O período de tempo limite é iniciado por meio de ClientSettings.operationTimeout
getSubscription
public SubscriptionDescription getSubscription(String topicPath, String subscriptionName)
Recupera uma assinatura para um determinado tópico do namespace de serviço
Parâmetros:
- O caminho do tópico em relação ao namespace do barramento de serviço.
- O nome da assinatura
Retornos:
- SubscriptionDescription que contém informações sobre a assinatura.
Gera:
- Gerado se path for nulo, vazio ou não no formato ou comprimento correto.
- Gerado se path for nulo, vazio ou não no formato ou comprimento correto.
getSubscriptionRuntimeInfo
public SubscriptionRuntimeInfo getSubscriptionRuntimeInfo(String topicPath, String subscriptionName)
Recupera as informações de runtime de uma assinatura em um determinado tópico
Parâmetros:
- O caminho do tópico em relação ao namespace do barramento de serviço.
- O nome da assinatura
Retornos:
- SubscriptionRuntimeInfo que contém as informações de runtime sobre a assinatura.
Gera:
- Gerado se path for nulo, vazio ou não no formato ou comprimento correto.
- Gerado se path for nulo, vazio ou não no formato ou comprimento correto.
getSubscriptions
public List
Recupera a lista de assinaturas de um determinado tópico no namespace .
Parâmetros:
- O nome do tópico.
Retornos:
Gera:
- A operação atinge o tempo limite. O período de tempo limite é iniciado por meio de ClientSettings.operationTimeout
- A operação atinge o tempo limite. O período de tempo limite é iniciado por meio de ClientSettings.operationTimeout
getSubscriptions
public List
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:
- O nome do tópico.
- O número de assinaturas a serem buscadas. O padrão é 100. O valor máximo permitido é 100.
- O número de assinaturas a serem ignoradas. Assume o padrão de 0. Não pode ser negativo.
Retornos:
Gera:
- A operação atinge o tempo limite. O período de tempo limite é iniciado por meio de ClientSettings.operationTimeout
- A operação atinge o tempo limite. O período de tempo limite é iniciado por meio de ClientSettings.operationTimeout
getTopic
public TopicDescription getTopic(String path)
Recupera um tópico do namespace de serviço
Parâmetros:
- 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.
Gera:
- Gerado se path for nulo, vazio ou não no formato ou comprimento correto.
- Gerado se path for nulo, vazio ou não no formato ou comprimento correto.
getTopicRuntimeInfo
public TopicRuntimeInfo getTopicRuntimeInfo(String path)
Recupera as informações de runtime de um tópico
Parâmetros:
- 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.
Gera:
- Gerado se path for nulo, vazio ou não no formato ou comprimento correto.
- Gerado se path for nulo, vazio ou não no formato ou comprimento correto.
getTopics
public List
Recupera a lista de tópicos presentes no namespace .
Retornos:
Gera:
- A operação atinge o tempo limite. O período de tempo limite é iniciado por meio de ClientSettings.operationTimeout
- A operação atinge o tempo limite. O período de tempo limite é iniciado por meio de ClientSettings.operationTimeout
getTopics
public List
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:
- O número de tópicos a serem buscados. O padrão é 100. O valor máximo permitido é 100.
- O número de tópicos a serem ignoradas. Assume o padrão de 0. Não pode ser negativo.
Retornos:
Gera:
- A operação atinge o tempo limite. O período de tempo limite é iniciado por meio de ClientSettings.operationTimeout
- A operação atinge o tempo limite. O período de tempo limite é iniciado por meio de ClientSettings.operationTimeout
queueExists
public Boolean queueExists(String path)
Verifica se uma determinada fila existe ou não.
Parâmetros:
- Caminho da entidade para marcar
Retornos:
- True se a entidade existir. De outra forma, falso.
Gera:
- path não é nulo/vazio/muito longo/inválido.
- path não é nulo/vazio/muito longo/inválido.
ruleExists
public Boolean ruleExists(String topicPath, String subscriptionName, String ruleName)
Verifica se uma determinada regra existe ou não para uma determinada assinatura.
Parâmetros:
- Caminho do tópico
- O nome da assinatura.
- Nome da regra
Retornos:
- True se a entidade existir. De outra forma, falso.
Gera:
- path não é nulo/vazio/muito longo/inválido.
- path não é nulo/vazio/muito longo/inválido.
subscriptionExists
public Boolean subscriptionExists(String topicPath, String subscriptionName)
Verifica se uma determinada assinatura existe ou não.
Parâmetros:
- Caminho do tópico
- O nome da assinatura.
Retornos:
- True se a entidade existir. De outra forma, falso.
Gera:
- path não é nulo/vazio/muito longo/inválido.
- path não é nulo/vazio/muito longo/inválido.
topicExists
public Boolean topicExists(String path)
Verifica se um determinado tópico existe ou não.
Parâmetros:
- Caminho da entidade para marcar
Retornos:
- True se a entidade existir. De outra forma, falso.
Gera:
- path não é nulo/vazio/muito longo/inválido.
- path não é nulo/vazio/muito longo/inválido.
updateQueue
public QueueDescription updateQueue(QueueDescription queueDescription)
Atualizações uma fila existente.
Parâmetros:
- Um QueueDescription objeto que descreve os atributos com os quais a fila será atualizada.
Retornos:
Gera:
- A entidade descrita não foi encontrada.
- A entidade descrita não foi encontrada.
updateRule
public RuleDescription updateRule(String topicName, String subscriptionName, RuleDescription ruleDescription)
Atualizações uma regra existente.
Parâmetros:
- Nome do tópico.
- O nome da assinatura.
- Um RuleDescription objeto que descreve os atributos com os quais a regra será atualizada.
Retornos:
Gera:
- A entidade descrita não foi encontrada.
- A entidade descrita não foi encontrada.
updateSubscription
public SubscriptionDescription updateSubscription(SubscriptionDescription subscriptionDescription)
Atualizações uma assinatura existente.
Parâmetros:
- Um SubscriptionDescription objeto que descreve os atributos com os quais a assinatura será atualizada.
Retornos:
Gera:
- A entidade descrita não foi encontrada.
- A entidade descrita não foi encontrada.
updateTopic
public TopicDescription updateTopic(TopicDescription topicDescription)
Atualizações um tópico existente.
Parâmetros:
- Um TopicDescription objeto que descreve os atributos com os quais o tópico será atualizado.
Retornos:
Gera:
- A entidade descrita não foi encontrada.
- A entidade descrita não foi encontrada.
Aplica-se a
Azure SDK for Java