patch method

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

Updates an active or paused Schedule.

When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.

request - The metadata request object.

Request parameters:

name - Immutable. The resource name of the Schedule. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/schedules/\[^/\]+$.

updateMask - Required. The update mask applies to the resource. See google.protobuf.FieldMask.

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

Completes with a GoogleCloudAiplatformV1Schedule.

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<GoogleCloudAiplatformV1Schedule> patch(
  GoogleCloudAiplatformV1Schedule 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 GoogleCloudAiplatformV1Schedule.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}