class TopicStatsProjectsLocationsTopics extends Resource (View source)

The "topics" collection of methods.

Typical usage is:

 $pubsubliteService = new Google\Service\PubsubLite(...);
 $topics = $pubsubliteService->topicStats_projects_locations_topics;

Methods

computeHeadCursor(string $topic, ComputeHeadCursorRequest $postBody, array $optParams = [])

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. (topics.computeHeadCursor)

computeMessageStats(string $topic, ComputeMessageStatsRequest $postBody, array $optParams = [])

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

computeTimeCursor(string $topic, ComputeTimeCursorRequest $postBody, array $optParams = [])

Compute the corresponding cursor for a publish or event time in a topic partition. (topics.computeTimeCursor)

Details

ComputeHeadCursorResponse computeHeadCursor(string $topic, ComputeHeadCursorRequest $postBody, array $optParams = [])

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. (topics.computeHeadCursor)

Parameters

string $topic

Required. The topic for which we should compute the head cursor.

ComputeHeadCursorRequest $postBody
array $optParams

Optional parameters.

Return Value

ComputeHeadCursorResponse

Exceptions

Exception

ComputeMessageStatsResponse computeMessageStats(string $topic, ComputeMessageStatsRequest $postBody, array $optParams = [])

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

(topics.computeMessageStats)

Parameters

string $topic

Required. The topic for which we should compute message stats.

ComputeMessageStatsRequest $postBody
array $optParams

Optional parameters.

Return Value

ComputeMessageStatsResponse

Exceptions

Exception

ComputeTimeCursorResponse computeTimeCursor(string $topic, ComputeTimeCursorRequest $postBody, array $optParams = [])

Compute the corresponding cursor for a publish or event time in a topic partition. (topics.computeTimeCursor)

Parameters

string $topic

Required. The topic for which we should compute the cursor.

ComputeTimeCursorRequest $postBody
array $optParams

Optional parameters.

Return Value

ComputeTimeCursorResponse

Exceptions

Exception