ServiceBusAdministrationClient Classe

Pacote:

com.azure.messaging.servicebus.administration

Artefato Maven:

com.azure:azure-messaging-servicebus:7.17.0

• java.lang.Object
• • com.azure.messaging.servicebus.administration.ServiceBusAdministrationClient

public final class ServiceBusAdministrationClient

Um cliente sí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.

HttpLogOptions logOptions = new HttpLogOptions()
     .setLogLevel(HttpLogDetailLevel.HEADERS);

 // DefaultAzureCredential creates a credential based on the environment it is executed in.
 TokenCredential tokenCredential = new DefaultAzureCredentialBuilder().build();

 // 'fullyQualifiedNamespace' will look similar to "{your-namespace}.servicebus.windows.net"
 ServiceBusAdministrationClient client = new ServiceBusAdministrationClientBuilder()
     .credential(fullyQualifiedNamespace, tokenCredential)
     .httpLogOptions(logOptions)
     .buildClient();

Exemplo: Criar uma fila

O exemplo a seguir cria uma fila com valores padrão. Os valores padrão são listados em CreateQueueOptions().

QueueProperties queue = client.createQueue("my-new-queue");
 System.out.printf("Queue created. Name: %s. Lock Duration: %s.%n",
     queue.getName(), queue.getLockDuration());

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.
 SubscriptionProperties subscription = client.getSubscription("my-topic", "my-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.
 SubscriptionProperties updated = client.updateSubscription(subscription);

 System.out.printf("Subscription updated. Name: %s. Delivery count: %s.%n",
     updated.getSubscriptionName(), updated.getMaxDeliveryCount());

Exemplo: listar todas as filas

O exemplo de código a seguir lista todas as filas no namespace do Barramento de Serviço.

client.listQueues().forEach(queue -> {
     System.out.printf("Queue [%s]. Lock Duration: %s.%n",
         queue.getName(), queue.getLockDuration());
 });

Exemplo: Excluir fila

O exemplo de código abaixo demonstra a exclusão de uma fila existente.

try {
     client.deleteQueue("my-existing-queue");
 } catch (AzureException exception) {
     System.err.println("Exception occurred deleting queue: " + exception);
 }

Resumo do método

Modificador e tipo	Método e descrição
QueueProperties	createQueue(String queueName) Cria uma fila com o nome fornecido.
QueueProperties	createQueue(String queueName, CreateQueueOptions queueOptions) Cria uma fila com o CreateQueueOptions.
Response<QueueProperties>	createQueueWithResponse(String queueName, CreateQueueOptions queueOptions, Context context) Cria uma fila e retorna a fila criada além da resposta HTTP.
RuleProperties	createRule(String topicName, String subscriptionName, String ruleName) Cria uma regra sob o tópico e a assinatura especificados
RuleProperties	createRule(String topicName, String ruleName, String subscriptionName, CreateRuleOptions ruleOptions) Cria uma regra com o CreateRuleOptions.
Response<RuleProperties>	createRuleWithResponse(String topicName, String subscriptionName, String ruleName, CreateRuleOptions ruleOptions, Context context) Cria uma regra e retorna a regra criada além da resposta HTTP.
SubscriptionProperties	createSubscription(String topicName, String subscriptionName) Cria uma assinatura com os nomes de tópico e assinatura fornecidos.
SubscriptionProperties	createSubscription(String topicName, String subscriptionName, CreateSubscriptionOptions subscriptionOptions) Cria uma assinatura com o CreateSubscriptionOptions.
SubscriptionProperties	createSubscription(String topicName, String subscriptionName, String ruleName, CreateSubscriptionOptions subscriptionOptions, CreateRuleOptions ruleOptions) Cria uma assinatura com a regra padrão usando o CreateSubscriptionOptions e CreateRuleOptionso .
Response<SubscriptionProperties>	createSubscriptionWithResponse(String topicName, String subscriptionName, CreateSubscriptionOptions subscriptionOptions, Context context) Cria uma assinatura e retorna a assinatura criada além da resposta HTTP.
Response<SubscriptionProperties>	createSubscriptionWithResponse(String topicName, String subscriptionName, String ruleName, CreateSubscriptionOptions subscriptionOptions, CreateRuleOptions ruleOptions, Context context) Cria uma assinatura com a regra padrão configurada e retorna a assinatura criada além da resposta HTTP.
TopicProperties	createTopic(String topicName) Cria um tópico com o nome fornecido.
TopicProperties	createTopic(String topicName, CreateTopicOptions topicOptions) Cria um tópico com o CreateTopicOptions.
Response<TopicProperties>	createTopicWithResponse(String topicName, CreateTopicOptions topicOptions, Context context) Cria um tópico e retorna o tópico criado além da resposta HTTP.
void	deleteQueue(String queueName) Exclui uma fila da correspondência queueName.
Response<Void>	deleteQueueWithResponse(String queueName, Context context) Exclui uma fila da correspondência queueName e retorna a resposta HTTP.
void	deleteRule(String topicName, String subscriptionName, String ruleName) Exclui uma regra da correspondência ruleName.
Response<Void>	deleteRuleWithResponse(String topicName, String subscriptionName, String ruleName, Context context) Exclui uma regra da correspondência ruleName e retorna a resposta HTTP.
void	deleteSubscription(String topicName, String subscriptionName) Exclui uma assinatura que corresponde ao subscriptionName no tópico topicName.
Response<Void>	deleteSubscriptionWithResponse(String topicName, String subscriptionName, Context context) Exclui uma assinatura da correspondência subscriptionName e retorna a resposta HTTP.
void	deleteTopic(String topicName) Exclui um tópico do correspondente topicName.
Response<Void>	deleteTopicWithResponse(String topicName, Context context) Exclui um tópico da correspondência topicName e retorna a resposta HTTP.
NamespaceProperties	getNamespaceProperties() Obtém informações sobre o namespace do Barramento de Serviço.
Response<NamespaceProperties>	getNamespacePropertiesWithResponse(Context context) Obtém informações sobre o namespace do Barramento de Serviço junto com sua resposta HTTP.
QueueProperties	getQueue(String queueName) Obtém informações sobre a fila.
boolean	getQueueExists(String queueName) Obtém se existe uma fila com queueName no namespace do Barramento de Serviço.
Response<Boolean>	getQueueExistsWithResponse(String queueName, Context context) Obtém se existe uma fila com queueName no namespace do Barramento de Serviço.
QueueRuntimeProperties	getQueueRuntimeProperties(String queueName) Obtém propriedades de runtime sobre a fila.
Response<QueueRuntimeProperties>	getQueueRuntimePropertiesWithResponse(String queueName, Context context) Obtém propriedades de runtime sobre a fila junto com sua resposta HTTP.
Response<QueueProperties>	getQueueWithResponse(String queueName, Context context) Obtém informações sobre a fila junto com sua resposta HTTP.
RuleProperties	getRule(String topicName, String subscriptionName, String ruleName) Obtém uma regra do namespace de serviço.
Response<RuleProperties>	getRuleWithResponse(String topicName, String subscriptionName, String ruleName, Context context) Obtém uma regra do namespace de serviço.
SubscriptionProperties	getSubscription(String topicName, String subscriptionName) Obtém informações sobre a fila.
boolean	getSubscriptionExists(String topicName, String subscriptionName) Obtém se existe uma assinatura dentro de um tópico.
Response<Boolean>	getSubscriptionExistsWithResponse(String topicName, String subscriptionName, Context context) Obtém se existe uma assinatura dentro de um tópico.
SubscriptionRuntimeProperties	getSubscriptionRuntimeProperties(String topicName, String subscriptionName) Obtém propriedades de runtime sobre a assinatura.
Response<SubscriptionRuntimeProperties>	getSubscriptionRuntimePropertiesWithResponse(String topicName, String subscriptionName, Context context) Obtém propriedades de runtime sobre a assinatura.
Response<SubscriptionProperties>	getSubscriptionWithResponse(String topicName, String subscriptionName, Context context) Obtém informações sobre a assinatura junto com sua resposta HTTP.
TopicProperties	getTopic(String topicName) Obtém informações sobre o tópico.
boolean	getTopicExists(String topicName) Obtém se um tópico com topicName existe no namespace do Barramento de Serviço.
Response<Boolean>	getTopicExistsWithResponse(String topicName, Context context) Obtém se um tópico com topicName existe no namespace do Barramento de Serviço.
TopicRuntimeProperties	getTopicRuntimeProperties(String topicName) Obtém propriedades de runtime sobre o tópico.
Response<TopicRuntimeProperties>	getTopicRuntimePropertiesWithResponse(String topicName, Context context) Obtém propriedades de runtime sobre o tópico com sua resposta HTTP.
Response<TopicProperties>	getTopicWithResponse(String topicName, Context context) Obtém informações sobre o tópico junto com sua resposta HTTP.
PagedIterable<QueueProperties>	listQueues() Busca todas as filas no namespace do Barramento de Serviço.
PagedIterable<QueueProperties>	listQueues(Context context) Busca todas as filas no namespace do Barramento de Serviço.
PagedIterable<RuleProperties>	listRules(String topicName, String subscriptionName) Busca todas as regras para um tópico e uma assinatura.
PagedIterable<RuleProperties>	listRules(String topicName, String subscriptionName, Context context) Busca todas as regras para um tópico e uma assinatura.
PagedIterable<SubscriptionProperties>	listSubscriptions(String topicName) Busca todas as assinaturas para um tópico.
PagedIterable<SubscriptionProperties>	listSubscriptions(String topicName, Context context) Busca todas as assinaturas para um tópico.
PagedIterable<TopicProperties>	listTopics() Busca todos os tópicos no namespace do Barramento de Serviço.
PagedIterable<TopicProperties>	listTopics(Context context) Busca todos os tópicos no namespace do Barramento de Serviço.
QueueProperties	updateQueue(QueueProperties queue) Atualizações uma fila com o fornecidoQueueProperties.
Response<QueueProperties>	updateQueueWithResponse(QueueProperties queue, Context context) Atualizações uma fila com o fornecidoQueueProperties.
RuleProperties	updateRule(String topicName, String subscriptionName, RuleProperties rule) Atualizações uma regra com o fornecidoRuleProperties.
Response<RuleProperties>	updateRuleWithResponse(String topicName, String subscriptionName, RuleProperties rule, Context context) Atualizações uma regra com o fornecidoRuleProperties.
SubscriptionProperties	updateSubscription(SubscriptionProperties subscription) Atualizações uma assinatura com o fornecidoSubscriptionProperties.
Response<SubscriptionProperties>	updateSubscriptionWithResponse(SubscriptionProperties subscription, Context context) Atualizações uma assinatura com o fornecidoSubscriptionProperties.
TopicProperties	updateTopic(TopicProperties topic) Atualizações um tópico com o determinado TopicProperties.
Response<TopicProperties>	updateTopicWithResponse(TopicProperties topic, Context context) Atualizações um tópico com o determinado TopicProperties.

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do método

createQueue

public QueueProperties createQueue(String queueName)

Cria uma fila com o nome fornecido.

Parameters:

queueName - Nome da fila a ser criada.

Returns:

A fila criada.

createQueue

public QueueProperties createQueue(String queueName, CreateQueueOptions queueOptions)

Cria uma fila com o CreateQueueOptions.

Parameters:

queueName - Nome da fila a ser criada.

queueOptions - Informações sobre a fila a ser criada.

Returns:

A fila criada.

createQueueWithResponse

public Response createQueueWithResponse(String queueName, CreateQueueOptions queueOptions, Context context)

Cria uma fila e retorna a fila criada além da resposta HTTP.

Parameters:

queueName - Nome da fila a ser criada.

queueOptions - Informações sobre a fila a ser criada.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

A fila criada além da resposta HTTP.

createRule

public RuleProperties createRule(String topicName, String subscriptionName, String ruleName)

Cria uma regra sob o tópico e a assinatura especificados

Parameters:

topicName - Nome do tópico associado à regra.

subscriptionName - Nome da assinatura associada à regra.

ruleName - Nome da regra.

Returns:

Informações sobre a regra criada.

createRule

public RuleProperties createRule(String topicName, String ruleName, String subscriptionName, CreateRuleOptions ruleOptions)

Cria uma regra com o CreateRuleOptions.

Parameters:

topicName - Nome do tópico associado à regra.

ruleName - Nome da regra.

subscriptionName - Nome da assinatura associada à regra.

ruleOptions - Informações sobre a regra a ser criada.

Returns:

Informações sobre a regra criada.

createRuleWithResponse

public Response createRuleWithResponse(String topicName, String subscriptionName, String ruleName, CreateRuleOptions ruleOptions, Context context)

Cria uma regra e retorna a regra criada além da resposta HTTP.

Parameters:

topicName - Nome do tópico associado à regra.

subscriptionName - Nome da assinatura associada à regra.

ruleName - Nome da regra.

ruleOptions - Informações sobre a regra a ser criada.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

A regra criada além da resposta HTTP.

createSubscription

public SubscriptionProperties createSubscription(String topicName, String subscriptionName)

Cria uma assinatura com os nomes de tópico e assinatura fornecidos.

Parameters:

topicName - Nome do tópico associado à assinatura.

subscriptionName - O nome da assinatura.

Returns:

Informações sobre a assinatura criada.

createSubscription

public SubscriptionProperties createSubscription(String topicName, String subscriptionName, CreateSubscriptionOptions subscriptionOptions)

Cria uma assinatura com o CreateSubscriptionOptions.

Parameters:

topicName - Nome do tópico associado à assinatura.

subscriptionName - O nome da assinatura.

subscriptionOptions - Informações sobre a assinatura a ser criada.

Returns:

Informações sobre a assinatura criada.

createSubscription

public SubscriptionProperties createSubscription(String topicName, String subscriptionName, String ruleName, CreateSubscriptionOptions subscriptionOptions, CreateRuleOptions ruleOptions)

Cria uma assinatura com a regra padrão usando o CreateSubscriptionOptions e CreateRuleOptionso .

Parameters:

topicName - Nome do tópico associado à assinatura.

subscriptionName - O nome da assinatura.

ruleName - Nome da regra padrão com a qual a assinatura deve ser criada.

subscriptionOptions - Um CreateSubscriptionOptions objeto que descreve a assinatura a ser criada.

ruleOptions - Um CreateRuleOptions objeto que descreve a regra padrão. Se for nulo, o filtro de passagem será criado.

Returns:

Informações sobre a assinatura criada.

createSubscriptionWithResponse

public Response createSubscriptionWithResponse(String topicName, String subscriptionName, CreateSubscriptionOptions subscriptionOptions, Context context)

Cria uma assinatura e retorna a assinatura criada além da resposta HTTP.

Parameters:

topicName - Nome do tópico associado à assinatura.

subscriptionName - O nome da assinatura.

subscriptionOptions - Informações sobre a assinatura a ser criada.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

A assinatura criada além da resposta HTTP.

createSubscriptionWithResponse

public Response createSubscriptionWithResponse(String topicName, String subscriptionName, String ruleName, CreateSubscriptionOptions subscriptionOptions, CreateRuleOptions ruleOptions, Context context)

Cria uma assinatura com a regra padrão configurada e retorna a assinatura criada além da resposta HTTP.

Parameters:

topicName - Nome do tópico associado à assinatura.

subscriptionName - O nome da assinatura.

ruleName - Nome da regra padrão com a qual a assinatura deve ser criada.

subscriptionOptions - Um CreateSubscriptionOptions objeto que descreve a assinatura a ser criada.

ruleOptions - Um CreateRuleOptions objeto que descreve a regra padrão. Se for nulo, o filtro de passagem será criado.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

A assinatura criada além da resposta HTTP.

createTopic

public TopicProperties createTopic(String topicName)

Cria um tópico com o nome fornecido.

Parameters:

topicName - Nome do tópico a ser criado.

Returns:

Informações sobre o tópico criado.

createTopic

public TopicProperties createTopic(String topicName, CreateTopicOptions topicOptions)

Cria um tópico com o CreateTopicOptions.

Parameters:

topicName - Nome do tópico a ser criado.

topicOptions - Informações sobre o tópico a ser criado.

Returns:

Informações sobre o tópico criado.

createTopicWithResponse

public Response createTopicWithResponse(String topicName, CreateTopicOptions topicOptions, Context context)

Cria um tópico e retorna o tópico criado além da resposta HTTP.

Parameters:

topicName - Nome do tópico a ser criado.

topicOptions - Informações sobre o tópico a ser criado.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

O tópico criado além da resposta HTTP.

deleteQueue

public void deleteQueue(String queueName)

Exclui uma fila da correspondência queueName.

Parameters:

queueName - Nome da fila a ser excluída.

deleteQueueWithResponse

public Response deleteQueueWithResponse(String queueName, Context context)

Exclui uma fila da correspondência queueName e retorna a resposta HTTP.

Parameters:

queueName - Nome da fila a ser excluída.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

A resposta HTTP quando a fila é excluída com êxito.

deleteRule

public void deleteRule(String topicName, String subscriptionName, String ruleName)

Exclui uma regra da correspondência ruleName.

Parameters:

topicName - Nome do tópico associado à regra a ser excluída.

subscriptionName - Nome da assinatura associada à regra a ser excluída.

ruleName - Nome da regra a ser excluída.

deleteRuleWithResponse

public Response deleteRuleWithResponse(String topicName, String subscriptionName, String ruleName, Context context)

Exclui uma regra da correspondência ruleName e retorna a resposta HTTP.

Parameters:

topicName - Nome do tópico associado à regra a ser excluída.

subscriptionName - Nome da assinatura associada à regra a ser excluída.

ruleName - Nome da regra a ser excluída.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

A resposta HTTP.

deleteSubscription

public void deleteSubscription(String topicName, String subscriptionName)

Exclui uma assinatura que corresponde ao subscriptionName no tópico topicName.

Parameters:

topicName - Nome do tópico associado à assinatura a ser excluída.

subscriptionName - Nome da assinatura a ser excluída.

deleteSubscriptionWithResponse

public Response deleteSubscriptionWithResponse(String topicName, String subscriptionName, Context context)

Exclui uma assinatura da correspondência subscriptionName e retorna a resposta HTTP.

Parameters:

topicName - Nome do tópico associado à assinatura a ser excluída.

subscriptionName - Nome da assinatura a ser excluída.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

A resposta HTTP.

deleteTopic

public void deleteTopic(String topicName)

Exclui um tópico do correspondente topicName.

Parameters:

topicName - Nome do tópico a ser excluído.

deleteTopicWithResponse

public Response deleteTopicWithResponse(String topicName, Context context)

Exclui um tópico da correspondência topicName e retorna a resposta HTTP.

Parameters:

topicName - Nome do tópico a ser excluído.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

A resposta HTTP.

getNamespaceProperties

public NamespaceProperties getNamespaceProperties()

Obtém informações sobre o namespace do Barramento de Serviço.

Returns:

Informações sobre o namespace do Barramento de Serviço.

getNamespacePropertiesWithResponse

public Response getNamespacePropertiesWithResponse(Context context)

Obtém informações sobre o namespace do Barramento de Serviço junto com sua resposta HTTP.

Parameters:

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Informações sobre o namespace e a resposta HTTP associada.

getQueue

public QueueProperties getQueue(String queueName)

Obtém informações sobre a fila.

Parameters:

queueName - Nome da fila sobre o qual obter informações.

Returns:

Informações sobre a fila.

getQueueExists

public boolean getQueueExists(String queueName)

Obtém se existe uma fila com queueName no namespace do Barramento de Serviço.

Parameters:

queueName - Nome da fila.

Returns:

true se a fila existir; caso contrário false, .

getQueueExistsWithResponse

public Response getQueueExistsWithResponse(String queueName, Context context)

Obtém se existe uma fila com queueName no namespace do Barramento de Serviço.

Parameters:

queueName - Nome da fila.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

A resposta HTTP e true se a fila existir; caso contrário false, .

getQueueRuntimeProperties

public QueueRuntimeProperties getQueueRuntimeProperties(String queueName)

Obtém propriedades de runtime sobre a fila.

Parameters:

queueName - Nome da fila sobre o qual obter informações.

Returns:

Propriedades de runtime sobre a fila.

getQueueRuntimePropertiesWithResponse

public Response getQueueRuntimePropertiesWithResponse(String queueName, Context context)

Obtém propriedades de runtime sobre a fila junto com sua resposta HTTP.

Parameters:

queueName - Nome da fila sobre o qual obter informações.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Propriedades de runtime sobre a fila e a resposta HTTP associada.

getQueueWithResponse

public Response getQueueWithResponse(String queueName, Context context)

Obtém informações sobre a fila junto com sua resposta HTTP.

Parameters:

queueName - Nome da fila sobre o qual obter informações.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Informações sobre a fila e a resposta HTTP associada.

getRule

public RuleProperties getRule(String topicName, String subscriptionName, String ruleName)

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:

topicName - O nome do tópico em relação ao namespace do barramento de serviço.

subscriptionName - O nome da assinatura ao qual a regra pertence.

ruleName - O nome da regra a ser recuperada.

Returns:

A regra associada.

getRuleWithResponse

public Response getRuleWithResponse(String topicName, String subscriptionName, String ruleName, Context context)

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:

topicName - O nome do tópico em relação ao namespace do barramento de serviço.

subscriptionName - O nome da assinatura ao qual a regra pertence.

ruleName - O nome da regra a ser recuperada.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

A regra associada à resposta HTTP correspondente.

getSubscription

public SubscriptionProperties getSubscription(String topicName, String subscriptionName)

Obtém informações sobre a fila.

Parameters:

topicName - Nome do tópico associado à assinatura.

subscriptionName - Nome da assinatura sobre a qual obter informações.

Returns:

Informações sobre a assinatura.

getSubscriptionExists

public boolean getSubscriptionExists(String topicName, String subscriptionName)

Obtém se existe uma assinatura dentro de um tópico.

Parameters:

topicName - Nome do tópico associado à assinatura.

subscriptionName - O nome da assinatura.

Returns:

true se a assinatura existir.

getSubscriptionExistsWithResponse

public Response getSubscriptionExistsWithResponse(String topicName, String subscriptionName, Context context)

Obtém se existe uma assinatura dentro de um tópico.

Parameters:

topicName - Nome do tópico associado à assinatura.

subscriptionName - O nome da assinatura.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

A resposta HTTP e true se a assinatura existir; caso contrário false, .

getSubscriptionRuntimeProperties

public SubscriptionRuntimeProperties getSubscriptionRuntimeProperties(String topicName, String subscriptionName)

Obtém propriedades de runtime sobre a assinatura.

Parameters:

topicName - Nome do tópico associado à assinatura.

subscriptionName - Nome da assinatura sobre a qual obter informações.

Returns:

Propriedades de runtime sobre a assinatura.

getSubscriptionRuntimePropertiesWithResponse

public Response getSubscriptionRuntimePropertiesWithResponse(String topicName, String subscriptionName, Context context)

Obtém propriedades de runtime sobre a assinatura.

Parameters:

topicName - Nome do tópico associado à assinatura.

subscriptionName - Nome da assinatura sobre a qual obter informações.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Propriedades de runtime sobre a assinatura.

getSubscriptionWithResponse

public Response getSubscriptionWithResponse(String topicName, String subscriptionName, Context context)

Obtém informações sobre a assinatura junto com sua resposta HTTP.

Parameters:

topicName - Nome do tópico associado à assinatura.

subscriptionName - Nome da assinatura sobre a qual obter informações.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Informações sobre a assinatura e a resposta HTTP associada.

getTopic

public TopicProperties getTopic(String topicName)

Obtém informações sobre o tópico.

Parameters:

topicName - Nome do tópico sobre o qual obter informações.

Returns:

Informações sobre o tópico.

getTopicExists

public boolean getTopicExists(String topicName)

Obtém se um tópico com topicName existe no namespace do Barramento de Serviço.

Parameters:

topicName - Nome do tópico.

Returns:

true se o tópico existir.

getTopicExistsWithResponse

public Response getTopicExistsWithResponse(String topicName, Context context)

Obtém se um tópico com topicName existe no namespace do Barramento de Serviço.

Parameters:

topicName - Nome do tópico.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

A resposta HTTP e true se o tópico existir; caso contrário false, .

getTopicRuntimeProperties

public TopicRuntimeProperties getTopicRuntimeProperties(String topicName)

Obtém propriedades de runtime sobre o tópico.

Parameters:

topicName - Nome do tópico sobre o qual obter informações.

Returns:

Propriedades de runtime sobre o tópico.

getTopicRuntimePropertiesWithResponse

public Response getTopicRuntimePropertiesWithResponse(String topicName, Context context)

Obtém propriedades de runtime sobre o tópico com sua resposta HTTP.

Parameters:

topicName - Nome do tópico sobre o qual obter informações.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Propriedades de runtime sobre o tópico e a resposta HTTP associada.

getTopicWithResponse

public Response getTopicWithResponse(String topicName, Context context)

Obtém informações sobre o tópico junto com sua resposta HTTP.

Parameters:

topicName - Nome do tópico sobre o qual obter informações.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Informações sobre o tópico e a resposta HTTP associada.

listQueues

public PagedIterable listQueues()

Busca todas as filas no namespace do Barramento de Serviço.

Returns:

Um PagedIterable de QueueProperties no namespace do Barramento de Serviço.

listQueues

public PagedIterable listQueues(Context context)

Busca todas as filas no namespace do Barramento de Serviço.

Parameters:

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Um PagedIterable de QueueProperties no namespace do Barramento de Serviço.

listRules

public PagedIterable listRules(String topicName, String subscriptionName)

Busca todas as regras para um tópico e uma assinatura.

Parameters:

topicName - O nome do tópico sob o qual todas as regras precisam ser recuperadas.

subscriptionName - O nome da assinatura para a qual todas as regras precisam ser recuperadas.

Returns:

Um iterável de RuleProperties para e topicNamesubscriptionName.

listRules

public PagedIterable listRules(String topicName, String subscriptionName, Context context)

Busca todas as regras para um tópico e uma assinatura.

Parameters:

topicName - O nome do tópico sob o qual todas as regras precisam ser recuperadas.

subscriptionName - O nome da assinatura para a qual todas as regras precisam ser recuperadas.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Um iterável de RuleProperties para e topicNamesubscriptionName.

listSubscriptions

public PagedIterable listSubscriptions(String topicName)

Busca todas as assinaturas para um tópico.

Parameters:

topicName - O nome do tópico no qual todas as assinaturas precisam ser recuperadas.

Returns:

Um iterável paginado de SubscriptionProperties para o topicName.

listSubscriptions

public PagedIterable listSubscriptions(String topicName, Context context)

Busca todas as assinaturas para um tópico.

Parameters:

topicName - O nome do tópico no qual todas as assinaturas precisam ser recuperadas.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Um iterável paginado de SubscriptionProperties para o topicName.

listTopics

public PagedIterable listTopics()

Busca todos os tópicos no namespace do Barramento de Serviço.

Returns:

Um iterável paginado de TopicProperties no namespace do Barramento de Serviço.

listTopics

public PagedIterable listTopics(Context context)

Busca todos os tópicos no namespace do Barramento de Serviço.

Parameters:

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Um iterável paginado de TopicProperties no namespace do Barramento de Serviço.

updateQueue

public QueueProperties updateQueue(QueueProperties queue)

Atualizações uma fila com o fornecidoQueueProperties. O QueueProperties 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 é:

1. getQueue(String queueName)
2. Atualizar os elementos necessários.
3. 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:

queue - Informações sobre a fila a ser atualizada. Você deve fornecer todos os valores de propriedades desejados na entidade atualizada. Todos os valores que não forem fornecidos serão definidos com os valores padrão do serviço.

Returns:

A fila atualizada.

updateQueueWithResponse

public Response updateQueueWithResponse(QueueProperties queue, Context context)

Atualizações uma fila com o fornecidoQueueProperties. O QueueProperties 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 é:

1. getQueue(String queueName)
2. Atualizar os elementos necessários.
3. 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:

queue - Informações sobre a fila a ser atualizada. Você deve fornecer todos os valores de propriedades desejados na entidade atualizada. Todos os valores que não forem fornecidos serão definidos com os valores padrão do serviço.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

A fila atualizada com sua resposta HTTP.

updateRule

public RuleProperties updateRule(String topicName, String subscriptionName, RuleProperties rule)

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 é:

1. getRule(String topicName, String subscriptionName, String ruleName)
2. Atualizar os elementos necessários.
3. Passe a descrição atualizada para esse método.

Parameters:

topicName - O nome do tópico sob o qual a regra é atualizada.

subscriptionName - O nome da assinatura para a qual a regra é atualizada.

rule - Informações sobre a regra a ser atualizada. Você deve fornecer todos os valores de propriedades desejados na entidade atualizada. Todos os valores que não forem fornecidos serão definidos com os valores padrão do serviço.

Returns:

A regra atualizada.

updateRuleWithResponse

public Response updateRuleWithResponse(String topicName, String subscriptionName, RuleProperties rule, Context context)

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 é:

1. getRule(String topicName, String subscriptionName, String ruleName)
2. Atualizar os elementos necessários.
3. Passe a descrição atualizada para esse método.

Parameters:

topicName - O nome do tópico sob o qual a regra é atualizada.

subscriptionName - O nome da assinatura para a qual a regra é atualizada.

rule - Informações sobre a regra a ser atualizada. Você deve fornecer todos os valores de propriedades desejados na entidade atualizada. Todos os valores que não forem fornecidos serão definidos com os valores padrão do serviço.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Um Mono que retorna a regra atualizada além da resposta HTTP.

updateSubscription

public SubscriptionProperties updateSubscription(SubscriptionProperties subscription)

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 é:

1. getSubscription(String topicName, String subscriptionName)
2. Atualizar os elementos necessários.
3. 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:

subscription - Informações sobre a assinatura a ser atualizada. Você deve fornecer todos os valores de propriedades desejados na entidade atualizada. Todos os valores que não forem fornecidos serão definidos com os valores padrão do serviço.

Returns:

Assinatura atualizada além da resposta HTTP.

updateSubscriptionWithResponse

public Response updateSubscriptionWithResponse(SubscriptionProperties subscription, Context context)

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 é:

1. getSubscription(String topicName, String subscriptionName)
2. Atualizar os elementos necessários.
3. 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:

subscription - Informações sobre a assinatura a ser atualizada. Você deve fornecer todos os valores de propriedades desejados na entidade atualizada. Todos os valores que não forem fornecidos serão definidos com os valores padrão do serviço.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

Assinatura atualizada além da resposta HTTP.

updateTopic

public TopicProperties updateTopic(TopicProperties topic)

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 é:

1. getTopic(String topicName)
2. Atualizar os elementos necessários.
3. 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:

topic - Informações sobre o tópico a ser atualizado. Você deve fornecer todos os valores de propriedades desejados na entidade atualizada. Todos os valores que não forem fornecidos serão definidos com os valores padrão do serviço.

Returns:

O tópico atualizado.

updateTopicWithResponse

public Response updateTopicWithResponse(TopicProperties topic, Context context)

Atualizações um tópico com o determinado TopicProperties. O TopicProperties 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 é:

1. getTopic(String topicName)
2. Atualizar os elementos necessários.
3. 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:

topic - Informações sobre o tópico a ser atualizado. Você deve fornecer todos os valores de propriedades desejados na entidade atualizada. Todos os valores que não forem fornecidos serão definidos com os valores padrão do serviço.

context - Contexto adicional que é passado pelo pipeline HTTP durante a chamada de serviço.

Returns:

O tópico atualizado com sua resposta HTTP.