ServiceBusReceivedMessage interface

Pakiet:

@azure/service-bus

Opisuje komunikat odebrany z usługi Service Bus podczas wykonywania operacji wglądu i dlatego nie można go rozstrzygnąć.

Rozszerzenie

ServiceBusMessage

Właściwości

deadLetterErrorDescription	Opis błędu dotyczący deadlettering komunikatu.
deadLetterReason	Przyczyna deadlettering wiadomości.
deadLetterSource	Nazwa kolejki lub subskrypcji, w ramach którego ten komunikat został w kolejce, zanim został utracony. Ustaw tylko w komunikatach, które zostały utracone, a następnie automatycznie przekazywane z kolejki podrzędnej utraconych komunikatów do innej jednostki. Wskazuje jednostkę, w której wiadomość nie została wysłana.
deliveryCount	Liczba dostaw, które próbowano dostarczyć dla tego komunikatu. Liczba jest zwiększana, gdy blokada komunikatu wygaśnie lub komunikat zostanie jawnie porzucony przy użyciu abandon() metody w komunikacie.
enqueuedSequenceNumber	Oryginalny numer sekwencji wiadomości. W przypadku komunikatów, które zostały automatycznie przekazane, ta właściwość odzwierciedla numer sekwencji, który został po raz pierwszy przypisany do wiadomości w oryginalnym punkcie przesyłania.
enqueuedTimeUtc	Czas UTC, w którym komunikat został zaakceptowany i przechowywany w usłudze Service Bus.
expiresAtUtc	Czas UTC, w którym komunikat jest oznaczony do usunięcia i nie jest już dostępny do pobrania z jednostki z powodu wygaśnięcia. Ta właściwość jest obliczana z 2 innych właściwości komunikatu: enqueuedTimeUtc + timeToLive.
lockedUntilUtc	Czas UTC, do którego komunikat jest zablokowany w kolejce/subskrypcji. Po wygaśnięciu blokady element jest zwiększany, deliveryCount a komunikat jest ponownie dostępny do pobierania. Nie dotyczy, gdy komunikat jest odbierany w receiveAndDelete trybie odbierania. Tryb.
lockToken	Token blokady jest odwołaniem do blokady przechowywanej przez brokera w peekLock trybie odbierania. Blokady są używane wewnętrznie rozstrzygnąć komunikaty, jak wyjaśniono w dokumentacji produktu bardziej szczegółowo Nie dotyczy, gdy komunikat jest odbierany w receiveAndDelete trybie odbierania. Tryb.
sequenceNumber	Unikatowy numer przypisany do komunikatu przez usługę Service Bus. Numer sekwencji jest unikatową 64-bitową liczbą całkowitą przypisaną do komunikatu, ponieważ jest akceptowana i przechowywana przez brokera oraz działa jako jej prawdziwy identyfikator. W przypadku jednostek podzielonych na partycje najbardziej 16 bitów odzwierciedla identyfikator partycji. Liczba sekwencji monotonicznie zwiększa się. Przewracają się do 0, gdy zakres 48-64 bitów jest wyczerpany. Maksymalna bezpieczna liczba całkowita obsługiwana obecnie przez język JavaScript to 2^53 - 1. Numer sekwencji jest typem PROTOKOŁU AMQP Long , który może mieć długość maksymalnie 64 bitów. Aby przedstawić, że używamy biblioteki o nazwie long.js. Oczekujemy, że klienci będą używać Long typu wyeksportowanego przez tę bibliotekę.
state	Stan komunikatu może być aktywny, odroczony lub zaplanowany. Komunikaty odroczone mają stan odroczenia, zaplanowane komunikaty mają stan zaplanowany, wszystkie inne komunikaty mają aktywny stan.

Właściwości dziedziczone

