Partager via

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

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

Représente la description des métadonnées de la file d’attente.

Récapitulatif du constructeur

Constructeur Description
QueueDescription(String path)

Initialise une nouvelle instance de description de file d’attenteavec le chemin relatif spécifié.

Résumé de la méthode

Modificateur et type Méthode et description
boolean equals(Object o)
List<AuthorizationRule> getAuthorizationRules()
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.
Duration getDuplicationDetectionHistoryTimeWindow()
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.
long getMaxSizeInMB()
String getPath()
String getUserMetadata()
int hashCode()
boolean isEnableBatchedOperations()
boolean isEnableDeadLetteringOnMessageExpiration()

Indique si cette file d’attente a une prise en charge des lettres mortes lorsqu’un message expire.
boolean isEnablePartitioning()
boolean isRequiresDuplicateDetection()

Si cette option est activée, les messages dupliqués ayant le même getMessageId() message et envoyés à la file d’attente dans la durée de #getDuplicationDetectionHistoryTimeWindow seront ignorés.
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)

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 setMaxSizeInMB(long maxSize)
void setRequiresDuplicateDetection(boolean requiresDuplicateDetection)
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

QueueDescription

public QueueDescription(String path)

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

Paramètres:

path -
  • Chemin de la rubrique. La longueur maximale est de 260 caractères. Impossible de commencer ou de se terminer par une barre oblique. Impossible d’avoir des caractères restreints : '@','?','#','*'

Détails de la méthode

equals

public boolean equals(Object o)

Remplacements:

QueueDescription.equals(Object o)

Paramètres:

o

getAuthorizationRules

public List getAuthorizationRules()

Retours:

AuthorizationRule sur la file d’attente pour contrôler l’accès utilisateur au niveau de l’entité.

getAutoDeleteOnIdle

public Duration getAutoDeleteOnIdle()

Retours:

Intervalle d’inactivité après lequel la file d’attente est automatiquement supprimée. 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.

Retours:

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

getDuplicationDetectionHistoryTimeWindow

public Duration getDuplicationDetectionHistoryTimeWindow()

Retours:

Durée de l’historique de détection en double géré par le service. La valeur par défaut est égale à 1 minute.

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.

Retours:

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

getForwardDeadLetteredMessagesTo

public String getForwardDeadLetteredMessagesTo()

Retours:

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

getForwardTo

public String getForwardTo()

Retours:

Chemin d’accès de l’entité destinataire vers laquelle tous les messages envoyés à la file d’attente sont transférés. Si cette option est définie, l’utilisateur ne peut pas recevoir manuellement les messages de cette file d’attente. 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.

Retours:

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.

Retours:

La valeur par défaut est 10.

getMaxSizeInMB

public long getMaxSizeInMB()

Retours:

taille maximale de la file d’attente en mégaoctets, qui correspond à la taille de la mémoire allouée pour la file d’attente. La valeur par défaut est 1024.

getPath

public String getPath()

Retours:

Chemin d'accès de la file d'attente.

getUserMetadata

public String getUserMetadata()

Retours:

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

hashCode

public int hashCode()

Remplacements:

QueueDescription.hashCode()

isEnableBatchedOperations

public boolean isEnableBatchedOperations()

Retours:

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

isEnableDeadLetteringOnMessageExpiration

public boolean isEnableDeadLetteringOnMessageExpiration()

Indique si cette file d’attente a une prise en charge des lettres mortes lorsqu’un message expire.

Retours:

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.

isEnablePartitioning

public boolean isEnablePartitioning()

Retours:

booléen indiquant si la file d’attente doit être partitionnée entre plusieurs répartiteurs de messages. La valeur par défaut est false

isRequiresDuplicateDetection

public boolean isRequiresDuplicateDetection()

Si cette option est activée, les messages dupliqués ayant le même getMessageId() message et envoyés à la file d’attente dans la durée de #getDuplicationDetectionHistoryTimeWindow seront ignorés.

Retours:

valeur indiquant si la file d’attente nécessite une protection contre les messages en double.

isRequiresSession

public boolean isRequiresSession()

Retours:

booléen qui indique si la file d’attente prend en charge le concept de session. Les messages de session suivent le classement FIFO.

setAuthorizationRules

public void setAuthorizationRules(List authorizationRules)

Paramètres:

authorizationRules -
  • AuthorizationRule sur la file d’attente pour contrôler l’accès utilisateur au niveau de l’entité.

setAutoDeleteOnIdle

public void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

Paramètres:

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

setDefaultMessageTimeToLive

public void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

Paramètres:

defaultMessageTimeToLive -

setDuplicationDetectionHistoryTimeWindow

public void setDuplicationDetectionHistoryTimeWindow(Duration duplicationDetectionHistoryTimeWindow)

Paramètres:

duplicationDetectionHistoryTimeWindow -
  • Durée de l’historique de détection en double géré par le service. La valeur maximale est de 1 jour et la valeur minimale est de 20 secondes.

setEnableBatchedOperations

public void setEnableBatchedOperations(boolean enableBatchedOperations)

Paramètres:

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

setEnableDeadLetteringOnMessageExpiration

public void setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)

Paramètres:

enableDeadLetteringOnMessageExpiration -

setEnablePartitioning

public void setEnablePartitioning(boolean enablePartitioning)

Paramètres:

enablePartitioning -
  • true si la file d’attente doit être partitionnée entre plusieurs répartiteurs de messages.

setEntityStatus

public void setEntityStatus(EntityStatus status)

Paramètres:

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)

Paramètres:

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

setForwardTo

public void setForwardTo(String forwardTo)

Paramètres:

forwardTo -
  • Chemin d’accès de l’entité destinataire vers laquelle tous les messages envoyés à la file d’attente sont transférés. Si cette option est définie, l’utilisateur ne peut pas recevoir manuellement les messages de cette file d’attente. 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.

Paramètres:

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.

Paramètres:

maxDeliveryCount -
  • La valeur minimale est 1.

setMaxSizeInMB

public void setMaxSizeInMB(long maxSize)

Paramètres:

maxSize -
  • Taille maximale de la file d’attente en mégaoctets, qui correspond à la taille de la mémoire allouée pour la file d’attente.

setRequiresDuplicateDetection

public void setRequiresDuplicateDetection(boolean requiresDuplicateDetection)

Paramètres:

requiresDuplicateDetection -

setRequiresSession

public void setRequiresSession(boolean requiresSession)

Paramètres:

requiresSession -
  • True si la file d’attente doit prendre en charge les sessions.

setUserMetadata

public void setUserMetadata(String userMetadata)

Paramètres:

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 à