ServiceBusMessage interface

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

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

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

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

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

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

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

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

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

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

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

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

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