Share via

SubscriptionDescription Classe

  • Référence
Paquet:
com.microsoft.azure.servicebus.management
Artefact 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

Représente la description des métadonnées de l’abonnement.

Récapitulatif du constructeur

Constructeur Description
SubscriptionDescription(String topicPath, String subscriptionName)

Initialise une nouvelle instance de description de l’abonnementavec le chemin d’accès relatif spécifié.

Résumé de la méthode

Modificateur et type Méthode et description
boolean equals(Object o)
Duration getAutoDeleteOnIdle()
Duration getDefaultMessageTimeToLive()

Time-To-Live est la durée après laquelle le message expire, à partir du moment où le message est envoyé à Service Bus.
EntityStatus getEntityStatus()

Obtient le status de l’entité.
String getForwardDeadLetteredMessagesTo()
String getForwardTo()
Duration getLockDuration()

Durée pendant laquelle le message est verrouillé par un récepteur donné afin qu’aucun autre destinataire ne reçoive le même message.
int getMaxDeliveryCount()

Nombre maximal de remises d’un message avant qu’il ne soit en lettres mortes.
String getPath()
String getSubscriptionName()
String getTopicPath()
String getUserMetadata()
int hashCode()
boolean isEnableBatchedOperations()
boolean isEnableDeadLetteringOnFilterEvaluationException()
boolean isEnableDeadLetteringOnMessageExpiration()

Indique si cet abonnement a une prise en charge de lettres mortes à l’expiration d’un message.
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)

Définit la durée pendant laquelle le message est verrouillé par un récepteur donné afin qu’aucun autre destinataire ne reçoive le même message.
void setMaxDeliveryCount(int maxDeliveryCount)

Nombre maximal de remises d’un message avant qu’il ne soit en lettres mortes.
void setRequiresSession(boolean requiresSession)
void setUserMetadata(String userMetadata)

Méthodes héritées de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Détails du constructeur

SubscriptionDescription

public SubscriptionDescription(String topicPath, String subscriptionName)

Initialise une nouvelle instance de SubscriptionDescription avec le chemin relatif spécifié.

Parameters:

topicPath -
  • Chemin d’accès de la rubrique Longueur maximale de 260 caractères. Impossible de commencer ou de se terminer par une barre oblique. Impossible d’avoir des caractères restreints : '@','?','#','*'
subscriptionName -
  • Nom de l’abonnement La longueur maximale est de 50 caractères. Impossible d’avoir des caractères restreints : '@','?','#','*','/'

Détails de la méthode

equals

public boolean equals(Object o)

Overrides:

SubscriptionDescription.equals(Object o)

Parameters:

o

getAutoDeleteOnIdle

public Duration getAutoDeleteOnIdle()

Returns:

Intervalle d’inactivité après lequel l’abonnement est automatiquement supprimé. La valeur par défaut est MAX_DURATION

getDefaultMessageTimeToLive

public Duration getDefaultMessageTimeToLive()

Time-To-Live est la durée après laquelle le message expire, à partir du moment où le message est envoyé à Service Bus. Il s’agit de la valeur par défaut utilisée lorsque getTimeToLive() n’est pas défini sur un message lui-même. Les messages plus anciens que la valeur TimeToLive expirent et ne peuvent plus être conservés dans la banque de messages. Les abonnés ne peuvent pas recevoir de messages expirés.

Returns:

Valeur de temps de vie par défaut pour les messages. La valeur par défaut est MAX_DURATION

getEntityStatus

public EntityStatus getEntityStatus()

Obtient le status de l’entité. Lorsqu’une entité est désactivée, cette entité ne peut pas envoyer ou recevoir des messages.

Returns:

Le status actuel de la file d’attente (Activé/Désactivé). La valeur par défaut est : Activé.

getForwardDeadLetteredMessagesTo

public String getForwardDeadLetteredMessagesTo()

Returns:

Chemin d’accès de l’entité destinataire vers laquelle tous les messages de lettres mortes de cet abonnement sont transférés. Si cette option est définie, l’utilisateur ne peut pas recevoir manuellement les messages en lettres mortes de cet abonnement. L’entité de destination doit déjà exister.

getForwardTo

public String getForwardTo()

Returns:

Chemin d’accès de l’entité destinataire vers laquelle tous les messages envoyés à l’abonnement sont transférés. Si cette option est définie, l’utilisateur ne peut pas recevoir manuellement les messages de cet abonnement. L’entité de destination doit être une entité déjà existante.

getLockDuration

public Duration getLockDuration()

Durée pendant laquelle le message est verrouillé par un récepteur donné afin qu’aucun autre destinataire ne reçoive le même message.

Returns:

Durée d’un verrou d’aperçu. La valeur par défaut est 60 secondes.

getMaxDeliveryCount

public int getMaxDeliveryCount()

Nombre maximal de remises d’un message avant qu’il ne soit en lettres mortes. Le nombre de remises est augmenté lorsqu’un message est reçu en PEEKLOCK mode et qu’il n’a pas terminé le message avant l’expiration du verrou de message.

Returns:

La valeur par défaut est 10.

getPath

public String getPath()

Returns:

chemin d’accès de l’abonnement, y compris la rubrique .

getSubscriptionName

public String getSubscriptionName()

Returns:

nom de l’abonnement.

getTopicPath

public String getTopicPath()

Returns:

chemin d’accès de la rubrique.

getUserMetadata

public String getUserMetadata()

Returns:

Metdata personnalisées que l’utilisateur peut associer à la description.

hashCode

public int hashCode()

Overrides:

SubscriptionDescription.hashCode()

isEnableBatchedOperations

public boolean isEnableBatchedOperations()

Returns:

Indique si les opérations par lots côté serveur sont activées. La valeur par défaut est true.

isEnableDeadLetteringOnFilterEvaluationException

public boolean isEnableDeadLetteringOnFilterEvaluationException()

Returns:

booléen indiquant si les messages doivent être transférés vers une sous-file d’attente de lettres mortes en cas d’échec de l’évaluation des règles d’abonnement. La valeur par défaut est true.

isEnableDeadLetteringOnMessageExpiration

public boolean isEnableDeadLetteringOnMessageExpiration()

Indique si cet abonnement a une prise en charge de lettres mortes à l’expiration d’un message.

Returns:

Si la valeur est true, les messages arrivés à expiration sont déplacés vers la sous-file d’attente de lettres mortes. La valeur par défaut est false.

isRequiresSession

public boolean isRequiresSession()

Returns:

Cela indique si l’abonnement prend en charge le concept de session. Les messages de session suivent le classement FIFO.

setAutoDeleteOnIdle

public void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

Parameters:

autoDeleteOnIdle -
  • Intervalle d’inactivité après lequel l’abonnement est automatiquement supprimé. La durée minimale est de 5 minutes.

setDefaultMessageTimeToLive

public void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

Parameters:

defaultMessageTimeToLive -
  • Définit la valeur temps réel du message par défaut. La valeur ne peut pas être inférieure à 1 seconde. Voir getDefaultMessageTimeToLive()

setEnableBatchedOperations

public void setEnableBatchedOperations(boolean enableBatchedOperations)

Parameters:

enableBatchedOperations -
  • Indique si les opérations par lots côté serveur sont activées.

setEnableDeadLetteringOnFilterEvaluationException

public void setEnableDeadLetteringOnFilterEvaluationException(boolean enableDeadLetteringOnFilterEvaluationException)

Parameters:

enableDeadLetteringOnFilterEvaluationException -

setEnableDeadLetteringOnMessageExpiration

public void setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)

Parameters:

enableDeadLetteringOnMessageExpiration -

setEntityStatus

public void setEntityStatus(EntityStatus status)

Parameters:

status -
  • status de la file d’attente (Activé/Désactivé). Lorsqu’une entité est désactivée, cette entité ne peut pas envoyer ou recevoir des messages.

setForwardDeadLetteredMessagesTo

public void setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)

Parameters:

forwardDeadLetteredMessagesTo -
  • Chemin d’accès de l’entité destinataire vers laquelle tous les messages de lettres mortes de cet abonnement sont transférés. Si cette option est définie, l’utilisateur ne peut pas recevoir manuellement les messages en lettres mortes de cet abonnement. L’entité de destination doit déjà exister.

setForwardTo

public void setForwardTo(String forwardTo)

Parameters:

forwardTo -
  • Chemin d’accès de l’entité destinataire vers laquelle tous les messages envoyés à l’abonnement sont transférés. Si cette option est définie, l’utilisateur ne peut pas recevoir manuellement les messages de cet abonnement. L’entité de destination doit être une entité déjà existante.

setLockDuration

public void setLockDuration(Duration lockDuration)

Définit la durée pendant laquelle le message est verrouillé par un récepteur donné afin qu’aucun autre destinataire ne reçoive le même message.

Parameters:

lockDuration -
  • Durée d’un verrou d’aperçu. La valeur maximale est de 5 minutes.

setMaxDeliveryCount

public void setMaxDeliveryCount(int maxDeliveryCount)

Nombre maximal de remises d’un message avant qu’il ne soit en lettres mortes. Le nombre de remises est augmenté lorsqu’un message est reçu en PEEKLOCK mode et qu’il n’a pas terminé le message avant l’expiration du verrou de message.

Parameters:

maxDeliveryCount -
  • La valeur minimale est 1.

setRequiresSession

public void setRequiresSession(boolean requiresSession)

Parameters:

requiresSession -
  • Définissez sur true si l’abonnement doit prendre en charge les sessions.

setUserMetadata

public void setUserMetadata(String userMetadata)

Parameters:

userMetadata -
  • Metdata personnalisées que l’utilisateur peut associer à la description. Ne peut pas être null. La longueur maximale est de 1 024 caractères

S’applique à