com.google.cloud.pubsublite.internal

Class TopicStatsClientImpl

java.lang.Object

com.google.cloud.pubsublite.internal.ApiResourceAggregation

com.google.cloud.pubsublite.internal.TopicStatsClientImpl

All Implemented Interfaces:

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

public class TopicStatsClientImpl
extends ApiResourceAggregation
implements TopicStatsClient

Constructor Summary

Constructors

Constructor and Description
TopicStatsClientImpl(CloudRegion region, TopicStatsServiceClient serviceClient)

Method Summary

Modifier and Type	Method and Description
com.google.api.core.ApiFuture<Cursor>	computeHeadCursor(TopicPath path, Partition partition) Compute the head cursor for the partition.
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.
CloudRegion	region() The Google Cloud region this client operates on.

Methods inherited from class com.google.cloud.pubsublite.internal.ApiResourceAggregation

awaitTermination, close, isShutdown, isTerminated, shutdown, shutdownNow

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

create

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

Constructor Detail

TopicStatsClientImpl

public TopicStatsClientImpl(CloudRegion region,
                            TopicStatsServiceClient serviceClient)

Method Detail

region

public CloudRegion region()

Description copied from interface: TopicStatsClient

The Google Cloud region this client operates on.

Specified by:

region in interface TopicStatsClient

computeMessageStats

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

Description copied from interface: TopicStatsClient

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

Specified by:

computeMessageStats in interface TopicStatsClient

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 ApiException or the ComputeMessageStatistics on success.

computeHeadCursor

public com.google.api.core.ApiFuture<Cursor> computeHeadCursor(TopicPath path,
                                                               Partition partition)

Description copied from interface: TopicStatsClient

Compute the head cursor for the partition. The head cursor's offset is guaranteed to be before or equal to all messages which have not yet been acknowledged to be published, and greater than the offset of any message whose publish has already been acknowledged. It is 0 if there have never been messages on the partition.

Specified by:

computeHeadCursor in interface TopicStatsClient

Parameters:

path - The topic to compute head cursor on

partition - The partition to compute head cursor for

Returns:

A future that will have either an error ApiException or the head cursor on success.