SubscriptionDescription Clase

Paquete:

com.microsoft.azure.servicebus.management

Artefacto Maven:

com.microsoft.azure:azure-servicebus:3.6.7

• java.lang.Object
• • com.microsoft.azure.servicebus.management.UnknownPropertiesHolder
  • • com.microsoft.azure.servicebus.management.SubscriptionDescription

public class SubscriptionDescription
extends com.microsoft.azure.servicebus.management.UnknownPropertiesHolder

Representa la descripción de metadatos de la suscripción.

Resumen del constructor

Constructor	Description
SubscriptionDescription(String topicPath, String subscriptionName)	Inicializa una nueva instancia de Descripción de la suscripcióncon la ruta de acceso relativa especificada.

Resumen del método

Modificador y tipo	Método y descripción
boolean	equals(Object o)
Duration	getAutoDeleteOnIdle()
Duration	getDefaultMessageTimeToLive() Período de vida es la duración después de la cual expira el mensaje, empezando desde cuándo se envía el mensaje a Service Bus.
EntityStatus	getEntityStatus() Obtiene el estado de la entidad.
String	getForwardDeadLetteredMessagesTo()
String	getForwardTo()
Duration	getLockDuration() Cantidad de tiempo que un receptor determinado bloquea el mensaje para que ningún otro receptor reciba el mismo mensaje.
int	getMaxDeliveryCount() Número máximo de entregas de un mensaje antes de que se produzcan mensajes fallidos.
String	getPath()
String	getSubscriptionName()
String	getTopicPath()
String	getUserMetadata()
int	hashCode()
boolean	isEnableBatchedOperations()
boolean	isEnableDeadLetteringOnFilterEvaluationException()
boolean	isEnableDeadLetteringOnMessageExpiration() Indica si esta suscripción tiene compatibilidad con mensajes fallidos cuando expira un mensaje.
boolean	isRequiresSession()
void	setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
void	setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
void	setEnableBatchedOperations(boolean enableBatchedOperations)
void	setEnableDeadLetteringOnFilterEvaluationException(boolean enableDeadLetteringOnFilterEvaluationException)
void	setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)
void	setEntityStatus(EntityStatus status)
void	setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)
void	setForwardTo(String forwardTo)
void	setLockDuration(Duration lockDuration) Establece la cantidad de tiempo que un receptor determinado bloquea el mensaje para que ningún otro receptor reciba el mismo mensaje.
void	setMaxDeliveryCount(int maxDeliveryCount) Número máximo de entregas de un mensaje antes de que se produzcan mensajes fallidos.
void	setRequiresSession(boolean requiresSession)
void	setUserMetadata(String userMetadata)

Métodos heredados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalles del constructor

SubscriptionDescription

public SubscriptionDescription(String topicPath, String subscriptionName)

Inicializa una nueva instancia de SubscriptionDescription con la ruta de acceso relativa especificada.

Parámetros:

topicPath -

• La ruta de acceso del tema Longitud máxima es de 260 caracteres. No se puede iniciar ni terminar con una barra diagonal. No se pueden tener caracteres restringidos: '@','?','#','*'

subscriptionName -

• El nombre de la suscripción Longitud máxima es de 50 caracteres. No se pueden tener caracteres restringidos: '@','?','#','*','/'

Detalles del método

equals

public boolean equals(Object o)

Invalidaciones:

SubscriptionDescription.equals(Object o)

Parámetros:

o

getAutoDeleteOnIdle

public Duration getAutoDeleteOnIdle()

Devoluciones:

Intervalo de inactividad después del cual se elimina automáticamente la suscripción. El valor predeterminado es MAX_DURATION.

getDefaultMessageTimeToLive

public Duration getDefaultMessageTimeToLive()

Período de vida es la duración después de la cual expira el mensaje, empezando desde cuándo se envía el mensaje a Service Bus. Este es el valor predeterminado que se usa cuando getTimeToLive() no se establece en un mensaje en sí. Los mensajes anteriores a su valor TimeToLive expirarán y se dejarán de conservar en el almacén de mensajes. Los suscriptores no podrán recibir mensajes expirados.

Devoluciones:

El valor predeterminado de período de vida para los mensajes. El valor predeterminado es MAX_DURATION.

getEntityStatus

public EntityStatus getEntityStatus()

Obtiene el estado de la entidad. Cuando una entidad está deshabilitada, esa entidad no puede enviar ni recibir mensajes.

Devoluciones:

Estado actual de la cola (Habilitado/Deshabilitado). El valor predeterminado es Enabled.

getForwardDeadLetteredMessagesTo

public String getForwardDeadLetteredMessagesTo()

Devoluciones:

Ruta de acceso de la entidad de destinatario a la que se reenvía todos los mensajes fallidos de esta suscripción. Si se establece, el usuario no puede recibir manualmente mensajes fallidos de esta suscripción. La entidad de destino ya debe existir.

getForwardTo

public String getForwardTo()

Devoluciones:

Ruta de acceso de la entidad de destinatario a la que se reenvía todos los mensajes enviados a la suscripción. Si se establece, el usuario no puede recibir manualmente mensajes de esta suscripción. La entidad de destino debe ser una entidad ya existente.

getLockDuration

public Duration getLockDuration()

Cantidad de tiempo que un receptor determinado bloquea el mensaje para que ningún otro receptor reciba el mismo mensaje.

Devoluciones:

Duración de un bloqueo de inspección. El valor predeterminado es de 60 segundos.

