IMessage Schnittstelle

Paket:

com.microsoft.azure.servicebus

Maven-Artefakt:

com.microsoft.azure:azure-servicebus:3.6.7

public interface IMessage

Stellt die Nachricht dar, die zwischen Azure Service Bus und seinen Clients ausgetauscht wird.

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
abstract IMessage	createCopy() Erstellt eine flache Kopie dieser Nachricht.
abstract byte[]	getBody() Als veraltet markiert Nachrichtentext benötigt nicht nur ein Bytearray. Ersetzt durch getMessageBody() Ruft den Text dieser Nachricht als Bytearray ab.
abstract String	getContentType() Ruft den Inhaltstyp dieser Nachricht ab.
abstract String	getCorrelationId() Ruft einen Korrelationsbezeichner ab.
abstract String	getDeadLetterSource() Ruft den Namen der Warteschlange oder des Abonnements ab, für die diese Nachricht in die Warteschlange gestellt wurde, bevor sie nicht gesendet wurde.
abstract long	getDeliveryCount() Ruft ab, wie oft diese Nachricht an Clients zugestellt wurde.
abstract Instant	getEnqueuedTimeUtc() Ruft den Moment ab, zu dem diese Nachricht in Azure Service Bus queuiert wurde.
abstract Instant	getExpiresAtUtc() Ruft den Moment ab, zu dem diese Nachricht abläuft.
abstract String	getLabel() Ruft die anwendungsspezifische Nachrichtenbezeichnung ab.
abstract UUID	getLockToken() Ruft das Sperrtoken für die aktuelle Nachricht ab.
abstract Instant	getLockedUntilUtc() Ruft den Moment ab, zu dem die Sperre dieser Nachricht abläuft.
abstract MessageBody	getMessageBody() Ruft den Text dieser Nachricht ab.
abstract String	getMessageId() Ruft die ID dieser Nachricht ab.
abstract String	getPartitionKey() Ruft den Partitionsschlüssel zum Senden einer Nachricht an eine partitionierte Entität ab.
abstract Map<String,Object>	getProperties() Ruft die Zuordnung der Benutzeranwendungseigenschaften dieser Nachricht ab.
abstract String	getReplyTo() Ruft die Adresse einer Entität ab, an die Antworten gesendet werden sollen.
abstract String	getReplyToSessionId() Ruft einen Sitzungsbezeichner ab, der die Adresse erweitert, oder legt diese getReplyTo() fest.
abstract Instant	getScheduledEnqueueTimeUtc() Ruft die geplante Queuezeit dieser Nachricht ab.
abstract Instant	getScheduledEnqueuedTimeUtc() Als veraltet markiert Ersetzt durch getScheduledEnqueueTimeUtc() Ruft die geplante Queuezeit dieser Nachricht ab.
abstract long	getSequenceNumber() Ruft die eindeutige Nummer ab, die einer Nachricht von Service Bus zugewiesen ist.
abstract String	getSessionId() Ruft den Sitzungsbezeichner für eine sitzungsfähige Entität ab.
abstract Duration	getTimeToLive() Ruft die Dauer ab, bevor diese Nachricht abläuft.
abstract String	getTo() Ruft die "to"-Adresse ab.
abstract String	getViaPartitionKey() Ruft den Partitionsschlüssel zum Senden einer Nachricht an eine Entität über eine andere partitionierte Übertragungsentität ab.
abstract void	setBody(byte[] body) Als veraltet markiert Nachrichtentext benötigt nicht nur ein Bytearray. Ersetzt durch setMessageBody(MessageBody body) Legt den Text dieser Nachricht als Bytearray fest.
abstract void	setContentType(String contentType) Legt den Inhaltstyp dieser Nachricht fest.
abstract void	setCorrelationId(String correlationId) Legt einen Korrelationsbezeichner fest.
abstract void	setLabel(String label) Legt eine anwendungsspezifische Nachrichtenbezeichnung fest.
abstract void	setMessageBody(MessageBody body) Legt den Text dieser Nachricht fest.
abstract void	setMessageId(String messageId) Legt die ID dieser Nachricht fest.
abstract void	setPartitionKey(String partitionKey) Legt einen Partitionsschlüssel zum Senden einer Nachricht an eine partitionierte Entität fest.
abstract void	setProperties(Map<String,Object> properties) Legt die Zuordnung der Benutzeranwendungseigenschaften dieser Nachricht fest.
abstract void	setReplyTo(String replyTo) Legt die Adresse einer Entität fest, an die Antworten gesendet werden sollen.
abstract void	setReplyToSessionId(String replyToSessionId) Ruft einen Sitzungsbezeichner ab, der die Adresse erweitert, oder legt diese getReplyTo() fest.
abstract void	setScheduledEnqueueTimeUtc(Instant scheduledEnqueueTimeUtc) Legt die geplante Warteschlange dieser Nachricht fest.
abstract void	setScheduledEnqueuedTimeUtc(Instant scheduledEnqueueTimeUtc) Als veraltet markiert Ersetzt durch setScheduledEnqueueTimeUtc(Instant scheduledEnqueueTimeUtc) Legt die geplante Warteschlange dieser Nachricht fest.
abstract void	setSessionId(String sessionId) Legt den Sitzungsbezeichner für eine sitzungsfähige Entität fest.
abstract void	setTimeToLive(Duration timeToLive) Legt die Dauer der Zeit fest, bis diese Nachricht abläuft.
abstract void	setTo(String to) Legt die "to"-Adresse fest.
abstract void	setViaPartitionKey(String viaPartitionKey) Legt einen partitionsbasierten Schlüssel zum Senden einer Nachricht an eine Zielentität über eine andere partitionierte Entität fest.

