QueueDescription Classe

  • Referência
Pacote:
com.microsoft.azure.servicebus.management
Artefato 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 a descrição de metadados da fila.

Resumo do Construtor

Construtor Description
QueueDescription(String path)

Inicializa uma nova instância da Descrição da Filacom o caminho relativo especificado.

Resumo do método

Modificador e tipo Método e descrição
boolean equals(Object o)
List<AuthorizationRule> getAuthorizationRules()
Duration getAutoDeleteOnIdle()
Duration getDefaultMessageTimeToLive()

Vida útil é a duração após a qual a mensagem expira, começando de quando a mensagem é enviada ao Barramento de Serviço.
Duration getDuplicationDetectionHistoryTimeWindow()
EntityStatus getEntityStatus()

Obtém o status da entidade.
String getForwardDeadLetteredMessagesTo()
String getForwardTo()
Duration getLockDuration()

A quantidade de tempo que a mensagem é bloqueada por um determinado receptor para que nenhum outro receptor receba a mesma mensagem.
int getMaxDeliveryCount()

A contagem máxima de entrega de uma mensagem antes de ser morta.
long getMaxSizeInMB()
String getPath()
String getUserMetadata()
int hashCode()
boolean isEnableBatchedOperations()
boolean isEnableDeadLetteringOnMessageExpiration()

Indica se essa fila tem suporte a mensagens mortas quando uma mensagem expira.
boolean isEnablePartitioning()
boolean isRequiresDuplicateDetection()

Se habilitada, mensagens duplicadas com o mesmo getMessageId() e enviadas para a fila dentro da duração de #getDuplicationDetectionHistoryTimeWindow serão descartadas.
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)

Define a quantidade de tempo que a mensagem é bloqueada por um determinado receptor para que nenhum outro receptor receba a mesma mensagem.
void setMaxDeliveryCount(int maxDeliveryCount)

A contagem máxima de entrega de uma mensagem antes de ser morta.
void setMaxSizeInMB(long maxSize)
void setRequiresDuplicateDetection(boolean requiresDuplicateDetection)
void setRequiresSession(boolean requiresSession)
void setUserMetadata(String userMetadata)

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do construtor

QueueDescription

public QueueDescription(String path)

Inicializa uma nova instância de QueueDescription com o caminho relativo especificado.

Parâmetros:

path -
  • Caminho do tópico. O comprimento máximo é de 260 caracteres. Não é possível iniciar ou terminar com uma barra. Não é possível ter caracteres restritos: '@','?','#','*'

Detalhes do método

equals

public boolean equals(Object o)

Substituições:

QueueDescription.equals(Object o)

Parâmetros:

o

getAuthorizationRules

public List getAuthorizationRules()

Retornos:

O AuthorizationRule na fila para controlar o acesso do usuário no nível da entidade.

getAutoDeleteOnIdle

public Duration getAutoDeleteOnIdle()

Retornos:

O intervalo ocioso após o qual a fila é excluída automaticamente. O valor padrão é MAX_DURATION

getDefaultMessageTimeToLive

public Duration getDefaultMessageTimeToLive()

Vida útil é a duração após a qual a mensagem expira, começando de quando a mensagem é enviada ao Barramento de Serviço. Esse é o valor padrão usado quando getTimeToLive() não está definido em uma mensagem em si. Mensagens mais antigas que seu valor de vida útil expirarão e não serão mais retidas no repositório de mensagens. Os assinantes não poderão receber mensagens expiradas.

Retornos:

O valor de vida útil padrão para as mensagens. O valor padrão é MAX_DURATION

getDuplicationDetectionHistoryTimeWindow

public Duration getDuplicationDetectionHistoryTimeWindow()

Retornos:

A duração do histórico de detecção duplicado que é mantido pelo serviço. O valor padrão é 1 minuto.

getEntityStatus

public EntityStatus getEntityStatus()

Obtém o status da entidade. Quando uma entidade é desabilitada, essa entidade não pode enviar ou receber mensagens.

Retornos:

O status atual da fila (Habilitado/Desabilitado). O valor padrão é Habilitado.

getForwardDeadLetteredMessagesTo

public String getForwardDeadLetteredMessagesTo()

Retornos:

O caminho da entidade de destinatário para a qual todas as mensagens mortas dessa fila são encaminhadas. Se definido, o usuário não poderá receber manualmente mensagens mortas dessa fila. A entidade de destino já deve existir.

getForwardTo

public String getForwardTo()

Retornos:

O caminho da entidade de destinatário para a qual todas as mensagens enviadas para a fila são encaminhadas. Se definido, o usuário não poderá receber mensagens manualmente dessa fila. A entidade de destino deve ser uma entidade já existente.

getLockDuration

public Duration getLockDuration()

A quantidade de tempo que a mensagem é bloqueada por um determinado receptor para que nenhum outro receptor receba a mesma mensagem.

Retornos:

A duração de um bloqueio de espiada. O valor padrão é de 60 segundos.

getMaxDeliveryCount

public int getMaxDeliveryCount()

A contagem máxima de entrega de uma mensagem antes de ser morta. A contagem de entrega é aumentada quando uma mensagem é recebida no PEEKLOCK modo e não conclui a mensagem antes do bloqueio da mensagem expirar.

Retornos:

O valor padrão é 10.

getMaxSizeInMB

public long getMaxSizeInMB()

Retornos:

