1. class
  2. Google
  3. \
  4. Service
  5. \
  6. AIPlatformNotebooks
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsSchedules

ProjectsLocationsSchedules

class ProjectsLocationsSchedules extends Resource (View source)

The "schedules" collection of methods.

Typical usage is:

 $notebooksService = new Google\Service\AIPlatformNotebooks(...);
 $schedules = $notebooksService->projects_locations_schedules;

Methods

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

Creates a new Scheduled Notebook in a given project and location.

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

Deletes schedule and all underlying jobs (schedules.delete)

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

Gets details of schedule (schedules.get)

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

Lists schedules in a given project and location.

Operation
trigger(string $name, TriggerScheduleRequest $postBody, array $optParams = [])

Triggers execution of an existing schedule. (schedules.trigger)

Details

at line 48
Operation create(string $parent, Schedule $postBody, array $optParams = [])

Creates a new Scheduled Notebook in a given project and location.

(schedules.create)

Parameters

string $parent

Required. Format: parent=projects/{project_id}/locations/{location}
Schedule $postBody
array $optParams

Optional parameters.

Return Value

Operation

at line 62
Operation delete(string $name, array $optParams = [])

Deletes schedule and all underlying jobs (schedules.delete)

Parameters

string $name

Required. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}
array $optParams

Optional parameters.

Return Value

Operation

at line 76
Schedule get(string $name, array $optParams = [])

Gets details of schedule (schedules.get)

Parameters

string $name

Required. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}
array $optParams

Optional parameters.

Return Value

Schedule

at line 97
ListSchedulesResponse listProjectsLocationsSchedules(string $parent, array $optParams = [])

Lists schedules in a given project and location.

(schedules.listProjectsLocationsSchedules)

Parameters

string $parent

Required. Format: parent=projects/{project_id}/locations/{location}
array $optParams

Optional parameters.

Return Value

ListSchedulesResponse

at line 112
Operation trigger(string $name, TriggerScheduleRequest $postBody, array $optParams = [])

Triggers execution of an existing schedule. (schedules.trigger)

Parameters

string $name

Required. Format: parent=projects/{project_id}/locations/{location}/schedules/{schedule_id}
TriggerScheduleRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation