From 750e16179e1a53bc916ae6db93cd28cfd3f911fe Mon Sep 17 00:00:00 2001 From: A Vertex SDK engineer Date: Thu, 22 Jun 2023 11:27:06 -0700 Subject: [PATCH] docs: Update scheduled pipelines client max_run_count docstring with allowed values. PiperOrigin-RevId: 542617816 --- google/cloud/aiplatform/preview/pipelinejob/pipeline_jobs.py | 1 + .../preview/pipelinejobschedule/pipeline_job_schedules.py | 3 +++ 2 files changed, 4 insertions(+) diff --git a/google/cloud/aiplatform/preview/pipelinejob/pipeline_jobs.py b/google/cloud/aiplatform/preview/pipelinejob/pipeline_jobs.py index 2c3bba29fa..8e1a58da30 100644 --- a/google/cloud/aiplatform/preview/pipelinejob/pipeline_jobs.py +++ b/google/cloud/aiplatform/preview/pipelinejob/pipeline_jobs.py @@ -98,6 +98,7 @@ def create_schedule( 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): diff --git a/google/cloud/aiplatform/preview/pipelinejobschedule/pipeline_job_schedules.py b/google/cloud/aiplatform/preview/pipelinejobschedule/pipeline_job_schedules.py index 008d32ab84..b27621eaa1 100644 --- a/google/cloud/aiplatform/preview/pipelinejobschedule/pipeline_job_schedules.py +++ b/google/cloud/aiplatform/preview/pipelinejobschedule/pipeline_job_schedules.py @@ -145,6 +145,7 @@ def create( 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): @@ -204,6 +205,7 @@ def _create( 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): @@ -402,6 +404,7 @@ def update( 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.