Compartilhar via

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

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

Representa a descrição dos metadados da assinatura.

Resumo do Construtor

Construtor Description
SubscriptionDescription(String topicPath, String subscriptionName)

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

Resumo do método

Modificador e tipo Método e descrição
boolean equals(Object o)
Duration getAutoDeleteOnIdle()
Duration getDefaultMessageTimeToLive()

Time-To-Live é a duração após a qual a mensagem expira, começando de quando a mensagem é enviada para o Barramento de Serviço.
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.
String getPath()
String getSubscriptionName()
String getTopicPath()
String getUserMetadata()
int hashCode()
boolean isEnableBatchedOperations()
boolean isEnableDeadLetteringOnFilterEvaluationException()
boolean isEnableDeadLetteringOnMessageExpiration()

Indica se essa assinatura tem suporte a mensagens mortas quando uma mensagem expira.
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)

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

SubscriptionDescription

public SubscriptionDescription(String topicPath, String subscriptionName)

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

Parâmetros:

topicPath -
  • O caminho do tópico Comprimento máximo é de 260 caracteres. Não é possível iniciar ou terminar com uma barra. Não é possível ter caracteres restritos: '@','?','#','*'
subscriptionName -
  • Nome da assinatura Tamanho máximo é 50 caracteres. Não é possível ter caracteres restritos: '@','?','#','*','/'

Detalhes do método

equals

public boolean equals(Object o)

Substituições:

SubscriptionDescription.equals(Object o)

Parâmetros:

o

getAutoDeleteOnIdle

public Duration getAutoDeleteOnIdle()

Retornos:

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

getDefaultMessageTimeToLive

public Duration getDefaultMessageTimeToLive()

Time-To-Live é a duração após a qual a mensagem expira, começando de quando a mensagem é enviada para o Barramento de Serviço. Esse é o valor padrão usado quando getTimeToLive() não é 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 tempo de vida padrão para as mensagens. O valor padrão é MAX_DURATION

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 com mensagens mortas dessa assinatura são encaminhadas. Se definido, o usuário não poderá receber manualmente mensagens com mensagens mortas dessa assinatura. 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 assinatura são encaminhadas. Se definido, o usuário não poderá receber mensagens manualmente dessa assinatura. 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 completa a mensagem antes do bloqueio de mensagem expirar.

Retornos:

O valor padrão é 10.

getPath

public String getPath()

Retornos:

o caminho da assinatura, incluindo o tópico.

getSubscriptionName

public String getSubscriptionName()

Retornos:

o nome da assinatura.

getTopicPath

public String getTopicPath()

Retornos:

o caminho do tópico.

getUserMetadata

public String getUserMetadata()

Retornos:

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

hashCode

public int hashCode()

Substituições:

SubscriptionDescription.hashCode()

isEnableBatchedOperations

public boolean isEnableBatchedOperations()

Retornos:

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

isEnableDeadLetteringOnFilterEvaluationException

public boolean isEnableDeadLetteringOnFilterEvaluationException()

Retornos:

booliano que indica se as mensagens precisam ser encaminhadas para a subconsulta de mensagens mortas quando a avaliação da regra de assinatura falha. O valor padrão é true.

isEnableDeadLetteringOnMessageExpiration

public boolean isEnableDeadLetteringOnMessageExpiration()

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

Retornos:

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

isRequiresSession

public boolean isRequiresSession()

Retornos:

Isso indica se a assinatura dá suporte ao conceito de sessão. As mensagens com sessão seguem a ordenação fifo.

setAutoDeleteOnIdle

public void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

Parâmetros:

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

setDefaultMessageTimeToLive

public void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

Parâmetros:

defaultMessageTimeToLive -

setEnableBatchedOperations

public void setEnableBatchedOperations(boolean enableBatchedOperations)

Parâmetros:

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

setEnableDeadLetteringOnFilterEvaluationException

public void setEnableDeadLetteringOnFilterEvaluationException(boolean enableDeadLetteringOnFilterEvaluationException)

Parâmetros:

enableDeadLetteringOnFilterEvaluationException -

setEnableDeadLetteringOnMessageExpiration

public void setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)

Parâmetros:

enableDeadLetteringOnMessageExpiration -

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 com mensagens mortas dessa assinatura são encaminhadas. Se definido, o usuário não poderá receber manualmente mensagens com mensagens mortas dessa assinatura. 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 assinatura são encaminhadas. Se definido, o usuário não poderá receber mensagens manualmente dessa assinatura. 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.

setRequiresSession

public void setRequiresSession(boolean requiresSession)

Parâmetros:

requiresSession -
  • Defina como true se a assinatura tiver suporte para 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