Package com.google.cloud.pubsublite.v1

Class SubscriberServiceClient

java.lang.Object
com.google.cloud.pubsublite.v1.SubscriberServiceClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class SubscriberServiceClient extends Object implements com.google.api.gax.core.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 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 (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().

Methods
Method Description Method Variants

Subscribe

Establishes a stream with the server for receiving messages.

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • subscribeCallable()

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 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
 SubscriberServiceSettings subscriberServiceSettings =
     SubscriberServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SubscriberServiceClient subscriberServiceClient =
     SubscriberServiceClient.create(subscriberServiceSettings);

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

  • Constructor Details

    • SubscriberServiceClient

      protected SubscriberServiceClient(SubscriberServiceSettings settings) throws IOException
      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.
      Throws:
      IOException

    • SubscriberServiceClient

      protected SubscriberServiceClient(SubscriberServiceStub stub)

  • Method Details

    • create

      public static final SubscriberServiceClient create() throws IOException
      Constructs an instance of SubscriberServiceClient with default settings.
      Throws:
      IOException

    • create

      public static final SubscriberServiceClient create(SubscriberServiceSettings settings) throws IOException
      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.
      Throws:
      IOException

    • create

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

    • getSettings

      public final SubscriberServiceSettings getSettings()

    • getStub

      public SubscriberServiceStub getStub()

    • subscribeCallable

      public final com.google.api.gax.rpc.BidiStreamingCallable<SubscribeRequest,SubscribeResponse> subscribeCallable()
      Establishes a stream with the server for receiving messages.

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

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface com.google.api.gax.core.BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface com.google.api.gax.core.BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface com.google.api.gax.core.BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface com.google.api.gax.core.BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface com.google.api.gax.core.BackgroundResource
      Throws:
      InterruptedException