getMaxDeliveryCount

public int getMaxDeliveryCount()

Número máximo de entregas de un mensaje antes de que se produzcan mensajes fallidos. El recuento de entregas aumenta cuando se recibe un mensaje en PEEKLOCK modo y no ha completado el mensaje antes de que el bloqueo de mensaje expire.

Devoluciones:

El valor predeterminado es 10.

getPath

public String getPath()

Devoluciones:

la ruta de acceso de la suscripción, incluido el tema.

getSubscriptionName

public String getSubscriptionName()

Devoluciones:

el nombre de la suscripción.

getTopicPath

public String getTopicPath()

Devoluciones:

la ruta de acceso del tema.

getUserMetadata

public String getUserMetadata()

Devoluciones:

Metdata personalizado que el usuario puede asociar a la descripción.

hashCode

public int hashCode()

Invalidaciones:

SubscriptionDescription.hashCode()

isEnableBatchedOperations

public boolean isEnableBatchedOperations()

Devoluciones:

Indica si las operaciones por lotes del lado servidor están habilitadas. El valor predeterminado es true.

isEnableDeadLetteringOnFilterEvaluationException

public boolean isEnableDeadLetteringOnFilterEvaluationException()

Devoluciones:

booleano que indica si los mensajes deben reenviarse a la subconsulta de mensajes fallidos cuando se produce un error en la evaluación de la regla de suscripción. El valor predeterminado es true.

isEnableDeadLetteringOnMessageExpiration

public boolean isEnableDeadLetteringOnMessageExpiration()

Indica si esta suscripción tiene compatibilidad con mensajes fallidos cuando expira un mensaje.

Devoluciones:

Si es true, los mensajes expirados se mueven a la subconsulta de mensajes fallidos. El valor predeterminado es False.

isRequiresSession

public boolean isRequiresSession()

Devoluciones:

Esto indica si la suscripción admite el concepto de sesión. Los mensajes con sesión siguen la ordenación de FIFO.

setAutoDeleteOnIdle

public void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

Parámetros:

autoDeleteOnIdle -

• Intervalo de inactividad después del cual se elimina automáticamente la suscripción. La duración mínima es de 5 minutos.

setDefaultMessageTimeToLive

public void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

Parámetros:

defaultMessageTimeToLive -

• Establece el tiempo de vida del mensaje predeterminado. El valor no puede ser inferior a 1 segundo. Consulta getDefaultMessageTimeToLive().

setEnableBatchedOperations

public void setEnableBatchedOperations(boolean enableBatchedOperations)

Parámetros:

enableBatchedOperations -

• Indica si las operaciones por lotes del lado servidor están habilitadas.

setEnableDeadLetteringOnFilterEvaluationException

public void setEnableDeadLetteringOnFilterEvaluationException(boolean enableDeadLetteringOnFilterEvaluationException)

Parámetros:

enableDeadLetteringOnFilterEvaluationException -

• True si los mensajes deben enviar mensajes fallidos en la excepción de evaluación de filtro. Consulta isEnableDeadLetteringOnFilterEvaluationException().

setEnableDeadLetteringOnMessageExpiration

public void setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)

Parámetros:

enableDeadLetteringOnMessageExpiration -

• True si los mensajes deben enviarse mensajes fallidos al expirar. Consulta isEnableDeadLetteringOnMessageExpiration().

setEntityStatus

public void setEntityStatus(EntityStatus status)

Parámetros:

status -

• el estado de la cola (Habilitado o Deshabilitado). Cuando una entidad está deshabilitada, esa entidad no puede enviar ni recibir mensajes.

setForwardDeadLetteredMessagesTo

public void setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)

Parámetros:

forwardDeadLetteredMessagesTo -

• Ruta de acceso de la entidad de destinatario a la que se reenvía todos los mensajes fallidos de esta suscripción. Si se establece, el usuario no puede recibir manualmente mensajes fallidos de esta suscripción. La entidad de destino ya debe existir.

setForwardTo

public void setForwardTo(String forwardTo)

Parámetros:

forwardTo -

• Ruta de acceso de la entidad de destinatario a la que se reenvía todos los mensajes enviados a la suscripción. Si se establece, el usuario no puede recibir manualmente mensajes de esta suscripción. La entidad de destino debe ser una entidad ya existente.

setLockDuration

public void setLockDuration(Duration lockDuration)

Establece la cantidad de tiempo que un receptor determinado bloquea el mensaje para que ningún otro receptor reciba el mismo mensaje.

Parámetros:

lockDuration -

• Duración de un bloqueo de inspección. El valor máximo es de 5 minutos.

setMaxDeliveryCount

public void setMaxDeliveryCount(int maxDeliveryCount)

Número máximo de entregas de un mensaje antes de que se produzcan mensajes fallidos. El recuento de entregas aumenta cuando se recibe un mensaje en PEEKLOCK modo y no ha completado el mensaje antes de que el bloqueo de mensaje expire.

Parámetros:

maxDeliveryCount -

• El valor mínimo es 1.

setRequiresSession

public void setRequiresSession(boolean requiresSession)

Parámetros:

requiresSession -

• Se establece en true si la suscripción debe admitir sesiones.

setUserMetadata

public void setUserMetadata(String userMetadata)

Parámetros:

userMetadata -

• Metdata personalizado que el usuario puede asociar a la descripción. No puede ser NULL. La longitud máxima es de 1024 caracteres