applicationProperties	Właściwości specyficzne dla aplikacji, które mogą być używane na potrzeby niestandardowych metadanych komunikatów.
body	Treść wiadomości, która musi zostać wysłana lub odebrana. Jeśli aplikacja, która otrzymuje komunikat, nie używa tego zestawu SDK, przekonwertuj ładunek treści na tablicę bajtów lub bufor, aby uzyskać lepszą zgodność między językami.
contentType	Typ zawartości wiadomości. Opcjonalnie opisano ładunek komunikatu z deskryptorem w formacie RFC2045, sekcja 5, na przykład "application/json".
correlationId	Identyfikator korelacji, który umożliwia aplikacji określenie kontekstu komunikatu na potrzeby korelacji, na przykład odzwierciedlające identyfikator MessageId komunikatu, na który jest odpowiadana. Zobacz Routing i korelacja komunikatów.
messageId	Identyfikator komunikatu jest wartością zdefiniowaną przez aplikację, która jednoznacznie identyfikuje komunikat i jego ładunek. Uwaga: liczby, które nie są liczbami całkowitymi, są niedozwolone.
partitionKey	Klucz partycji do wysyłania komunikatu do jednostki podzielonej na partycje. Maksymalna długość to 128 znaków. W przypadku jednostek partycjonowanych ustawienie tej wartości umożliwia przypisywanie powiązanych komunikatów do tej samej partycji wewnętrznej, dzięki czemu kolejność sekwencji przesyłania jest poprawnie rejestrowana. Partycja jest wybierana przez funkcję skrótu dla tej wartości i nie można jej wybrać bezpośrednio. W przypadku jednostek obsługujących sesję sessionId właściwość zastępuje tę wartość. W przypadku jednostek bez partycjonowania klucz partycji zostanie zignorowany
replyTo	Adres jednostki do wysyłania odpowiedzi. Ta opcjonalna i zdefiniowana przez aplikację wartość jest standardowym sposobem wyrażania ścieżki odpowiedzi do odbiorcy komunikatu. Gdy nadawca oczekuje odpowiedzi, ustawia wartość na bezwzględną lub względną ścieżkę kolejki lub tematu, do których oczekuje wysłania odpowiedzi. Zobacz Routing i korelacja komunikatów.
replyToSessionId	Identyfikator sesji rozszerza replyTo adres. Maksymalna długość to 128 znaków. Ta wartość rozszerza informacje ReplyTo i określa, które identyfikator sesji powinny być ustawione dla odpowiedzi po wysłaniu do jednostki odpowiedzi. Zobacz Routing i korelacja komunikatów.
scheduledEnqueueTimeUtc	Data i godzina w formacie UTC, o której komunikat zostanie w kolejce. Ta właściwość zwraca czas w formacie UTC; podczas ustawiania właściwości podana wartość DateTime musi być również w formacie UTC. Ta wartość dotyczy opóźnionego wysyłania komunikatów. Służy do opóźniania wysyłania komunikatów do określonego czasu w przyszłości. Czas kolejkowania komunikatów nie oznacza, że wiadomość zostanie wysłana w tym samym czasie. Zostanie ono w kolejce, ale rzeczywisty czas wysyłania zależy od obciążenia kolejki i jego stanu.
sessionId	Identyfikator sesji dla jednostki obsługującej sesję. Maksymalna długość to 128 znaków. W przypadku jednostek obsługujących sesję ta wartość zdefiniowana przez aplikację określa przynależność sesji komunikatu. Komunikaty z tym samym identyfikatorem sesji podlegają blokadzie podsumowania i umożliwiają dokładne przetwarzanie w kolejności i demultiplexing. W przypadku jednostek nieświadomych sesji ta wartość jest ignorowana. Sesje komunikatów.
subject	Etykieta specyficzna dla aplikacji. Ta właściwość umożliwia aplikacji wskazanie przeznaczenia komunikatu odbiorcy w ustandaryzowanym. moda, podobna do wiersza tematu wiadomości e-mail. Zamapowana właściwość AMQP to "subject".
timeToLive	Czas wygaśnięcia wiadomości. Ta wartość jest względnym czasem trwania, po upływie którego komunikat wygasa, począwszy od momentu zaakceptowania wiadomości i jego przechowywania przez brokera w sposób przechwycony w enqueuedTimeUtcprogramie . Jeśli nie zostanie jawnie ustawiona, zakładana wartość to DefaultTimeToLive odpowiedniej kolejki lub tematu. Wartość na poziomie timeToLive komunikatu nie może być dłuższa niż ustawienie DefaultTimeToLive jednostki i jest ona w trybie dyskretnym dostosowywana, jeśli tak się stanie. Zobacz Wygaśnięcie.
to	Adres "do". Ta właściwość jest zarezerwowana do użytku w przyszłości w scenariuszach routingu i obecnie ignorowana przez samego brokera. Aplikacje mogą używać tej wartości w scenariuszach automatycznego przekazywania reguł w celu wskazania zamierzonego logicznego miejsca docelowego komunikatu.

