MqClient

Classes

Item dataclass

Item(item_internal_id: Optional[str] = None, message_data: Optional[str] = None, message_id: Optional[str] = None, correlation_id: Optional[str] = None, put_date_time: Optional[str] = None, user_identifier: Optional[str] = None, put_application_name: Optional[str] = None, put_application_type: Optional[str] = None, format: Optional[str] = None, accounting_token: Optional[str] = None, ccsid: Optional[int] = None, group_id: Optional[str] = None, logical_sequence_number: Optional[int] = None, message_type: Optional[str] = None, offset: Optional[int] = None, original_length: Optional[int] = None, persistence: Optional[str] = None, priority: Optional[int] = None, reply_to_queue: Optional[str] = None, reply_to_queue_manager: Optional[str] = None)

Response for Delete message

ItemsList dataclass

ItemsList(value: Optional[List[Item]] = None)

Response for Delete messages

SendResponse dataclass

SendResponse(item_internal_id: Optional[str] = None, message_data: Optional[str] = None, message_id: Optional[str] = None, correlation_id: Optional[str] = None)

Response for Send message

ProcedureMetadata dataclass

ProcedureMetadata(name: Optional[str] = None, title: Optional[str] = None, schema: Optional[ObjectEntity] = None)

Definition: ProcedureMetadata

ObjectEntity dataclass

ObjectEntity(additional_properties: Dict[str, Any] = dict())

Definition: Object

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

SingleGetValidOptions dataclass

SingleGetValidOptions(queue: Optional[str] = None, message_id: Optional[str] = None, correlation_id: Optional[str] = None, group_id: Optional[str] = None, message_token: Optional[str] = None, offset: Optional[float] = None, logical_sequence_number: Optional[float] = None, include_info: Optional[str] = None, timeout: Optional[str] = None)

Definition: SingleGetValidOptions

Attributes

queue class-attribute instance-attribute

queue: Optional[str] = field(default=None, metadata={'wire_name': 'Queue'})

When specified, overrides the queue defined in the connection.

message_id class-attribute instance-attribute

message_id: Optional[str] = field(default=None, metadata={'wire_name': 'MessageId'})

Base64 string that represents a byte array with 24 bytes.

correlation_id class-attribute instance-attribute

correlation_id: Optional[str] = field(default=None, metadata={'wire_name': 'CorrelationId'})

Base64 string that represents a byte array with 24 bytes.

group_id class-attribute instance-attribute

group_id: Optional[str] = field(default=None, metadata={'wire_name': 'GroupId'})

Base64 string that represents a byte array with 24 bytes.

message_token class-attribute instance-attribute

message_token: Optional[str] = field(default=None, metadata={'wire_name': 'MessageToken'})

Base64 string that represents a byte array with 16 bytes.

offset class-attribute instance-attribute

offset: Optional[float] = field(default=None, metadata={'wire_name': 'Offset'})

Offset in bytes of the data in the physical message from the start of the logical message.

logical_sequence_number class-attribute instance-attribute

logical_sequence_number: Optional[float] = field(default=None, metadata={'wire_name': 'LogicalSequenceNumber'})

Sequence number of a logical message within a group.

include_info class-attribute instance-attribute

include_info: Optional[str] = field(default=None, metadata={'wire_name': 'IncludeInfo'})

Indicates if additional message info should be included. Expects true or false.

timeout class-attribute instance-attribute

timeout: Optional[str] = field(default=None, metadata={'wire_name': 'Timeout'})

Wait time for a message to appear in the queue, expects an XML duration or hh:mm:ss.

MultipleGetValidOptions dataclass

MultipleGetValidOptions(queue: Optional[str] = None, message_id: Optional[str] = None, correlation_id: Optional[str] = None, group_id: Optional[str] = None, message_token: Optional[str] = None, offset: Optional[float] = None, logical_sequence_number: Optional[float] = None, include_info: Optional[str] = None, timeout: Optional[str] = None, batch_size: Optional[float] = None)

Definition: MultipleGetValidOptions

Attributes

queue class-attribute instance-attribute

queue: Optional[str] = field(default=None, metadata={'wire_name': 'Queue'})

When specified, overrides the queue defined in the connection.

message_id class-attribute instance-attribute

message_id: Optional[str] = field(default=None, metadata={'wire_name': 'MessageId'})

Base64 string that represents a byte array with 24 bytes.

correlation_id class-attribute instance-attribute

correlation_id: Optional[str] = field(default=None, metadata={'wire_name': 'CorrelationId'})

Base64 string that represents a byte array with 24 bytes.

group_id class-attribute instance-attribute

group_id: Optional[str] = field(default=None, metadata={'wire_name': 'GroupId'})