Details zur Methode

createCopy

public abstract IMessage createCopy()

Erstellt eine flache Kopie dieser Nachricht.

Gibt zurück:

Kopie dieser Nachricht

getBody

@Deprecated
public abstract byte[] getBody()

Als veraltet markiert

Nachrichtentext benötigt nicht nur ein Bytearray. Ersetzt durch getMessageBody()

Ruft den Text dieser Nachricht als Bytearray ab. Es liegt an Clientanwendungen, die Bytes zu decodieren.

Gibt zurück:

Textkörper dieser Nachricht

getContentType

public abstract String getContentType()

Ruft den Inhaltstyp dieser Nachricht ab. Beschreibt optional die Nutzlast der Nachricht, wobei ein Deskriptor dem Format von RFC2045, Abschnitt 5 folgt, z. B. "application/json". Beachten Sie, dass der Inhaltstyp nicht mit dem Nachrichtentexttyp identisch ist.

Gibt zurück:

Inhaltstyp dieser Nachricht

getCorrelationId

public abstract 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.

Gibt zurück:

Korrelations-ID dieser Nachricht

getDeadLetterSource

public abstract String getDeadLetterSource()

Ruft den Namen der Warteschlange oder des Abonnements ab, für die diese Nachricht in die Warteschlange gestellt wurde, bevor sie nicht gesendet wurde. 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. Gibt die Entität an, in der die Nachricht unzustellbar war. Diese Eigenschaft ist schreibgeschützt.

Gibt zurück:

Quelle für unzustellbare Nachrichten

getDeliveryCount

public abstract long getDeliveryCount()

Ruft ab, wie oft diese Nachricht an Clients zugestellt wurde. Die Anzahl wird erhöht, wenn eine Nachrichtensperre abläuft oder die Nachricht vom Empfänger explizit abgewiesen wird. Diese Eigenschaft ist schreibgeschützt.

Gibt zurück:

Anzahl der Übermittlungen dieser Nachricht.

getEnqueuedTimeUtc

public abstract Instant getEnqueuedTimeUtc()

Ruft den Moment ab, zu dem diese Nachricht in Azure Service Bus queuiert wurde. Der UTC-Moment, in dem die Nachricht angenommen und in der Entität gespeichert wurde. Bei geplanten Nachrichten spiegelt dies den Zeitpunkt wider, 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. Diese Eigenschaft ist schreibgeschützt.

Gibt zurück:

der Zeitpunkt, zu dem die Nachricht in Azure Service Bus

getExpiresAtUtc

public abstract Instant getExpiresAtUtc()

Ruft den Moment ab, zu dem diese Nachricht abläuft. Der Wert ist der UTC-Moment für, wenn die Nachricht für die Entfernung geplant ist und aufgrund des Ablaufs nicht mehr für den Abruf aus der Entität verfügbar ist. Der Ablauf wird von der getTimeToLive() -Eigenschaft gesteuert. Diese Eigenschaft wird aus getEnqueuedTimeUtc()+getTimeToLive()berechnet.

Gibt zurück:

sofort, bei dem diese Nachricht abläuft

getLabel

public abstract String getLabel()

Ruft die anwendungsspezifische Nachrichtenbezeichnung 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".

Gibt zurück:

Bezeichnungseigenschaftswert dieser Nachricht

