Class TopicStatsServiceClient (1.6.1)

Version 1.6.1

• 1.13.2 (latest)
• 1.13.0
• 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 class TopicStatsServiceClient implements 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:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 TopicStatsServiceSettings topicStatsServiceSettings =
     TopicStatsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TopicStatsServiceClient topicStatsServiceClient =
     TopicStatsServiceClient.create(topicStatsServiceSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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.

Inheritance

java.lang.Object > TopicStatsServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final TopicStatsServiceClient create()

Constructs an instance of TopicStatsServiceClient with default settings.

Returns

Type	Description
TopicStatsServiceClient

Exceptions

Type	Description
IOException

create(TopicStatsServiceSettings settings)

public static final TopicStatsServiceClient create(TopicStatsServiceSettings settings)

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.

Parameter

Name	Description
settings	TopicStatsServiceSettings

Returns

Type	Description
TopicStatsServiceClient

Exceptions

Type	Description
IOException

create(TopicStatsServiceStub stub)

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).

Parameter

Name	Description
stub	TopicStatsServiceStub

Returns

Type	Description
TopicStatsServiceClient

Constructors

TopicStatsServiceClient(TopicStatsServiceSettings settings)

protected TopicStatsServiceClient(TopicStatsServiceSettings settings)

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.

Parameter

Name	Description
settings	TopicStatsServiceSettings

TopicStatsServiceClient(TopicStatsServiceStub stub)

protected TopicStatsServiceClient(TopicStatsServiceStub stub)

Parameter

Name	Description
stub	TopicStatsServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

close()

public final void close()

computeHeadCursor(ComputeHeadCursorRequest request)

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:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (TopicStatsServiceClient topicStatsServiceClient = TopicStatsServiceClient.create()) {
   ComputeHeadCursorRequest request =
       ComputeHeadCursorRequest.newBuilder()
           .setTopic(TopicName.of("[PROJECT]", "[LOCATION]", "[TOPIC]").toString())
           .setPartition(-1799810326)
           .build();
   ComputeHeadCursorResponse response = topicStatsServiceClient.computeHeadCursor(request);
 }
 

Parameter

Name	Description
request	ComputeHeadCursorRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ComputeHeadCursorResponse

computeHeadCursorCallable()

public final 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:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 

Returns

Type	Description
UnaryCallable<ComputeHeadCursorRequest,ComputeHeadCursorResponse>

computeMessageStats(ComputeMessageStatsRequest request)

public final ComputeMessageStatsResponse computeMessageStats(ComputeMessageStatsRequest request)

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
 }
 

Parameter

Name	Description
request	ComputeMessageStatsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ComputeMessageStatsResponse

computeMessageStatsCallable()

public final UnaryCallable<ComputeMessageStatsRequest,ComputeMessageStatsResponse> computeMessageStatsCallable()

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 

Returns

Type	Description
UnaryCallable<ComputeMessageStatsRequest,ComputeMessageStatsResponse>

computeTimeCursor(ComputeTimeCursorRequest request)

public final ComputeTimeCursorResponse computeTimeCursor(ComputeTimeCursorRequest request)

Compute the corresponding cursor for a publish or event time in a topic partition.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (TopicStatsServiceClient topicStatsServiceClient = TopicStatsServiceClient.create()) {
   ComputeTimeCursorRequest request =
       ComputeTimeCursorRequest.newBuilder()
           .setTopic(TopicName.of("[PROJECT]", "[LOCATION]", "[TOPIC]").toString())
           .setPartition(-1799810326)
           .setTarget(TimeTarget.newBuilder().build())
           .build();
   ComputeTimeCursorResponse response = topicStatsServiceClient.computeTimeCursor(request);
 }
 

Parameter

Name	Description
request	ComputeTimeCursorRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ComputeTimeCursorResponse

computeTimeCursorCallable()

public final UnaryCallable<ComputeTimeCursorRequest,ComputeTimeCursorResponse> computeTimeCursorCallable()

Compute the corresponding cursor for a publish or event time in a topic partition.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (TopicStatsServiceClient topicStatsServiceClient = TopicStatsServiceClient.create()) {
   ComputeTimeCursorRequest request =
       ComputeTimeCursorRequest.newBuilder()
           .setTopic(TopicName.of("[PROJECT]", "[LOCATION]", "[TOPIC]").toString())
           .setPartition(-1799810326)
           .setTarget(TimeTarget.newBuilder().build())
           .build();
   ApiFuture<ComputeTimeCursorResponse> future =
       topicStatsServiceClient.computeTimeCursorCallable().futureCall(request);
   // Do something.
   ComputeTimeCursorResponse response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<ComputeTimeCursorRequest,ComputeTimeCursorResponse>

getSettings()

public final TopicStatsServiceSettings getSettings()

Returns

Type	Description
TopicStatsServiceSettings

getStub()

public TopicStatsServiceStub getStub()

Returns

Type	Description
TopicStatsServiceStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()