Cloud Pub/Sub v1 API - Namespace Google.Cloud.PubSub.V1 (3.18.0)

Classes

AckNackResponse

A public representation of a response to an ACKnowledge (ACK) or Not ACKnowledge (NACK) request.

AcknowledgeRequest

Request for the Acknowledge method.

AcknowledgementException

Represents an exception while calling the Acknowledge or ModifyAckDeadline RPC fails with a permanent error.

BigQueryConfig

Configuration for a BigQuery subscription.

BigQueryConfig.Types

Container for nested types declared in the BigQueryConfig message type.

CloudStorageConfig

Configuration for a Cloud Storage subscription.

CloudStorageConfig.Types

Container for nested types declared in the CloudStorageConfig message type.

CloudStorageConfig.Types.AvroConfig

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

CloudStorageConfig.Types.TextConfig

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

CommitSchemaRequest

Request for CommitSchema 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.

DeleteSchemaRevisionRequest

Request for the DeleteSchemaRevision 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.

IngestionDataSourceSettings

Settings for an ingestion data source on a topic.

IngestionDataSourceSettings.Types

Container for nested types declared in the IngestionDataSourceSettings message type.

IngestionDataSourceSettings.Types.AwsKinesis

Ingestion settings for Amazon Kinesis Data Streams.

IngestionDataSourceSettings.Types.AwsKinesis.Types

Container for nested types declared in the AwsKinesis message type.

IngestionDataSourceSettings.Types.CloudStorage

Ingestion settings for Cloud Storage.

IngestionDataSourceSettings.Types.CloudStorage.Types

Container for nested types declared in the CloudStorage message type.

IngestionDataSourceSettings.Types.CloudStorage.Types.AvroFormat

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.

IngestionDataSourceSettings.Types.CloudStorage.Types.PubSubAvroFormat

Configuration for reading Cloud Storage data written via Cloud Storage subscriptions. The data and attributes fields of the originally exported Pub/Sub message will be restored when publishing.

IngestionDataSourceSettings.Types.CloudStorage.Types.TextFormat

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.

ListSchemaRevisionsRequest

Request for the ListSchemaRevisions method.

ListSchemaRevisionsResponse

Response for the ListSchemaRevisions 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.

ListTopicSubscriptionsRequest

Request for the ListTopicSubscriptions method.

ListTopicSubscriptionsResponse

Response for the ListTopicSubscriptions method.

ListTopicsRequest

Request for the ListTopics method.

ListTopicsResponse

Response for the ListTopics 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.

PlatformLogsSettings

Settings for Platform Logs produced by Pub/Sub.

PlatformLogsSettings.Types

Container for nested types declared in the PlatformLogsSettings message type.

PublishRequest

Request for the Publish method.

PublishResponse

Response for the Publish method.

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. This type is now obsolete; please use PublisherClientBuilder which provides an API surface consistent with other clients (as well as additional Pub/Sub-specific properties such as ClientCount).

PublisherClient.Settings

Settings for the PublisherClient.

PublisherClientBuilder

Builder class for PublisherClient to provide simple configuration of credentials, endpoint, client count, publication settings etc.

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.

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.NoWrapper

Sets the data field as the HTTP body for delivery.

PushConfig.Types.OidcToken

Contains information needed for generating an OpenID Connect token.

PushConfig.Types.PubsubWrapper

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).

ReceivedMessage

A message and its corresponding acknowledgment ID.

RetryPolicy

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

RollbackSchemaRequest

Request for the RollbackSchema method.

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.AcknowledgeConfirmation

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

StreamingPullResponse.Types.ModifyAckDeadlineConfirmation

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

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. This type is now obsolete; please use SubscriberClientBuilder which provides an API surface consistent with other clients (as well as additional Pub/Sub-specific properties such as ClientCount).

SubscriberClient.Settings

Settings for SubscriberClient. Defaults will be used for null properties.

SubscriberClientBuilder

Builder class for SubscriberClient to provide simple configuration of credentials, endpoint, client count, subscription settings etc.

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

Subscription.Types

Container for nested types declared in the Subscription message type.

Subscription.Types.AnalyticsHubSubscriptionInfo

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

SubscriptionHandler

This abstract class provides the message handler to handle and process the messages. It also provides the ACKnowledge (ACK) and Not ACKnowledge (NACK) response handlers which indicates the ACK/NACK status of each message for the subscription. The users of subscription should inherit from this class and provide their implementation to handle messages and their acknowledgement response.

SubscriptionName

Resource name for the Subscription resource.

Topic

A topic resource.

Topic.Types

Container for nested types declared in the Topic message type.

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

AcknowledgementStatus

The possible status values of acknowledgement for a message in an acknowledgement request.

BigQueryConfig.Types.State

Possible states for a BigQuery subscription.

CloudStorageConfig.OutputFormatOneofCase

Enum of possible cases for the "output_format" oneof.

CloudStorageConfig.Types.State

Possible states for a Cloud Storage subscription.

Encoding

Possible encoding types for messages.

IngestionDataSourceSettings.SourceOneofCase

Enum of possible cases for the "source" oneof.

IngestionDataSourceSettings.Types.AwsKinesis.Types.State

Possible states for ingestion from Amazon Kinesis Data Streams.

IngestionDataSourceSettings.Types.CloudStorage.InputFormatOneofCase

Enum of possible cases for the "input_format" oneof.

IngestionDataSourceSettings.Types.CloudStorage.Types.State

Possible states for ingestion from Cloud Storage.

PlatformLogsSettings.Types.Severity

Severity levels of Platform Logs.

PushConfig.AuthenticationMethodOneofCase

Enum of possible cases for the "authentication_method" oneof.

PushConfig.WrapperOneofCase

Enum of possible cases for the "wrapper" 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.

Subscription.Types.State

Possible states for a subscription.

SubscriptionName.ResourceNameType

The possible contents of SubscriptionName.

Topic.Types.State

The state of the topic.

TopicName.ResourceNameType

The possible contents of TopicName.

ValidateMessageRequest.SchemaSpecOneofCase

Enum of possible cases for the "schema_spec" oneof.