getLockToken

public abstract UUID getLockToken()

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

Gibt zurück:

Sperrtoken dieser Nachricht.

getLockedUntilUtc

public abstract Instant getLockedUntilUtc()

Ruft den Moment ab, zu dem die Sperre dieser Nachricht abläuft. Bei Nachrichten, die unter einer Sperre (Empfangsmodus „peek-lock“, nicht vor der Übereinkunft) abgerufen werden, entspricht diese Eigenschaft dem UTC-Moment, bis zu dem die Nachricht in der Warteschlange bzw. im Abonnement gesperrt gehalten wird. Wenn die Sperre abläuft, wird die getDeliveryCount() inkrementiert, und die Nachricht ist wieder für den Abruf verfügbar. Diese Eigenschaft ist schreibgeschützt.

Gibt zurück:

der Moment, zu dem die Sperre dieser Nachricht abläuft, wenn die Nachricht im PEEKLOCK-Modus empfangen wird. Andernfalls wird NULL zurückgegeben.

getMessageBody

public abstract MessageBody getMessageBody()

Ruft den Text dieser Nachricht ab. Clientanwendungen sollten Nachrichteninhalte basierend auf dem Texttyp extrahieren.

Gibt zurück:

Textkörper dieser Nachricht

getMessageId

public abstract String getMessageId()

Ruft die ID dieser 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 diese Option aktiviert ist, identifiziert und entfernt das Feature zur doppelten Erkennung die zweite und weitere Übermittlung von Nachrichten mit derselben MessageId.

Gibt zurück:

ID dieser Nachricht

getPartitionKey

public abstract 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.

Gibt zurück:

Partitionsschlüssel dieser Nachricht

getProperties

public abstract Map getProperties()

Ruft die Zuordnung der Benutzeranwendungseigenschaften dieser Nachricht ab. Clientanwendungen können Mithilfe dieser Zuordnung Benutzereigenschaften (Header) für die Nachricht festlegen.

Gibt zurück:

Die Zuordnung der Benutzeranwendungseigenschaften dieser Nachricht

getReplyTo

public abstract 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.

Gibt zurück:

ReplyTo-Eigenschaftswert dieser Nachricht

getReplyToSessionId

public abstract 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.

Gibt zurück:

ReplyToSessionId-Eigenschaftswert dieser Nachricht

getScheduledEnqueueTimeUtc

public abstract Instant getScheduledEnqueueTimeUtc()

Ruft die geplante Queuezeit 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 nach der geplanten Warteschlange abgerufen werden. Beachten Sie, dass die Nachricht möglicherweise nicht zum angegebenen Zeitpunkt aktiviert (enqueued) wird; Die tatsächliche Aktivierungszeit hängt von der Workload und dem Zustand der Warteschlange ab.

Gibt zurück:

der Zeitpunkt, zu dem die Nachricht in Azure Service Bus

getScheduledEnqueuedTimeUtc

@Deprecated
public abstract Instant getScheduledEnqueuedTimeUtc()

Als veraltet markiert

Ersetzt durch getScheduledEnqueueTimeUtc()

Ruft die geplante Queuezeit 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 nach der geplanten Warteschlange abgerufen werden. Beachten Sie, dass die Nachricht möglicherweise nicht zum angegebenen Zeitpunkt aktiviert (enqueued) wird; Die tatsächliche Aktivierungszeit hängt von der Workload und dem Zustand der Warteschlange ab.

Gibt zurück:

der Zeitpunkt, zu dem die Nachricht in Azure Service Bus

getSequenceNumber

public abstract 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.

Gibt zurück:

Sequenznummer dieser Nachricht

getSessionId

public abstract String getSessionId()

Ruft den Sitzungsbezeichner für eine sitzungsfähige Entität 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.

Gibt zurück:

Sitzungs-ID dieser Nachricht

getTimeToLive

public abstract 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 Zeitpunkt, an dem die Nachricht akzeptiert und vom Broker gespeichert wurde, wie in getEnqueuedTimeUtc()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.

Gibt zurück:

Gültigkeitsdauer dieser Nachricht

getTo

public abstract String getTo()

Ruft die "to"-Adresse ab.

Gibt zurück:

An -Eigenschaftswert dieser Nachricht

getViaPartitionKey

public abstract String getViaPartitionKey()

Ruft den Partitionsschlüssel zum Senden einer Nachricht an eine Entität über eine andere partitionierte Übertragungsentität ab. Wenn eine Nachricht über eine Übertragungswarteschlange im Bereich einer Transaktion gesendet wird, wählt dieser Wert die Übertragungswarteschlangenpartition aus: Dies entspricht funktional getPartitionKey() und stellt sicher, dass Die Nachrichten zusammen und in der reihenfolgeweisen Übertragung aufbewahrt werden.

Gibt zurück:

Partitionsschlüssel in der via-Warteschlange.

setBody

@Deprecated
public abstract void setBody(byte[] body)

Als veraltet markiert

Nachrichtentext benötigt nicht nur ein Bytearray. Ersetzt durch setMessageBody(MessageBody body)

Legt den Text dieser Nachricht als Bytearray fest.

Parameter:

body - Text dieser Nachricht

setContentType

public abstract void setContentType(String contentType)

Legt den Inhaltstyp dieser Nachricht fest.

Parameter:

contentType - Inhaltstyp dieser Nachricht

setCorrelationId

public abstract void setCorrelationId(String correlationId)

Legt einen Korrelationsbezeichner fest.

Parameter:

correlationId - Korrelations-ID dieser Nachricht

setLabel

public abstract void setLabel(String label)

Legt eine anwendungsspezifische Nachrichtenbezeichnung fest.

Parameter:

label - Label-Eigenschaftswert dieser Nachricht

setMessageBody

public abstract void setMessageBody(MessageBody body)

Legt den Text dieser Nachricht fest.

Parameter:

body - Text dieser Nachricht

setMessageId

public abstract void setMessageId(String messageId)

Legt die ID dieser Nachricht fest.

Parameter:

messageId - ID dieser Nachricht

setPartitionKey

public abstract void setPartitionKey(String partitionKey)

Legt einen Partitionsschlüssel zum Senden einer Nachricht an eine partitionierte Entität fest.

Parameter:

partitionKey - Partitionsschlüssel dieser Meldung

setProperties

public abstract void setProperties(Map properties)

Legt die Zuordnung der Benutzeranwendungseigenschaften dieser Nachricht fest. Clientanwendungen können mithilfe dieser Zuordnung Benutzereigenschaften für die Nachricht festlegen.

Parameter:

properties - Die Zuordnung der Benutzeranwendungseigenschaften dieser Nachricht

setReplyTo

public abstract void setReplyTo(String replyTo)

Legt die Adresse einer Entität fest, an die Antworten gesendet werden sollen.

Parameter:

replyTo - ReplyTo-Eigenschaftswert dieser Nachricht

setReplyToSessionId

public abstract void setReplyToSessionId(String replyToSessionId)

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

Parameter:

replyToSessionId - ReplyToSessionId-Eigenschaftswert dieser Nachricht

setScheduledEnqueueTimeUtc

public abstract void setScheduledEnqueueTimeUtc(Instant scheduledEnqueueTimeUtc)

Legt die geplante Warteschlange dieser Nachricht fest.

Parameter:

scheduledEnqueueTimeUtc - der Zeitpunkt, zu dem diese Nachricht in Azure Service Bus in die Warteschlange eingereiht werden soll

setScheduledEnqueuedTimeUtc

@Deprecated
public abstract void setScheduledEnqueuedTimeUtc(Instant scheduledEnqueueTimeUtc)

Als veraltet markiert

Ersetzt durch setScheduledEnqueueTimeUtc(Instant scheduledEnqueueTimeUtc)

Legt die geplante Warteschlange dieser Nachricht fest.

Parameter:

scheduledEnqueueTimeUtc - der Zeitpunkt, zu dem diese Nachricht in Azure Service Bus in die Warteschlange eingereiht werden soll

setSessionId

public abstract void setSessionId(String sessionId)

Legt den Sitzungsbezeichner für eine sitzungsfähige Entität fest.

Parameter:

sessionId - Sitzungs-ID dieser Nachricht

setTimeToLive

public abstract void setTimeToLive(Duration timeToLive)

Legt die Dauer der Zeit fest, bis diese Nachricht abläuft.

Parameter:

timeToLive - Gültigkeitsdauer dieser Nachricht

setTo

public abstract void setTo(String to)

Legt die "to"-Adresse fest. 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.

Parameter:

to - An -Eigenschaftswert dieser Nachricht

setViaPartitionKey

public abstract void setViaPartitionKey(String viaPartitionKey)

Legt einen partitionsbasierten Schlüssel zum Senden einer Nachricht an eine Zielentität über eine andere partitionierte Entität fest.

Parameter:

viaPartitionKey - Überpartitionsschlüssel dieser Nachricht