ServiceBusReceivedMessage Klasse

Paket:

com.azure.messaging.servicebus

Maven-Artefakt:

com.azure:azure-messaging-servicebus:7.17.0

• java.lang.Object
• • com.azure.messaging.servicebus.ServiceBusReceivedMessage

public final class ServiceBusReceivedMessage

Die Datenstruktur, die die von Service Bus empfangene Nachricht kapselt. Die Nachrichtenstruktur wird in der Produktdokumentation ausführlich erläutert.

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
Map<String,Object>	getApplicationProperties() Ruft den Satz von Freiformeigenschaften ServiceBusReceivedMessage ab, die zum Übergeben von Metadaten verwendet werden können, die ServiceBusReceivedMessage während Service Bus-Vorgängen zugeordnet sind.
BinaryData	getBody() Ruft die Nutzlast ab, die ServiceBusReceivedMessagevon umschlossen wird.
String	getContentType() Ruft den Inhaltstyp der Nachricht ab.
String	getCorrelationId() Ruft einen Korrelationsbezeichner ab.
String	getDeadLetterErrorDescription() Ruft die Beschreibung für eine Nachricht ab, die unzustellbar wurde.
String	getDeadLetterReason() Ruft den Grund ab, warum eine Nachricht unzustellbar war.
String	getDeadLetterSource() Ruft den Namen der Warteschlange oder des Abonnements ab, für die diese Nachricht in die Warteschlange eingereiht wurde, bevor sie unzustellbar war.
long	getDeliveryCount() Ruft ab, wie oft diese Nachricht an Clients übermittelt wurde.
long	getEnqueuedSequenceNumber() Ruft die in die Warteschlange eingereihte Sequenznummer ab, die einer Nachricht von Service Bus zugewiesen ist.
OffsetDateTime	getEnqueuedTime() Ruft die datetime ab, zu der diese Nachricht in Azure Service Bus in die Warteschlange eingereiht wurde.
OffsetDateTime	getExpiresAt() Ruft die datetime ab, an der diese Nachricht abläuft.
String	getLockToken() Ruft das Sperrtoken für die aktuelle Nachricht ab.
OffsetDateTime	getLockedUntil() Ruft die datetime ab, an der die Sperre dieser Nachricht abläuft.
String	getMessageId() Ruft den Bezeichner für die Nachricht ab.
String	getPartitionKey() Ruft den Partitionsschlüssel zum Senden einer Nachricht an eine partitionierte Entität ab.
AmqpAnnotatedMessage	getRawAmqpMessage() Die Darstellung der Nachricht, wie vom AMQP-Protokoll definiert.
String	getReplyTo() Ruft die Adresse einer Entität ab, an die Antworten gesendet werden sollen.
String	getReplyToSessionId() Ruft einen Sitzungsbezeichner ab, der die Adresse erweitert, oder legt diese getReplyTo() fest.
OffsetDateTime	getScheduledEnqueueTime() Ruft die geplante Warteschlange dieser Nachricht ab.
long	getSequenceNumber() Ruft die eindeutige Nummer ab, die einer Nachricht von Service Bus zugewiesen ist.
String	getSessionId() Ruft die Sitzungs-ID der Nachricht ab.
ServiceBusMessageState	getState() Ruft den Status der Nachricht ab.
String	getSubject() Ruft den Betreff für die Nachricht ab.
Duration	getTimeToLive() Ruft die Dauer ab, bevor diese Nachricht abläuft.
String	getTo() Ruft die "to"-Adresse ab.

Geerbte Methoden von java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Details zur Methode

getApplicationProperties

public Map getApplicationProperties()

Ruft den Satz von Freiformeigenschaften ServiceBusReceivedMessage ab, die zum Übergeben von Metadaten verwendet werden können, die ServiceBusReceivedMessage während Service Bus-Vorgängen zugeordnet sind. Ein gängiger Anwendungsfall für properties() ist das Zuordnen von Serialisierungshinweisen für die getBody() Als Hilfe für Verbraucher, die die Binärdaten deserialisieren möchten.

Returns:

Diesem ServiceBusReceivedMessagezugeordnete Anwendungseigenschaften.

getBody

public BinaryData getBody()

Ruft die Nutzlast ab, die ServiceBusReceivedMessagevon umschlossen wird.

