read method

Future<GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse> read(
  1. String tensorboardTimeSeries, {
  2. String? filter,
  3. int? maxDataPoints,
  4. String? $fields,
})

Reads a TensorboardTimeSeries' data.

By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

Request parameters:

tensorboardTimeSeries - Required. The resource name of the TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/tensorboards/\[^/\]+/experiments/\[^/\]+/runs/\[^/\]+/timeSeries/\[^/\]+$.

filter - Reads the TensorboardTimeSeries' data that match the filter expression.

maxDataPoints - The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.

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

Completes with a GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse.

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<GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse>
    read(
  core.String tensorboardTimeSeries, {
  core.String? filter,
  core.int? maxDataPoints,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (maxDataPoints != null) 'maxDataPoints': ['${maxDataPoints}'],
    if ($fields != null) 'fields': [$fields],
  };

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

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