Package Classes (2.31.0)

A publisher client for Google Cloud Pub/Sub.

This creates an object that is capable of publishing messages. Generally, you can instantiate this client with no arguments, and you get sensible defaults.

This future object is returned from asychronous Pub/Sub publishing calls.

Calling result will resolve the future by returning the message ID, unless an error occurs.

A subscriber client for Google Cloud Pub/Sub.

This creates an object that is capable of subscribing to messages. Generally, you can instantiate this client with no arguments, and you get sensible defaults.

This future object is for subscribe-side calls.

Calling result will resolve the future by returning the message ID, unless an error occurs.

Represents a process that asynchronously performs streaming pull and schedules messages to be processed.

This future is resolved when the process is stopped (via cancel) or if it encounters an unrecoverable error. Calling .result() will cause the calling thread to block indefinitely.

A representation of a single Pub/Sub message.

The common way to interact with .pubsub_v1.subscriber.message.Message objects is to receive them in callbacks on subscriptions; most users should never have a need to instantiate them by hand. (The exception to this is if you are implementing a custom subclass to .pubsub_v1.subscriber._consumer.Consumer.)

Abstract base class for schedulers.

Schedulers are used to schedule callbacks asynchronously.

A thread pool-based scheduler. It must not be shared across SubscriberClients.

This scheduler is useful in typical I/O-bound message processing.

Request for the Acknowledge method.

API documentation for pubsub_v1.types.AuditConfig class.

API documentation for pubsub_v1.types.AuditConfigDelta class.

API documentation for pubsub_v1.types.AuditData class.

API documentation for pubsub_v1.types.AuditLogConfig class.

The settings for batch publishing the messages.

Configuration for a BigQuery subscription.

Possible states for a BigQuery subscription.

    -  Pub/Sub SA has not been granted the `appropriate BigQuery
       IAM
       permissions <https://cloud.google.com/pubsub/docs/create-subscription#assign_bigquery_service_account>`__
    -  bigquery.googleapis.com API is not enabled for the
       project
       (`instructions <https://cloud.google.com/service-usage/docs/enable-disable>`__)
NOT_FOUND (3):
    Cannot write to the BigQuery table because it
    does not exist.
SCHEMA_MISMATCH (4):
    Cannot write to the BigQuery table due to a
    schema mismatch.
IN_TRANSIT_LOCATION_RESTRICTION (5):
    Cannot write to the destination because enforce_in_transit
    is set to true and the destination locations are not in the
    allowed regions.

API documentation for pubsub_v1.types.Binding class.

API documentation for pubsub_v1.types.BindingDelta class.

Configuration for a Cloud Storage subscription.

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

Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary.

Possible states for a Cloud Storage subscription.

Configuration for writing message data in text format. Message payloads will be written to files as raw text, separated by a newline.

Request for the CreateSnapshot method.

The abstract base class for a message.

API documentation for pubsub_v1.types.CustomHttpPattern class.

Dead lettering is done on a best effort basis. The same message might be dead lettered multiple times.

If validation on any of the fields fails at subscription creation/updation, the create/update subscription request will fail.

Request for the DeleteSnapshot method.

Request for the DeleteSubscription method.

Request for the DeleteTopic method.

API documentation for pubsub_v1.types.DescriptorProto class.

API documentation for pubsub_v1.types.DescriptorProto.ExtensionRange class.

API documentation for pubsub_v1.types.DescriptorProto.ReservedRange class.

Request for the DetachSubscription method.

Response for the DetachSubscription method. Reserved for future use.

API documentation for pubsub_v1.types.Duration class.

API documentation for pubsub_v1.types.Empty class.

API documentation for pubsub_v1.types.EnumDescriptorProto class.

API documentation for pubsub_v1.types.EnumDescriptorProto.EnumReservedRange class.

API documentation for pubsub_v1.types.EnumOptions class.

API documentation for pubsub_v1.types.EnumValueDescriptorProto class.

API documentation for pubsub_v1.types.EnumValueOptions class.

A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).

API documentation for pubsub_v1.types.ExtensionRangeOptions class.

API documentation for pubsub_v1.types.ExtensionRangeOptions.Declaration class.

API documentation for pubsub_v1.types.FeatureSet class.

API documentation for pubsub_v1.types.FeatureSet.VisibilityFeature class.