Das BinaryData umschließt das Bytearray und ist eine Abstraktion über viele verschiedene Arten, wie es dargestellt werden kann. Es bietet praktische APIs zum Serialisieren/Deserialisieren des Objekts.

Wenn die Mittel zum Deserialisieren der Rohdaten für Consumer nicht sichtbar sind, besteht eine gängige Technik darin, beim Erstellen des Ereignisses getApplicationProperties() zu verwenden, Serialisierungshinweise als Hilfe für Consumer zu zuordnen, die die Binärdaten deserialisieren möchten.

Returns:

Binärdaten, die die Nutzlast darstellen.

getContentType

public String getContentType()

Ruft den Inhaltstyp der Nachricht ab.

Beschreibt optional die Nutzlast der Nachricht mit einem Deskriptor, der dem Format von RFC2045, Abschnitt 5 folgt, z. B. "application/json".

Returns:

Der contentType von ServiceBusReceivedMessage.

getCorrelationId

public String getCorrelationId()

Ruft einen Korrelationsbezeichner ab.

Ermöglicht einer Anwendung, einen Kontext für die Nachricht zum Zweck der Korrelation anzugeben, z.B. die MessageId einer Nachricht, auf die geantwortet wird.

Returns:

Die Korrelations-ID dieser Nachricht.

getDeadLetterErrorDescription

public String getDeadLetterErrorDescription()

Ruft die Beschreibung für eine Nachricht ab, die unzustellbar wurde.

Returns:

Die Beschreibung für eine Nachricht, die unzustellbar war; null Andernfalls.

getDeadLetterReason

public String getDeadLetterReason()

Ruft den Grund ab, warum eine Nachricht unzustellbar war.

Returns:

Der Grund, warum eine Nachricht unzustellbar war; null Andernfalls.

getDeadLetterSource

public String getDeadLetterSource()

Ruft den Namen der Warteschlange oder des Abonnements ab, für die diese Nachricht in die Warteschlange eingereiht wurde, bevor sie unzustellbar war.

Dieser Wert wird nur in Nachrichten festgelegt, die unzustellbar und anschließend automatisch von der Warteschlange für unzustellbare Nachrichten an eine andere Entität weitergeleitet wurden.

Returns:

Die Entität, in der die Nachricht unzustellbar war; null Andernfalls.

getDeliveryCount

public long getDeliveryCount()

Ruft ab, wie oft diese Nachricht an Clients übermittelt wurde.

Die Anzahl wird erhöht, wenn eine Nachrichtensperre abläuft oder die Nachricht vom Empfänger explizit abgewiesen wird.

Returns:

Anzahl der Übermittlungen dieser Nachricht.

getEnqueuedSequenceNumber

public long getEnqueuedSequenceNumber()

Ruft die in die Warteschlange eingereihte Sequenznummer ab, die einer Nachricht von Service Bus zugewiesen ist.

Die Sequenznummer ist eine eindeutige 64-Bit-Ganzzahl, die zuerst einer Nachricht zugewiesen wird, da sie am ursprünglichen Übermittlungspunkt akzeptiert wird.

Returns:

Die in die Warteschlange eingereihte Sequenznummer dieser Nachricht

getEnqueuedTime

public OffsetDateTime getEnqueuedTime()

Ruft die datetime ab, zu der diese Nachricht in Azure Service Bus in die Warteschlange eingereiht wurde.

Die UTC-Datetime, zu der die Nachricht akzeptiert und in der Entität gespeichert wurde. Bei geplanten Nachrichten gibt dies den Zeitpunkt an, zu dem die Nachricht aktiviert wurde. Dieser Wert kann als autoritative und neutrale Eingangszeitangabe verwendet werden, wenn der Empfänger der Uhr des Absenders nicht vertrauen möchte.

Returns:

Die datetime, zu der die Nachricht in Azure Service Bus in die Warteschlange eingereiht wurde.

getExpiresAt

public OffsetDateTime getExpiresAt()

Ruft die datetime ab, an der diese Nachricht abläuft.

Der Wert ist die UTC-Datumsangabe für den Zeitpunkt, zu dem die Entfernung der Nachricht geplant ist und nicht mehr für den Abruf von der Entität verfügbar ist. Ablauf wird durch die getTimeToLive() -Eigenschaft gesteuert. Diese Eigenschaft wird aus getEnqueuedTime() plus getTimeToLive()berechnet.

