QueueDescription 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.QueueDescription

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

Representa la descripción de metadatos de la cola.

Resumen del constructor

Constructor	Description
QueueDescription(String path)	Inicializa una nueva instancia de Descripción de colacon la ruta de acceso relativa especificada.

Resumen del método

Modificador y tipo	Método y descripción
boolean	equals(Object o)
List<AuthorizationRule>	getAuthorizationRules()
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.
Duration	getDuplicationDetectionHistoryTimeWindow()
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.
long	getMaxSizeInMB()
String	getPath()
String	getUserMetadata()
int	hashCode()
boolean	isEnableBatchedOperations()
boolean	isEnableDeadLetteringOnMessageExpiration() Indica si esta cola tiene compatibilidad con mensajes fallidos cuando expira un mensaje.
boolean	isEnablePartitioning()
boolean	isRequiresDuplicateDetection() Si está habilitado, se descartarán los mensajes duplicados que tienen el mismo getMessageId() y se enviarán a la cola dentro de la duración de #getDuplicationDetectionHistoryTimeWindow .
boolean	isRequiresSession()
void	setAuthorizationRules(List<AuthorizationRule> authorizationRules)
void	setAutoDeleteOnIdle(Duration autoDeleteOnIdle)
void	setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
void	setDuplicationDetectionHistoryTimeWindow(Duration duplicationDetectionHistoryTimeWindow)
void	setEnableBatchedOperations(boolean enableBatchedOperations)
void	setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)
void	setEnablePartitioning(boolean enablePartitioning)
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) Recuento máximo de entregas de un mensaje antes de que se produzcan mensajes fallidos.
void	setMaxSizeInMB(long maxSize)
void	setRequiresDuplicateDetection(boolean requiresDuplicateDetection)
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

QueueDescription

public QueueDescription(String path)

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

Parámetros:

path -

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

Detalles del método

equals

public boolean equals(Object o)

Invalidaciones:

QueueDescription.equals(Object o)

Parámetros:

o

getAuthorizationRules

public List getAuthorizationRules()

Devoluciones:

en AuthorizationRule la cola para controlar el acceso de usuario en el nivel de entidad.

getAutoDeleteOnIdle

public Duration getAutoDeleteOnIdle()

Devoluciones:

Intervalo de inactividad después del cual se elimina automáticamente la cola. 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.

getDuplicationDetectionHistoryTimeWindow

public Duration getDuplicationDetectionHistoryTimeWindow()

Devoluciones:

Duración del historial de detección de duplicados que mantiene el servicio. El valor predeterminado es 1 minuto.

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 cola. Si se establece, el usuario no puede recibir manualmente mensajes fallidos de esta cola. 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 cola. Si se establece, el usuario no puede recibir manualmente mensajes de esta cola. 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.

getMaxSizeInMB

public long getMaxSizeInMB()

Devoluciones:

el tamaño máximo de la cola en megabytes, que es el tamaño de la memoria asignada para la cola. El valor predeterminado es 1024.

getPath

public String getPath()

Devoluciones:

Ruta de acceso de la cola.

getUserMetadata

public String getUserMetadata()

Devoluciones:

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

hashCode

public int hashCode()

Invalidaciones:

QueueDescription.hashCode()

isEnableBatchedOperations

public boolean isEnableBatchedOperations()

Devoluciones:

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

isEnableDeadLetteringOnMessageExpiration

public boolean isEnableDeadLetteringOnMessageExpiration()

Indica si esta cola tiene compatibilidad con mensajes fallidos cuando expira un mensaje.

Devoluciones:

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

isEnablePartitioning

public boolean isEnablePartitioning()

Devoluciones:

booleano que indica si la cola se va a particionar entre varios agentes de mensajes. El valor predeterminado es false

isRequiresDuplicateDetection

public boolean isRequiresDuplicateDetection()

Si está habilitado, se descartarán los mensajes duplicados que tienen el mismo getMessageId() y se enviarán a la cola dentro de la duración de #getDuplicationDetectionHistoryTimeWindow .

Devoluciones:

valor que indica si la cola requiere protección contra mensajes duplicados.

isRequiresSession

public boolean isRequiresSession()

Devoluciones:

booleano que indica si la cola admite el concepto de sesión. Los mensajes con sesión siguen la ordenación de FIFO.

setAuthorizationRules

public void setAuthorizationRules(List authorizationRules)

Parámetros:

authorizationRules -

• en AuthorizationRule la cola para controlar el acceso de usuario en el nivel de entidad.

setAutoDeleteOnIdle

public void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

Parámetros:

autoDeleteOnIdle -

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

setDefaultMessageTimeToLive

public void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

Parámetros:

defaultMessageTimeToLive -

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

setDuplicationDetectionHistoryTimeWindow

public void setDuplicationDetectionHistoryTimeWindow(Duration duplicationDetectionHistoryTimeWindow)

Parámetros:

duplicationDetectionHistoryTimeWindow -

• Duración del historial de detección de duplicados que mantiene el servicio. El valor máximo es 1 día y el mínimo es de 20 segundos.

setEnableBatchedOperations

public void setEnableBatchedOperations(boolean enableBatchedOperations)

Parámetros:

enableBatchedOperations -

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

setEnableDeadLetteringOnMessageExpiration

public void setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)

Parámetros:

enableDeadLetteringOnMessageExpiration -

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

setEnablePartitioning

public void setEnablePartitioning(boolean enablePartitioning)

Parámetros:

enablePartitioning -

• True si la cola se va a particionar entre varios agentes de mensajes.

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 cola. Si se establece, el usuario no puede recibir manualmente mensajes fallidos de esta cola. 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 cola. Si se establece, el usuario no puede recibir manualmente mensajes de esta cola. 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 expire el bloqueo del mensaje.

Parámetros:

maxDeliveryCount -

• El valor mínimo es 1.

setMaxSizeInMB

public void setMaxSizeInMB(long maxSize)

Parámetros:

maxSize -

• Tamaño máximo de la cola en megabytes, que es el tamaño de la memoria asignada para la cola.

setRequiresDuplicateDetection

public void setRequiresDuplicateDetection(boolean requiresDuplicateDetection)

Parámetros:

requiresDuplicateDetection -

• True si es necesario habilitar la detección de duplicados. Consulte también: isRequiresDuplicateDetection()

setRequiresSession

public void setRequiresSession(boolean requiresSession)

Parámetros:

requiresSession -

• True si la cola debe admitir sesiones.

setUserMetadata

public void setUserMetadata(String userMetadata)

Parámetros:

userMetadata -

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