Interface CursorClient (1.12.22)

Version 1.12.22

• 1.14.7 (latest)
• 1.14.4
• 1.13.8
• 1.12.22
• 1.11.2
• 1.10.0
• 1.9.4
• 1.8.0
• 1.7.1
• 1.6.3
• 1.5.5
• 1.4.12

public interface CursorClient extends ApiBackgroundResource

Implements

ApiBackgroundResource

Static Methods

create(CursorClientSettings settings)

public static CursorClient create(CursorClientSettings settings)

Parameter
Name	Description
settings	CursorClientSettings

Returns
Type	Description
CursorClient

Exceptions
Type	Description
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
Name	Description
path	SubscriptionPath The subscription to commit a cursor for.
partition	Partition The partition to commit a cursor for.
offset	Offset The offset to commit.

Returns
Type	Description
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
Name	Description
path	SubscriptionPath The subscription to list cursors for.

Returns
Type	Description
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
Type	Description
CloudRegion