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 youget sensible defaults.

This future object is returned from asychronous Pub/Sub publishingcalls.

Callingresult will resolve the future by returning the messageID, 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 youget sensible defaults.

This future object is for subscribe-side calls.

Callingresult will resolve the future by returning the messageID, unless an error occurs.

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

This future is resolved when the process is stopped (viacancel) orif it encounters an unrecoverable error. Calling.result() will causethe 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 receivethem in callbacks on subscriptions; most users should never have a needto instantiate them by hand. (The exception to this is if you areimplementing 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 forpubsub_v1.types.AuditConfig class.

API documentation forpubsub_v1.types.AuditConfigDelta class.

API documentation forpubsub_v1.types.AuditData class.

API documentation forpubsub_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 forpubsub_v1.types.Binding class.

API documentation forpubsub_v1.types.BindingDelta class.

Configuration for a Cloud Storage subscription.

This message hasoneof_ 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 othermembers.

.. _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 anAvro 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, separatedby a newline.

Request for theCreateSnapshot method.

The abstract base class for a message.

The abstract base class for a message.

API documentation forpubsub_v1.types.CustomHttpPattern class.

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

If validation on any of the fields fails at subscriptioncreation/updation, the create/update subscription request willfail.

Request for theDeleteSnapshot method.

Request for the DeleteSubscription method.

Request for theDeleteTopic method.

API documentation forpubsub_v1.types.DescriptorProto class.

API documentation forpubsub_v1.types.DescriptorProto.ExtensionRange class.

API documentation forpubsub_v1.types.DescriptorProto.ReservedRange class.

Request for the DetachSubscription method.

Response for the DetachSubscription method.Reserved for future use.

API documentation forpubsub_v1.types.Duration class.

API documentation forpubsub_v1.types.Empty class.

API documentation forpubsub_v1.types.EnumDescriptorProto class.

API documentation forpubsub_v1.types.EnumDescriptorProto.EnumReservedRange class.

API documentation forpubsub_v1.types.EnumOptions class.

API documentation forpubsub_v1.types.EnumValueDescriptorProto class.

API documentation forpubsub_v1.types.EnumValueOptions class.

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

API documentation forpubsub_v1.types.ExtensionRangeOptions class.

API documentation forpubsub_v1.types.ExtensionRangeOptions.Declaration class.

API documentation forpubsub_v1.types.FeatureSet class.

API documentation forpubsub_v1.types.FeatureSet.VisibilityFeature class.

API documentation forpubsub_v1.types.FeatureSetDefaults class.

API documentation forpubsub_v1.types.FeatureSetDefaults.FeatureSetEditionDefault class.

API documentation forpubsub_v1.types.FieldDescriptorProto class.

API documentation forpubsub_v1.types.FieldMask class.

API documentation forpubsub_v1.types.FieldOptions class.

API documentation forpubsub_v1.types.FieldOptions.EditionDefault class.

API documentation forpubsub_v1.types.FieldOptions.FeatureSupport class.

API documentation forpubsub_v1.types.FileDescriptorProto class.

API documentation forpubsub_v1.types.FileDescriptorSet class.

API documentation forpubsub_v1.types.FileOptions class.

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

API documentation forpubsub_v1.types.GeneratedCodeInfo class.

API documentation forpubsub_v1.types.GeneratedCodeInfo.Annotation class.

API documentation forpubsub_v1.types.GetIamPolicyRequest class.

Request for the GetSnapshot method.

Request for the GetSubscription method.

Request for the GetTopic method.

API documentation forpubsub_v1.types.Http class.

API documentation forpubsub_v1.types.HttpRule class.

Settings for an ingestion data source on a topic.

This message hasoneof_ 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 othermembers.

.. _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 DataStreams.

    - 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 hasoneof_ 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 othermembers.

.. _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 thedata field of aPub/Sub message.

Configuration for reading Cloud Storage data written viaCloudStoragesubscriptions <https://cloud.google.com/pubsub/docs/cloudstorage>__.The data and attributes fields of the originally exported Pub/Submessage 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. Eachline of text as specified by the delimiter will be set to thedata 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 isencountered while ingesting.

This message hasoneof_ 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 othermembers.

.. _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 thedesired Pub/Sub message due to the API message limits(https://cloud.google.com/pubsub/quotas#resource_limits). Forexample, when the number of attributes is larger than 100, thenumber of attributes is truncated to 100 to respect the limit on theattribute count. Other attribute limits are treated similarly. Whenthe size of the desired message would've been larger than 10MB, themessage won't be published at all, and ingestion of the subsequentmessages will proceed as normal.

Set when an Avro file is unsupported or its format is notvalid. When this occurs, one or more Avro objects won't beingested.

Failure when ingesting from an AWS Kinesis source.

This message hasoneof_ 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 othermembers.

.. _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 hasoneof_ 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 othermembers.

.. _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 hasoneof_ 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 othermembers.

.. _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 hasoneof_ 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 othermembers.

.. _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 hasoneof_ 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 othermembers.

.. _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 amessage transformation error.

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

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

The possible actions when exceeding the publish flow control limits.

Request for theListSnapshots method.

Response for theListSnapshots method.

Request for theListSubscriptions method.

Response for theListSubscriptions method.

Request for theListTopicSnapshots method.

Response for theListTopicSnapshots method.

Request for theListTopicSubscriptions method.

Response for theListTopicSubscriptions method.

Request for theListTopics method.

Response for theListTopics method.

API documentation forpubsub_v1.types.MessageOptions class.

A policy constraining the storage of messages published tothe topic.

All supported message transforms types.

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

API documentation forpubsub_v1.types.MethodDescriptorProto class.

API documentation forpubsub_v1.types.MethodOptions class.

Request for the ModifyAckDeadline method.

Request for the ModifyPushConfig method.

API documentation forpubsub_v1.types.OneofDescriptorProto class.

API documentation forpubsub_v1.types.OneofOptions class.

Settings for Platform Logs produced by Pub/Sub.

Severity levels of Platform Logs.

API documentation forpubsub_v1.types.Policy class.

API documentation forpubsub_v1.types.PolicyDelta class.

The client flow control settings for message publishing.

Request for the Publish method.

Response for thePublish method.

The options for the publisher client.

A message that is published by publishers and consumed bysubscribers. The message must contain either a non-empty data fieldor at least one attribute. Note that client libraries represent thisobject differently depending on the language. See the correspondingclient librarydocumentation <https://cloud.google.com/pubsub/docs/reference/libraries>__for more information. Seequotas and limits for more information aboutmessage limits.

The abstract base class for a message.

Request for thePull method.

Response for thePull method.

Configuration for a push delivery endpoint.

This message hasoneof_ 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 othermembers.

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

The abstract base class for a message.

Sets thedata field as the HTTP body for delivery.

Contains information needed for generating anOpenID Connecttoken <https://developers.google.com/identity/protocols/OpenIDConnect>__.

The payload to the push endpoint is in the form of the JSONrepresentation 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 andmaximum backoffs.https://en.wikipedia.org/wiki/Exponential_backoff.

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

Retry Policy is implemented on a best effort basis. At times, thedelay between consecutive deliveries may not match theconfiguration. That is, delay can be more or less than configuredbackoff.

Settings for validating messages published against a schema.

Request for theSeek method.

This message hasoneof_ 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 othermembers.

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

Response for theSeek method (this response is empty).

API documentation forpubsub_v1.types.ServiceDescriptorProto class.

API documentation forpubsub_v1.types.ServiceOptions class.

API documentation forpubsub_v1.types.SetIamPolicyRequest class.

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

The abstract base class for a message.

API documentation forpubsub_v1.types.SourceCodeInfo class.

API documentation forpubsub_v1.types.SourceCodeInfo.Location class.

Request for theStreamingPull streaming RPC method. This requestis used to establish the initial stream as well as to streamacknowledgments and ack deadline modifications from the client tothe server.

Response for theStreamingPull method. This response is used tostream messages from the server to the client.

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

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

Subscription properties sent as part of the response.

A subscription resource. If none ofpush_config,bigquery_config, orcloud_storage_config is set, then thesubscriber will pull and ack messages using API methods. At most oneof these fields may be set.

Information about an associatedAnalytics Hubsubscription <https://cloud.google.com/bigquery/docs/analytics-hub-manage-subscriptions>__.

The abstract base class for a message.

Possible states for a subscription.

The abstract base class for a message.

API documentation forpubsub_v1.types.TestIamPermissionsRequest class.

API documentation forpubsub_v1.types.TestIamPermissionsResponse class.

API documentation forpubsub_v1.types.Timestamp class.

A topic resource.

The abstract base class for a message.

The state of the topic.

The abstract base class for a message.

API documentation forpubsub_v1.types.UninterpretedOption class.

API documentation forpubsub_v1.types.UninterpretedOption.NamePart class.

Request for the UpdateSnapshot method.

Request for the UpdateSubscription method.

Request for the UpdateTopic method.

A pager for iterating throughlist_topic_snapshots requests.

This class thinly wraps an initialgoogle.pubsub_v1.types.ListTopicSnapshotsResponse object, andprovides an__aiter__ method to iterate through itssnapshots field.

If there are more pages, the__aiter__ method will make additionalListTopicSnapshots requests and continue to iteratethrough thesnapshots field on thecorresponding responses.

All the usualgoogle.pubsub_v1.types.ListTopicSnapshotsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_topic_snapshots requests.

This class thinly wraps an initialgoogle.pubsub_v1.types.ListTopicSnapshotsResponse object, andprovides an__iter__ method to iterate through itssnapshots field.

If there are more pages, the__iter__ method will make additionalListTopicSnapshots requests and continue to iteratethrough thesnapshots field on thecorresponding responses.

All the usualgoogle.pubsub_v1.types.ListTopicSnapshotsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_topic_subscriptions requests.

This class thinly wraps an initialgoogle.pubsub_v1.types.ListTopicSubscriptionsResponse object, andprovides an__aiter__ method to iterate through itssubscriptions field.

If there are more pages, the__aiter__ method will make additionalListTopicSubscriptions requests and continue to iteratethrough thesubscriptions field on thecorresponding responses.

All the usualgoogle.pubsub_v1.types.ListTopicSubscriptionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_topic_subscriptions requests.

This class thinly wraps an initialgoogle.pubsub_v1.types.ListTopicSubscriptionsResponse object, andprovides an__iter__ method to iterate through itssubscriptions field.

If there are more pages, the__iter__ method will make additionalListTopicSubscriptions requests and continue to iteratethrough thesubscriptions field on thecorresponding responses.

All the usualgoogle.pubsub_v1.types.ListTopicSubscriptionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_topics requests.

This class thinly wraps an initialgoogle.pubsub_v1.types.ListTopicsResponse object, andprovides an__aiter__ method to iterate through itstopics field.

If there are more pages, the__aiter__ method will make additionalListTopics requests and continue to iteratethrough thetopics field on thecorresponding responses.

All the usualgoogle.pubsub_v1.types.ListTopicsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_topics requests.

This class thinly wraps an initialgoogle.pubsub_v1.types.ListTopicsResponse object, andprovides an__iter__ method to iterate through itstopics field.

If there are more pages, the__iter__ method will make additionalListTopics requests and continue to iteratethrough thetopics field on thecorresponding responses.

All the usualgoogle.pubsub_v1.types.ListTopicsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_snapshots requests.

This class thinly wraps an initialgoogle.pubsub_v1.types.ListSnapshotsResponse object, andprovides an__aiter__ method to iterate through itssnapshots field.

If there are more pages, the__aiter__ method will make additionalListSnapshots requests and continue to iteratethrough thesnapshots field on thecorresponding responses.

All the usualgoogle.pubsub_v1.types.ListSnapshotsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_snapshots requests.

This class thinly wraps an initialgoogle.pubsub_v1.types.ListSnapshotsResponse object, andprovides an__iter__ method to iterate through itssnapshots field.

If there are more pages, the__iter__ method will make additionalListSnapshots requests and continue to iteratethrough thesnapshots field on thecorresponding responses.

All the usualgoogle.pubsub_v1.types.ListSnapshotsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_subscriptions requests.

This class thinly wraps an initialgoogle.pubsub_v1.types.ListSubscriptionsResponse object, andprovides an__aiter__ method to iterate through itssubscriptions field.

If there are more pages, the__aiter__ method will make additionalListSubscriptions requests and continue to iteratethrough thesubscriptions field on thecorresponding responses.

All the usualgoogle.pubsub_v1.types.ListSubscriptionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

A pager for iterating throughlist_subscriptions requests.

This class thinly wraps an initialgoogle.pubsub_v1.types.ListSubscriptionsResponse object, andprovides an__iter__ method to iterate through itssubscriptions field.

If there are more pages, the__iter__ method will make additionalListSubscriptions requests and continue to iteratethrough thesubscriptions field on thecorresponding responses.

All the usualgoogle.pubsub_v1.types.ListSubscriptionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

API documentation forpubsub_v1.publisher.client module.

API documentation forpubsub_v1.publisher.futures module.

API documentation forpubsub_v1.subscriber.client module.

API documentation forpubsub_v1.subscriber.futures module.

Schedulers provide means toschedule callbacks asynchronously.

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

API documentation forpubsub_v1.types module.

API documentation forpubsub_v1.services.publisher.pagers module.

API documentation forpubsub_v1.services.subscriber.pagers module.