Method: schedules.patch

Full name: projects.locations.schedules.patch

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.

Endpoint

patchhttps://{service-endpoint}/v1/{schedule.name}

PATCH https://{service-endpoint}/v1/{schedule.name}

Where{service-endpoint} is one of thesupported service endpoints.

Path parameters

schedule.namestring

Immutable. The resource name of the Schedule.

Query parameters

updateMaskstring (FieldMask format)

Required. The update mask applies to the resource. Seegoogle.protobuf.FieldMask.

This is a comma-separated list of fully qualified names of fields. Example:"user.displayName,photo".

Request body

The request body contains an instance ofSchedule.

Response body

If successful, the response body contains an instance ofSchedule.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-06-27 UTC.