class ProjectsLocationsSchedules extends Resource (View source)

The "schedules" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $schedules = $aiplatformService->projects_locations_schedules;

Methods

create(string $parent, GoogleCloudAiplatformV1Schedule $postBody, array $optParams = [])

Creates a Schedule. (schedules.create)

delete(string $name, array $optParams = [])

Deletes a Schedule. (schedules.delete)

get(string $name, array $optParams = [])

Gets a Schedule. (schedules.get)

listProjectsLocationsSchedules(string $parent, array $optParams = [])

Lists Schedules in a Location. (schedules.listProjectsLocationsSchedules)

patch(string $name, GoogleCloudAiplatformV1Schedule $postBody, array $optParams = [])

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. (schedules.patch)

pause(string $name, GoogleCloudAiplatformV1PauseScheduleRequest $postBody, array $optParams = [])

Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled. (schedules.pause)

resume(string $name, GoogleCloudAiplatformV1ResumeScheduleRequest $postBody, array $optParams = [])

Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catchUp is set up true, all missed runs will be scheduled for backfill first. (schedules.resume)

Details

GoogleCloudAiplatformV1Schedule create(string $parent, GoogleCloudAiplatformV1Schedule $postBody, array $optParams = [])

Creates a Schedule. (schedules.create)

Parameters

string $parent

Required. The resource name of the Location to create the Schedule in. Format: projects/{project}/locations/{location}

GoogleCloudAiplatformV1Schedule $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1Schedule

Exceptions

Exception

GoogleLongrunningOperation delete(string $name, array $optParams = [])

Deletes a Schedule. (schedules.delete)

Parameters

string $name

Required. The name of the Schedule resource to be deleted. Format: projects/{project}/locations/{location}/schedules/{schedule}

array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleCloudAiplatformV1Schedule get(string $name, array $optParams = [])

Gets a Schedule. (schedules.get)

Parameters

string $name

Required. The name of the Schedule resource. Format: projects/{project}/locations/{location}/schedules/{schedule}

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1Schedule

Exceptions

Exception

GoogleCloudAiplatformV1ListSchedulesResponse listProjectsLocationsSchedules(string $parent, array $optParams = [])

Lists Schedules in a Location. (schedules.listProjectsLocationsSchedules)

Parameters

string $parent

Required. The resource name of the Location to list the Schedules from. Format: projects/{project}/locations/{location}

array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListSchedulesResponse

Exceptions

Exception

GoogleCloudAiplatformV1Schedule patch(string $name, GoogleCloudAiplatformV1Schedule $postBody, array $optParams = [])

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. (schedules.patch)

Parameters

string $name

Immutable. The resource name of the Schedule.

GoogleCloudAiplatformV1Schedule $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1Schedule

Exceptions

Exception

GoogleProtobufEmpty pause(string $name, GoogleCloudAiplatformV1PauseScheduleRequest $postBody, array $optParams = [])

Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled. (schedules.pause)

Parameters

string $name

Required. The name of the Schedule resource to be paused. Format: projects/{project}/locations/{location}/schedules/{schedule}

GoogleCloudAiplatformV1PauseScheduleRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleProtobufEmpty resume(string $name, GoogleCloudAiplatformV1ResumeScheduleRequest $postBody, array $optParams = [])

Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catchUp is set up true, all missed runs will be scheduled for backfill first. (schedules.resume)

Parameters

string $name

Required. The name of the Schedule resource to be resumed. Format: projects/{project}/locations/{location}/schedules/{schedule}

GoogleCloudAiplatformV1ResumeScheduleRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception