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.
- AwsKinesis
- Ingestion settings for Amazon Kinesis Data Streams.
- AwsMsk
- Ingestion settings for Amazon MSK.
- AzureEventHubs
- Ingestion settings for Azure Event Hubs.
- Binding
-
Associates
members
, or principals, with arole
. - CloudStorage
- Ingestion settings for Cloud Storage.
- CloudStorageConfig
- Configuration for a Cloud Storage subscription.
- CommitSchemaRequest
- Request for CommitSchema method.
- ConfluentCloud
- Ingestion settings for Confluent Cloud.
- CreateSnapshotRequest
-
Request for the
CreateSnapshot
method. - 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.
- MessageTransform
- All supported message transforms types.
- ModifyAckDeadlineRequest
- Request for the ModifyAckDeadline method.
- ModifyPushConfigRequest
- Request for the ModifyPushConfig method.
- PlatformLogsSettings
- Settings for Platform Logs produced by Pub/Sub.
- 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.
- 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.
- TextFormat
- Configuration for reading Cloud Storage data in text format.
- 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
- AnalyticsHubSubscriptionInfo = $AnalyticsHubSubscriptionInfo
- Information about an associated Analytics Hub subscription.
- AvroConfig = $AvroConfig
- Configuration for writing message data in Avro format.
- AvroFormat = $Empty
- Configuration for reading Cloud Storage data in Avro binary format.
- BigQueryConfig = $BigQueryConfig
- Configuration for a BigQuery subscription.
- DeadLetterPolicy = $DeadLetterPolicy
- Dead lettering is done on a best effort basis.
- 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.
- ExpirationPolicy = $ExpirationPolicy
- A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).
- Expr = $Expr
- Represents a textual expression in the Common Expression Language (CEL) syntax.
- JavaScriptUDF = $JavaScriptUDF
- User-defined JavaScript function that can transform or filter a Pub/Sub message.
- NoWrapper = $NoWrapper
-
Sets the
data
field as the HTTP body for delivery. - OidcToken = $OidcToken
- Contains information needed for generating an OpenID Connect token.
- PubSubAvroFormat = $Empty
- Configuration for reading Cloud Storage data written via Cloud Storage subscriptions.
- 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).
- RetryPolicy = $RetryPolicy
- A policy that specifies how Pub/Sub retries message delivery.
- 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.