| GitHub Repository | Product Reference |
Service Description: The service that a publisher client application uses to publish messages to
topics. Published messages are retained by the service for the duration of the retention period
configured for the respective topic, and are delivered to subscriber clients upon request (via
the SubscriberService).
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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (PublisherServiceClient publisherServiceClient = PublisherServiceClient.create()) {
BidiStream<PublishRequest, PublishResponse> bidiStream =
publisherServiceClient.publishCallable().call();
PublishRequest request = PublishRequest.newBuilder().build();
bidiStream.send(request);
for (PublishResponse response : bidiStream) {
// Do something when a response is received.
}
}
Note: close() needs to be called on the PublisherServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
| Method | Description | Method Variants |
|---|---|---|
Publish |
Establishes a stream with the server for publishing messages. Once the stream is initialized, the client publishes messages by sending publish requests on the stream. The server responds with a PublishResponse for each PublishRequest sent by the client, in the same order that the requests were sent. Note that multiple PublishRequests can be in flight simultaneously, but they will be processed by the server in the order that they are sent by the client on a given stream. |
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of PublisherServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
PublisherServiceSettings publisherServiceSettings =
PublisherServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
PublisherServiceClient publisherServiceClient =
PublisherServiceClient.create(publisherServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
PublisherServiceSettings publisherServiceSettings =
PublisherServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
PublisherServiceClient publisherServiceClient =
PublisherServiceClient.create(publisherServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final PublisherServiceClient create()Constructs an instance of PublisherServiceClient with default settings.
| Returns | |
|---|---|
| Type | Description |
PublisherServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(PublisherServiceSettings settings)
public static final PublisherServiceClient create(PublisherServiceSettings settings)Constructs an instance of PublisherServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
| Parameter | |
|---|---|
| Name | Description |
settings |
PublisherServiceSettings |
| Returns | |
|---|---|
| Type | Description |
PublisherServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(PublisherServiceStub stub)
public static final PublisherServiceClient create(PublisherServiceStub stub)Constructs an instance of PublisherServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(PublisherServiceSettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
PublisherServiceStub |
| Returns | |
|---|---|
| Type | Description |
PublisherServiceClient |
|
Constructors
PublisherServiceClient(PublisherServiceSettings settings)
protected PublisherServiceClient(PublisherServiceSettings settings)Constructs an instance of PublisherServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
| Parameter | |
|---|---|
| Name | Description |
settings |
PublisherServiceSettings |
PublisherServiceClient(PublisherServiceStub stub)
protected PublisherServiceClient(PublisherServiceStub stub)| Parameter | |
|---|---|
| Name | Description |
stub |
PublisherServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)| Parameters | |
|---|---|
| Name | Description |
duration |
long |
unit |
TimeUnit |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
| Exceptions | |
|---|---|
| Type | Description |
InterruptedException |
|
close()
public final void close()getSettings()
public final PublisherServiceSettings getSettings()| Returns | |
|---|---|
| Type | Description |
PublisherServiceSettings |
|
getStub()
public PublisherServiceStub getStub()| Returns | |
|---|---|
| Type | Description |
PublisherServiceStub |
|
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
publishCallable()
public final BidiStreamingCallable<PublishRequest,PublishResponse> publishCallable()Establishes a stream with the server for publishing messages. Once the stream is initialized, the client publishes messages by sending publish requests on the stream. The server responds with a PublishResponse for each PublishRequest sent by the client, in the same order that the requests were sent. Note that multiple PublishRequests can be in flight simultaneously, but they will be processed by the server in the order that they are sent by the client on a given stream.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (PublisherServiceClient publisherServiceClient = PublisherServiceClient.create()) {
BidiStream<PublishRequest, PublishResponse> bidiStream =
publisherServiceClient.publishCallable().call();
PublishRequest request = PublishRequest.newBuilder().build();
bidiStream.send(request);
for (PublishResponse response : bidiStream) {
// Do something when a response is received.
}
}
| Returns | |
|---|---|
| Type | Description |
BidiStreamingCallable<PublishRequest,PublishResponse> |
|
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()