write method

Future<GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse> write(
  1. GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest request,
  2. String tensorboardExperiment, {
  3. String? $fields,
})

Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's.

If any data fail to be ingested, an error is returned.

request - The metadata request object.

Request parameters:

tensorboardExperiment - Required. The resource name of the TensorboardExperiment to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/tensorboards/\[^/\]+/experiments/\[^/\]+$.

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

Completes with a GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse.

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<GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse>
    write(
  GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest request,
  core.String tensorboardExperiment, {
  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/' + core.Uri.encodeFull('$tensorboardExperiment') + ':write';

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