patch method

Future<GoogleCloudAiplatformV1TensorboardExperiment> patch(
  1. GoogleCloudAiplatformV1TensorboardExperiment request,
  2. String name, {
  3. String? updateMask,
  4. String? $fields,
})

Updates a TensorboardExperiment.

request - The metadata request object.

Request parameters:

name - Output only. Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/tensorboards/\[^/\]+/experiments/\[^/\]+$.

updateMask - Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

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

Completes with a GoogleCloudAiplatformV1TensorboardExperiment.

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<GoogleCloudAiplatformV1TensorboardExperiment> patch(
  GoogleCloudAiplatformV1TensorboardExperiment request,
  core.String name, {
  core.String? updateMask,
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if (updateMask != null) 'updateMask': [updateMask],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name');

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