Freigeben über

SubscriptionDescription Klasse

  • Referenz
Paket:
com.microsoft.azure.servicebus.management
Maven-Artefakt:
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

Stellt die Metadatenbeschreibung des Abonnements dar.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
SubscriptionDescription(String topicPath, String subscriptionName)

Initialisiert eine neue instance der Abonnementbeschreibungmit dem angegebenen relativen Pfad.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
boolean equals(Object o)
Duration getAutoDeleteOnIdle()
Duration getDefaultMessageTimeToLive()

Die Gültigkeitsdauer ist die Dauer, nach der die Nachricht abläuft, beginnend mit dem Zeitpunkt, an den die Nachricht an Service Bus gesendet wird.
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 Anzahl der Zustellungen einer Nachricht, bevor sie unzustellbar ist.
String getPath()
String getSubscriptionName()
String getTopicPath()
String getUserMetadata()
int hashCode()
boolean isEnableBatchedOperations()
boolean isEnableDeadLetteringOnFilterEvaluationException()
boolean isEnableDeadLetteringOnMessageExpiration()

Gibt an, ob dieses Abonnement über Unterstützung für unzustellbare Nachrichten verfügt, wenn eine Nachricht abläuft.
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)

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 setRequiresSession(boolean requiresSession)
void setUserMetadata(String userMetadata)

Geerbte Methoden von java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Details zum Konstruktor

SubscriptionDescription

public SubscriptionDescription(String topicPath, String subscriptionName)

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

Parameter:

topicPath -
  • Der Pfad des Themas Max. Länge beträgt 260 Zeichen. Kann nicht mit einem Schrägstrich beginnen oder enden. Darf keine eingeschränkten Zeichen haben: "@","?","#","*"
subscriptionName -
  • Der Name des Abonnements Max. Länge beträgt 50 Zeichen. Darf keine eingeschränkten Zeichen haben: "@","?","#","*","/"

Details zur Methode

equals

public boolean equals(Object o)

Überschreibt:

SubscriptionDescription.equals(Object o)

Parameter:

o

getAutoDeleteOnIdle

public Duration getAutoDeleteOnIdle()

Gibt zurück:

Das Leerlaufintervall, nach dem das Abonnement automatisch gelöscht wird. Standardwert: MAX_DURATION

getDefaultMessageTimeToLive

public Duration getDefaultMessageTimeToLive()

Die Gültigkeitsdauer ist die Dauer, nach der die Nachricht abläuft, beginnend mit dem Zeitpunkt, an den die Nachricht an Service Bus gesendet wird. Dies ist der Standardwert, der verwendet wird, wenn getTimeToLive() nicht für eine Nachricht selbst festgelegt ist. 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 Gültigkeitsdauer der Nachrichten. Standardwert: MAX_DURATION

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 dieses Abonnements weitergeleitet werden. Wenn festgelegt, kann der Benutzer keine Nachrichten mit unzustellbaren Nachrichten aus diesem Abonnement 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 das Abonnement gesendeten Nachrichten weitergeleitet werden. Wenn festgelegt, kann der Benutzer keine Nachrichten aus diesem Abonnement 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 Einsehensperre. Der Standardwert ist 60 Sekunden.

getMaxDeliveryCount

public int getMaxDeliveryCount()

Die maximale Anzahl der Zustellungen 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.

Gibt zurück:

Der Standardwert ist 10.

getPath

public String getPath()

Gibt zurück:

der Pfad des Abonnements, einschließlich des Themas.

getSubscriptionName

public String getSubscriptionName()

Gibt zurück:

den Abonnementnamen.

getTopicPath

public String getTopicPath()

Gibt zurück:

der Pfad des Themas.

getUserMetadata

public String getUserMetadata()

Gibt zurück:

Benutzerdefinierte Metdata, die Der Benutzer der Beschreibung zuordnen kann.

hashCode

public int hashCode()

Überschreibt:

SubscriptionDescription.hashCode()

isEnableBatchedOperations

public boolean isEnableBatchedOperations()

Gibt zurück:

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

isEnableDeadLetteringOnFilterEvaluationException

public boolean isEnableDeadLetteringOnFilterEvaluationException()

Gibt zurück:

Boolescher Wert, der angibt, ob Nachrichten an die Unterwarteschlange für unzustellbare Nachrichten weitergeleitet werden müssen, wenn die Auswertung der Abonnementregel fehlschlägt. Der Standardwert ist true.

isEnableDeadLetteringOnMessageExpiration

public boolean isEnableDeadLetteringOnMessageExpiration()

Gibt an, ob dieses Abonnement über Unterstützung für unzustellbare Nachrichten verfügt, 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“.

isRequiresSession

public boolean isRequiresSession()

Gibt zurück:

Dies gibt an, ob das Abonnement das Sitzungskonzept unterstützt. Sessionful-Messages folgen der FIFO-Reihenfolge.

setAutoDeleteOnIdle

public void setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

Parameter:

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

setDefaultMessageTimeToLive

public void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

Parameter:

defaultMessageTimeToLive -
  • Legt die Standardzeit der Nachricht auf den Livewert fest. Der Wert darf nicht kleiner als 1 Sekunde sein. Siehe getDefaultMessageTimeToLive().

setEnableBatchedOperations

public void setEnableBatchedOperations(boolean enableBatchedOperations)

Parameter:

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

setEnableDeadLetteringOnFilterEvaluationException

public void setEnableDeadLetteringOnFilterEvaluationException(boolean enableDeadLetteringOnFilterEvaluationException)

Parameter:

enableDeadLetteringOnFilterEvaluationException -

setEnableDeadLetteringOnMessageExpiration

public void setEnableDeadLetteringOnMessageExpiration(boolean enableDeadLetteringOnMessageExpiration)

Parameter:

enableDeadLetteringOnMessageExpiration -

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 dieses Abonnements weitergeleitet werden. Wenn festgelegt, kann der Benutzer keine Nachrichten mit unzustellbaren Nachrichten aus diesem Abonnement 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 das Abonnement gesendeten Nachrichten weitergeleitet werden. Wenn festgelegt, kann der Benutzer keine Nachrichten aus diesem Abonnement 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 Einsehensperre. Der maximale Wert beträgt 5 Minuten.

setMaxDeliveryCount

public void setMaxDeliveryCount(int maxDeliveryCount)

Die maximale Anzahl der Zustellungen 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.

setRequiresSession

public void setRequiresSession(boolean requiresSession)

Parameter:

requiresSession -
  • Legen Sie auf TRUE fest, wenn das Abonnement 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: