ServiceBusReceivedMessage interface

Pakiet:

@azure/service-bus

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

Rozszerzenie

ServiceBusMessage

Właściwości

deadLetterErrorDescription	Opis błędu dotyczący zakleszczenia komunikatu.
deadLetterReason	Przyczyna zakleszczenia wiadomości.
deadLetterSource	Nazwa kolejki lub subskrypcji, od którego ten komunikat został w kolejce, zanim został utracony. Ustawiane tylko w komunikatach, które zostały utracone, a następnie automatycznie przekazywane z kolejki podrzędnej utraconych wiadomości do innej jednostki. Wskazuje jednostkę, w której wiadomość nie została wysłana.
deliveryCount	Liczba dostaw, które próbowano wykonać dla tego komunikatu. Liczba jest zwiększana, gdy blokada komunikatu wygaśnie lub komunikat zostanie jawnie porzucony przy użyciu metody abandon() 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ł wcześniej przypisany do wiadomości w oryginalnym punkcie przesyłania.
enqueuedTimeUtc	Czas UTC, w którym wiadomość została zaakceptowana i zapisana 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 deliveryCount jest zwiększana, a komunikat jest ponownie dostępny do pobierania. Nie dotyczy, gdy komunikat jest odbierany w trybie odbierania receiveAndDelete. tryb.
lockToken	Token blokady jest odwołaniem do blokady przechowywanej przez brokera w trybie odbierania peekLock. Blokady są używane wewnętrznie rozstrzygnąć komunikaty, jak wyjaśniono w dokumentacji produktu bardziej szczegółowo Nie dotyczy, gdy komunikat jest odbierany w trybie odbierania receiveAndDelete. 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 partycjonowanych najważniejsze 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 obecnie obsługiwana przez język JavaScript jest 2^53 - 1. Numer sekwencji to typ Long AMQP, 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ć typu Long wyeksportowanego przez tę bibliotekę.
state	Stan komunikatu może być aktywny, odroczony lub zaplanowany. Odroczone komunikaty mają stan odroczony, 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 odbieraca 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 opisuje ł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, do którego jest odpowiadana. Zobacz Routing komunikatów i korelacja.
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, nie są dozwolone.
partitionKey	Klucz partycji do wysyłania komunikatu do jednostki podzielonej na partycje. Maksymalna długość to 128 znaków. W przypadku partycjonowanych jednostekustawienie 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ę właściwość sessionId 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żenia ś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 się wysłania odpowiedzi. Zobacz Routing komunikatów i korelacja.
replyToSessionId	Identyfikator sesji zwiększający adres replyTo. Maksymalna długość to 128 znaków. Ta wartość rozszerza informacje ReplyTo i określa, które identyfikatory sesji powinny być ustawione dla odpowiedzi po wysłaniu do jednostki odpowiedzi. Zobacz Routing komunikatów i korelacja.
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 on 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 jest "subject".
timeToLive	Czas wygaśnięcia wiadomości. Ta wartość jest względnym czasem trwania, po upływie którego komunikat wygaśnie, począwszy od momentu zaakceptowania i przechowywania komunikatu przez brokera, jak przechwycono w enqueuedTimeUtc. Jeśli nie ustawiono jawnie, zakładana wartość to DefaultTimeToLive dla odpowiedniej kolejki lub tematu. Wartość timeToLive na poziomie komunikatu nie może być dłuższa niż ustawienie DefaultTimeToLive jednostki i jest ona dyskretnie dostosowywana, jeśli tak. Zobacz wygasanie.
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 opartych na regułach automatycznego przesyłania dalej, aby wskazać zamierzone logiczne miejsce docelowe komunikatu.

Szczegóły właściwości

deadLetterErrorDescription

Opis błędu dotyczący zakleszczenia komunikatu.

deadLetterErrorDescription?: string

Wartość właściwości

string

deadLetterReason

Przyczyna zakleszczenia wiadomości.

deadLetterReason?: string

Wartość właściwości

string

deadLetterSource

Nazwa kolejki lub subskrypcji, od którego ten komunikat został w kolejce, zanim został utracony. Ustawiane tylko w komunikatach, które zostały utracone, a następnie automatycznie przekazywane z kolejki podrzędnej utraconych wiadomości 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 wykonać dla tego komunikatu. Liczba jest zwiększana, gdy blokada komunikatu wygaśnie lub komunikat zostanie jawnie porzucony przy użyciu metody abandon() 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ł wcześniej przypisany do wiadomości w oryginalnym punkcie przesyłania.

enqueuedSequenceNumber?: number

Wartość właściwości

number

enqueuedTimeUtc

Czas UTC, w którym wiadomość została zaakceptowana i zapisana 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 deliveryCount jest zwiększana, a komunikat jest ponownie dostępny do pobierania.

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

lockedUntilUtc?: Date

Wartość właściwości

Date

lockToken

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

• Nie dotyczy, gdy komunikat jest odbierany w trybie odbierania receiveAndDelete. 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 partycjonowanych najważniejsze 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 obecnie obsługiwana przez język JavaScript jest 2^53 - 1. Numer sekwencji to typ Long AMQP, 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ć typu Long wyeksportowanego przez tę bibliotekę.

sequenceNumber?: Long

Wartość właściwości

Long

state

Stan komunikatu może być aktywny, odroczony lub zaplanowany. Odroczone komunikaty mają stan odroczony, 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 odbieraca 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 zServiceBusMessage.body

contentType

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

contentType?: string

Wartość właściwości

string

dziedziczone zServiceBusMessage.contentType

correlationId

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

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, nie są dozwolone.

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 partycjonowanych jednostekustawienie 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ę właściwość sessionId 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żenia ś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 się wysłania odpowiedzi. Zobacz Routing komunikatów i korelacja.

replyTo?: string

Wartość właściwości

string

dziedziczone zServiceBusMessage.replyTo

replyToSessionId

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

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 on 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 jest "subject".

subject?: string

Wartość właściwości

string

dziedziczone zServiceBusMessage.subject

timeToLive

Czas wygaśnięcia wiadomości. Ta wartość jest względnym czasem trwania, po upływie którego komunikat wygaśnie, począwszy od momentu zaakceptowania i przechowywania komunikatu przez brokera, jak przechwycono w enqueuedTimeUtc. Jeśli nie ustawiono jawnie, zakładana wartość to DefaultTimeToLive dla odpowiedniej kolejki lub tematu. Wartość timeToLive na poziomie komunikatu nie może być dłuższa niż ustawienie DefaultTimeToLive jednostki i jest ona dyskretnie dostosowywana, jeśli tak. Zobacz wygasanie.

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 opartych na regułach automatycznego przesyłania dalej, aby wskazać zamierzone logiczne miejsce docelowe komunikatu.

to?: string

Wartość właściwości

string

dziedziczone zServiceBusMessage.to