pubsub.subscriber_client

Attributes

SCOPES

Classes

SubscriberClient

Functions

init_api_root(api_root)

Module Contents

pubsub.subscriber_client.SCOPES = ['https://www.googleapis.com/auth/pubsub']
pubsub.subscriber_client.init_api_root(api_root)
Parameters:

api_root (str | None)

Return type:

tuple[bool, str]

class pubsub.subscriber_client.SubscriberClient(*, service_file=None, token=None, session=None, api_root=None)
Parameters:

  • service_file (str | IO[AnyStr] | None)

  • token (gcloud.aio.auth.Token | None)

  • session (requests.Session | None)

  • api_root (str | None)

_api_root: str
_api_is_dev: bool
session
token
static project_path(project)
Parameters:

project (str)

Return type:

str

classmethod subscription_path(project, subscription)
Parameters:

  • project (str)

  • subscription (str)

Return type:

str

classmethod topic_path(project, topic)
Parameters:

  • project (str)

  • topic (str)

Return type:

str

classmethod snapshot_path(project, snapshot)
Parameters:

  • project (str)

  • snapshot (str)

Return type:

str

async _headers()
Return type:

dict[str, str]

async create_subscription(subscription, topic, body=None, *, session=None, timeout=10)

Create subscription.

Parameters:

  • subscription (str)

  • topic (str)

  • body (dict[str, Any] | None)

  • session (requests.Session | None)

  • timeout (int)

Return type:

dict[str, Any]

async patch_subscription(subscription, body, *, session=None, timeout=10)
Parameters:

  • subscription (str)

  • body (dict[str, Any])

  • session (requests.Session | None)

  • timeout (int)

Return type:

dict[str, Any]

async delete_subscription(subscription, *, session=None, timeout=10)

Delete subscription.

Parameters:

  • subscription (str)

  • session (requests.Session | None)

  • timeout (int)

Return type:

None

async pull(subscription, max_messages, *, session=None, timeout=30)

Pull messages from subscription

Parameters:

  • subscription (str)

  • max_messages (int)

  • session (requests.Session | None)

  • timeout (int)

Return type:

list[pubsub.subscriber_message.SubscriberMessage]

async acknowledge(subscription, ack_ids, *, session=None, timeout=10)

Acknowledge messages by ackIds

Parameters:

  • subscription (str)

  • ack_ids (list[str])

  • session (requests.Session | None)

  • timeout (int)

Return type:

None

async modify_ack_deadline(subscription, ack_ids, ack_deadline_seconds, *, session=None, timeout=10)

Modify messages’ ack deadline. Set ack deadline to 0 to nack messages.

Parameters:

  • subscription (str)

  • ack_ids (list[str])

  • ack_deadline_seconds (int)

  • session (requests.Session | None)

  • timeout (int)

Return type:

None

async get_subscription(subscription, *, session=None, timeout=10)

Get Subscription

Parameters:

  • subscription (str)

  • session (requests.Session | None)

  • timeout (int)

Return type:

dict[str, Any]

async list_subscriptions(project, query_params=None, *, session=None, timeout=10)

List subscriptions

Parameters:

  • project (str)

  • query_params (dict[str, str] | None)

  • session (requests.Session | None)

  • timeout (int)

Return type:

dict[str, Any]

async seek(subscription, body, *, session=None, timeout=10)

Seeks a subscription to a point in time or to a given snapshot.

Parameters:

  • subscription (str)

  • body (dict[str, Any])

  • session (requests.Session | None)

  • timeout (int)

Return type:

None

async create_snapshot(snapshot, subscription, body=None, *, session=None, timeout=10)

Create snapshot.

Parameters:

  • snapshot (str)

  • subscription (str)

  • body (dict[str, Any] | None)

  • session (requests.Session | None)

  • timeout (int)

Return type:

dict[str, Any]

async delete_snapshot(snapshot, *, session=None, timeout=10)

Delete snapshot.

Parameters:

  • snapshot (str)

  • session (requests.Session | None)

  • timeout (int)

Return type:

None

async list_snapshots(project, query_params=None, *, session=None, timeout=10)

List snapshots

Parameters:

  • project (str)

  • query_params (dict[str, str] | None)

  • session (requests.Session | None)

  • timeout (int)

Return type:

dict[str, Any]

async get_snapshot(snapshot, *, session=None, timeout=10)

Get snapshot

Parameters:

  • snapshot (str)

  • session (requests.Session | None)

  • timeout (int)

Return type:

dict[str, Any]

async close()
Return type:

None

async __aenter__()
Return type:

SubscriberClient

async __aexit__(*args)
Parameters:

args (Any)

Return type:

None