com.google.cloud.pubsublite.internal

Interface TopicStatsClient

All Superinterfaces:

ApiBackgroundResource, AutoCloseable, com.google.api.gax.core.BackgroundResource

All Known Implementing Classes:

TopicStatsClientImpl

public interface TopicStatsClient
extends ApiBackgroundResource

Method Summary

Modifier and Type	Method and Description
com.google.api.core.ApiFuture<ComputeMessageStatsResponse>	computeMessageStats(TopicPath path, Partition partition, Offset start, Offset end) Compute statistics about the messages between two cursors in a topic partition.
static TopicStatsClient	create(TopicStatsClientSettings settings)
CloudRegion	region() The Google Cloud region this client operates on.

Methods inherited from interface com.google.cloud.pubsublite.internal.ApiBackgroundResource

close

Methods inherited from interface com.google.api.gax.core.BackgroundResource

awaitTermination, isShutdown, isTerminated, shutdown, shutdownNow

Method Detail

create

static TopicStatsClient create(TopicStatsClientSettings settings)
                        throws io.grpc.StatusException

Throws:

io.grpc.StatusException

region

CloudRegion region()

The Google Cloud region this client operates on.

computeMessageStats

com.google.api.core.ApiFuture<ComputeMessageStatsResponse> computeMessageStats(TopicPath path,
                                                                               Partition partition,
                                                                               Offset start,
                                                                               Offset end)

Compute statistics about the messages between two cursors in a topic partition.

Parameters:

path - The topic to compute statistics on

partition - The partition to compute statistics for

start - The start cursor

end - The end cursor

Returns:

A future that will have either an error StatusException or the ComputeMessageStatistics on success.