com.google.cloud.pubsublite.v1

Class TopicStatsServiceClient

java.lang.Object

com.google.cloud.pubsublite.v1.TopicStatsServiceClient

All Implemented Interfaces:

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

@Generated(value="by gapic-generator-java")
public class TopicStatsServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: This service allows users to get stats about messages in their topic.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 try (TopicStatsServiceClient topicStatsServiceClient = TopicStatsServiceClient.create()) {
   ComputeMessageStatsRequest request =
       ComputeMessageStatsRequest.newBuilder()
           .setTopic(TopicName.of("[PROJECT]", "[LOCATION]", "[TOPIC]").toString())
           .setPartition(-1799810326)
           .setStartCursor(Cursor.newBuilder().build())
           .setEndCursor(Cursor.newBuilder().build())
           .build();
   ComputeMessageStatsResponse response = topicStatsServiceClient.computeMessageStats(request);
 }
 

Note: close() needs to be called on the TopicStatsServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of TopicStatsServiceSettings to create(). For example:

To customize credentials:

 TopicStatsServiceSettings topicStatsServiceSettings =
     TopicStatsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TopicStatsServiceClient topicStatsServiceClient =
     TopicStatsServiceClient.create(topicStatsServiceSettings);
 

To customize the endpoint:

 TopicStatsServiceSettings topicStatsServiceSettings =
     TopicStatsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 TopicStatsServiceClient topicStatsServiceClient =
     TopicStatsServiceClient.create(topicStatsServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TopicStatsServiceClient(TopicStatsServiceSettings settings) Constructs an instance of TopicStatsServiceClient, using the given settings.
protected	TopicStatsServiceClient(TopicStatsServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
ComputeHeadCursorResponse	computeHeadCursor(ComputeHeadCursorRequest request) Compute the head cursor for the partition.
com.google.api.gax.rpc.UnaryCallable<ComputeHeadCursorRequest,ComputeHeadCursorResponse>	computeHeadCursorCallable() Compute the head cursor for the partition.
ComputeMessageStatsResponse	computeMessageStats(ComputeMessageStatsRequest request) Compute statistics about a range of messages in a given topic and partition.
com.google.api.gax.rpc.UnaryCallable<ComputeMessageStatsRequest,ComputeMessageStatsResponse>	computeMessageStatsCallable() Compute statistics about a range of messages in a given topic and partition.
static TopicStatsServiceClient	create() Constructs an instance of TopicStatsServiceClient with default settings.
static TopicStatsServiceClient	create(TopicStatsServiceSettings settings) Constructs an instance of TopicStatsServiceClient, using the given settings.
static TopicStatsServiceClient	create(TopicStatsServiceStub stub) Constructs an instance of TopicStatsServiceClient, using the given stub for making calls.
TopicStatsServiceSettings	getSettings()
TopicStatsServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

TopicStatsServiceClient

protected TopicStatsServiceClient(TopicStatsServiceSettings settings)
                           throws IOException

Constructs an instance of TopicStatsServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

TopicStatsServiceClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected TopicStatsServiceClient(TopicStatsServiceStub stub)

Method Detail

create

public static final TopicStatsServiceClient create()
                                            throws IOException

Constructs an instance of TopicStatsServiceClient with default settings.

Throws:

IOException

create

public static final TopicStatsServiceClient create(TopicStatsServiceSettings settings)
                                            throws IOException

Constructs an instance of TopicStatsServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final TopicStatsServiceClient create(TopicStatsServiceStub stub)

Constructs an instance of TopicStatsServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(TopicStatsServiceSettings).

getSettings

public final TopicStatsServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public TopicStatsServiceStub getStub()

computeMessageStats

public final ComputeMessageStatsResponse computeMessageStats(ComputeMessageStatsRequest request)

Compute statistics about a range of messages in a given topic and partition.

Sample code:

 try (TopicStatsServiceClient topicStatsServiceClient = TopicStatsServiceClient.create()) {
   ComputeMessageStatsRequest request =
       ComputeMessageStatsRequest.newBuilder()
           .setTopic(TopicName.of("[PROJECT]", "[LOCATION]", "[TOPIC]").toString())
           .setPartition(-1799810326)
           .setStartCursor(Cursor.newBuilder().build())
           .setEndCursor(Cursor.newBuilder().build())
           .build();
   ComputeMessageStatsResponse response = topicStatsServiceClient.computeMessageStats(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

computeMessageStatsCallable

public final com.google.api.gax.rpc.UnaryCallable<ComputeMessageStatsRequest,ComputeMessageStatsResponse> computeMessageStatsCallable()

Compute statistics about a range of messages in a given topic and partition.

Sample code:

 try (TopicStatsServiceClient topicStatsServiceClient = TopicStatsServiceClient.create()) {
   ComputeMessageStatsRequest request =
       ComputeMessageStatsRequest.newBuilder()
           .setTopic(TopicName.of("[PROJECT]", "[LOCATION]", "[TOPIC]").toString())
           .setPartition(-1799810326)
           .setStartCursor(Cursor.newBuilder().build())
           .setEndCursor(Cursor.newBuilder().build())
           .build();
   ApiFuture<ComputeMessageStatsResponse> future =
       topicStatsServiceClient.computeMessageStatsCallable().futureCall(request);
   // Do something.
   ComputeMessageStatsResponse response = future.get();
 }
 

computeHeadCursor

public final ComputeHeadCursorResponse computeHeadCursor(ComputeHeadCursorRequest request)

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

Sample code:

 try (TopicStatsServiceClient topicStatsServiceClient = TopicStatsServiceClient.create()) {
   ComputeHeadCursorRequest request =
       ComputeHeadCursorRequest.newBuilder()
           .setTopic(TopicName.of("[PROJECT]", "[LOCATION]", "[TOPIC]").toString())
           .setPartition(-1799810326)
           .build();
   ComputeHeadCursorResponse response = topicStatsServiceClient.computeHeadCursor(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

computeHeadCursorCallable

public final com.google.api.gax.rpc.UnaryCallable<ComputeHeadCursorRequest,ComputeHeadCursorResponse> computeHeadCursorCallable()

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

Sample code:

 try (TopicStatsServiceClient topicStatsServiceClient = TopicStatsServiceClient.create()) {
   ComputeHeadCursorRequest request =
       ComputeHeadCursorRequest.newBuilder()
           .setTopic(TopicName.of("[PROJECT]", "[LOCATION]", "[TOPIC]").toString())
           .setPartition(-1799810326)
           .build();
   ApiFuture<ComputeHeadCursorResponse> future =
       topicStatsServiceClient.computeHeadCursorCallable().futureCall(request);
   // Do something.
   ComputeHeadCursorResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException