CursorServiceClient (Google Cloud Pub/Sub Lite 0.5.0 API)

java.lang.Object
- com.google.cloud.pubsublite.v1.CursorServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
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:
```
 
 try (CursorServiceClient cursorServiceClient = CursorServiceClient.create()) {
   SubscriptionName parent = SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]");
   for (PartitionCursor element : cursorServiceClient.listPartitionCursors(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
 
```
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:
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 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);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CursorServiceClient.ListPartitionCursorsFixedSizeCollection`
`static class`	`CursorServiceClient.ListPartitionCursorsPage`
`static class`	`CursorServiceClient.ListPartitionCursorsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`CursorServiceClient(CursorServiceSettings settings)` Constructs an instance of CursorServiceClient, using the given settings.
`protected`	`CursorServiceClient(CursorServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`CommitCursorResponse`	`commitCursor(CommitCursorRequest request)` Updates the committed cursor.
`com.google.api.gax.rpc.UnaryCallable<CommitCursorRequest,CommitCursorResponse>`	`commitCursorCallable()` Updates the committed cursor.
`static CursorServiceClient`	`create()` Constructs an instance of CursorServiceClient with default settings.
`static CursorServiceClient`	`create(CursorServiceSettings settings)` Constructs an instance of CursorServiceClient, using the given settings.
`static CursorServiceClient`	`create(CursorServiceStub stub)` Constructs an instance of CursorServiceClient, using the given stub for making calls.
`CursorServiceSettings`	`getSettings()`
`CursorServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`CursorServiceClient.ListPartitionCursorsPagedResponse`	`listPartitionCursors(ListPartitionCursorsRequest request)` Returns all committed cursor information for a subscription.
`CursorServiceClient.ListPartitionCursorsPagedResponse`	`listPartitionCursors(String parent)` Returns all committed cursor information for a subscription.
`CursorServiceClient.ListPartitionCursorsPagedResponse`	`listPartitionCursors(SubscriptionName parent)` Returns all committed cursor information for a subscription.
`com.google.api.gax.rpc.UnaryCallable<ListPartitionCursorsRequest,ListPartitionCursorsResponse>`	`listPartitionCursorsCallable()` Returns all committed cursor information for a subscription.
`com.google.api.gax.rpc.UnaryCallable<ListPartitionCursorsRequest,CursorServiceClient.ListPartitionCursorsPagedResponse>`	`listPartitionCursorsPagedCallable()` Returns all committed cursor information for a subscription.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.api.gax.rpc.BidiStreamingCallable<StreamingCommitCursorRequest,StreamingCommitCursorResponse>`	`streamingCommitCursorCallable()` Establishes a stream with the server for managing committed cursors.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- 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
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected CursorServiceClient(CursorServiceStub stub)
```

Method Detail

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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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 to use CursorServiceSettings}.

getSettings

public final CursorServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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:


 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 receive a response
   }
 }

commitCursor

public final CommitCursorResponse commitCursor(CommitCursorRequest request)

Updates the committed cursor.

Sample code:


 try (CursorServiceClient cursorServiceClient = CursorServiceClient.create()) {
   CommitCursorRequest request = CommitCursorRequest.newBuilder().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:


 try (CursorServiceClient cursorServiceClient = CursorServiceClient.create()) {
   CommitCursorRequest request = CommitCursorRequest.newBuilder().build();
   ApiFuture<CommitCursorResponse> future = cursorServiceClient.commitCursorCallable().futureCall(request);
   // Do something
   CommitCursorResponse response = future.get();
 }