API documentation for pubsub_v1.types.FeatureSetDefaults class.

API documentation for pubsub_v1.types.FeatureSetDefaults.FeatureSetEditionDefault class.

API documentation for pubsub_v1.types.FieldDescriptorProto class.

API documentation for pubsub_v1.types.FieldMask class.

API documentation for pubsub_v1.types.FieldOptions class.

API documentation for pubsub_v1.types.FieldOptions.EditionDefault class.

API documentation for pubsub_v1.types.FieldOptions.FeatureSupport class.

API documentation for pubsub_v1.types.FileDescriptorProto class.

API documentation for pubsub_v1.types.FileDescriptorSet class.

API documentation for pubsub_v1.types.FileOptions class.

The settings for controlling the rate at which messages are pulled with an asynchronous subscription.

API documentation for pubsub_v1.types.GeneratedCodeInfo class.

API documentation for pubsub_v1.types.GeneratedCodeInfo.Annotation class.

API documentation for pubsub_v1.types.GetIamPolicyRequest class.

Request for the GetSnapshot method.

Request for the GetSubscription method.

Request for the GetTopic method.

API documentation for pubsub_v1.types.Http class.

API documentation for pubsub_v1.types.HttpRule class.

Settings for an ingestion data source on a topic.

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

Ingestion settings for Amazon Kinesis Data Streams.

Possible states for ingestion from Amazon Kinesis Data Streams.

    -  The provided `aws_role_arn` does not exist or does not
       have the appropriate permissions attached.
    -  The provided `aws_role_arn` is not set up properly for
       Identity Federation using `gcp_service_account`.
    -  The Pub/Sub SA is not granted the
       `iam.serviceAccounts.getOpenIdToken` permission on
       `gcp_service_account`.
PUBLISH_PERMISSION_DENIED (3):
    Permission denied encountered while publishing to the topic.
    This can happen if the Pub/Sub SA has not been granted the
    `appropriate publish
    permissions <https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher>`__
STREAM_NOT_FOUND (4):
    The Kinesis stream does not exist.
CONSUMER_NOT_FOUND (5):
    The Kinesis consumer does not exist.

Ingestion settings for Amazon MSK.

Possible states for managed ingestion from Amazon MSK.

Ingestion settings for Azure Event Hubs.

Possible states for managed ingestion from Event Hubs.

Ingestion settings for Cloud Storage.

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

Configuration for reading Cloud Storage data in Avro binary format. The bytes of each object will be set to the data field of a Pub/Sub message.

Configuration for reading Cloud Storage data written via Cloud Storage subscriptions <https://cloud.google.com/pubsub/docs/cloudstorage>__. The data and attributes fields of the originally exported Pub/Sub message will be restored when publishing.

Possible states for ingestion from Cloud Storage.

    -  storage.objects.list: to list the objects in a bucket.
    -  storage.objects.get: to read the objects in a bucket.
    -  storage.buckets.get: to verify the bucket exists.
PUBLISH_PERMISSION_DENIED (3):
    Permission denied encountered while publishing to the topic.
    This can happen if the Pub/Sub SA has not been granted the
    `appropriate publish
    permissions <https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher>`__
BUCKET_NOT_FOUND (4):
    The provided Cloud Storage bucket doesn't
    exist.
TOO_MANY_OBJECTS (5):
    The Cloud Storage bucket has too many
    objects, ingestion will be paused.

Configuration for reading Cloud Storage data in text format. Each line of text as specified by the delimiter will be set to the data field of a Pub/Sub message.

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

Ingestion settings for Confluent Cloud.

Possible states for managed ingestion from Confluent Cloud.

Payload of the Platform Log entry sent when a failure is encountered while ingesting.

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