Base64 string that represents a byte array with 24 bytes.

message_token class-attribute instance-attribute

message_token: Optional[str] = field(default=None, metadata={'wire_name': 'MessageToken'})

Base64 string that represents a byte array with 16 bytes.

offset class-attribute instance-attribute

offset: Optional[float] = field(default=None, metadata={'wire_name': 'Offset'})

Offset in bytes of the data in the physical message from the start of the logical message.

logical_sequence_number class-attribute instance-attribute

logical_sequence_number: Optional[float] = field(default=None, metadata={'wire_name': 'LogicalSequenceNumber'})

Sequence number of a logical message within a group.

include_info class-attribute instance-attribute

include_info: Optional[str] = field(default=None, metadata={'wire_name': 'IncludeInfo'})

Indicates if additional message info should be included. Expects true or false.

timeout class-attribute instance-attribute

timeout: Optional[str] = field(default=None, metadata={'wire_name': 'Timeout'})

Wait time for a message to appear in the queue, expects an XML duration or hh:mm:ss.

batch_size class-attribute instance-attribute

batch_size: Optional[float] = field(default=None, metadata={'wire_name': 'BatchSize'})

Maximum number of messages to be retrieved from the queue.

SendValidDataOptions dataclass

SendValidDataOptions(queue: Optional[str] = None, message: Optional[str] = None, message_type: Optional[str] = None, correlation_id: Optional[str] = None, message_id: Optional[str] = None, reply_to_queue: Optional[str] = None, reply_to_queue_manager: Optional[str] = None, code_char_set_id: Optional[float] = None, offset: Optional[float] = None, format: Optional[str] = None)

Definition: SendValidDataOptions

Attributes

queue class-attribute instance-attribute

queue: Optional[str] = field(default=None, metadata={'wire_name': 'Queue'})

When specified, overrides the queue defined in the connection.

message class-attribute instance-attribute

message: Optional[str] = field(default=None, metadata={'wire_name': 'Message'})

Message data

message_type class-attribute instance-attribute

message_type: Optional[str] = field(default=None, metadata={'wire_name': 'MessageType'})

Message type

correlation_id class-attribute instance-attribute

correlation_id: Optional[str] = field(default=None, metadata={'wire_name': 'CorrelationId'})

Base64 string that represents a byte array with 24 bytes.

message_id class-attribute instance-attribute

message_id: Optional[str] = field(default=None, metadata={'wire_name': 'MessageId'})

Base64 string that represents a byte array with 24 bytes.

reply_to_queue class-attribute instance-attribute

reply_to_queue: Optional[str] = field(default=None, metadata={'wire_name': 'ReplyToQueue'})

Reply-to queue

reply_to_queue_manager class-attribute instance-attribute

reply_to_queue_manager: Optional[str] = field(default=None, metadata={'wire_name': 'ReplyToQueueManager'})

Reply-to queue manager

code_char_set_id class-attribute instance-attribute

code_char_set_id: Optional[float] = field(default=None, metadata={'wire_name': 'CodeCharSetId'})

Character set for the message.

offset class-attribute instance-attribute

offset: Optional[float] = field(default=None, metadata={'wire_name': 'Offset'})

Offset in bytes of the data in the physical message from the start of the logical message.

format class-attribute instance-attribute

format: Optional[str] = field(default=None, metadata={'wire_name': 'Format'})

Format field for the message.

SendValidDataOptionsArray dataclass

SendValidDataOptionsArray(messages: Optional[List[SendValidDataOptions]] = None)

Definition: SendValidDataOptionsArray

MqClient

MqClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for mq connector.

Initialize a MqClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

delete_async async

delete_async(input: SingleGetValidOptions) -> dict[str, Any] | None

Delete message

Deletes one message from the queue, by doing a destructive get.

delete_all_async async

delete_all_async(input: MultipleGetValidOptions) -> dict[str, Any] | None

Delete messages

Deletes messages from the queue, by doing a destructive get.

read_async async

read_async(input: SingleGetValidOptions) -> dict[str, Any] | None

Browse message

Browse one message from the queue.

read_all_async async

read_all_async(input: MultipleGetValidOptions) -> dict[str, Any] | None

Browse messages

Browse messages in a queue.

receive_async async

receive_async(input: SingleGetValidOptions) -> dict[str, Any] | None

Receive message

Returns one message from the queue, by doing a destructive get.

receive_all_async async

receive_all_async(input: MultipleGetValidOptions) -> dict[str, Any] | None

Receive messages

Returns messages from the queue, by doing a destructive get.

send_async async

send_async(input: SendValidDataOptions) -> dict[str, Any] | None

Send message

Send a message to a queue.