public interface CursorClient extends ApiBackgroundResourceImplements
ApiBackgroundResourceStatic 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 |
SubscriptionPathThe subscription to commit a cursor for. |
partition |
PartitionThe partition to commit a cursor for. |
offset |
OffsetThe 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 |
SubscriptionPathThe 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 |
|