Returns:

Die OffsetDateTime , an der diese Nachricht abläuft.

getLockToken

public String getLockToken()

Ruft das Sperrtoken für die aktuelle Nachricht ab.

Das Sperrtoken ist ein Verweis auf die Sperre, die vom Broker im PEEK_LOCK Modus gehalten wird. Sperren werden verwendet, um Nachrichten explizit zu begleichen, wie in der Produktdokumentation erläutert. Das Token kann auch verwendet werden, um die Sperre dauerhaft über die Deferral-API anzuheften und die Nachricht aus dem regulären Übermittlungszustandsfluss zu entfernen. Diese Eigenschaft ist schreibgeschützt.

Returns:

Das Sperrtoken für diese Nachricht. null für Nachrichten, die über den RECEIVE_AND_DELETE Modus abgerufen werden.

getLockedUntil

public OffsetDateTime getLockedUntil()

Ruft die datetime ab, an der die Sperre dieser Nachricht abläuft.

Für Nachrichten, die unter einer Sperre abgerufen werden (Empfangsmodus für Einsehen/Sperren, nicht vorab festgelegt), gibt diese Eigenschaft den UTC-Datetime-Wert an, bis zu dem die Nachricht gesperrt in der Warteschlange bzw. im Abonnement aufbewahrt wird. Wenn die Sperre abläuft, wird erhöht getDeliveryCount() , und die Nachricht ist wieder für den Abruf verfügbar. Diese Eigenschaft ist schreibgeschützt.

Returns:

die datetime, an der die Sperre dieser Nachricht abläuft, wenn die Nachricht im PEEK_LOCK Modus empfangen wird. Andernfalls wird NULL zurückgegeben.

getMessageId

public String getMessageId()

Ruft den Bezeichner für die Nachricht ab.

Der Nachrichtenbezeichner ist ein von der Anwendung definierter Wert, der die Nachricht und ihre Nutzlast eindeutig identifiziert. Der Bezeichner ist eine Zeichenfolge in freier Form und kann eine GUID oder einen aus dem Anwendungskontext abgeleiteten Bezeichner widerspiegeln. Wenn aktiviert, identifiziert und entfernt das Feature zur Duplikaterkennung die zweite und weitere Übermittlung von Nachrichten mit demselben messageId.

Returns:

ID der ServiceBusReceivedMessage.

getPartitionKey

public String getPartitionKey()

Ruft den Partitionsschlüssel zum Senden einer Nachricht an eine partitionierte Entität ab.

Für partitionierte Entitäten ermöglicht das Festlegen dieses Werts, verwandte Nachrichten derselben internen Partition zuzuweisen, sodass die Reihenfolge der Übermittlung ordnungsgemäß aufgezeichnet wird. Die Partition wird von einer Hashfunktion über diesen Wert ausgewählt und kann nicht direkt ausgewählt werden. Bei sitzungsfähigen Entitäten überschreibt die getSessionId() -Eigenschaft diesen Wert.

Returns:

Der Partitionsschlüssel dieser Nachricht.

getRawAmqpMessage

public AmqpAnnotatedMessage getRawAmqpMessage()

Die Darstellung der Nachricht, wie vom AMQP-Protokoll definiert.

Returns:

die AmqpAnnotatedMessage AMQP-Nachricht darstellt.

getReplyTo

public String getReplyTo()

Ruft die Adresse einer Entität ab, an die Antworten gesendet werden sollen.

Dieser optionale und von der Anwendung definierte Wert ist eine Standardmethode, einen Antwortpfad zum Empfänger der Nachricht auszudrücken. Wenn ein Absender eine Antwort erwartet, legt er den Wert auf den absoluten oder relativen Pfad der Warteschlange oder des Themas fest, an den bzw. das die Antwort gesendet werden soll.

Returns:

ReplyTo-Eigenschaftswert dieser Nachricht

getReplyToSessionId

public String getReplyToSessionId()

Ruft einen Sitzungsbezeichner ab, der die Adresse erweitert, oder legt diese getReplyTo() fest.

Dieser Wert ergänzt die ReplyTo-Informationen und gibt an, welche SessionId für die Antwort festgelegt werden soll, wenn sie an die Antwortentität gesendet wird.

Returns:

ReplyToSessionId-Eigenschaftswert dieser Nachricht

