Freigeben über


QueueDescription Klasse

  • 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

Stellt die Metadatenbeschreibung der Warteschlange dar.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
QueueDescription(String path)

Initialisiert eine neue instance der Warteschlangenbeschreibungmit dem angegebenen relativen Pfad.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
boolean equals(Object o)
List<AuthorizationRule> getAuthorizationRules()
Duration getAutoDeleteOnIdle()
Duration getDefaultMessageTimeToLive()

Time-To-Live ist die Dauer, nach der die Nachricht abläuft, beginnend mit dem Zeitpunkt, an dem die Nachricht an Service Bus gesendet wird.

Duration getDuplicationDetectionHistoryTimeWindow()
EntityStatus getEntityStatus()

Ruft den status der Entität ab.

String getForwardDeadLetteredMessagesTo()
String getForwardTo()
Duration getLockDuration()

Die Zeitspanne, in der die Nachricht von einem bestimmten Empfänger gesperrt wird, sodass kein anderer Empfänger dieselbe Nachricht empfängt.

int getMaxDeliveryCount()

Die maximale Zustellungsanzahl einer Nachricht, bevor sie unzustellbar ist.

long getMaxSizeInMB()
String getPath()
String getUserMetadata()
int hashCode()
boolean isEnableBatchedOperations()
boolean isEnableDeadLetteringOnMessageExpiration()

Gibt an, ob diese Warteschlange unterstützung für unzustellbare Nachrichten hat, wenn eine Nachricht abläuft.

boolean isEnablePartitioning()
boolean isRequiresDuplicateDetection()

Wenn diese Option aktiviert ist, werden doppelte Nachrichten verworfen, die dieselbe getMessageId() enthalten und innerhalb der Dauer von an die #getDuplicationDetectionHistoryTimeWindow Warteschlange gesendet wurden.

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)

Legt fest, wie lange die Nachricht von einem bestimmten Empfänger gesperrt wird, sodass kein anderer Empfänger dieselbe Nachricht empfängt.

void setMaxDeliveryCount(int maxDeliveryCount)

Die maximale Anzahl der Zustellungen einer Nachricht, bevor sie unzustellbar ist.

void setMaxSizeInMB(long maxSize)
void setRequiresDuplicateDetection(boolean requiresDuplicateDetection)
void setRequiresSession(boolean requiresSession)
void setUserMetadata(String userMetadata)

Geerbte Methoden von java.lang.Object

Details zum Konstruktor

QueueDescription

public QueueDescription(String path)

Initialisiert eine neue instance von QueueDescription mit dem angegebenen relativen Pfad.

Parameter:

path -
  • Pfad des Themas. Die maximale Länge beträgt 260 Zeichen. Kann nicht mit einem Schrägstrich beginnen oder enden. Darf keine eingeschränkten Zeichen haben: '@','?','#','*'

Details zur Methode

equals

public boolean equals(Object o)

Überschreibt:

QueueDescription.equals(Object o)

Parameter:

o

getAuthorizationRules

public List getAuthorizationRules()

Gibt zurück:

Der AuthorizationRule in der Warteschlange, um den Benutzerzugriff auf Entitätsebene zu steuern.

getAutoDeleteOnIdle

public Duration getAutoDeleteOnIdle()

Gibt zurück:

Das Leerlaufintervall, nach dem die Warteschlange automatisch gelöscht wird. Standardwert: MAX_DURATION

getDefaultMessageTimeToLive

public Duration getDefaultMessageTimeToLive()

Time-To-Live ist die Dauer, nach der die Nachricht abläuft, beginnend mit dem Zeitpunkt, an dem die Nachricht an Service Bus gesendet wird. Dies ist der Standardwert, der verwendet wird, wenn getTimeToLive() nicht für eine Nachricht selbst festgelegt wird. Nachrichten, die älter als ihr TimeToLive-Wert sind, laufen ab und werden nicht mehr im Nachrichtenspeicher verwaltet. Abonnenten sind nicht mehr in der Lage, abgelaufene Nachrichten zu empfangen.

Gibt zurück:

Der Standardwert für die Live-Zeit für die Nachrichten. Standardwert: MAX_DURATION

getDuplicationDetectionHistoryTimeWindow

public Duration getDuplicationDetectionHistoryTimeWindow()

Gibt zurück:

