Package Classes (1.11.1)

Summary of entries of Classes for pubsublite.

Classes

AdminClient

An admin client for Pub/Sub Lite. Only operates on a single region.

AsyncPublisherClient

An AsyncPublisherClient publishes messages similar to Google Pub/Sub, but must be used in an async context. Any publish failures are unlikely to succeed if retried.

Must be used in an async with block or have aenter() awaited before use.

PublisherClient

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.

AsyncSubscriberClient

An AsyncSubscriberClient reads messages similar to Google Pub/Sub, but must be used in an async context. Any subscribe failures are unlikely to succeed if retried.

Must be used in an async with block or have aenter() awaited before use.

SubscriberClient

A SubscriberClient reads messages similar to Google Pub/Sub. Any subscribe failures are unlikely to succeed if retried.

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

BacklogLocation

A location with respect to the message backlog. BEGINNING refers to the location of the oldest retained message. END refers to the location past all currently published messages, skipping the entire message backlog.

CloudRegion

CloudRegion(name,)

CloudZone

CloudZone(region, zone_id)

EventTime

A user-defined event timestamp of a message.

FlowControlSettings

FlowControlSettings(messages_outstanding, bytes_outstanding)

LocationPath

LocationPath(project, location)

MessageMetadata

Information about a message in Pub/Sub Lite.

Partition

Partition(value,)

PublishTime

The publish timestamp of a message.

ReservationPath

ReservationPath(project, location, name)

SubscriptionPath

SubscriptionPath(project, location, name)

TopicPath

TopicPath(project, location, name)

Cursor

A cursor that describes the position of a message within a topic partition.

Subscription

Metadata about a subscription resource.

DeliveryConfig

The settings for a subscription's message delivery.

DeliveryRequirement

When this subscription should send messages to subscribers relative to messages persistence in storage. For details, see Creating Lite subscriptions <https://cloud.google.com/pubsub/lite/docs/subscriptions#creating_lite_subscriptions>__.

Topic

Metadata about a topic resource.

PartitionConfig

The settings for a topic's partitions.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Capacity

The throughput capacity configuration for each partition.

ReservationConfig

The settings for this topic's Reservation usage.

RetentionConfig

The settings for a topic's message retention.

Modules

admin_client

API documentation for pubsublite.admin_client module.

publisher_client

API documentation for pubsublite.cloudpubsub.publisher_client module.

subscriber_client

API documentation for pubsublite.cloudpubsub.subscriber_client module.