Package com.google.cloud.pubsub.v1 (1.143.0)

Client Classes

Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.

Client Description
com.google.cloud.pubsub.v1.SchemaServiceClient Service Description: Service for doing schema-related operations.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

com.google.cloud.pubsub.v1.SubscriptionAdminClient Service Description: 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.
com.google.cloud.pubsub.v1.TopicAdminClient Service Description: The service that an application uses to manipulate topics, and to send messages to a topic.

This class provides the ability to make remote calls to the backing service through method

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.cloud.pubsub.v1.SchemaServiceSettings Settings class to configure an instance of SchemaServiceClient.

The default instance has everything set to sensible defaults:

com.google.cloud.pubsub.v1.SubscriberShutdownSettings Settings for configuring the shutdown behavior of a Subscriber.

This class allows customization of how the subscriber handles outstanding messages during shutdown, including whether to wait for processing to complete or to immediately nack messages,

com.google.cloud.pubsub.v1.SubscriptionAdminSettings Settings class to configure an instance of SubscriptionAdminClient.

The default instance has everything set to sensible defaults:

com.google.cloud.pubsub.v1.TopicAdminSettings Settings class to configure an instance of TopicAdminClient.

The default instance has everything set to sensible defaults:

Classes

Class Description
com.google.cloud.pubsub.v1.AckReplyConsumerImpl
com.google.cloud.pubsub.v1.AckReplyConsumerWithResponseImpl
com.google.cloud.pubsub.v1.AckRequestData
com.google.cloud.pubsub.v1.AckRequestData.Builder Builder of AckRequestData.
com.google.cloud.pubsub.v1.OpenCensusUtil Utilities for propagating OpenCensus TagContext and SpanContext from publishers to subscribers.
com.google.cloud.pubsub.v1.OpenCensusUtil.OpenCensusMessageReceiver Wrapper class for MessageReceiver that decodes any received trace and tag contexts and puts them in scope.
com.google.cloud.pubsub.v1.OpenTelemetryPubsubTracer
com.google.cloud.pubsub.v1.Publisher A Cloud Pub/Sub publisher, that is associated with a specific topic at creation.

A Publisher provides built-in capabilities to automatically handle batching of

com.google.cloud.pubsub.v1.Publisher.Builder A builder of Publishers.
com.google.cloud.pubsub.v1.PubsubMessageWrapper A wrapper class for a PubsubMessage object that handles creation and tracking of OpenTelemetry Span objects for different operations that occur during publishing.
com.google.cloud.pubsub.v1.SchemaServiceClient.ListSchemaRevisionsFixedSizeCollection
com.google.cloud.pubsub.v1.SchemaServiceClient.ListSchemaRevisionsPage
com.google.cloud.pubsub.v1.SchemaServiceClient.ListSchemaRevisionsPagedResponse
com.google.cloud.pubsub.v1.SchemaServiceClient.ListSchemasFixedSizeCollection
com.google.cloud.pubsub.v1.SchemaServiceClient.ListSchemasPage
com.google.cloud.pubsub.v1.SchemaServiceClient.ListSchemasPagedResponse
com.google.cloud.pubsub.v1.SchemaServiceSettings.Builder Builder for SchemaServiceSettings.
com.google.cloud.pubsub.v1.Subscriber A Cloud Pub/Sub subscriber that is associated with a specific subscription at creation.

A Subscriber allows you to provide an implementation of a receiver to which messages are going to be delivered as soon as they are received by the

com.google.cloud.pubsub.v1.Subscriber.Builder Builder of Subscribers.
com.google.cloud.pubsub.v1.SubscriberShutdownSettings.Builder Builder for SubscriberShutdownSettings.
com.google.cloud.pubsub.v1.SubscriptionAdminClient.ListSnapshotsFixedSizeCollection
com.google.cloud.pubsub.v1.SubscriptionAdminClient.ListSnapshotsPage
com.google.cloud.pubsub.v1.SubscriptionAdminClient.ListSnapshotsPagedResponse
com.google.cloud.pubsub.v1.SubscriptionAdminClient.ListSubscriptionsFixedSizeCollection
com.google.cloud.pubsub.v1.SubscriptionAdminClient.ListSubscriptionsPage
com.google.cloud.pubsub.v1.SubscriptionAdminClient.ListSubscriptionsPagedResponse
com.google.cloud.pubsub.v1.SubscriptionAdminSettings.Builder Builder for SubscriptionAdminSettings.
com.google.cloud.pubsub.v1.TopicAdminClient.ListTopicSnapshotsFixedSizeCollection
com.google.cloud.pubsub.v1.TopicAdminClient.ListTopicSnapshotsPage
com.google.cloud.pubsub.v1.TopicAdminClient.ListTopicSnapshotsPagedResponse
com.google.cloud.pubsub.v1.TopicAdminClient.ListTopicSubscriptionsFixedSizeCollection
com.google.cloud.pubsub.v1.TopicAdminClient.ListTopicSubscriptionsPage
com.google.cloud.pubsub.v1.TopicAdminClient.ListTopicSubscriptionsPagedResponse
com.google.cloud.pubsub.v1.TopicAdminClient.ListTopicsFixedSizeCollection
com.google.cloud.pubsub.v1.TopicAdminClient.ListTopicsPage
com.google.cloud.pubsub.v1.TopicAdminClient.ListTopicsPagedResponse
com.google.cloud.pubsub.v1.TopicAdminSettings.Builder Builder for TopicAdminSettings.

Interfaces

Interface Description
com.google.cloud.pubsub.v1.AckReplyConsumer Accepts a reply, sending it to the service.
com.google.cloud.pubsub.v1.AckReplyConsumerWithResponse Acknowledging a message in Pub/Sub means that you are done with it, and it will not be delivered to this subscription again. You should avoid acknowledging messages until you have finished processing them, so that in the event of a failure, you receive the message again.
com.google.cloud.pubsub.v1.MessageReceiver This interface can be implemented by users of Subscriber to receive messages.
com.google.cloud.pubsub.v1.MessageReceiverWithAckResponse
com.google.cloud.pubsub.v1.PublisherInterface An interface for a Cloud Pub/Sub publisher.
com.google.cloud.pubsub.v1.SubscriberInterface The core interface for a Cloud Pub/Sub subscriber, consisting only of ApiService methods.

Enums

Enum Description
com.google.cloud.pubsub.v1.AckResponse
com.google.cloud.pubsub.v1.SubscriberShutdownSettings.ShutdownMode Defines the behavior for handling outstanding messages during subscriber shutdown.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.