docs: Update scheduled pipelines client max_run_count docstring with …

…allowed values. PiperOrigin-RevId: 542617816
googleapis · Jun 22, 2023 · 750e161 · 750e161
1 parent 5bcf602
commit 750e161
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git 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
@@ -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.