Interface CursorClient (1.4.12)

public interface CursorClient extends ApiBackgroundResource

Static Methods

create(CursorClientSettings settings)

public static CursorClient create(CursorClientSettings settings)
Parameter
NameDescription
settingsCursorClientSettings
Returns
TypeDescription
CursorClient
Exceptions
TypeDescription
ApiException

Methods

commitCursor(SubscriptionPath path, Partition partition, Offset offset)

public abstract ApiFuture<Void> commitCursor(SubscriptionPath path, Partition partition, Offset offset)

Commit a single cursor.

Parameters
NameDescription
pathSubscriptionPath

The subscription to commit a cursor for.

partitionPartition

The partition to commit a cursor for.

offsetOffset

The offset to commit.

Returns
TypeDescription
ApiFuture<Void>

A future for the operation's completion.

listPartitionCursors(SubscriptionPath path)

public abstract ApiFuture<Map<Partition,Offset>> listPartitionCursors(SubscriptionPath path)

List the cursors for a given subscription.

Parameter
NameDescription
pathSubscriptionPath

The subscription to list cursors for.

Returns
TypeDescription
ApiFuture<Map<Partition,Offset>>

A future holding the map of Partition to Offset of the cursors.

region()

public abstract CloudRegion region()

The Google Cloud region this client operates on.

Returns
TypeDescription
CloudRegion