computeMessageStats method

Future<ComputeMessageStatsResponse> computeMessageStats(
  1. ComputeMessageStatsRequest request,
  2. String topic, {
  3. String? $fields,
})

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

request - The metadata request object.

Request parameters:

topic - Required. The topic for which we should compute message stats. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/topics/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a ComputeMessageStatsResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<ComputeMessageStatsResponse> computeMessageStats(
  ComputeMessageStatsRequest request,
  core.String topic, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/topicStats/' +
      core.Uri.encodeFull('$topic') +
      ':computeMessageStats';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return ComputeMessageStatsResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}