- 1.63.0 (latest)
- 1.62.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.1
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.39.0
- 1.38.1
- 1.37.0
- 1.36.4
- 1.35.0
- 1.34.0
- 1.33.1
- 1.32.0
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.1
- 1.27.1
- 1.26.1
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.1
- 1.21.0
- 1.20.0
- 1.19.1
- 1.18.3
- 1.17.1
- 1.16.1
- 1.15.1
- 1.14.0
- 1.13.1
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.1
- 1.7.1
- 1.6.2
- 1.5.0
- 1.4.3
- 1.3.0
- 1.2.0
- 1.1.1
- 1.0.1
- 0.9.0
- 0.8.0
- 0.7.1
- 0.6.0
- 0.5.1
- 0.4.0
- 0.3.1
PipelineJobSchedule(
pipeline_job: google.cloud.aiplatform.pipeline_jobs.PipelineJob,
display_name: str,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
)
Retrieves a PipelineJobSchedule resource and instantiates its representation.
Parameters |
|
---|---|
Name | Description |
pipeline_job |
PipelineJob
Required. PipelineJob used to init the schedule. |
display_name |
str
Required. The user-defined name of this PipelineJobSchedule. |
credentials |
auth_credentials.Credentials
Optional. Custom credentials to use to create this PipelineJobSchedule. Overrides credentials set in aiplatform.init. |
project |
str
Optional. The project that you want to run this PipelineJobSchedule in. If not set, the project used for the PipelineJob will be used. |
location |
str
Optional. Location to create PipelineJobSchedule. If not set, location used for the PipelineJob will be used. |
Properties
allow_queueing
Whether current Schedule allows queueing.
create_time
Time this resource was created.
cron
Current Schedule cron.
display_name
Display name of this resource.
encryption_spec
Customer-managed encryption key options for this Vertex AI resource.
If this is set, then all resources created by this Vertex AI resource will be encrypted with the provided encryption key.
gca_resource
The underlying resource proto representation.
labels
User-defined labels containing metadata about this resource.
Read more about labels at https://goo.gl/xmQnxf
max_concurrent_run_count
Current Schedule max_concurrent_run_count.
max_run_count
Current Schedule max_run_count.
name
Name of this resource.
resource_name
Full qualified resource name.
state
Current Schedule state.
update_time
Time this resource was last updated.
Methods
create
create(
cron: str,
start_time: typing.Optional[str] = None,
end_time: typing.Optional[str] = None,
allow_queueing: bool = False,
max_run_count: typing.Optional[int] = None,
max_concurrent_run_count: int = 1,
service_account: typing.Optional[str] = None,
network: typing.Optional[str] = None,
create_request_timeout: typing.Optional[float] = None,
) -> None
Create a PipelineJobSchedule.
Parameters | |
---|---|
Name | Description |
cron |
str
Required. Time specification (cron schedule expression) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". |
start_time |
str
Optional. Timestamp after which the first run can be scheduled. If unspecified, it defaults to the schedule creation timestamp. |
end_time |
str
Optional. Timestamp after which no more runs will be scheduled. If unspecified, then runs will be scheduled indefinitely. |
allow_queueing |
bool
Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. |
max_run_count |
int
Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. Must be positive and <= 2^63-1. |
max_concurrent_run_count |
int
Optional. Maximum number of runs that can be started concurrently for this PipelineJobSchedule. |
service_account |
str
Optional. Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. |
network |
str
Optional. The full name of the Compute Engine network to which the job should be peered. For example, projects/12345/global/networks/myVPC. Private services access must already be configured for the network. If left unspecified, the network set in aiplatform.init will be used. Otherwise, the job is not peered with any network. |
create_request_timeout |
float
Optional. The timeout for the create request in seconds. |
delete
delete(sync: bool = True) -> None
Deletes this Vertex AI resource. WARNING: This deletion is permanent.
Parameter | |
---|---|
Name | Description |
sync |
bool
Whether to execute this deletion synchronously. If False, this method will be executed in concurrent Future and any downstream object will be immediately returned and synced when the Future has completed. |
done
done() -> bool
Helper method that return True is Schedule is done. False otherwise.
get
get(
schedule_id: str,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.Any
Get a Vertex AI Schedule for the given resource_name.
Parameters | |
---|---|
Name | Description |
schedule_id |
str
Required. Schedule ID used to identify or locate the schedule. |
project |
str
Optional. Project to retrieve dataset from. If not set, project set in aiplatform.init will be used. |
location |
str
Optional. Location to retrieve dataset from. If not set, location set in aiplatform.init will be used. |
credentials |
auth_credentials.Credentials
Optional. Custom credentials to use to upload this model. Overrides credentials set in aiplatform.init. |
list
list(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.pipeline_job_schedules.PipelineJobSchedule]
List all instances of this PipelineJobSchedule resource.
Example Usage:
aiplatform.PipelineJobSchedule.list( filter='display_name="experiment_a27"', order_by='create_time desc' )
Parameters | |
---|---|
Name | Description |
filter |
str
Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. |
order_by |
str
Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: |
project |
str
Optional. Project to retrieve list from. If not set, project set in aiplatform.init will be used. |
location |
str
Optional. Location to retrieve list from. If not set, location set in aiplatform.init will be used. |
credentials |
auth_credentials.Credentials
Optional. Custom credentials to use to retrieve list. Overrides credentials set in aiplatform.init. |
list_jobs
list_jobs(
filter: typing.Optional[str] = None,
order_by: typing.Optional[str] = None,
enable_simple_view: bool = True,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
) -> typing.List[google.cloud.aiplatform.pipeline_jobs.PipelineJob]
List all PipelineJob 's created by this PipelineJobSchedule.
Example usage:
pipeline_job_schedule.list_jobs(order_by='create_time_desc')
Parameters | |
---|---|
Name | Description |
filter |
str
Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. |
order_by |
str
Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: |
enable_simple_view |
bool
Optional. Whether to pass the |
project |
str
Optional. Project to retrieve list from. If not set, project set in aiplatform.init will be used. |
location |
str
Optional. Location to retrieve list from. If not set, location set in aiplatform.init will be used. |
credentials |
auth_credentials.Credentials
Optional. Custom credentials to use to retrieve list. Overrides credentials set in aiplatform.init. |
pause
pause() -> None
Starts asynchronous pause on the Schedule.
Changes Schedule state from State.ACTIVE to State.PAUSED.
resume
resume(catch_up: bool = True) -> None
Starts asynchronous resume on the Schedule.
Changes Schedule state from State.PAUSED to State.ACTIVE.
Parameter | |
---|---|
Name | Description |
catch_up |
bool
Optional. Whether to backfill missed runs when the Schedule is resumed from State.PAUSED. |
to_dict
to_dict() -> typing.Dict[str, typing.Any]
Returns the resource proto as a dictionary.
update
update(
display_name: typing.Optional[str] = None,
cron: typing.Optional[str] = None,
start_time: typing.Optional[str] = None,
end_time: typing.Optional[str] = None,
allow_queueing: typing.Optional[bool] = None,
max_run_count: typing.Optional[int] = None,
max_concurrent_run_count: typing.Optional[int] = None,
) -> None
Update an existing PipelineJobSchedule.
Example usage:
pipeline_job_schedule.update( display_name='updated-display-name', cron='* * * * *', )
Parameters | |
---|---|
Name | Description |
display_name |
str
Optional. The user-defined name of this PipelineJobSchedule. |
cron |
str
Optional. Time specification (cron schedule expression) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". |
start_time |
str
Optional. Timestamp after which the first run can be scheduled. If unspecified, it defaults to the schedule creation timestamp. |
end_time |
str
Optional. Timestamp after which no more runs will be scheduled. If unspecified, then runs will be scheduled indefinitely. |
allow_queueing |
bool
Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. |
max_run_count |
int
Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. Must be positive and <= 2^63-1. |
max_concurrent_run_count |
int
Optional. Maximum number of runs that can be started concurrently for this PipelineJobSchedule. |
Exceptions | |
---|---|
Type | Description |
RuntimeError |
User tried to call update() before create(). |
wait
wait() -> None
Wait for all runs scheduled by this Schedule to complete.