Classes
AcknowledgeRequest
Request for the Acknowledge method.
CreateSchemaRequest
Request for the CreateSchema method.
CreateSnapshotRequest
Request for the CreateSnapshot
method.
DeadLetterPolicy
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.
DeleteSchemaRequest
Request for the DeleteSchema
method.
DeleteSnapshotRequest
Request for the DeleteSnapshot
method.
DeleteSubscriptionRequest
Request for the DeleteSubscription method.
DeleteTopicRequest
Request for the DeleteTopic
method.
DetachSubscriptionRequest
Request for the DetachSubscription method.
DetachSubscriptionResponse
Response for the DetachSubscription method. Reserved for future use.
ExpirationPolicy
A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).
GetSchemaRequest
Request for the GetSchema method.
GetSnapshotRequest
Request for the GetSnapshot method.
GetSubscriptionRequest
Request for the GetSubscription method.
GetTopicRequest
Request for the GetTopic method.
ListSchemasRequest
Request for the ListSchemas
method.
ListSchemasResponse
Response for the ListSchemas
method.
ListSnapshotsRequest
Request for the ListSnapshots
method.
ListSnapshotsResponse
Response for the ListSnapshots
method.
ListSubscriptionsRequest
Request for the ListSubscriptions
method.
ListSubscriptionsResponse
Response for the ListSubscriptions
method.
ListTopicSnapshotsRequest
Request for the ListTopicSnapshots
method.
ListTopicSnapshotsResponse
Response for the ListTopicSnapshots
method.
ListTopicsRequest
Request for the ListTopics
method.
ListTopicsResponse
Response for the ListTopics
method.
ListTopicSubscriptionsRequest
Request for the ListTopicSubscriptions
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.
OrderingKeyInErrorStateException
Exception thrown when publishing a message with an ordering key that is in an error state.
Publisher
The service that an application uses to manipulate topics, and to send messages to a topic.
Publisher.PublisherBase
Base class for server-side implementations of Publisher
Publisher.PublisherClient
Client for Publisher
PublisherClient
A PubSub publisher that is associated with a specific TopicName.
PublisherClient.ClientCreationSettings
Settings for creating PublisherServiceApiClients.
PublisherClient.Settings
Settings for the PublisherClient.
PublisherClientImpl
Implementation of PubSub publisher that is associated with a specific TopicName.
PublisherServiceApiClient
PublisherServiceApi client wrapper, for convenient use.
PublisherServiceApiClientBuilder
Builder class for PublisherServiceApiClient to provide simple configuration of credentials, endpoint etc.
PublisherServiceApiClientImpl
PublisherServiceApi client wrapper implementation, for convenient use.
PublisherServiceApiSettings
Settings for PublisherServiceApiClient instances.
PublishRequest
Request for the Publish method.
PublishResponse
Response for the Publish
method.
PubsubExtensions
Extensions to pubsub messages.
PubsubMessage
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 for more information. See quotas and limits for more information about message limits.
PullRequest
Request for the Pull
method.
PullResponse
Response for the Pull
method.
PushConfig
Configuration for a push delivery endpoint.
PushConfig.Types
Container for nested types declared in the PushConfig message type.
PushConfig.Types.OidcToken
Contains information needed for generating an OpenID Connect token.
ReceivedMessage
A message and its corresponding acknowledgment ID.
RetryPolicy
A policy that specifies how Cloud 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 acknowledgement 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.
Schema
A schema resource.
Schema.Types
Container for nested types declared in the Schema message type.
SchemaName
Resource name for the Schema
resource.
SchemaService
Service for doing schema-related operations.
SchemaService.SchemaServiceBase
Base class for server-side implementations of SchemaService
SchemaService.SchemaServiceClient
Client for SchemaService
SchemaServiceClient
SchemaService client wrapper, for convenient use.
SchemaServiceClientBuilder
Builder class for SchemaServiceClient to provide simple configuration of credentials, endpoint etc.
SchemaServiceClientImpl
SchemaService client wrapper implementation, for convenient use.
SchemaServiceSettings
Settings for SchemaServiceClient instances.
SchemaSettings
Settings for validating messages published against a schema.
SeekRequest
Request for the Seek
method.
SeekResponse
Response for the Seek
method (this response is empty).
Snapshot
A snapshot resource. Snapshots are used in Seek 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.
SnapshotName
Resource name for the Snapshot
resource.
StreamingPullRequest
Request for the StreamingPull
streaming RPC method. This request is used to
establish the initial stream as well as to stream acknowledgements and ack
deadline modifications from the client to the server.
StreamingPullResponse
Response for the StreamingPull
method. This response is used to stream
messages from the server to the client.
StreamingPullResponse.Types
Container for nested types declared in the StreamingPullResponse message type.
StreamingPullResponse.Types.SubscriptionProperties
Subscription properties sent as part of the response.
Subscriber
The service that an application uses to manipulate subscriptions and to
consume messages from a subscription via the Pull
method or by
establishing a bi-directional stream using the StreamingPull
method.
Subscriber.SubscriberBase
Base class for server-side implementations of Subscriber
Subscriber.SubscriberClient
Client for Subscriber
SubscriberClient
A PubSub subscriber that is associated with a specific SubscriptionName.
SubscriberClient.ClientCreationSettings
Settings for creating SubscriberServiceApiClients.
SubscriberClient.Settings
Settings for SubscriberClient.
Defaults will be used for null
properties.
SubscriberClientImpl
Implementation of SubscriberClient.
SubscriberServiceApiClient
SubscriberServiceApi client wrapper, for convenient use.
SubscriberServiceApiClient.StreamingPullStream
Bidirectional streaming methods for StreamingPull(CallSettings, BidirectionalStreamingSettings).
SubscriberServiceApiClientBuilder
Builder class for SubscriberServiceApiClient to provide simple configuration of credentials, endpoint etc.
SubscriberServiceApiClientImpl
SubscriberServiceApi client wrapper implementation, for convenient use.
SubscriberServiceApiSettings
Settings for SubscriberServiceApiClient instances.
Subscription
A subscription resource.
SubscriptionName
Resource name for the Subscription
resource.
Topic
A topic resource.
TopicName
Resource name for the 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.
ValidateMessageResponse
Response for the ValidateMessage
method.
Empty for now.
ValidateSchemaRequest
Request for the ValidateSchema
method.
ValidateSchemaResponse
Response for the ValidateSchema
method.
Empty for now.
Enums
Encoding
Possible encoding types for messages.
PushConfig.AuthenticationMethodOneofCase
Enum of possible cases for the "authentication_method" oneof.
Schema.Types.Type
Possible schema definition types.
SchemaName.ResourceNameType
The possible contents of SchemaName.
SchemaView
View of Schema object fields to be returned by GetSchema and ListSchemas.
SeekRequest.TargetOneofCase
Enum of possible cases for the "target" oneof.
SnapshotName.ResourceNameType
The possible contents of SnapshotName.
SubscriberClient.Reply
Reply from a message handler; whether to Ack or Nack the message to the server.
SubscriptionName.ResourceNameType
The possible contents of SubscriptionName.
TopicName.ResourceNameType
The possible contents of TopicName.
ValidateMessageRequest.SchemaSpecOneofCase
Enum of possible cases for the "schema_spec" oneof.