PublisherOptions(enable_message_ordering: bool = False, flow_control: google.cloud.pubsub_v1.types.PublishFlowControl = PublishFlowControl(message_limit=1000, byte_limit=10000000, limit_exceeded_behavior=<LimitExceededBehavior.IGNORE: 'ignore'>), retry: OptionalRetry = _MethodDefault._DEFAULT_VALUE, timeout: OptionalTimeout = _MethodDefault._DEFAULT_VALUE)
The options for the publisher client.
Attributes | |
---|---|
Name | Description |
enable_message_ordering
:noindex: |
bool
Whether to order messages in a batch by a supplied ordering key. Defaults to false. |
flow_control
:noindex: |
PublishFlowControl
Flow control settings for message publishing by the client. By default the publisher client does not do any throttling. |
retry
:noindex: |
OptionalRetry
Retry settings for message publishing by the client. This should be an instance of google.api_core.retry.Retry .
|
timeout
:noindex: |
OptionalTimeout
Timeout settings for message publishing by the client. It should be compatible with .pubsub_v1.types.TimeoutType .
|
Methods
PublisherOptions
PublisherOptions(enable_message_ordering: bool = False, flow_control: google.cloud.pubsub_v1.types.PublishFlowControl = PublishFlowControl(message_limit=1000, byte_limit=10000000, limit_exceeded_behavior=<LimitExceededBehavior.IGNORE: 'ignore'>), retry: OptionalRetry = _MethodDefault._DEFAULT_VALUE, timeout: OptionalTimeout = _MethodDefault._DEFAULT_VALUE)
Create new instance of PublisherOptions(enable_message_ordering, flow_control, retry, timeout)