ManagementClient Clase
- java.
lang. Object - com.
microsoft. azure. servicebus. management. ManagementClient
- com.
public class ManagementClient
Cliente sincrónico para realizar operaciones de administración en entidades de Service Bus. Se usa ManagementClientAsync para operaciones asincrónicas.
Resumen del constructor
Constructor | Description | |
---|---|---|
ManagementClient(ConnectionStringBuilder connectionStringBuilder) | ||
ManagementClient(URI namespaceEndpointURI, ClientSettings clientSettings) |
Resumen del método
Modificador y tipo | Método y descripción |
---|---|
void |
close()
Elimina y cierra el cliente de administración |
Queue |
createQueue(QueueDescription queueDescription)
Crea una nueva cola en el espacio de nombres del servicio con el nombre especificado. |
Queue |
createQueue(String queuePath)
Crea una nueva cola en el espacio de nombres del servicio con el nombre especificado. |
Rule |
createRule(String topicName, String subscriptionName, RuleDescription ruleDescription)
Crea una nueva regla para un tema determinado: suscripción. |
Subscription |
createSubscription(SubscriptionDescription subscriptionDescription)
Crea una nueva suscripción en el espacio de nombres del servicio con el nombre especificado. |
Subscription |
createSubscription(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)
Crea una nueva suscripción en el espacio de nombres del servicio con la regla predeterminada proporcionada. |
Subscription |
createSubscription(String topicPath, String subscriptionName)
Crea una nueva suscripción para un tema determinado en el espacio de nombres del servicio con el nombre especificado. |
Topic |
createTopic(TopicDescription topicDescription)
Crea un nuevo tema en el espacio de nombres del servicio con el nombre especificado. |
Topic |
createTopic(String topicPath)
Crea un nuevo tema en el espacio de nombres del servicio con el nombre especificado. |
Void |
deleteQueue(String path)
Elimina la cola descrita por la ruta de acceso relativa a la dirección base del espacio de nombres del servicio. |
Void |
deleteRule(String topicPath, String subscriptionName, String ruleName)
Elimina la regla de una suscripción a temas determinada. |
Void |
deleteSubscription(String topicPath, String subscriptionName)
Elimina la suscripción descrita por la ruta de acceso del tema |
Void |
deleteTopic(String path)
Elimina el tema descrito por la ruta de acceso relativa a la dirección base del espacio de nombres del servicio. |
Namespace |
getNamespaceInfo()
Recupera información relacionada con el espacio de nombres. |
Queue |
getQueue(String path)
Recupera una cola del espacio de nombres del servicio. |
Queue |
getQueueRuntimeInfo(String path)
Recupera la información en tiempo de ejecución de una cola. |
List<Queue |
getQueues()
Recupera la lista de colas presentes en el espacio de nombres . |
List<Queue |
getQueues(int count, int skip)
Recupera la lista de colas presentes en el espacio de nombres . |
Rule |
getRule(String topicPath, String subscriptionName, String ruleName)
Recupera una regla para un tema y una suscripción concretos del espacio de nombres del servicio. |
List<Rule |
getRules(String topicName, String subscriptionName)
Recupera la lista de reglas de una suscripción a temas determinada en el espacio de nombres . |
List<Rule |
getRules(String topicName, String subscriptionName, int count, int skip)
Recupera la lista de reglas de una suscripción a temas determinada en el espacio de nombres . |
Subscription |
getSubscription(String topicPath, String subscriptionName)
Recupera una suscripción para un tema determinado del espacio de nombres del servicio. |
Subscription |
getSubscriptionRuntimeInfo(String topicPath, String subscriptionName)
Recupera la información en tiempo de ejecución de una suscripción en un tema determinado. |
List<Subscription |
getSubscriptions(String topicName)
Recupera la lista de suscripciones de un tema determinado en el espacio de nombres . |
List<Subscription |
getSubscriptions(String topicName, int count, int skip)
Recupera la lista de suscripciones de un tema determinado en el espacio de nombres . |
Topic |
getTopic(String path)
Recupera un tema del espacio de nombres del servicio. |
Topic |
getTopicRuntimeInfo(String path)
Recupera la información en tiempo de ejecución de un tema. |
List<Topic |
getTopics()
Recupera la lista de temas presentes en el espacio de nombres. |
List<Topic |
getTopics(int count, int skip)
Recupera la lista de temas presentes en el espacio de nombres. |
Boolean |
queueExists(String path)
Comprueba si existe o no una cola determinada. |
Boolean |
ruleExists(String topicPath, String subscriptionName, String ruleName)
Comprueba si existe o no una regla determinada para una suscripción determinada. |
Boolean |
subscriptionExists(String topicPath, String subscriptionName)
Comprueba si existe o no una suscripción determinada. |
Boolean |
topicExists(String path)
Comprueba si existe o no un tema determinado. |
Queue |
updateQueue(QueueDescription queueDescription)
Novedades una cola existente. |
Rule |
updateRule(String topicName, String subscriptionName, RuleDescription ruleDescription)
Novedades una regla existente. |
Subscription |
updateSubscription(SubscriptionDescription subscriptionDescription)
Novedades una suscripción existente. |
Topic |
updateTopic(TopicDescription topicDescription)
Novedades un tema existente. |
Métodos heredados de java.lang.Object
Detalles del constructor
ManagementClient
public ManagementClient(ConnectionStringBuilder connectionStringBuilder)
Parámetros:
ManagementClient
public ManagementClient(URI namespaceEndpointURI, ClientSettings clientSettings)
Parámetros:
Detalles del método
close
public void close()
Elimina y cierra managementClient.
Produce:
createQueue
public QueueDescription createQueue(QueueDescription queueDescription)
Crea una nueva cola en el espacio de nombres del servicio con el nombre especificado. Consulte QueueDescription para conocer los valores predeterminados de las propiedades de la cola.
Parámetros:
- Objeto QueueDescription que describe los atributos con los que se creará la nueva cola.
Devoluciones:
Produce:
- Existe una entidad con el mismo nombre en el mismo espacio de nombres de servicio.
- Existe una entidad con el mismo nombre en el mismo espacio de nombres de servicio.
createQueue
public QueueDescription createQueue(String queuePath)
Crea una nueva cola en el espacio de nombres del servicio con el nombre especificado. Consulte QueueDescription para conocer los valores predeterminados de las propiedades de la cola.
Parámetros:
- Nombre de la cola relativa a la dirección base del espacio de nombres del servicio.
Devoluciones:
Produce:
- El nombre de la entidad es nulo, está vacío, es demasiado largo o usa caracteres no válidos.
- El nombre de la entidad es nulo, está vacío, es demasiado largo o usa caracteres no válidos.
createRule
public RuleDescription createRule(String topicName, String subscriptionName, RuleDescription ruleDescription)
Crea una nueva regla para un tema determinado: suscripción. Consulte RuleDescription para conocer los valores predeterminados de las propiedades de la suscripción.
Parámetros:
- Nombre del tema.
- Nombre de la suscripción.
- Objeto RuleDescription que describe los atributos con los que se creará la nueva regla.
Devoluciones:
Produce:
- Existe una entidad con el mismo nombre en el mismo espacio de nombres de servicio.
- Existe una entidad con el mismo nombre en el mismo espacio de nombres de servicio.
createSubscription
public SubscriptionDescription createSubscription(SubscriptionDescription subscriptionDescription)
Crea una nueva suscripción en el espacio de nombres del servicio con el nombre especificado. Consulte SubscriptionDescription para conocer los valores predeterminados de las propiedades de la suscripción.
Parámetros:
- Objeto SubscriptionDescription que describe los atributos con los que se creará la nueva suscripción.
Devoluciones:
Produce:
- Existe una entidad con el mismo nombre en el mismo espacio de nombres de servicio.
- Existe una entidad con el mismo nombre en el mismo espacio de nombres de servicio.
createSubscription
public SubscriptionDescription createSubscription(SubscriptionDescription subscriptionDescription, RuleDescription defaultRule)
Crea una nueva suscripción en el espacio de nombres del servicio con la regla predeterminada proporcionada. Consulte SubscriptionDescription para conocer los valores predeterminados de las propiedades de la suscripción.
Parámetros:
- Objeto SubscriptionDescription que describe los atributos con los que se creará la nueva suscripción.
- Objeto RuleDescription que describe la regla predeterminada. Si es null, se creará el filtro de paso a través.
Devoluciones:
Produce:
- Existe una entidad con el mismo nombre en el mismo espacio de nombres de servicio.
- Existe una entidad con el mismo nombre en el mismo espacio de nombres de servicio.
createSubscription
public SubscriptionDescription createSubscription(String topicPath, String subscriptionName)
Crea una nueva suscripción para un tema determinado en el espacio de nombres del servicio con el nombre especificado. Consulte SubscriptionDescription para conocer los valores predeterminados de las propiedades de la suscripción.
Parámetros:
- Nombre del tema relativo a la dirección base del espacio de nombres del servicio.
- Nombre de la suscripción.
Devoluciones:
Produce:
- El nombre de entidad es null, vacío, demasiado largo o usa caracteres no válidos.
- El nombre de entidad es null, vacío, demasiado largo o usa caracteres no válidos.
createTopic
public TopicDescription createTopic(TopicDescription topicDescription)
Crea un nuevo tema en el espacio de nombres del servicio con el nombre especificado. Consulte TopicDescription para conocer los valores predeterminados de las propiedades del tema.
Parámetros:
- Objeto QueueDescription que describe los atributos con los que se creará el nuevo tema.
Devoluciones:
Produce:
- Existe una entidad con el mismo nombre en el mismo espacio de nombres de servicio.
- Existe una entidad con el mismo nombre en el mismo espacio de nombres de servicio.
createTopic
public TopicDescription createTopic(String topicPath)
Crea un nuevo tema en el espacio de nombres del servicio con el nombre especificado. Consulte TopicDescription para conocer los valores predeterminados de las propiedades del tema.
Parámetros:
- Nombre del tema relativo a la dirección base del espacio de nombres del servicio.
Devoluciones:
Produce:
- El nombre de entidad es null, vacío, demasiado largo o usa caracteres no válidos.
- El nombre de entidad es null, vacío, demasiado largo o usa caracteres no válidos.
deleteQueue
public Void deleteQueue(String path)
Elimina la cola descrita por la ruta de acceso relativa a la dirección base del espacio de nombres del servicio.
Parámetros:
- Nombre de la entidad relativa a la dirección base del espacio de nombres del servicio.
Produce:
- path no es null/ empty/ too long/ invalid.
- path no es null/ empty/ too long/ invalid.
deleteRule
public Void deleteRule(String topicPath, String subscriptionName, String ruleName)
Elimina la regla de una suscripción a temas determinada.
Parámetros:
- El nombre del tema.
- Nombre de la suscripción.
- Nombre de la regla.
Produce:
- path no es null/ empty/ too long/ invalid.
- path no es null/ empty/ too long/ invalid.
deleteSubscription
public Void deleteSubscription(String topicPath, String subscriptionName)
Elimina la suscripción descrita por topicPath y subscriptionName.
Parámetros:
- El nombre del tema.
- Nombre de la suscripción.
Produce:
- path no es null/ empty/ too long/ invalid.
- path no es null/ empty/ too long/ invalid.
deleteTopic
public Void deleteTopic(String path)
Elimina el tema descrito por la ruta de acceso relativa a la dirección base del espacio de nombres del servicio.
Parámetros:
- Nombre de la entidad relativa a la dirección base del espacio de nombres del servicio.
Produce:
- path no es null/ empty/ too long/ invalid.
- path no es null/ empty/ too long/ invalid.
getNamespaceInfo
public NamespaceInfo getNamespaceInfo()
Recupera información relacionada con el espacio de nombres. Funciona con cualquier notificación (Send/Listen/Manage).
Devoluciones:
- NamespaceInfo que contiene información del espacio de nombres.
Produce:
- Error interno o excepción inesperada.
- Error interno o excepción inesperada.
getQueue
public QueueDescription getQueue(String path)
Recupera una cola del espacio de nombres del servicio.
Parámetros:
- Ruta de acceso de la cola relativa al espacio de nombres de Service Bus.
Devoluciones:
- QueueDescription que contiene información sobre la cola.
Produce:
- Se produce si la ruta de acceso es nula, vacía o no tiene el formato o la longitud correctos.
- Se produce si la ruta de acceso es nula, vacía o no tiene el formato o la longitud correctos.
getQueueRuntimeInfo
public QueueRuntimeInfo getQueueRuntimeInfo(String path)
Recupera la información en tiempo de ejecución de una cola.
Parámetros:
- Ruta de acceso de la cola relativa al espacio de nombres de Service Bus.
Devoluciones:
- QueueRuntimeInfo que contiene información en tiempo de ejecución sobre la cola.
Produce:
- Se produce si la ruta de acceso es nula, vacía o no tiene el formato o la longitud correctos.
- Se produce si la ruta de acceso es nula, vacía o no tiene el formato o la longitud correctos.
getQueues
public List
Recupera la lista de colas presentes en el espacio de nombres .
Devoluciones:
Produce:
- Se agota el tiempo de espera de la operación. El período de tiempo de espera se inicia a través de ClientSettings.operationTimeout.
- Se agota el tiempo de espera de la operación. El período de tiempo de espera se inicia a través de ClientSettings.operationTimeout.
getQueues
public List
Recupera la lista de colas presentes en el espacio de nombres . Puede simular páginas de lista de entidades manipulando parámetros count y skip. skip(0)+count(100) proporciona las primeras 100 entidades. skip(100)+count(100) proporciona las 100 entidades siguientes.
Parámetros:
- Número de colas que se van a capturar. El valor predeterminado es 100. El valor máximo permitido es 100.
- Número de colas que se van a omitir. El valor predeterminado es 0. No puede ser negativo.
Devoluciones:
Produce:
- Se agota el tiempo de espera de la operación. El período de tiempo de espera se inicia a través de ClientSettings.operationTimeout.
- Se agota el tiempo de espera de la operación. El período de tiempo de espera se inicia a través de ClientSettings.operationTimeout.
getRule
public RuleDescription getRule(String topicPath, String subscriptionName, String ruleName)
Recupera una regla para un tema y una suscripción concretos del espacio de nombres del servicio.
Parámetros:
- Ruta de acceso del tema relativa al espacio de nombres de Service Bus.
- Nombre de la suscripción.
- Nombre de la regla.
Devoluciones:
- RuleDescription que contiene información sobre la suscripción.
Produce:
- Se produce si la ruta de acceso es nula, vacía o no tiene el formato o la longitud correctos.
- Se produce si la ruta de acceso es nula, vacía o no tiene el formato o la longitud correctos.
getRules
public List
Recupera la lista de reglas de una suscripción a temas determinada en el espacio de nombres .
Parámetros:
- El nombre del tema.
- Nombre de la suscripción.
Devoluciones:
Produce:
- Se agota el tiempo de espera de la operación. El período de tiempo de espera se inicia a través de ClientSettings.operationTimeout.
- Se agota el tiempo de espera de la operación. El período de tiempo de espera se inicia a través de ClientSettings.operationTimeout.
getRules
public List
Recupera la lista de reglas de una suscripción a temas determinada en el espacio de nombres . Puede simular páginas de lista de entidades manipulando parámetros count y skip. skip(0)+count(100) proporciona las primeras 100 entidades. skip(100)+count(100) proporciona las 100 entidades siguientes.
Parámetros:
- El nombre del tema.
- Nombre de la suscripción.
- Número de reglas que se van a capturar. El valor predeterminado es 100. El valor máximo permitido es 100.
- El número de reglas que se omiten. El valor predeterminado es 0. No puede ser negativo.
Devoluciones:
Produce:
- Se agota el tiempo de espera de la operación. El período de tiempo de espera se inicia a través de ClientSettings.operationTimeout.
- Se agota el tiempo de espera de la operación. El período de tiempo de espera se inicia a través de ClientSettings.operationTimeout.
getSubscription
public SubscriptionDescription getSubscription(String topicPath, String subscriptionName)
Recupera una suscripción para un tema determinado del espacio de nombres del servicio.
Parámetros:
- Ruta de acceso del tema relativa al espacio de nombres de Service Bus.
- Nombre de la suscripción
Devoluciones:
- SubscriptionDescription que contiene información sobre la suscripción.
Produce:
- Se produce si la ruta de acceso es nula, vacía o no tiene el formato o la longitud correctos.
- Se produce si la ruta de acceso es nula, vacía o no tiene el formato o la longitud correctos.
getSubscriptionRuntimeInfo
public SubscriptionRuntimeInfo getSubscriptionRuntimeInfo(String topicPath, String subscriptionName)
Recupera la información en tiempo de ejecución de una suscripción en un tema determinado.
Parámetros:
- Ruta de acceso del tema relativa al espacio de nombres de Service Bus.
- Nombre de la suscripción
Devoluciones:
- SubscriptionRuntimeInfo que contiene la información en tiempo de ejecución sobre la suscripción.
Produce:
- Se produce si la ruta de acceso es nula, vacía o no tiene el formato o la longitud correctos.
- Se produce si la ruta de acceso es nula, vacía o no tiene el formato o la longitud correctos.
getSubscriptions
public List
Recupera la lista de suscripciones de un tema determinado en el espacio de nombres .
Parámetros:
- El nombre del tema.
Devoluciones:
Produce:
- Se agota el tiempo de espera de la operación. El período de tiempo de espera se inicia a través de ClientSettings.operationTimeout.
- Se agota el tiempo de espera de la operación. El período de tiempo de espera se inicia a través de ClientSettings.operationTimeout.
getSubscriptions
public List
Recupera la lista de suscripciones de un tema determinado en el espacio de nombres . Puede simular páginas de lista de entidades manipulando parámetros count y skip. skip(0)+count(100) proporciona las primeras 100 entidades. skip(100)+count(100) proporciona las 100 entidades siguientes.
Parámetros:
- El nombre del tema.
- Número de suscripciones que se van a capturar. El valor predeterminado es 100. El valor máximo permitido es 100.
- Número de suscripciones que se van a omitir. El valor predeterminado es 0. No puede ser negativo.
Devoluciones:
Produce:
- Se agota el tiempo de espera de la operación. El período de tiempo de espera se inicia a través de ClientSettings.operationTimeout.
- Se agota el tiempo de espera de la operación. El período de tiempo de espera se inicia a través de ClientSettings.operationTimeout.
getTopic
public TopicDescription getTopic(String path)
Recupera un tema del espacio de nombres del servicio.
Parámetros:
- Ruta de acceso de la cola relativa al espacio de nombres de Service Bus.
Devoluciones:
- Descripción que contiene información sobre el tema.
Produce:
- Se produce si la ruta de acceso es nula, vacía o no tiene el formato o la longitud correctos.
- Se produce si la ruta de acceso es nula, vacía o no tiene el formato o la longitud correctos.
getTopicRuntimeInfo
public TopicRuntimeInfo getTopicRuntimeInfo(String path)
Recupera la información en tiempo de ejecución de un tema.
Parámetros:
- Ruta de acceso de la cola relativa al espacio de nombres de Service Bus.
Devoluciones:
- TopicRuntimeInfo que contiene información en tiempo de ejecución sobre el tema.
Produce:
- Se produce si la ruta de acceso es nula, vacía o no tiene el formato o la longitud correctos.
- Se produce si la ruta de acceso es nula, vacía o no tiene el formato o la longitud correctos.
getTopics
public List
Recupera la lista de temas presentes en el espacio de nombres.
Devoluciones:
Produce:
- Se agota el tiempo de espera de la operación. El período de tiempo de espera se inicia a través de ClientSettings.operationTimeout.
- Se agota el tiempo de espera de la operación. El período de tiempo de espera se inicia a través de ClientSettings.operationTimeout.
getTopics
public List
Recupera la lista de temas presentes en el espacio de nombres. Puede simular páginas de lista de entidades manipulando parámetros count y skip. skip(0)+count(100) proporciona las primeras 100 entidades. skip(100)+count(100) proporciona las 100 entidades siguientes.
Parámetros:
- Número de temas que se van a capturar. El valor predeterminado es 100. El valor máximo permitido es 100.
- Número de temas que se van a omitir. El valor predeterminado es 0. No puede ser negativo.
Devoluciones:
Produce:
- Se agota el tiempo de espera de la operación. El período de tiempo de espera se inicia a través de ClientSettings.operationTimeout.
- Se agota el tiempo de espera de la operación. El período de tiempo de espera se inicia a través de ClientSettings.operationTimeout.
queueExists
public Boolean queueExists(String path)
Comprueba si existe o no una cola determinada.
Parámetros:
- Ruta de acceso de la entidad que se va a comprobar
Devoluciones:
- True si la entidad existe. En caso contrario, devuelve un valor falso.
Produce:
- path no es null/empty/too long/invalid.
- path no es null/empty/too long/invalid.
ruleExists
public Boolean ruleExists(String topicPath, String subscriptionName, String ruleName)
Comprueba si existe o no una regla determinada para una suscripción determinada.
Parámetros:
- Ruta de acceso del tema
- Nombre de la suscripción.
- Nombre de la regla.
Devoluciones:
- True si la entidad existe. En caso contrario, devuelve un valor falso.
Produce:
- path no es null/empty/too long/invalid.
- path no es null/empty/too long/invalid.
subscriptionExists
public Boolean subscriptionExists(String topicPath, String subscriptionName)
Comprueba si existe o no una suscripción determinada.
Parámetros:
- Ruta de acceso del tema
- Nombre de la suscripción.
Devoluciones:
- True si la entidad existe. En caso contrario, devuelve un valor falso.
Produce:
- path no es null/empty/too long/invalid.
- path no es null/empty/too long/invalid.
topicExists
public Boolean topicExists(String path)
Comprueba si existe o no un tema determinado.
Parámetros:
- Ruta de acceso de la entidad que se va a comprobar
Devoluciones:
- True si la entidad existe. En caso contrario, devuelve un valor falso.
Produce:
- path no es null/empty/too long/invalid.
- path no es null/empty/too long/invalid.
updateQueue
public QueueDescription updateQueue(QueueDescription queueDescription)
Novedades una cola existente.
Parámetros:
- Objeto QueueDescription que describe los atributos con los que se actualizará la cola.
Devoluciones:
Produce:
- No se encontró la entidad descrita.
- No se encontró la entidad descrita.
updateRule
public RuleDescription updateRule(String topicName, String subscriptionName, RuleDescription ruleDescription)
Novedades una regla existente.
Parámetros:
- Nombre del tema.
- Nombre de la suscripción.
- Objeto RuleDescription que describe los atributos con los que se actualizará la regla.
Devoluciones:
Produce:
- No se encontró la entidad descrita.
- No se encontró la entidad descrita.
updateSubscription
public SubscriptionDescription updateSubscription(SubscriptionDescription subscriptionDescription)
Novedades una suscripción existente.
Parámetros:
- Objeto SubscriptionDescription que describe los atributos con los que se actualizará la suscripción.
Devoluciones:
Produce:
- No se encontró la entidad descrita.
- No se encontró la entidad descrita.
updateTopic
public TopicDescription updateTopic(TopicDescription topicDescription)
Novedades un tema existente.
Parámetros:
- Objeto TopicDescription que describe los atributos con los que se actualizará el tema.
Devoluciones:
Produce:
- No se encontró la entidad descrita.
- No se encontró la entidad descrita.
Se aplica a
Azure SDK for Java