pubsub/v1 library

Cloud Pub/Sub API - v1

Provides reliable, many-to-many, asynchronous messaging between applications.

For more information, see cloud.google.com/pubsub/docs

Create an instance of PubsubApi to access these resources:

Classes

AcknowledgeRequest
Request for the Acknowledge method.
AvroConfig
Configuration for writing message data in Avro format.
AwsKinesis
Ingestion settings for Amazon Kinesis Data Streams.
BigQueryConfig
Configuration for a BigQuery subscription.
Binding
Associates members, or principals, with a role.
CloudStorageConfig
Configuration for a Cloud Storage subscription.
CommitSchemaRequest
Request for CommitSchema method.
CreateSnapshotRequest
Request for the CreateSnapshot method.
DeadLetterPolicy
Dead lettering is done on a best effort basis.
ExpirationPolicy
A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).
IngestionDataSourceSettings
Settings for an ingestion data source on a topic.
ListSchemaRevisionsResponse
Response for the ListSchemaRevisions method.
ListSchemasResponse
Response for the ListSchemas method.
ListSnapshotsResponse
Response for the ListSnapshots method.
ListSubscriptionsResponse
Response for the ListSubscriptions method.
ListTopicSnapshotsResponse
Response for the ListTopicSnapshots method.
ListTopicsResponse
Response for the ListTopics method.
ListTopicSubscriptionsResponse
Response for the ListTopicSubscriptions method.
MessageStoragePolicy
A policy constraining the storage of messages published to the topic.
ModifyAckDeadlineRequest
Request for the ModifyAckDeadline method.
ModifyPushConfigRequest
Request for the ModifyPushConfig method.
NoWrapper
Sets the data field as the HTTP body for delivery.
OidcToken
Contains information needed for generating an OpenID Connect token.
Policy
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
ProjectsResource
ProjectsSchemasResource
ProjectsSnapshotsResource
ProjectsSubscriptionsResource
ProjectsTopicsResource
ProjectsTopicsSnapshotsResource
ProjectsTopicsSubscriptionsResource
PublishRequest
Request for the Publish method.
PublishResponse
Response for the Publish method.
PubsubApi
Provides reliable, many-to-many, asynchronous messaging between applications.
PullRequest
Request for the Pull method.
PullResponse
Response for the Pull method.
PushConfig
Configuration for a push delivery endpoint.
ReceivedMessage
A message and its corresponding acknowledgment ID.
RetryPolicy
A policy that specifies how Pub/Sub retries message delivery.
RollbackSchemaRequest
Request for the RollbackSchema method.
Schema
A schema resource.
SchemaSettings
Settings for validating messages published against a schema.
SeekRequest
Request for the Seek method.
SetIamPolicyRequest
Request message for SetIamPolicy method.
Snapshot
A snapshot resource.
Subscription
A subscription resource.
Topic
A topic resource.
UpdateSnapshotRequest
Request for the UpdateSnapshot method.
UpdateSubscriptionRequest
Request for the UpdateSubscription method.
UpdateTopicRequest
Request for the UpdateTopic method.
ValidateMessageRequest
Request for the ValidateMessage method.
ValidateSchemaRequest
Request for the ValidateSchema method.

Typedefs

DetachSubscriptionResponse = $Empty
Response for the DetachSubscription method.
Empty = $Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
Expr = $Expr
Represents a textual expression in the Common Expression Language (CEL) syntax.
PubsubMessage = $PubsubMessage
A message that is published by publishers and consumed by subscribers.
PubsubWrapper = $Empty
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).
SeekResponse = $Empty
Response for the Seek method (this response is empty).
TestIamPermissionsRequest = $TestIamPermissionsRequest00
Request message for TestIamPermissions method.
TestIamPermissionsResponse = $PermissionsResponse
Response message for TestIamPermissions method.
TextConfig = $Empty
Configuration for writing message data in text format.
ValidateMessageResponse = $Empty
Response for the ValidateMessage method.
ValidateSchemaResponse = $Empty
Response for the ValidateSchema method.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.