getScheduledEnqueueTime

public OffsetDateTime getScheduledEnqueueTime()

Ruft die geplante Warteschlange dieser Nachricht ab.

Dieser Wert wird für die verzögerte Nachrichtenverfügbarkeit verwendet. Die Nachricht wird der Warteschlange sicher hinzugefügt, gilt aber nicht als aktiv und kann daher erst zum geplanten Zeitpunkt der Warteschlange abgerufen werden. Beachten Sie, dass die Nachricht nicht zum genau angegebenen datetime aktiviert (in die Warteschlange) eingereiht wird. Die tatsächliche Aktivierungszeit hängt von der Workload und dem Status der Warteschlange ab.

Returns:

die datetime, an der die Nachricht in die Warteschlange Azure Service Bus

getSequenceNumber

public long getSequenceNumber()

Ruft die eindeutige Nummer ab, die einer Nachricht von Service Bus zugewiesen ist.

Die Sequenznummer ist eine eindeutige ganze 64-Bit-Zahl, die einer Nachricht zugeordnet wird, sobald sie vom Broker akzeptiert und gespeichert wird, und fungiert als ihr tatsächlicher Bezeichner. Bei partitionierte Entitäten stellen die obersten 16 Bits den Partitionsbezeichner dar. Sequenznummern erhöhen sich monoton und sind lückenlos. Sie werden auf 0 zurückgesetzt, sobald der 48-64-Bit-Bereich ausgeschöpft ist. Diese Eigenschaft ist schreibgeschützt.

Returns:

Sequenznummer dieser Nachricht

getSessionId

public String getSessionId()

Ruft die Sitzungs-ID der Nachricht ab.

Bei sitzungsabhängigen Entitäten gibt dieser von der Anwendung definierte Wert die Sitzungszugehörigkeit der Nachricht an. Nachrichten mit demselben Sitzungsbezeichner unterliegen einer zusammenfassenden Sperre und ermöglichen eine Verarbeitung in exakter Reihenfolge und Demultiplexing. Bei nicht sitzungsabhängigen Entitäten wird dieser Wert ignoriert. Weitere Informationen finden Sie unter Nachrichtensitzungen.

Returns:

Die Sitzungs-ID von ServiceBusReceivedMessage.

getState

public ServiceBusMessageState getState()

Ruft den Status der Nachricht ab. Der Status der Nachricht kann Aktiv, Verzögert oder Geplant sein. Verzögerte Nachrichten haben den Status "Verzögert", geplante Nachrichten den Status "Geplant", und alle anderen Nachrichten haben den Status "Aktiv".

Returns:

Der Status der Nachricht.

getSubject

public String getSubject()

Ruft den Betreff für die Nachricht ab.

Diese Eigenschaft ermöglicht der Anwendung, dem Empfänger auf standardisierte Weise den Zweck der Nachricht anzuzeigen, ähnlich einer Betreffzeile für E-Mails. Die zugeordnete AMQP-Eigenschaft ist "subject".

Returns:

Der Betreff für die Nachricht.

getTimeToLive

public Duration getTimeToLive()

Ruft die Dauer ab, bevor diese Nachricht abläuft.

Dieser Wert ist die relative Dauer, nach der die Nachricht abläuft, beginnend mit dem Datum, zu dem die Nachricht akzeptiert und vom Broker gespeichert wurde, wie in getScheduledEnqueueTime()erfasst. Wenn nicht explizit festgelegt, ist der angenommene Wert der DefaultTimeToLive-Satz für die jeweilige Warteschlange oder das jeweilige Thema. Ein TimeToLive-Wert auf Nachrichtenebene darf nicht länger als die DefaultTimeToLive-Einstellung der Entität sein und wird automatisch angepasst, falls dies doch der Fall ist.

Returns:

Gültigkeitsdauer dieser Nachricht

getTo

public String getTo()

Ruft die "to"-Adresse ab.

Diese Eigenschaft ist für die künftige Verwendung in Routingszenarien reserviert und wird derzeit vom Broker selbst ignoriert. Anwendungen können diesen Wert in regelgesteuerten Szenarien mit automatischer Weiterleitungsverkettung verwenden, um das beabsichtigte logische Ziel der Nachricht anzugeben.

Returns:

Eigenschaftswert "To" dieser Nachricht