Class SubscriberServiceClient (1.6.3) 

public class SubscriberServiceClient implements BackgroundResource

Service Description: The service that a subscriber client application uses to receive messages from subscriptions.

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SubscriberServiceClient subscriberServiceClient = SubscriberServiceClient.create()) {
   BidiStream<SubscribeRequest, SubscribeResponse> bidiStream =
       subscriberServiceClient.subscribeCallable().call();
   SubscribeRequest request = SubscribeRequest.newBuilder().build();
   bidiStream.send(request);
   for (SubscribeResponse response : bidiStream) {
     // Do something when a response is received.
   }
 }

Note: close() needs to be called on the SubscriberServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns 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 SubscriberServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 SubscriberServiceSettings subscriberServiceSettings =
     SubscriberServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SubscriberServiceClient subscriberServiceClient =
     SubscriberServiceClient.create(subscriberServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 SubscriberServiceSettings subscriberServiceSettings =
     SubscriberServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SubscriberServiceClient subscriberServiceClient =
     SubscriberServiceClient.create(subscriberServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > SubscriberServiceClient

Implements

BackgroundResource

Static Methods

create()

public static final SubscriberServiceClient create()

Constructs an instance of SubscriberServiceClient with default settings.

Returns
TypeDescription
SubscriberServiceClient
Exceptions
TypeDescription
IOException

create(SubscriberServiceSettings settings)

public static final SubscriberServiceClient create(SubscriberServiceSettings settings)

Constructs an instance of SubscriberServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
NameDescription
settingsSubscriberServiceSettings
Returns
TypeDescription
SubscriberServiceClient
Exceptions
TypeDescription
IOException

create(SubscriberServiceStub stub)

public static final SubscriberServiceClient create(SubscriberServiceStub stub)

Constructs an instance of SubscriberServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(SubscriberServiceSettings).

Parameter
NameDescription
stubSubscriberServiceStub
Returns
TypeDescription
SubscriberServiceClient

Constructors

SubscriberServiceClient(SubscriberServiceSettings settings)

protected SubscriberServiceClient(SubscriberServiceSettings settings)

Constructs an instance of SubscriberServiceClient, 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
NameDescription
settingsSubscriberServiceSettings

SubscriberServiceClient(SubscriberServiceStub stub)

protected SubscriberServiceClient(SubscriberServiceStub stub)
Parameter
NameDescription
stubSubscriberServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

getSettings()

public final SubscriberServiceSettings getSettings()
Returns
TypeDescription
SubscriberServiceSettings

getStub()

public SubscriberServiceStub getStub()
Returns
TypeDescription
SubscriberServiceStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

subscribeCallable()

public final BidiStreamingCallable<SubscribeRequest,SubscribeResponse> subscribeCallable()

Establishes a stream with the server for receiving messages.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (SubscriberServiceClient subscriberServiceClient = SubscriberServiceClient.create()) {
   BidiStream<SubscribeRequest, SubscribeResponse> bidiStream =
       subscriberServiceClient.subscribeCallable().call();
   SubscribeRequest request = SubscribeRequest.newBuilder().build();
   bidiStream.send(request);
   for (SubscribeResponse response : bidiStream) {
     // Do something when a response is received.
   }
 }
Returns
TypeDescription
BidiStreamingCallable<SubscribeRequest,SubscribeResponse>