o tamanho máximo da fila em megabytes, que é o tamanho da memória alocada para a fila. O valor padrão é 1024.

getPath

public String getPath()

Retornos:

O caminho da fila.

getUserMetadata

public String getUserMetadata()

Retornos:

Metdata personalizado que o usuário pode associar à descrição.

hashCode

public int hashCode()

Substituições:

QueueDescription.hashCode()

isEnableBatchedOperations

public boolean isEnableBatchedOperations()

Retornos:

Indica se as operações em lote do lado do servidor estão habilitadas. O padrão é verdadeiro.

isEnableDeadLetteringOnMessageExpiration

public boolean isEnableDeadLetteringOnMessageExpiration()

Indica se essa fila tem suporte a mensagens mortas quando uma mensagem expira.

Retornos:

Se for true, as mensagens expiradas serão movidas para a sub-fila de mensagens mortas. O valor padrão é false.

isEnablePartitioning

public boolean isEnablePartitioning()

Retornos:

booleano que indica se a fila deve ser particionada entre vários agentes de mensagens. O padrão é false

isRequiresDuplicateDetection

public boolean isRequiresDuplicateDetection()

Se habilitada, mensagens duplicadas com o mesmo getMessageId() e enviadas para a fila dentro da duração de #getDuplicationDetectionHistoryTimeWindow serão descartadas.

Retornos:

valor que indica se a fila requer proteção contra mensagens duplicadas.

isRequiresSession

public boolean isRequiresSession()

Retornos:

booleano que indica se a fila dá suporte ao conceito de sessão. As mensagens com sessão seguem a ordenação FIFO.

setAuthorizationRules

public void setAuthorizationRules(List authorizationRules)

Parâmetros:

authorizationRules -
  • O AuthorizationRule na fila para controlar o acesso do usuário no nível da entidade.

setAutoDeleteOnIdle

public void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

Parâmetros:

autoDeleteOnIdle -
  • O intervalo ocioso após o qual a fila é excluída automaticamente. A duração mínima é de 5 minutos.

setDefaultMessageTimeToLive

public void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

Parâmetros:

defaultMessageTimeToLive -

setDuplicationDetectionHistoryTimeWindow

public void setDuplicationDetectionHistoryTimeWindow(Duration duplicationDetectionHistoryTimeWindow)

Parâmetros:

duplicationDetectionHistoryTimeWindow -
  • A duração do histórico de detecção duplicado que é mantido pelo serviço. O valor máximo é de 1 dia e o mínimo é de 20 segundos.

setEnableBatchedOperations

public void setEnableBatchedOperations(boolean enableBatchedOperations)

Parâmetros:

enableBatchedOperations -
  • Indica se as operações em lote do lado do servidor estão habilitadas.

setEnableDeadLetteringOnMessageExpiration

public void setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)

Parâmetros:

enableDeadLetteringOnMessageExpiration -

setEnablePartitioning

public void setEnablePartitioning(boolean enablePartitioning)

Parâmetros:

enablePartitioning -
  • true se a fila deve ser particionada entre vários agentes de mensagens.

setEntityStatus

public void setEntityStatus(EntityStatus status)

Parâmetros:

status -
  • o status da fila (Habilitado/Desabilitado). Quando uma entidade é desabilitada, essa entidade não pode enviar ou receber mensagens.

setForwardDeadLetteredMessagesTo

public void setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)

Parâmetros:

forwardDeadLetteredMessagesTo -
  • O caminho da entidade de destinatário para a qual todas as mensagens mortas dessa fila são encaminhadas. Se definido, o usuário não poderá receber manualmente mensagens mortas dessa fila. A entidade de destino já deve existir.

setForwardTo

public void setForwardTo(String forwardTo)

Parâmetros:

forwardTo -
  • O caminho da entidade de destinatário para a qual todas as mensagens enviadas para a fila são encaminhadas. Se definido, o usuário não poderá receber mensagens manualmente dessa fila. A entidade de destino deve ser uma entidade já existente.

setLockDuration

public void setLockDuration(Duration lockDuration)

Define a quantidade de tempo que a mensagem é bloqueada por um determinado receptor para que nenhum outro receptor receba a mesma mensagem.

Parâmetros:

lockDuration -
  • A duração de um bloqueio de espiada. O valor máximo é de 5 minutos.

setMaxDeliveryCount

public void setMaxDeliveryCount(int maxDeliveryCount)

A contagem máxima de entrega de uma mensagem antes de ser morta. A contagem de entrega é aumentada quando uma mensagem é recebida no PEEKLOCK modo e não completa a mensagem antes do bloqueio de mensagem expirar.

Parâmetros:

maxDeliveryCount -
  • O valor mínimo é 1.

setMaxSizeInMB

public void setMaxSizeInMB(long maxSize)

Parâmetros:

maxSize -
  • Tamanho máximo da fila em megabytes, que é o tamanho da memória alocada para a fila.

setRequiresDuplicateDetection

public void setRequiresDuplicateDetection(boolean requiresDuplicateDetection)

Parâmetros:

requiresDuplicateDetection -

setRequiresSession

public void setRequiresSession(boolean requiresSession)

Parâmetros:

requiresSession -
  • True se a fila deve dar suporte a sessões.

setUserMetadata

public void setUserMetadata(String userMetadata)

Parâmetros:

userMetadata -
  • Metdata personalizado que o usuário pode associar à descrição. Não pode ser nulo. O comprimento máximo é de 1024 caracteres

Aplica-se a