ServiceBusReceivedMessage Klasa

Komunikat usługi Service Bus odebrany po stronie usługi.

Dziedziczenie

azure.servicebus._common.message.ServiceBusMessage

ServiceBusReceivedMessage

Konstruktor

ServiceBusReceivedMessage(message: 'Message' | 'pyamqp_Message', receive_mode: ServiceBusReceiveMode | str = ServiceBusReceiveMode.PEEK_LOCK, frame: 'TransferFrame' | None = None, **kwargs: Any)

Parametry

Nazwa	Opis
message Wymagane
receive_mode	Domyślna wartość: ServiceBusReceiveMode.PEEK_LOCK
frame	Domyślna wartość: None

Przykłady

Sprawdzanie właściwości odebranego komunikatu.

       from typing import List
       from azure.servicebus import ServiceBusReceivedMessage

       messages_complex: List[ServiceBusReceivedMessage] = servicebus_receiver.receive_messages(max_wait_time=5)
       for message in messages_complex:
           print("Receiving: {}".format(message))
           print("Time to live: {}".format(message.time_to_live))
           print("Sequence number: {}".format(message.sequence_number))
           print("Enqueued Sequence number: {}".format(message.enqueued_sequence_number))
           print("Partition Key: {}".format(message.partition_key))
           print("Application Properties: {}".format(message.application_properties))
           print("Delivery count: {}".format(message.delivery_count))
           print("Message ID: {}".format(message.message_id))
           print("Locked until: {}".format(message.locked_until_utc))
           print("Lock Token: {}".format(message.lock_token))
           print("Enqueued time: {}".format(message.enqueued_time_utc))

Zmienne

Nazwa	Opis
auto_renew_error	<xref:azure.servicebus.AutoLockRenewTimeout> lub <xref:azure.servicebus.AutoLockRenewFailed> Błąd podczas użycia funkcji AutoLockRenewer i nie można odnowić blokady komunikatu.

Atrybuty

application_properties

Właściwości zdefiniowane przez użytkownika w komunikacie.

Zwraca

Typ	Opis
dict[str, bytes, <xref:PrimitiveTypes>], None

body

Treść wiadomości. Format może się różnić w zależności od typu treści: dla DATAelementu treść może być bajty lub iterowalne[bajty]. W przypadku SEQUENCEelementu treść może mieć wartość List lub Iterable[List]. W przypadku VALUEelementu treść może być dowolnym typem.

Zwraca

Typ	Opis
Any

body_type

Typ treści bazowego komunikatu AMQP.

Zwraca

Typ	Opis
AmqpMessageBodyType

content_type

Deskryptor typu zawartości.

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

Zwraca

Typ	Opis
str, None

correlation_id

Identyfikator korelacji.

Umożliwia aplikacji określenie kontekstu komunikatu na potrzeby korelacji, na przykład odzwierciedlając identyfikator MessageId komunikatu, do którego jest odpowiadana.

Zobacz Routing komunikatów i korelacja w pliku https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.

Zwraca

Typ	Opis
str, None

dead_letter_error_description

Opis błędu utraconych liter, gdy komunikat zostanie odebrany z pod kolejki nieaktywnej jednostki.

Zwraca

Typ	Opis
str

dead_letter_reason

Przyczyna martwych komunikatów, gdy wiadomość jest odbierana z podqueue deadletter jednostki.

Zwraca

Typ	Opis
str

dead_letter_source

Nazwa kolejki lub subskrypcji, w ramach którego ta wiadomość została w kolejce, zanim została utrwolona. Ta właściwość jest ustawiana tylko w komunikatach, które zostały zakleszczone, a następnie automatycznie przekazywane z kolejki utraconych wiadomości do innej jednostki. Wskazuje jednostkę, w której wiadomość została oznaczona jako martwa.

Zwraca

Typ	Opis
str

delivery_count

Liczba dostaw, które próbowano wykonać dla tego komunikatu. Liczba jest zwiększana, gdy blokada komunikatu wygaśnie lub komunikat zostanie jawnie porzucony przez odbiorcę.

Zwraca

Typ	Opis
int

enqueued_sequence_number

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 komunikatu w oryginalnym punkcie przesyłania.

Zwraca

Typ	Opis
int

enqueued_time_utc

Data/godzina UTC, w której wiadomość została zaakceptowana i zapisana w jednostce.

Zwraca

Typ	Opis
datetime

expires_at_utc

Data/godzina UTC, w której komunikat jest oznaczony do usunięcia i nie jest już dostępny do pobierania z jednostki z powodu wygaśnięcia. Wygaśnięcie jest kontrolowane przez właściwość Message.time_to_live . Ta właściwość jest obliczana z Message.enqueued_time_utc Message.time_to_live + .

Zwraca

Typ	Opis
datetime

lock_token

Token blokady dla bieżącego komunikatu obsługującego odwołanie do blokady przechowywanej przez brokera w trybie PEEK_LOCK.

Zwraca

Typ	Opis
UUID, str

locked_until_utc

Data/godzina UTC, do której komunikat zostanie zablokowany w kolejce/subskrypcji. Po wygaśnięciu blokady liczba dostarczania komunikatu jest zwiększana, a komunikat jest ponownie dostępny do pobierania.

Zwraca

Typ	Opis
datetime

message

Pobierz podstawową wiadomość LegacyMessage. Jest to przestarzałe i zostanie usunięte w nowszej wersji.

Zwraca

Typ	Opis
<xref:LegacyMessage>

message_id

Identyfikator umożliwiający zidentyfikowanie komunikatu.

Identyfikator komunikatu to wartość zdefiniowana przez aplikację, która jednoznacznie identyfikuje komunikat i jego ładunek. Identyfikator jest ciągiem bez formularza i może odzwierciedlać identyfikator GUID lub identyfikator pochodzący z kontekstu aplikacji. Jeśli ta funkcja jest włączona, funkcja wykrywania duplikatów (patrz https://docs.microsoft.com/azure/service-bus-messaging/duplicate-detection) identyfikuje i usuwa drugie i dalsze przesyłanie komunikatów o tym samym identyfikatorze komunikatu.

Zwraca

Typ	Opis
str, None

partition_key

Klucz partycji do wysyłania komunikatu do jednostki partycjonowanej.

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.

Zobacz Partycjonowane kolejki i tematy w temacie https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning.

Zwraca

Typ	Opis
str, None

raw_amqp_message

Tylko zaawansowane użycie. Wewnętrzny ładunek komunikatu AMQP, który jest wysyłany lub odbierany. :rtype: ~azure.servicebus.amqp.AmqpAnnotatedMessage

reply_to

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 się wysłania odpowiedzi.

Zobacz Routing komunikatów i korelacja w pliku https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.

Zwraca

Typ	Opis
str, None

reply_to_session_id

Identyfikator sesji powiększający adres reply_to .

Ta wartość rozszerza informacje reply_to i określa, który identyfikator sesji powinien być ustawiony dla odpowiedzi po wysłaniu do jednostki odpowiedzi.

Zobacz Routing komunikatów i korelacja w pliku https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.

Zwraca

Typ	Opis
str, None

scheduled_enqueue_time_utc

Zaplanowany czas kolejkowania utc do wiadomości.

Ta właściwość może służyć do planowania podczas wysyłania komunikatu za pośrednictwem metody ServiceBusSender.send . Jeśli wymagane jest anulowanie zaplanowanych komunikatów, należy użyć metody ServiceBusSender.schedule , która zwraca numery sekwencji, które mogą być używane do przyszłego anulowania. scheduled_enqueue_time_utc ma wartość Brak, jeśli nie zostanie ustawiona.

Zwraca

Typ	Opis
datetime

sequence_number

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 i działa jako prawdziwy identyfikator. W przypadku jednostek podzielonych na partycje najważniejsze 16 bitów odzwierciedlają identyfikator partycji. Liczba sekwencji monotonicznie zwiększa się. Są one przerzucane do 0, gdy zakres 48-64 bitów jest wyczerpany.

Zwraca

Typ	Opis
int

session_id

Identyfikator sesji komunikatu dla jednostki sesji.

W przypadku jednostek sesji ta wartość zdefiniowana przez aplikację określa przynależność sesji do komunikatu. Komunikaty z tym samym identyfikatorem sesji podlegają blokadzie podsumowania i umożliwiają dokładne przetwarzanie w kolejności i demultiplexing. W przypadku jednostek innych niż sesja ta wartość jest ignorowana.

Zobacz Sesje komunikatów w programie https://docs.microsoft.com/azure/service-bus-messaging/message-sessions.

Zwraca

Typ	Opis
str, None

state

Wartość domyślna to Aktywna. Reprezentuje stan komunikatu komunikatu. Może być aktywny, odroczony. lub Zaplanowane.

Zwraca

Typ	Opis
ServiceBusMessageState

subject

Temat specyficzny dla aplikacji, czasami określany jako etykieta.

Ta właściwość umożliwia aplikacji wskazanie przeznaczenia wiadomości odbiorcy w ustandaryzowany sposób, podobnie jak w wierszu tematu wiadomości e-mail.

Zwraca

Typ	Opis
str

time_to_live

Czas trwania 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 enqueued_time_utc. Jeśli nie ustawiono jawnie, zakładana wartość to DefaultTimeToLive dla odpowiedniej kolejki lub tematu. Wartość czasu wygaśnięcia na poziomie komunikatu nie może być dłuższa niż ustawienie czasu wygaśnięcia jednostki i jest ona w trybie dyskretnym dostosowywana, jeśli tak się stanie.

Zobacz Wygaśnięcie w https://docs.microsoft.com/azure/service-bus-messaging/message-expiration

Zwraca

Typ	Opis
timedelta

to

Adres do .

Ta właściwość jest zarezerwowana do przyszłego użycia w scenariuszach routingu i obecnie ignorowana przez samego brokera. Aplikacje mogą używać tej wartości w scenariuszach automatycznego przesyłania dalej opartego na regułach, aby wskazać zamierzone logiczne miejsce docelowe komunikatu.

Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/service-bus-messaging/service-bus-auto-forwarding .

Zwraca

Typ	Opis
str, None