Class CursorServiceClient (1.4.12)

public class CursorServiceClient implements 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:


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

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

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.
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.
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 CursorServiceSettings to create(). For example:

To customize credentials:


 CursorServiceSettings cursorServiceSettings =
     CursorServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CursorServiceClient cursorServiceClient = CursorServiceClient.create(cursorServiceSettings);

To customize the endpoint:


 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.

Inheritance

java.lang.Object > CursorServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final CursorServiceClient create()

Constructs an instance of CursorServiceClient with default settings.

Returns

Type	Description
CursorServiceClient

Exceptions

Type	Description
IOException

create(CursorServiceSettings settings)

public static final CursorServiceClient create(CursorServiceSettings settings)

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.

Parameter

Name	Description
settings	`CursorServiceSettings`

Returns

Type	Description
CursorServiceClient

Exceptions

Type	Description
IOException

create(CursorServiceStub stub)

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

Parameter

Name	Description
stub	`CursorServiceStub`

Returns

Type	Description
CursorServiceClient

Constructors

CursorServiceClient(CursorServiceSettings settings)

protected CursorServiceClient(CursorServiceSettings settings)

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.

Parameter

Name	Description
settings	`CursorServiceSettings`

CursorServiceClient(CursorServiceStub stub)

protected CursorServiceClient(CursorServiceStub stub)

Parameter

Name	Description
stub	`CursorServiceStub`

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

commitCursor(CommitCursorRequest request)

public final CommitCursorResponse commitCursor(CommitCursorRequest request)

Updates the committed cursor.

Sample code:


 try (CursorServiceClient cursorServiceClient = CursorServiceClient.create()) {
   CommitCursorRequest request =
       CommitCursorRequest.newBuilder()
           .setSubscription("subscription341203229")
           .setPartition(-1799810326)
           .setCursor(Cursor.newBuilder().build())
           .build();
   CommitCursorResponse response = cursorServiceClient.commitCursor(request);
 }

Parameter

Name	Description
request	`CommitCursorRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
CommitCursorResponse

commitCursorCallable()

public final UnaryCallable<CommitCursorRequest,CommitCursorResponse> commitCursorCallable()

Updates the committed cursor.

Sample code:


 try (CursorServiceClient cursorServiceClient = CursorServiceClient.create()) {
   CommitCursorRequest request =
       CommitCursorRequest.newBuilder()
           .setSubscription("subscription341203229")
           .setPartition(-1799810326)
           .setCursor(Cursor.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CommitCursorRequest,CommitCursorResponse>

getSettings()

public final CursorServiceSettings getSettings()

Returns

Type	Description
CursorServiceSettings

getStub()

public CursorServiceStub getStub()

Returns

Type	Description
CursorServiceStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listPartitionCursors(ListPartitionCursorsRequest request)

public final CursorServiceClient.ListPartitionCursorsPagedResponse listPartitionCursors(ListPartitionCursorsRequest request)

Returns all committed cursor information for a subscription.

Sample code:


 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);
   }
 }

Parameter

Name	Description
request	`ListPartitionCursorsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
CursorServiceClient.ListPartitionCursorsPagedResponse

listPartitionCursors(SubscriptionName parent)

public final CursorServiceClient.ListPartitionCursorsPagedResponse listPartitionCursors(SubscriptionName parent)

Returns all committed cursor information for a subscription.

Sample code:


 try (CursorServiceClient cursorServiceClient = CursorServiceClient.create()) {
   SubscriptionName parent = SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]");
   for (PartitionCursor element :
       cursorServiceClient.listPartitionCursors(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`SubscriptionName` Required. The subscription for which to retrieve cursors. Structured like `projects/{project_number}/locations/{location}/subscriptions/{subscription_id}`.

Returns

Type	Description
CursorServiceClient.ListPartitionCursorsPagedResponse

listPartitionCursors(String parent)

public final CursorServiceClient.ListPartitionCursorsPagedResponse listPartitionCursors(String parent)

Returns all committed cursor information for a subscription.

Sample code:


 try (CursorServiceClient cursorServiceClient = CursorServiceClient.create()) {
   String parent = SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString();
   for (PartitionCursor element :
       cursorServiceClient.listPartitionCursors(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name	Description
parent	`String` Required. The subscription for which to retrieve cursors. Structured like `projects/{project_number}/locations/{location}/subscriptions/{subscription_id}`.

Returns

Type	Description
CursorServiceClient.ListPartitionCursorsPagedResponse

listPartitionCursorsCallable()

public final UnaryCallable<ListPartitionCursorsRequest,ListPartitionCursorsResponse> listPartitionCursorsCallable()

Returns all committed cursor information for a subscription.

Sample code:


 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.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListPartitionCursorsRequest,ListPartitionCursorsResponse>

listPartitionCursorsPagedCallable()

public final UnaryCallable<ListPartitionCursorsRequest,CursorServiceClient.ListPartitionCursorsPagedResponse> listPartitionCursorsPagedCallable()

Returns all committed cursor information for a subscription.

Sample code:


 try (CursorServiceClient cursorServiceClient = CursorServiceClient.create()) {
   ListPartitionCursorsRequest request =
       ListPartitionCursorsRequest.newBuilder()
           .setParent(
               SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListPartitionCursorsRequest,ListPartitionCursorsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

streamingCommitCursorCallable()

public final BidiStreamingCallable<StreamingCommitCursorRequest,StreamingCommitCursorResponse> streamingCommitCursorCallable()

Establishes a stream with the server for managing committed cursors.

Sample code:


 try (CursorServiceClient cursorServiceClient = CursorServiceClient.create()) {
   BidiStream

Returns

Type	Description
BidiStreamingCallable<StreamingCommitCursorRequest,StreamingCommitCursorResponse>