ServiceBusAdministrationAsyncClient Clase
- java.
lang. Object - com.
azure. messaging. servicebus. administration. ServiceBusAdministrationAsyncClient
- com.
public final class ServiceBusAdministrationAsyncClient
Un cliente asincrónico para administrar un espacio de nombres de Service Bus. Creación de instancias a través de ServiceBusAdministrationClientBuilder.
Ejemplo: Creación del cliente asincrónico
En el ejemplo de código siguiente se muestra la creación del cliente de administración asincrónica. La credencial usada en el ejemplo siguiente es DefaultAzureCredential para la autenticación. Es adecuado para la mayoría de los escenarios, incluidos los entornos de desarrollo y producción locales. Además, se recomienda usar la identidad administrada para la autenticación en entornos de producción. Puede encontrar más información sobre las distintas formas de autenticación y sus tipos de credenciales correspondientes en la documentación de Azure Identity.
// 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();
Ejemplo: Creación de una cola
En el ejemplo siguiente se crea una cola con valores predeterminados. Los valores predeterminados se enumeran en 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);
});
Ejemplo: Edición de una suscripción existente
En el ejemplo de código siguiente se muestra cómo actualizar una suscripción existente. Los usuarios deben capturar las propiedades de la suscripción, modificar las propiedades y, a continuación, pasar el objeto para actualizar el 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);
});
Ejemplo: Enumeración de todas las colas
En el ejemplo de código siguiente se enumeran todas las colas del espacio de nombres de Service Bus.
// `.subscribe()` is a non-blocking call. It'll move onto the next
// instruction after setting up the `consumer` and `errorConsumer` callbacks.
client.listQueues().subscribe(queue -> {
System.out.printf("Queue [%s]. Lock Duration: %s.%n",
queue.getName(), queue.getLockDuration());
}, error -> {
System.err.println("Error fetching queues: " + error);
});
Ejemplo: Eliminar cola
En el ejemplo de código siguiente se muestra cómo eliminar una cola 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.");
});
Resumen del método
Métodos heredados de java.lang.Object
Detalles del método
createQueue
public Mono
Crea una cola con el nombre especificado.
Parameters:
Returns:
createQueue
public Mono
Crea una cola con el nombre de la CreateQueueOptions cola y dado.
Parameters:
Returns:
createQueueWithResponse
public Mono
Crea una cola y devuelve la cola creada además de la respuesta HTTP.
Parameters:
Returns:
createRule
public Mono
Crea una regla en el tema y la suscripción especificados.
Parameters:
Returns:
createRule
public Mono
Crea una regla con CreateRuleOptions.
Parameters:
Returns:
createRuleWithResponse
public Mono
Crea una regla y devuelve la regla creada además de la respuesta HTTP.
Parameters:
Returns:
createSubscription
public Mono
Crea una suscripción con los nombres de suscripción y el tema especificados.
Parameters:
Returns:
createSubscription
public Mono
Crea una suscripción con CreateSubscriptionOptions.
Parameters:
Returns:
createSubscription
public Mono
Crea una suscripción con una regla predeterminada mediante CreateSubscriptionOptions y CreateRuleOptions.
Parameters:
Returns:
createSubscriptionWithResponse
public Mono
Crea una suscripción y devuelve la suscripción creada además de la respuesta HTTP.
Parameters:
Returns:
createSubscriptionWithResponse
public Mono
Crea una suscripción con una regla predeterminada y devuelve la suscripción creada además de la respuesta HTTP.
Parameters:
Returns:
createTopic
public Mono
Crea un tema con el nombre especificado.
Parameters:
Returns:
createTopic
public Mono
Crea un tema con .CreateTopicOptions
Parameters:
Returns:
createTopicWithResponse
public Mono
Crea un tema y devuelve el tema creado además de la respuesta HTTP.
Parameters:
Returns:
deleteQueue
public Mono
Elimina una cola que coincide queueNamecon .
Parameters:
Returns:
deleteQueueWithResponse
public Mono
Elimina una cola que coincide queueName y devuelve la respuesta HTTP.
Parameters:
Returns:
deleteRule
public Mono
Elimina una regla que coincide con ruleName.
Parameters:
Returns:
deleteRuleWithResponse
public Mono
Elimina una regla que coincide ruleName y devuelve la respuesta HTTP.
Parameters:
Returns:
deleteSubscription
public Mono
Elimina una suscripción coincidente subscriptionName.
Parameters:
Returns:
deleteSubscriptionWithResponse
public Mono
Elimina una suscripción que coincide subscriptionName y devuelve la respuesta HTTP.
Parameters:
Returns:
deleteTopic
public Mono
Elimina un tema que coincide topicNamecon .
Parameters:
Returns:
deleteTopicWithResponse
public Mono
Elimina un tema que coincide topicName y devuelve la respuesta HTTP.
Parameters:
Returns:
getNamespaceProperties
public Mono
Obtiene información sobre el espacio de nombres de Service Bus.
Returns:
getNamespacePropertiesWithResponse
public Mono
Obtiene información sobre el espacio de nombres de Service Bus junto con su respuesta HTTP.
Returns:
getQueue
public Mono
Obtiene información sobre la cola.
Parameters:
Returns:
getQueueExists
public Mono
Obtiene si existe o no una cola con queueName en el espacio de nombres de Service Bus.
Parameters:
Returns:
getQueueExistsWithResponse
public Mono
Obtiene si existe o no una cola con queueName en el espacio de nombres de Service Bus.
Parameters:
Returns:
getQueueRuntimeProperties
public Mono
Obtiene las propiedades en tiempo de ejecución sobre la cola.
Parameters:
Returns:
getQueueRuntimePropertiesWithResponse
public Mono
Obtiene las propiedades en tiempo de ejecución sobre la cola junto con su respuesta HTTP.
Parameters:
Returns:
getQueueWithResponse
public Mono
Obtiene información sobre la cola junto con su respuesta HTTP.
Parameters:
Returns:
getRule
public Mono
Obtiene una regla del espacio de nombres del servicio. Solo se deserializan los siguientes tipos de datos en filtros y parámetros action: string, int, long, boolean, double y OffsetDateTime. Otros tipos de datos devolverían su valor de cadena.
Parameters:
Returns:
getRuleWithResponse
public Mono
Obtiene una regla del espacio de nombres del servicio. Solo se deserializan los siguientes tipos de datos en filtros y parámetros action: string, int, long, bool, double y OffsetDateTime. Otros tipos de datos devolverían su valor de cadena.
Parameters:
Returns:
getSubscription
public Mono
Obtiene información sobre la cola.
Parameters:
Returns:
getSubscriptionExists
public Mono
Obtiene si existe o no una suscripción dentro de un tema.
Parameters:
Returns:
getSubscriptionExistsWithResponse
public Mono
Obtiene si existe o no una suscripción dentro de un tema.
Parameters:
Returns:
getSubscriptionRuntimeProperties
public Mono
Obtiene las propiedades en tiempo de ejecución sobre la suscripción.
Parameters:
Returns:
getSubscriptionRuntimePropertiesWithResponse
public Mono
Obtiene las propiedades en tiempo de ejecución sobre la suscripción.
Parameters:
Returns:
getSubscriptionWithResponse
public Mono
Obtiene información sobre la suscripción junto con su respuesta HTTP.
Parameters:
Returns:
getTopic
public Mono
Obtiene información sobre el tema.
Parameters:
Returns:
getTopicExists
public Mono
Obtiene si existe o no un tema con topicName en el espacio de nombres de Service Bus.
Parameters:
Returns:
getTopicExistsWithResponse
public Mono
Obtiene si existe o no un tema con topicName en el espacio de nombres de Service Bus.
Parameters:
Returns:
getTopicRuntimeProperties
public Mono
Obtiene las propiedades en tiempo de ejecución sobre el tema.
Parameters:
Returns:
getTopicRuntimePropertiesWithResponse
public Mono
Obtiene las propiedades en tiempo de ejecución sobre el tema con su respuesta HTTP.
Parameters:
Returns:
getTopicWithResponse
public Mono
Obtiene información sobre el tema junto con su respuesta HTTP.
Parameters:
Returns:
listQueues
public PagedFlux
Captura todas las colas del espacio de nombres de Service Bus.
Returns:
listRules
public PagedFlux
Captura todas las reglas de un tema y una suscripción.
Parameters:
Returns:
listSubscriptions
public PagedFlux
Captura todas las suscripciones de un tema.
Parameters:
Returns:
topicNamelistTopics
public PagedFlux
Captura todos los temas del espacio de nombres de Service Bus.
Returns:
updateQueue
public Mono
Novedades una cola con el especificadoQueueProperties. Debe QueueProperties rellenarse completamente a medida que se reemplazan todas las propiedades. Si no se establece una propiedad, se usa el valor predeterminado del servicio. El flujo sugerido es:
- getQueue(String queueName)
- Actualizar los elementos necesarios.
- Pase la descripción actualizada a este método.
Hay un subconjunto de propiedades que se pueden actualizar. Puede encontrar más información en los vínculos siguientes. Son las siguientes:
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
- setMaxDeliveryCount(Integer maxDeliveryCount)
Parameters:
Returns:
updateQueueWithResponse
public Mono
Novedades una cola con el especificadoQueueProperties. Debe QueueProperties rellenarse completamente a medida que se reemplazan todas las propiedades. Si no se establece una propiedad, se usa el valor predeterminado del servicio. El flujo sugerido es:
- getQueue(String queueName)
- Actualizar los elementos necesarios.
- Pase la descripción actualizada a este método.
Hay un subconjunto de propiedades que se pueden actualizar. Puede encontrar más información en los vínculos siguientes. Son las siguientes:
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
- setMaxDeliveryCount(Integer maxDeliveryCount)
Parameters:
Returns:
updateRule
public Mono
Novedades una regla con el especificadoRuleProperties. debe RuleProperties rellenarse completamente, ya que se reemplazan todas las propiedades. Si no se establece una propiedad, se usa el valor predeterminado del servicio. El flujo sugerido es:
- getRule(String topicName, String subscriptionName, String ruleName)
- Actualizar los elementos necesarios.
- Pase la descripción actualizada a este método.
Parameters:
Returns:
updateRuleWithResponse
public Mono
Novedades una regla con el especificadoRuleProperties. debe RuleProperties rellenarse completamente, ya que se reemplazan todas las propiedades. Si no se establece una propiedad, se usa el valor predeterminado del servicio. El flujo sugerido es:
- getRule(String topicName, String subscriptionName, String ruleName)
- Actualizar los elementos necesarios.
- Pase la descripción actualizada a este método.
Parameters:
Returns:
updateSubscription
public Mono
Novedades una suscripción con el especificadoSubscriptionProperties. Debe SubscriptionProperties rellenarse completamente a medida que se reemplazan todas las propiedades. Si no se establece una propiedad, se usa el valor predeterminado del servicio. El flujo sugerido es:
- getSubscription(String topicName, String subscriptionName)
- Actualizar los elementos necesarios.
- Pase la descripción actualizada a este método.
Hay un subconjunto de propiedades que se pueden actualizar. Puede encontrar más información en los vínculos siguientes. Son las siguientes:
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setMaxDeliveryCount(int maxDeliveryCount)
Parameters:
Returns:
updateSubscriptionWithResponse
public Mono
Novedades una suscripción con el especificadoSubscriptionProperties. Debe SubscriptionProperties rellenarse completamente a medida que se reemplazan todas las propiedades. Si no se establece una propiedad, se usa el valor predeterminado del servicio. El flujo sugerido es:
- getSubscription(String topicName, String subscriptionName)
- Actualizar los elementos necesarios.
- Pase la descripción actualizada a este método.
Hay un subconjunto de propiedades que se pueden actualizar. Puede encontrar más información en los vínculos siguientes. Son las siguientes:
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setLockDuration(Duration lockDuration)
- setMaxDeliveryCount(int maxDeliveryCount)
Parameters:
Returns:
updateTopic
public Mono
Novedades un tema con el especificadoTopicProperties. Debe TopicProperties rellenarse completamente a medida que se reemplazan todas las propiedades. Si no se establece una propiedad, se usa el valor predeterminado del servicio. El flujo sugerido es:
- getTopic(String topicName)
- Actualizar los elementos necesarios.
- Pase la descripción actualizada a este método.
Hay un subconjunto de propiedades que se pueden actualizar. Puede encontrar más información en los vínculos siguientes. Son las siguientes:
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
Parameters:
Returns:
updateTopicWithResponse
public Mono
Novedades un tema con el especificadoTopicProperties. Debe TopicProperties rellenarse completamente a medida que se reemplazan todas las propiedades. Si no se establece una propiedad, se usa el valor predeterminado del servicio. El flujo sugerido es:
- getTopic(String topicName)
- Actualizar los elementos necesarios.
- Pase la descripción actualizada a este método.
Hay un subconjunto de propiedades que se pueden actualizar. Puede encontrar más información en los vínculos siguientes. Son las siguientes:
- setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
- setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)
Parameters:
Returns:
Se aplica a
Azure SDK for Java