Szczegóły właściwości

deadLetterErrorDescription

Opis błędu dotyczący deadlettering komunikatu.

deadLetterErrorDescription?: string

Wartość właściwości

string

deadLetterReason

Przyczyna deadlettering wiadomości.

deadLetterReason?: string

Wartość właściwości

string

deadLetterSource

Nazwa kolejki lub subskrypcji, w ramach którego ten komunikat został w kolejce, zanim został utracony. Ustaw tylko w komunikatach, które zostały utracone, a następnie automatycznie przekazywane z kolejki podrzędnej utraconych komunikatów do innej jednostki. Wskazuje jednostkę, w której wiadomość nie została wysłana.

deadLetterSource?: string

Wartość właściwości

string

deliveryCount

Liczba dostaw, które próbowano dostarczyć dla tego komunikatu. Liczba jest zwiększana, gdy blokada komunikatu wygaśnie lub komunikat zostanie jawnie porzucony przy użyciu abandon() metody w komunikacie.

deliveryCount?: number

Wartość właściwości

number

enqueuedSequenceNumber

Oryginalny numer sekwencji wiadomości. W przypadku komunikatów, które zostały automatycznie przekazane, ta właściwość odzwierciedla numer sekwencji, który został po raz pierwszy przypisany do wiadomości w oryginalnym punkcie przesyłania.

enqueuedSequenceNumber?: number

Wartość właściwości

number

enqueuedTimeUtc

Czas UTC, w którym komunikat został zaakceptowany i przechowywany w usłudze Service Bus.

enqueuedTimeUtc?: Date

Wartość właściwości

Date

expiresAtUtc

Czas UTC, w którym komunikat jest oznaczony do usunięcia i nie jest już dostępny do pobrania z jednostki z powodu wygaśnięcia. Ta właściwość jest obliczana z 2 innych właściwości komunikatu: enqueuedTimeUtc + timeToLive.

expiresAtUtc?: Date

Wartość właściwości

Date

lockedUntilUtc

Czas UTC, do którego komunikat jest zablokowany w kolejce/subskrypcji. Po wygaśnięciu blokady element jest zwiększany, deliveryCount a komunikat jest ponownie dostępny do pobierania.

• Nie dotyczy, gdy komunikat jest odbierany w receiveAndDelete trybie odbierania. Tryb.

lockedUntilUtc?: Date

Wartość właściwości

Date

lockToken

Token blokady jest odwołaniem do blokady przechowywanej przez brokera w peekLock trybie odbierania. Blokady są używane wewnętrznie rozstrzygnąć komunikaty, jak wyjaśniono w dokumentacji produktu bardziej szczegółowo

• Nie dotyczy, gdy komunikat jest odbierany w receiveAndDelete trybie odbierania. Tryb.

lockToken?: string

Wartość właściwości

string

sequenceNumber

Unikatowy numer przypisany do komunikatu przez usługę Service Bus. Numer sekwencji jest unikatową 64-bitową liczbą całkowitą przypisaną do komunikatu, ponieważ jest akceptowana i przechowywana przez brokera oraz działa jako jej prawdziwy identyfikator. W przypadku jednostek podzielonych na partycje najbardziej 16 bitów odzwierciedla identyfikator partycji. Liczba sekwencji monotonicznie zwiększa się. Przewracają się do 0, gdy zakres 48-64 bitów jest wyczerpany.

Maksymalna bezpieczna liczba całkowita obsługiwana obecnie przez język JavaScript to 2^53 - 1. Numer sekwencji jest typem PROTOKOŁU AMQP Long , który może mieć długość maksymalnie 64 bitów. Aby przedstawić, że używamy biblioteki o nazwie long.js. Oczekujemy, że klienci będą używać Long typu wyeksportowanego przez tę bibliotekę.

sequenceNumber?: Long

Wartość właściwości

Long

state

Stan komunikatu może być aktywny, odroczony lub zaplanowany. Komunikaty odroczone mają stan odroczenia, zaplanowane komunikaty mają stan zaplanowany, wszystkie inne komunikaty mają aktywny stan.

state: "active" | "deferred" | "scheduled"

Wartość właściwości

"active" | "deferred" | "scheduled"

Szczegóły właściwości dziedziczonej

applicationProperties

Właściwości specyficzne dla aplikacji, które mogą być używane na potrzeby niestandardowych metadanych komunikatów.

applicationProperties?: {[key: string]: number | boolean | string | Date | null}

Wartość właściwości

{[key: string]: number | boolean | string | Date | null}

Dziedziczone zserviceBusMessage.applicationProperties

body

Treść wiadomości, która musi zostać wysłana lub odebrana. Jeśli aplikacja, która otrzymuje komunikat, nie używa tego zestawu SDK, przekonwertuj ładunek treści na tablicę bajtów lub bufor, aby uzyskać lepszą zgodność między językami.

body: any

Wartość właściwości

any

Dziedziczone zelementu ServiceBusMessage.body

contentType

Typ zawartości wiadomości. Opcjonalnie opisano ładunek komunikatu z deskryptorem w formacie RFC2045, sekcja 5, na przykład "application/json".

contentType?: string

Wartość właściwości

string

Dziedziczone zklasy ServiceBusMessage.contentType

correlationId

Identyfikator korelacji, który umożliwia aplikacji określenie kontekstu komunikatu na potrzeby korelacji, na przykład odzwierciedlające identyfikator MessageId komunikatu, na który jest odpowiadana. Zobacz Routing i korelacja komunikatów.

correlationId?: string | number | Buffer

Wartość właściwości

string | number | Buffer

Dziedziczone zserviceBusMessage.correlationId

messageId

Identyfikator komunikatu jest wartością zdefiniowaną przez aplikację, która jednoznacznie identyfikuje komunikat i jego ładunek.

Uwaga: liczby, które nie są liczbami całkowitymi, są niedozwolone.

messageId?: string | number | Buffer

Wartość właściwości

string | number | Buffer

Dziedziczone zserviceBusMessage.messageId

partitionKey

Klucz partycji do wysyłania komunikatu do jednostki podzielonej na partycje. Maksymalna długość to 128 znaków. W przypadku jednostek partycjonowanych ustawienie tej wartości umożliwia przypisywanie powiązanych komunikatów do tej samej partycji wewnętrznej, dzięki czemu kolejność sekwencji przesyłania jest poprawnie rejestrowana. Partycja jest wybierana przez funkcję skrótu dla tej wartości i nie można jej wybrać bezpośrednio.

• W przypadku jednostek obsługujących sesję sessionId właściwość zastępuje tę wartość.
• W przypadku jednostek bez partycjonowania klucz partycji zostanie zignorowany

partitionKey?: string

Wartość właściwości

string

Dziedziczone zserviceBusMessage.partitionKey

replyTo

Adres jednostki do wysyłania odpowiedzi. Ta opcjonalna i zdefiniowana przez aplikację wartość jest standardowym sposobem wyrażania ścieżki odpowiedzi do odbiorcy komunikatu. Gdy nadawca oczekuje odpowiedzi, ustawia wartość na bezwzględną lub względną ścieżkę kolejki lub tematu, do których oczekuje wysłania odpowiedzi. Zobacz Routing i korelacja komunikatów.

replyTo?: string

Wartość właściwości

string

Dziedziczone zserviceBusMessage.replyTo

replyToSessionId

Identyfikator sesji rozszerza replyTo adres. Maksymalna długość to 128 znaków. Ta wartość rozszerza informacje ReplyTo i określa, które identyfikator sesji powinny być ustawione dla odpowiedzi po wysłaniu do jednostki odpowiedzi. Zobacz Routing i korelacja komunikatów.

replyToSessionId?: string

Wartość właściwości

string

Dziedziczone zserviceBusMessage.replyToSessionId

scheduledEnqueueTimeUtc

Data i godzina w formacie UTC, o której komunikat zostanie w kolejce. Ta właściwość zwraca czas w formacie UTC; podczas ustawiania właściwości podana wartość DateTime musi być również w formacie UTC. Ta wartość dotyczy opóźnionego wysyłania komunikatów. Służy do opóźniania wysyłania komunikatów do określonego czasu w przyszłości. Czas kolejkowania komunikatów nie oznacza, że wiadomość zostanie wysłana w tym samym czasie. Zostanie ono w kolejce, ale rzeczywisty czas wysyłania zależy od obciążenia kolejki i jego stanu.

scheduledEnqueueTimeUtc?: Date

Wartość właściwości

Date

Dziedziczone zserviceBusMessage.scheduledEnqueueTimeUtc

sessionId

Identyfikator sesji dla jednostki obsługującej sesję. Maksymalna długość to 128 znaków. W przypadku jednostek obsługujących sesję ta wartość zdefiniowana przez aplikację określa przynależność sesji komunikatu. Komunikaty z tym samym identyfikatorem sesji podlegają blokadzie podsumowania i umożliwiają dokładne przetwarzanie w kolejności i demultiplexing. W przypadku jednostek nieświadomych sesji ta wartość jest ignorowana. Sesje komunikatów.

sessionId?: string

Wartość właściwości

string

Dziedziczone zserviceBusMessage.sessionId

subject

Etykieta specyficzna dla aplikacji. Ta właściwość umożliwia aplikacji wskazanie przeznaczenia komunikatu odbiorcy w ustandaryzowanym. moda, podobna do wiersza tematu wiadomości e-mail. Zamapowana właściwość AMQP to "subject".

subject?: string

Wartość właściwości

string

Dziedziczone zobiektu ServiceBusMessage.subject

timeToLive

Czas wygaśnięcia wiadomości. Ta wartość jest względnym czasem trwania, po upływie którego komunikat wygasa, począwszy od momentu zaakceptowania wiadomości i jego przechowywania przez brokera w sposób przechwycony w enqueuedTimeUtcprogramie . Jeśli nie zostanie jawnie ustawiona, zakładana wartość to DefaultTimeToLive odpowiedniej kolejki lub tematu. Wartość na poziomie timeToLive komunikatu nie może być dłuższa niż ustawienie DefaultTimeToLive jednostki i jest ona w trybie dyskretnym dostosowywana, jeśli tak się stanie. Zobacz Wygaśnięcie.

timeToLive?: number

Wartość właściwości

number

Dziedziczone zserviceBusMessage.timeToLive

to

Adres "do". Ta właściwość jest zarezerwowana do użytku w przyszłości w scenariuszach routingu i obecnie ignorowana przez samego brokera. Aplikacje mogą używać tej wartości w scenariuszach automatycznego przekazywania reguł w celu wskazania zamierzonego logicznego miejsca docelowego komunikatu.

to?: string

Wartość właściwości

string

Dziedziczone zServiceBusMessage.to