MqClient

Classes

Item dataclass

Item(message_data: str, *, item_internal_id: 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 | Mapping[str, Any]]] = 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 | Mapping[str, Any]] = 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] = dataclass_field(default_factory=dict, kw_only=True)

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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Queue'})

When specified, overrides the queue defined in the connection.

message_id class-attribute instance-attribute

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

Base64 string that represents a byte array with 24 bytes.

correlation_id class-attribute instance-attribute

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

Base64 string that represents a byte array with 24 bytes.

group_id class-attribute instance-attribute

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

Base64 string that represents a byte array with 24 bytes.

message_token class-attribute instance-attribute

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

Base64 string that represents a byte array with 16 bytes.

offset class-attribute instance-attribute

offset: Optional[float] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LogicalSequenceNumber'})

Sequence number of a logical message within a group.

include_info class-attribute instance-attribute

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

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

timeout class-attribute instance-attribute

timeout: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Queue'})

When specified, overrides the queue defined in the connection.

message_id class-attribute instance-attribute

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

Base64 string that represents a byte array with 24 bytes.

correlation_id class-attribute instance-attribute

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

Base64 string that represents a byte array with 24 bytes.

group_id class-attribute instance-attribute

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

Base64 string that represents a byte array with 24 bytes.

message_token class-attribute instance-attribute

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

Base64 string that represents a byte array with 16 bytes.

offset class-attribute instance-attribute

offset: Optional[float] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LogicalSequenceNumber'})

Sequence number of a logical message within a group.

include_info class-attribute instance-attribute

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

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

timeout class-attribute instance-attribute

timeout: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BatchSize'})

Maximum number of messages to be retrieved from the queue.

SendValidDataOptions dataclass

SendValidDataOptions(message: str, *, queue: 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Queue'})

When specified, overrides the queue defined in the connection.

message class-attribute instance-attribute

message: str = dataclass_field(metadata={'wire_name': 'Message'})

Message data

message_type class-attribute instance-attribute

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

Message type

correlation_id class-attribute instance-attribute

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

Base64 string that represents a byte array with 24 bytes.

message_id class-attribute instance-attribute

message_id: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReplyToQueue'})

Reply-to queue

reply_to_queue_manager class-attribute instance-attribute

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

Reply-to queue manager

code_char_set_id class-attribute instance-attribute

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

Character set for the message.

offset class-attribute instance-attribute

offset: Optional[float] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Format'})

Format field for the message.

SendValidDataOptionsArray dataclass

SendValidDataOptionsArray(messages: List[SendValidDataOptions | Mapping[str, Any]])

Definition: SendValidDataOptionsArray

MqClient

MqClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

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
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

delete async

delete(input: SingleGetValidOptions | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Delete message

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

Swagger operation ID: DeleteV2.

Parameters:

Name	Type	Description	Default
input	SingleGetValidOptions | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

delete_all async

delete_all(input: MultipleGetValidOptions | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Delete messages

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

Swagger operation ID: DeleteAllV2.

Parameters:

Name	Type	Description	Default
input	MultipleGetValidOptions | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

read async

read(input: SingleGetValidOptions | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Browse message

Browse one message from the queue.

Swagger operation ID: ReadV2.

Parameters:

Name	Type	Description	Default
input	SingleGetValidOptions | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

read_all async

read_all(input: MultipleGetValidOptions | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Browse messages

Browse messages in a queue.

Swagger operation ID: ReadAllV2.

Parameters:

Name	Type	Description	Default
input	MultipleGetValidOptions | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

receive async

receive(input: SingleGetValidOptions | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Receive message

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

Swagger operation ID: ReceiveV2.

Parameters:

Name	Type	Description	Default
input	SingleGetValidOptions | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

receive_all async

receive_all(input: MultipleGetValidOptions | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Receive messages

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

Swagger operation ID: ReceiveAllV2.

Parameters:

Name	Type	Description	Default
input	MultipleGetValidOptions | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

send async

send(input: SendValidDataOptions | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Send message

Send a message to a queue.

Swagger operation ID: SendV2.

Parameters:

Name	Type	Description	Default
input	SendValidDataOptions | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.