write method

Future<GoogleCloudAiplatformV1WriteTensorboardRunDataResponse> write(
  1. GoogleCloudAiplatformV1WriteTensorboardRunDataRequest request,
  2. String tensorboardRun, {
  3. String? $fields,
})

Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun.

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

request - The metadata request object.

Request parameters:

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

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

Completes with a GoogleCloudAiplatformV1WriteTensorboardRunDataResponse.

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<GoogleCloudAiplatformV1WriteTensorboardRunDataResponse> write(
  GoogleCloudAiplatformV1WriteTensorboardRunDataRequest request,
  core.String tensorboardRun, {
  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('$tensorboardRun') + ':write';

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