Die Dauer des Vom Dienst verwalteten Verlaufs der doppelten Erkennung. Der Standardwert beträgt 1 Minute.

getEntityStatus

public EntityStatus getEntityStatus()

Ruft den status der Entität ab. Wenn eine Entität deaktiviert ist, kann diese Entität keine Nachrichten senden oder empfangen.

Gibt zurück:

Der aktuelle status der Warteschlange (Aktiviert /Deaktiviert). Der Standardwert ist „Enabled“.

getForwardDeadLetteredMessagesTo

public String getForwardDeadLetteredMessagesTo()

Gibt zurück:

Der Pfad der Empfängerentität, an die alle unzustellbaren Nachrichten dieser Warteschlange weitergeleitet werden. Wenn festgelegt, kann der Benutzer keine Nachrichten mit unzustellbaren Nachrichten aus dieser Warteschlange manuell empfangen. Die Zielentität muss bereits vorhanden sein.

getForwardTo

public String getForwardTo()

Gibt zurück:

Der Pfad der Empfängerentität, an die alle an die Warteschlange gesendeten Nachrichten weitergeleitet werden. Wenn festgelegt, kann der Benutzer keine Nachrichten aus dieser Warteschlange manuell empfangen. Die Zielentität muss eine bereits vorhandene Entität sein.

getLockDuration

public Duration getLockDuration()

Die Zeitspanne, in der die Nachricht von einem bestimmten Empfänger gesperrt wird, sodass kein anderer Empfänger dieselbe Nachricht empfängt.

Gibt zurück:

Die Dauer einer Peek-Sperre. Der Standardwert ist 60 Sekunden.

getMaxDeliveryCount

public int getMaxDeliveryCount()

Die maximale Zustellungsanzahl einer Nachricht, bevor sie unzustellbar ist. Die Übermittlungsanzahl wird erhöht, wenn eine Nachricht im PEEKLOCK Modus empfangen wird und die Nachricht nicht abgeschlossen wurde, bevor die Nachrichtensperre abgelaufen ist.

Gibt zurück:

Der Standardwert ist 10.

getMaxSizeInMB

public long getMaxSizeInMB()

Gibt zurück:

die maximale Größe der Warteschlange in Megabyte, d. h. die Größe des für die Warteschlange zugewiesenen Arbeitsspeichers. Der Standardwert ist 1024.

getPath

public String getPath()

Gibt zurück:

Der Pfad der Warteschlange.

getUserMetadata

public String getUserMetadata()

Gibt zurück:

Benutzerdefinierte Metdata, die der Benutzer der Beschreibung zuordnen kann.

hashCode

public int hashCode()

Überschreibt:

QueueDescription.hashCode()

isEnableBatchedOperations

public boolean isEnableBatchedOperations()

Gibt zurück:

Gibt an, ob serverseitige Batchvorgänge aktiviert sind. Der Standardwert ist TRUE.

isEnableDeadLetteringOnMessageExpiration

public boolean isEnableDeadLetteringOnMessageExpiration()

Gibt an, ob diese Warteschlange unterstützung für unzustellbare Nachrichten hat, wenn eine Nachricht abläuft.

Gibt zurück:

Wenn true, werden die abgelaufenen Nachrichten in die Unterwarteschlange für unzustellbare Nachrichten verschoben. Der Standardwert ist „false“.

isEnablePartitioning

public boolean isEnablePartitioning()

Gibt zurück:

Boolescher Wert, der angibt, ob die Warteschlange auf mehrere Nachrichtenbroker partitioniert werden soll. Standardwert auf "false"

isRequiresDuplicateDetection

public boolean isRequiresDuplicateDetection()

Wenn diese Option aktiviert ist, werden doppelte Nachrichten verworfen, die dieselbe getMessageId() enthalten und innerhalb der Dauer von an die #getDuplicationDetectionHistoryTimeWindow Warteschlange gesendet wurden.

Gibt zurück:

Wert, der angibt, ob die Warteschlange vor doppelten Nachrichten geschützt werden muss.

isRequiresSession

public boolean isRequiresSession()

Gibt zurück:

Boolescher Wert, der angibt, ob die Warteschlange das Sitzungskonzept unterstützt. Sessionful-Messages folgen der FIFO-Reihenfolge.

setAuthorizationRules

public void setAuthorizationRules(List authorizationRules)

Parameter:

authorizationRules -
  • Der AuthorizationRule in der Warteschlange, um den Benutzerzugriff auf Entitätsebene zu steuern.

setAutoDeleteOnIdle

public void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

Parameter:

autoDeleteOnIdle -
  • Das Leerlaufintervall, nach dem die Warteschlange automatisch gelöscht wird. Die Mindestdauer ist fünf Minuten.

setDefaultMessageTimeToLive

public void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

Parameter:

defaultMessageTimeToLive -

setDuplicationDetectionHistoryTimeWindow

public void setDuplicationDetectionHistoryTimeWindow(Duration duplicationDetectionHistoryTimeWindow)

Parameter:

duplicationDetectionHistoryTimeWindow -
  • Die Dauer des Vom Dienst verwalteten Verlaufs der doppelten Erkennung. Der maximale Wert ist 1 Tag und der Mindestwert beträgt 20 Sekunden.

setEnableBatchedOperations

public void setEnableBatchedOperations(boolean enableBatchedOperations)

Parameter:

enableBatchedOperations -
  • Gibt an, ob serverseitige Batchvorgänge aktiviert sind.

setEnableDeadLetteringOnMessageExpiration

public void setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)

Parameter:

enableDeadLetteringOnMessageExpiration -

setEnablePartitioning

public void setEnablePartitioning(boolean enablePartitioning)

Parameter:

enablePartitioning -
  • true, wenn die Warteschlange über mehrere Nachrichtenbroker partitioniert werden soll.

setEntityStatus

public void setEntityStatus(EntityStatus status)

Parameter:

status -
  • die status der Warteschlange (Aktiviert /Deaktiviert). Wenn eine Entität deaktiviert ist, kann diese Entität keine Nachrichten senden oder empfangen.

setForwardDeadLetteredMessagesTo

public void setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)

Parameter:

forwardDeadLetteredMessagesTo -
  • Der Pfad der Empfängerentität, an die alle unzustellbaren Nachrichten dieser Warteschlange weitergeleitet werden. Wenn festgelegt, kann der Benutzer keine Nachrichten mit unzustellbaren Nachrichten aus dieser Warteschlange manuell empfangen. Die Zielentität muss bereits vorhanden sein.

setForwardTo

public void setForwardTo(String forwardTo)

Parameter:

forwardTo -
  • Der Pfad der Empfängerentität, an die alle an die Warteschlange gesendeten Nachrichten weitergeleitet werden. Wenn festgelegt, kann der Benutzer keine Nachrichten aus dieser Warteschlange manuell empfangen. Die Zielentität muss eine bereits vorhandene Entität sein.

setLockDuration

public void setLockDuration(Duration lockDuration)

Legt fest, wie lange die Nachricht von einem bestimmten Empfänger gesperrt wird, sodass kein anderer Empfänger dieselbe Nachricht empfängt.

Parameter:

lockDuration -
  • Die Dauer einer Peek-Sperre. Der maximale Wert beträgt 5 Minuten.

setMaxDeliveryCount

public void setMaxDeliveryCount(int maxDeliveryCount)

Die maximale Zustellungsanzahl einer Nachricht, bevor sie unzustellbar ist. Die Anzahl der Zustellungen wird erhöht, wenn eine Nachricht im PEEKLOCK Modus empfangen wird und die Nachricht nicht abgeschlossen wurde, bevor die Nachrichtensperre abgelaufen ist.

Parameter:

maxDeliveryCount -
  • Der Mindestwert ist 1.

setMaxSizeInMB

public void setMaxSizeInMB(long maxSize)

Parameter:

maxSize -
  • Maximale Größe der Warteschlange in Megabyte, d. h. die Größe des für die Warteschlange zugeordneten Arbeitsspeichers.

setRequiresDuplicateDetection

public void setRequiresDuplicateDetection(boolean requiresDuplicateDetection)

Parameter:

requiresDuplicateDetection -

setRequiresSession

public void setRequiresSession(boolean requiresSession)

Parameter:

requiresSession -
  • True, wenn die Warteschlange Sitzungen unterstützen soll.

setUserMetadata

public void setUserMetadata(String userMetadata)

Parameter:

userMetadata -
  • Benutzerdefinierte Metdata, die Der Benutzer der Beschreibung zuordnen kann. Darf nicht NULL sein. Die maximale Länge beträgt 1024 Zeichen.

Gilt für: