Compartilhar via

ServiceBusMessage Classe

  • Referência

Uma mensagem do Barramento de Serviço.

Herança
builtins.object
ServiceBusMessage

Construtor

ServiceBusMessage(body: str | bytes | None, *, application_properties: Dict[str | bytes, int | float | bytes | bool | str | UUID] | None = None, session_id: str | None = None, message_id: str | None = None, scheduled_enqueue_time_utc: datetime | None = None, time_to_live: timedelta | None = None, content_type: str | None = None, correlation_id: str | None = None, subject: str | None = None, partition_key: str | None = None, to: str | None = None, reply_to: str | None = None, reply_to_session_id: str | None = None, **kwargs: Any)

Parâmetros

body
Optional[Union[str, bytes]]
Obrigatório

Os dados a serem enviados em uma única mensagem.

application_properties
Dict[str, Union[int ou float ou bool ou bytes ou str ou UUID ou datetime ou None]]

As propriedades definidas pelo usuário na mensagem.

session_id
Optional[str]

O identificador de sessão da mensagem para uma entidade com sessão.

message_id
Optional[str]

A ID para identificar a mensagem.

scheduled_enqueue_time_utc
Optional[datetime]

O horário de enfileiramento agendado utc para a mensagem.

time_to_live
Optional[timedelta]

A duração da vida útil de uma mensagem.

content_type
Optional[str]

O descritor de tipo de conteúdo.

correlation_id
Optional[str]

O identificador de correlação.

subject
Optional[str]

O assunto específico do aplicativo, às vezes chamado de rótulo.

partition_key
Optional[str]

A chave de partição para enviar uma mensagem para uma entidade particionada.

to
Optional[str]

O a ser endereçado usado para auto_forward cenários de encadeamento.

reply_to
Optional[str]

O endereço de uma entidade para a qual enviar respostas.

reply_to_session_id
Optional[str]

O identificador de sessão que aumenta o endereço reply_to .

Exemplos

Enviando uma mensagem com propriedades adicionais


   message_send = ServiceBusMessage(
       "Hello World!!",
       session_id="MySessionID",
       application_properties={'data': 'custom_data'},
       time_to_live=datetime.timedelta(seconds=30),
       label='MyLabel'
   )

Atributos

application_properties

As propriedades definidas pelo usuário na mensagem.

Tipo de retorno

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

body

O corpo da Mensagem. O formato pode variar dependendo do tipo de corpo: para DATA, o corpo pode ser bytes ou Iterable[bytes]. Para SEQUENCE, o corpo pode ser List ou Iterable[List]. Para VALUE, o corpo pode ser qualquer tipo.

Tipo de retorno

Any

body_type

O tipo de corpo da mensagem AMQP subjacente.

Tipo de retorno

AmqpMessageBodyType

content_type

O descritor de tipo de conteúdo.

Opcionalmente, descreve o conteúdo da mensagem, com um descritor seguindo o formato de RFC2045, Seção 5, por exemplo , "application/json".

Tipo de retorno

str,
None

correlation_id

O identificador de correlação.

Permite que um aplicativo especifique um contexto para a mensagem para fins de correlação, por exemplo, refletindo o MessageId de uma mensagem que está sendo respondida.

Consulte Roteamento de Mensagens e Correlação em https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.

Tipo de retorno

str,
None

message

Obtenha o uamqp subjacente. Message ou LegacyMessage. Isso foi preterido e será removido em uma versão posterior.

Tipo de retorno

<xref:uamqp.Message>,
<xref:LegacyMessage>

message_id

A ID para identificar a mensagem.

O identificador da mensagem é um valor definido pelo aplicativo que identifica exclusivamente a mensagem e seu payload. O identificador é uma cadeia de caracteres de forma livre e pode refletir um GUID ou um identificador derivado do contexto do aplicativo. Se habilitado, o recurso de detecção duplicada (consulte https://docs.microsoft.com/azure/service-bus-messaging/duplicate-detection) identifica e remove o segundo e mais envios de mensagens com a mesma ID de mensagem.

Tipo de retorno

str,
None

partition_key

A chave de partição para enviar uma mensagem para uma entidade particionada.

Definir esse valor permite atribuir mensagens relacionadas à mesma partição interna, para que a ordem de sequência de envio seja registrada corretamente. A partição é escolhida por uma função de hash sobre esse valor e não pode ser escolhida diretamente.

Consulte Filas e tópicos particionados em https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning.

Tipo de retorno

str,
None

raw_amqp_message

Somente uso avançado. O conteúdo da mensagem AMQP interna que é enviado ou recebido. :rtype: ~azure.servicebus.amqp.AmqpAnnotatedMessage

reply_to

O endereço de uma entidade para a qual enviar respostas.

Esse valor opcional e definido pelo aplicativo é uma maneira padrão de expressar um caminho de resposta para o receptor da mensagem. Quando um remetente espera uma resposta, ele define o valor como o caminho absoluto ou relativo da fila ou do tópico para o qual ele espera que a resposta seja enviada.

Consulte Roteamento de Mensagens e Correlação em https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.

Tipo de retorno

str,
None

reply_to_session_id

O identificador de sessão que aumenta o endereço reply_to .

Esse valor aumenta as informações de reply_to e especifica qual ID de sessão deve ser definida para a resposta quando enviada à entidade de resposta.

Consulte Roteamento de Mensagens e Correlação em https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation.

Tipo de retorno

str,
None

scheduled_enqueue_time_utc

O horário de enfileiramento agendado utc para a mensagem.

Essa propriedade pode ser usada para agendamento ao enviar uma mensagem por meio do método ServiceBusSender.send . Se for necessário cancelar mensagens agendadas, você deverá usar o método ServiceBusSender.schedule , que retorna números de sequência que podem ser usados para cancelamento futuro. scheduled_enqueue_time_utc será Nenhum se não estiver definido.

Tipo de retorno

datetime

session_id

O identificador de sessão da mensagem para uma entidade com sessão.

Para entidades com sessão, esse valor definido pelo aplicativo especifica a afiliação de sessão da mensagem. As mensagens com o mesmo identificador de sessão estão sujeitas ao bloqueio de resumo e permitem a demultiplexação e o processamento na ordem exata. Para entidades não sessões, esse valor é ignorado.

Consulte Sessões de mensagem em https://docs.microsoft.com/azure/service-bus-messaging/message-sessions.

Tipo de retorno

str,
None

subject

O assunto específico do aplicativo, às vezes chamado de rótulo.

Essa propriedade permite que o aplicativo indique a finalidade da mensagem para o destinatário de maneira padronizada, semelhante a uma linha do assunto de email.

Tipo de retorno

str

time_to_live

A duração da vida útil de uma mensagem.

Esse valor é a duração relativa após a qual a mensagem expira, começando a partir do instante em que a mensagem foi aceita e armazenada pelo agente, conforme capturado em enqueued_time_utc. Quando não definido explicitamente, o valor assumido será o DefaultTimeToLive para a respectiva fila ou tópico. Um valor de vida útil no nível da mensagem não pode ser maior do que a configuração de vida útil da entidade e é ajustado silenciosamente se isso acontecer.

Confira Expiração em https://docs.microsoft.com/azure/service-bus-messaging/message-expiration

Tipo de retorno

timedelta

to

O endereço a ser endereçado.

Essa propriedade é reservada para uso futuro em cenários de roteamento e é atualmente ignorada pelo próprio agente. Os aplicativos podem usar esse valor em cenários de encadeamento de encaminhamento automático orientado à regra para indicar o destino lógico pretendido da mensagem.

Consulte https://docs.microsoft.com/azure/service-bus-messaging/service-bus-auto-forwarding para obter mais detalhes.

Tipo de retorno

str,
None