Class TopicStatsServiceClient (2.18.0)

Version 2.18.0

• 2.32.0-rc (latest)
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

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

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

TopicStatsServiceClient(TopicStatsServiceClient const &)

Copy and move support

Parameter
Name	Description
	TopicStatsServiceClient const &

TopicStatsServiceClient(TopicStatsServiceClient &&)

Copy and move support

Parameter
Name	Description
	TopicStatsServiceClient &&

TopicStatsServiceClient(std::shared_ptr< TopicStatsServiceConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< TopicStatsServiceConnection >
opts	Options

Operators

operator=(TopicStatsServiceClient const &)

Copy and move support

Parameter
Name	Description
	TopicStatsServiceClient const &

Returns
Type	Description
TopicStatsServiceClient &

operator=(TopicStatsServiceClient &&)

Copy and move support

Parameter
Name	Description
	TopicStatsServiceClient &&

Returns
Type	Description
TopicStatsServiceClient &

Functions

ComputeMessageStats(google::cloud::pubsublite::v1::ComputeMessageStatsRequest const &, Options)

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

Parameters
Name	Description
request	google::cloud::pubsublite::v1::ComputeMessageStatsRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.pubsublite.v1.ComputeMessageStatsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::pubsublite::v1::ComputeMessageStatsResponse >	the result of the RPC. The response message type (google.cloud.pubsublite.v1.ComputeMessageStatsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ComputeHeadCursor(google::cloud::pubsublite::v1::ComputeHeadCursorRequest const &, Options)

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.

Parameters
Name	Description
request	google::cloud::pubsublite::v1::ComputeHeadCursorRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.pubsublite.v1.ComputeHeadCursorRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::pubsublite::v1::ComputeHeadCursorResponse >	the result of the RPC. The response message type (google.cloud.pubsublite.v1.ComputeHeadCursorResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ComputeTimeCursor(google::cloud::pubsublite::v1::ComputeTimeCursorRequest const &, Options)

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

Parameters
Name	Description
request	google::cloud::pubsublite::v1::ComputeTimeCursorRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.pubsublite.v1.ComputeTimeCursorRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::pubsublite::v1::ComputeTimeCursorResponse >	the result of the RPC. The response message type (google.cloud.pubsublite.v1.ComputeTimeCursorResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.