readUsage method

Future<GoogleCloudAiplatformV1ReadTensorboardUsageResponse> readUsage(
  1. String tensorboard, {
  2. String? $fields,
})

Returns a list of monthly active users for a given TensorBoard instance.

Request parameters:

tensorboard - Required. The name of the Tensorboard resource. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/tensorboards/\[^/\]+$.

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

Completes with a GoogleCloudAiplatformV1ReadTensorboardUsageResponse.

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<GoogleCloudAiplatformV1ReadTensorboardUsageResponse> readUsage(
  core.String tensorboard, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$tensorboard') + ':readUsage';

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