batchRead method

Future<GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse> batchRead(String tensorboard, { List<String>? timeSeries, String? $fields, })

Reads multiple TensorboardTimeSeries' data.

The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.

Request parameters:

tensorboard - Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/tensorboards/\[^/\]+$.

timeSeries - Required. The resource names of the TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

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

Completes with a GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse.

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

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

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