Class PublisherClient (1.11.0)

PublisherClient(
    *,
    per_partition_batching_settings: typing.Optional[
        google.cloud.pubsub_v1.types.BatchSettings
    ] = None,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: str = "grpc_asyncio",
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
    enable_idempotence: bool = False
)

A PublisherClient publishes messages similar to Google Pub/Sub. Any publish failures are unlikely to succeed if retried.

Must be used in a with block or have enter() called before use.

Methods

PublisherClient

PublisherClient(
    *,
    per_partition_batching_settings: typing.Optional[
        google.cloud.pubsub_v1.types.BatchSettings
    ] = None,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: str = "grpc_asyncio",
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
    enable_idempotence: bool = False
)

Create a new PublisherClient.

enter

__enter__()

Return self upon entering the runtime context.

exit

__exit__(exc_type, exc_value, traceback)

Raise any exception triggered within the runtime context.

publish

publish(
    topic: typing.Union[google.cloud.pubsublite.types.paths.TopicPath, str],
    data: bytes,
    ordering_key: str = "",
    **attrs: typing.Mapping[str, str]
) -> concurrent.futures._base.Future[str]

Publish a message.

Parameters
Name	Description
`topic`	`typing.Union[google.cloud.pubsublite.types.paths.TopicPath, str]` The topic to publish to. Publishes to new topics may have nontrivial startup latency.
`data`	`bytes` The bytestring payload of the message
`ordering_key`	`str` The key to enforce ordering on, or "" for no ordering.

Exceptions
Type	Description
`GoogleApiCallError`	On a permanent failure.