Package com.google.cloud.pubsublite.v1

Class CursorServiceClient

java.lang.Object
com.google.cloud.pubsublite.v1.CursorServiceClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class CursorServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: The service that a subscriber client application uses to manage committed cursors while receiving messsages. A cursor represents a subscriber's progress within a topic partition for a given subscription.

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 (CursorServiceClient cursorServiceClient = CursorServiceClient.create()) {
   CommitCursorRequest request =
       CommitCursorRequest.newBuilder()
           .setSubscription("subscription341203229")
           .setPartition(-1799810326)
           .setCursor(Cursor.newBuilder().build())
           .build();
   CommitCursorResponse response = cursorServiceClient.commitCursor(request);
 }

Note: close() needs to be called on the CursorServiceClient 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

StreamingCommitCursor

Establishes a stream with the server for managing committed cursors.

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

  • streamingCommitCursorCallable()

CommitCursor

Updates the committed cursor.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • commitCursor(CommitCursorRequest request)

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

  • commitCursorCallable()

ListPartitionCursors

Returns all committed cursor information for a subscription.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listPartitionCursors(ListPartitionCursorsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listPartitionCursors(SubscriptionName parent)

  • listPartitionCursors(String parent)

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

  • listPartitionCursorsPagedCallable()

  • listPartitionCursorsCallable()

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 CursorServiceSettings 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
 CursorServiceSettings cursorServiceSettings =
     CursorServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CursorServiceClient cursorServiceClient = CursorServiceClient.create(cursorServiceSettings);

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
 CursorServiceSettings cursorServiceSettings =
     CursorServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CursorServiceClient cursorServiceClient = CursorServiceClient.create(cursorServiceSettings);

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

  • Constructor Details

    • CursorServiceClient

      protected CursorServiceClient(CursorServiceSettings settings) throws IOException
      Constructs an instance of CursorServiceClient, 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

    • CursorServiceClient

      protected CursorServiceClient(CursorServiceStub stub)

  • Method Details

    • create

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

    • create

      public static final CursorServiceClient create(CursorServiceSettings settings) throws IOException
      Constructs an instance of CursorServiceClient, 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 CursorServiceClient create(CursorServiceStub stub)
      Constructs an instance of CursorServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(CursorServiceSettings).

    • getSettings

      public final CursorServiceSettings getSettings()

    • getStub

      public CursorServiceStub getStub()

    • streamingCommitCursorCallable

      public final com.google.api.gax.rpc.BidiStreamingCallable<StreamingCommitCursorRequest,StreamingCommitCursorResponse> streamingCommitCursorCallable()
      Establishes a stream with the server for managing committed cursors.

      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 (CursorServiceClient cursorServiceClient = CursorServiceClient.create()) {
   BidiStream<StreamingCommitCursorRequest, StreamingCommitCursorResponse> bidiStream =
       cursorServiceClient.streamingCommitCursorCallable().call();
   StreamingCommitCursorRequest request = StreamingCommitCursorRequest.newBuilder().build();
   bidiStream.send(request);
   for (StreamingCommitCursorResponse response : bidiStream) {
     // Do something when a response is received.
   }
 }

    • commitCursor

      public final CommitCursorResponse commitCursor(CommitCursorRequest request)
      Updates the committed cursor.

      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 (CursorServiceClient cursorServiceClient = CursorServiceClient.create()) {
   CommitCursorRequest request =
       CommitCursorRequest.newBuilder()
           .setSubscription("subscription341203229")
           .setPartition(-1799810326)
           .setCursor(Cursor.newBuilder().build())
           .build();
   CommitCursorResponse response = cursorServiceClient.commitCursor(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • commitCursorCallable

      public final com.google.api.gax.rpc.UnaryCallable<CommitCursorRequest,CommitCursorResponse> commitCursorCallable()
      Updates the committed cursor.

      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 (CursorServiceClient cursorServiceClient = CursorServiceClient.create()) {
   CommitCursorRequest request =
       CommitCursorRequest.newBuilder()
           .setSubscription("subscription341203229")
           .setPartition(-1799810326)
           .setCursor(Cursor.newBuilder().build())
           .build();
   ApiFuture<CommitCursorResponse> future =
       cursorServiceClient.commitCursorCallable().futureCall(request);
   // Do something.
   CommitCursorResponse response = future.get();
 }

    • listPartitionCursors

      public final CursorServiceClient.ListPartitionCursorsPagedResponse listPartitionCursors(SubscriptionName parent)
      Returns all committed cursor information for a subscription.

      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 (CursorServiceClient cursorServiceClient = CursorServiceClient.create()) {
   SubscriptionName parent = SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]");
   for (PartitionCursor element :
       cursorServiceClient.listPartitionCursors(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The subscription for which to retrieve cursors. Structured like `projects/{project_number}/locations/{location}/subscriptions/{subscription_id}`.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • listPartitionCursors

      public final CursorServiceClient.ListPartitionCursorsPagedResponse listPartitionCursors(String parent)
      Returns all committed cursor information for a subscription.

      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 (CursorServiceClient cursorServiceClient = CursorServiceClient.create()) {
   String parent = SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString();
   for (PartitionCursor element :
       cursorServiceClient.listPartitionCursors(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The subscription for which to retrieve cursors. Structured like `projects/{project_number}/locations/{location}/subscriptions/{subscription_id}`.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • listPartitionCursors

      public final CursorServiceClient.ListPartitionCursorsPagedResponse listPartitionCursors(ListPartitionCursorsRequest request)
      Returns all committed cursor information for a subscription.

      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 (CursorServiceClient cursorServiceClient = CursorServiceClient.create()) {
   ListPartitionCursorsRequest request =
       ListPartitionCursorsRequest.newBuilder()
           .setParent(
               SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (PartitionCursor element :
       cursorServiceClient.listPartitionCursors(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • listPartitionCursorsPagedCallable

      public final com.google.api.gax.rpc.UnaryCallable<ListPartitionCursorsRequest,CursorServiceClient.ListPartitionCursorsPagedResponse> listPartitionCursorsPagedCallable()
      Returns all committed cursor information for a subscription.

      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 (CursorServiceClient cursorServiceClient = CursorServiceClient.create()) {
   ListPartitionCursorsRequest request =
       ListPartitionCursorsRequest.newBuilder()
           .setParent(
               SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<PartitionCursor> future =
       cursorServiceClient.listPartitionCursorsPagedCallable().futureCall(request);
   // Do something.
   for (PartitionCursor element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listPartitionCursorsCallable

      public final com.google.api.gax.rpc.UnaryCallable<ListPartitionCursorsRequest,ListPartitionCursorsResponse> listPartitionCursorsCallable()
      Returns all committed cursor information for a subscription.

      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 (CursorServiceClient cursorServiceClient = CursorServiceClient.create()) {
   ListPartitionCursorsRequest request =
       ListPartitionCursorsRequest.newBuilder()
           .setParent(
               SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListPartitionCursorsResponse response =
         cursorServiceClient.listPartitionCursorsCallable().call(request);
     for (PartitionCursor element : response.getPartitionCursorsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • 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