Specifies the reason why some data may have been left out of the desired Pub/Sub message due to the API message limits (https://cloud.google.com/pubsub/quotas#resource_limits). For example, when the number of attributes is larger than 100, the number of attributes is truncated to 100 to respect the limit on the attribute count. Other attribute limits are treated similarly. When the size of the desired message would've been larger than 10MB, the message won't be published at all, and ingestion of the subsequent messages will proceed as normal.

Set when an Avro file is unsupported or its format is not valid. When this occurs, one or more Avro objects won't be ingested.

Failure when ingesting from an AWS Kinesis source.

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

Failure when ingesting from an Amazon MSK source.

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

Failure when ingesting from an Azure Event Hubs source.

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

Failure when ingesting from a Cloud Storage source.

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

Failure when ingesting from a Confluent Cloud source.

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

Set when a Pub/Sub message fails to get published due to a message transformation error.

Set when a Pub/Sub message fails to get published due to a schema validation violation.

User-defined JavaScript function that can transform or filter a Pub/Sub message.

The possible actions when exceeding the publish flow control limits.

Request for the ListSnapshots method.

Response for the ListSnapshots method.

Request for the ListSubscriptions method.

Response for the ListSubscriptions method.

Request for the ListTopicSnapshots method.

Response for the ListTopicSnapshots method.

Request for the ListTopicSubscriptions method.

Response for the ListTopicSubscriptions method.

Request for the ListTopics method.

Response for the ListTopics method.

API documentation for pubsub_v1.types.MessageOptions class.

A policy constraining the storage of messages published to the topic.

All supported message transforms types.

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

API documentation for pubsub_v1.types.MethodDescriptorProto class.

API documentation for pubsub_v1.types.MethodOptions class.

Request for the ModifyAckDeadline method.

Request for the ModifyPushConfig method.

API documentation for pubsub_v1.types.OneofDescriptorProto class.

API documentation for pubsub_v1.types.OneofOptions class.

Settings for Platform Logs produced by Pub/Sub.

Severity levels of Platform Logs.

API documentation for pubsub_v1.types.Policy class.

API documentation for pubsub_v1.types.PolicyDelta class.

The client flow control settings for message publishing.

Request for the Publish method.

Response for the Publish method.

The options for the publisher client.

A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding client library documentation <https://cloud.google.com/pubsub/docs/reference/libraries>__ for more information. See quotas and limits for more information about message limits.

The abstract base class for a message.

Request for the Pull method.

Response for the Pull method.

Configuration for a push delivery endpoint.

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

The abstract base class for a message.

Sets the data field as the HTTP body for delivery.

Contains information needed for generating an OpenID Connect token <https://developers.google.com/identity/protocols/OpenIDConnect>__.

The payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).

A message and its corresponding acknowledgment ID.

A policy that specifies how Pub/Sub retries message delivery.

Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff.

RetryPolicy will be triggered on NACKs or acknowledgment deadline exceeded events for a given message.

Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.

Settings for validating messages published against a schema.

Request for the Seek method.

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

Response for the Seek method (this response is empty).

API documentation for pubsub_v1.types.ServiceDescriptorProto class.

API documentation for pubsub_v1.types.ServiceOptions class.

API documentation for pubsub_v1.types.SetIamPolicyRequest class.

A snapshot resource. Snapshots are used in Seek <https://cloud.google.com/pubsub/docs/replay-overview>__ operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

The abstract base class for a message.

API documentation for pubsub_v1.types.SourceCodeInfo class.

API documentation for pubsub_v1.types.SourceCodeInfo.Location class.

Request for the StreamingPull streaming RPC method. This request is used to establish the initial stream as well as to stream acknowledgments and ack deadline modifications from the client to the server.

Response for the StreamingPull method. This response is used to stream messages from the server to the client.

Acknowledgment IDs sent in one or more previous requests to acknowledge a previously received message.

Acknowledgment IDs sent in one or more previous requests to modify the deadline for a specific message.

Subscription properties sent as part of the response.

A subscription resource. If none of push_config, bigquery_config, or cloud_storage_config is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set.

Information about an associated Analytics Hub subscription <https://cloud.google.com/bigquery/docs/analytics-hub-manage-subscriptions>__.

The abstract base class for a message.

Possible states for a subscription.

API documentation for pubsub_v1.types.TestIamPermissionsRequest class.

API documentation for pubsub_v1.types.TestIamPermissionsResponse class.

API documentation for pubsub_v1.types.Timestamp class.

A topic resource.

The abstract base class for a message.

The state of the topic.

API documentation for pubsub_v1.types.UninterpretedOption class.

API documentation for pubsub_v1.types.UninterpretedOption.NamePart class.

Request for the UpdateSnapshot method.

Request for the UpdateSubscription method.

Request for the UpdateTopic method.

A pager for iterating through list_topic_snapshots requests.

This class thinly wraps an initial google.pubsub_v1.types.ListTopicSnapshotsResponse object, and provides an __aiter__ method to iterate through its snapshots field.

If there are more pages, the __aiter__ method will make additional ListTopicSnapshots requests and continue to iterate through the snapshots field on the corresponding responses.

All the usual google.pubsub_v1.types.ListTopicSnapshotsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_topic_snapshots requests.

This class thinly wraps an initial google.pubsub_v1.types.ListTopicSnapshotsResponse object, and provides an __iter__ method to iterate through its snapshots field.

If there are more pages, the __iter__ method will make additional ListTopicSnapshots requests and continue to iterate through the snapshots field on the corresponding responses.

All the usual google.pubsub_v1.types.ListTopicSnapshotsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_topic_subscriptions requests.

This class thinly wraps an initial google.pubsub_v1.types.ListTopicSubscriptionsResponse object, and provides an __aiter__ method to iterate through its subscriptions field.

If there are more pages, the __aiter__ method will make additional ListTopicSubscriptions requests and continue to iterate through the subscriptions field on the corresponding responses.

All the usual google.pubsub_v1.types.ListTopicSubscriptionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_topic_subscriptions requests.

This class thinly wraps an initial google.pubsub_v1.types.ListTopicSubscriptionsResponse object, and provides an __iter__ method to iterate through its subscriptions field.

If there are more pages, the __iter__ method will make additional ListTopicSubscriptions requests and continue to iterate through the subscriptions field on the corresponding responses.

All the usual google.pubsub_v1.types.ListTopicSubscriptionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_topics requests.

This class thinly wraps an initial google.pubsub_v1.types.ListTopicsResponse object, and provides an __aiter__ method to iterate through its topics field.

If there are more pages, the __aiter__ method will make additional ListTopics requests and continue to iterate through the topics field on the corresponding responses.

All the usual google.pubsub_v1.types.ListTopicsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_topics requests.

This class thinly wraps an initial google.pubsub_v1.types.ListTopicsResponse object, and provides an __iter__ method to iterate through its topics field.

If there are more pages, the __iter__ method will make additional ListTopics requests and continue to iterate through the topics field on the corresponding responses.

All the usual google.pubsub_v1.types.ListTopicsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_snapshots requests.

This class thinly wraps an initial google.pubsub_v1.types.ListSnapshotsResponse object, and provides an __aiter__ method to iterate through its snapshots field.

If there are more pages, the __aiter__ method will make additional ListSnapshots requests and continue to iterate through the snapshots field on the corresponding responses.

All the usual google.pubsub_v1.types.ListSnapshotsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_snapshots requests.

This class thinly wraps an initial google.pubsub_v1.types.ListSnapshotsResponse object, and provides an __iter__ method to iterate through its snapshots field.

If there are more pages, the __iter__ method will make additional ListSnapshots requests and continue to iterate through the snapshots field on the corresponding responses.

All the usual google.pubsub_v1.types.ListSnapshotsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_subscriptions requests.

This class thinly wraps an initial google.pubsub_v1.types.ListSubscriptionsResponse object, and provides an __aiter__ method to iterate through its subscriptions field.

If there are more pages, the __aiter__ method will make additional ListSubscriptions requests and continue to iterate through the subscriptions field on the corresponding responses.

All the usual google.pubsub_v1.types.ListSubscriptionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_subscriptions requests.

This class thinly wraps an initial google.pubsub_v1.types.ListSubscriptionsResponse object, and provides an __iter__ method to iterate through its subscriptions field.

If there are more pages, the __iter__ method will make additional ListSubscriptions requests and continue to iterate through the subscriptions field on the corresponding responses.

All the usual google.pubsub_v1.types.ListSubscriptionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

API documentation for pubsub_v1.publisher.client module.

API documentation for pubsub_v1.publisher.futures module.

API documentation for pubsub_v1.subscriber.client module.

API documentation for pubsub_v1.subscriber.futures module.

Schedulers provide means to schedule callbacks asynchronously.

These are used by the subscriber to call the user-provided callback to process each message.

API documentation for pubsub_v1.types module.

API documentation for pubsub_v1.services.publisher.pagers module.

API documentation for pubsub_v1.services.subscriber.pagers module.