Skip to content

Commit f019e18

Browse files
vertex-sdk-botcopybara-github
authored andcommitted
docs: Improve description of enable_simple_view parameter
PiperOrigin-RevId: 715059034
1 parent cabe522 commit f019e18

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

google/cloud/aiplatform/pipeline_jobs.py

+13-9
Original file line numberDiff line numberDiff line change
@@ -868,15 +868,19 @@ def list(
868868
Supported fields: `display_name`, `create_time`, `update_time`
869869
enable_simple_view (bool):
870870
Optional. Whether to pass the `read_mask` parameter to the list call.
871-
Defaults to False if not provided. This will improve the performance of calling
872-
list(). However, the returned PipelineJob list will not include all fields for
873-
each PipelineJob. Setting this to True will exclude the following fields in your
874-
response: `runtime_config`, `service_account`, `network`, and some subfields of
875-
`pipeline_spec` and `job_detail`. The following fields will be included in
876-
each PipelineJob resource in your response: `state`, `display_name`,
877-
`pipeline_spec.pipeline_info`, `create_time`, `start_time`, `end_time`,
878-
`update_time`, `labels`, `template_uri`, `template_metadata.version`,
879-
`job_detail.pipeline_run_context`, `job_detail.pipeline_context`.
871+
Defaults to `False` if not provided. This improves the performance of
872+
calling the `list()` method. It's recommended to set this parameter to
873+
`True` if your region has multiple pipeline runs, which can result in
874+
high latency and errors. However, the returned pipeline job list
875+
doesn't include all fields for each `PipelineJob`.
876+
Setting this to `True` excludes the following fields from your response:
877+
`runtime_config`, `service_account`, `network`, and some subfields of
878+
`pipeline_spec` and `job_detail`. The following
879+
fields are included in each `PipelineJob` resource in your response:
880+
`state`, `display_name`, `pipeline_spec.pipeline_info`, `create_time`,
881+
`start_time`, `end_time`, `update_time`, `labels`, `template_uri`,
882+
`template_metadata.version`, `job_detail.pipeline_run_context`, and
883+
`job_detail.pipeline_context`.
880884
project (str):
881885
Optional. Project to retrieve list from. If not set, project
882886
set in aiplatform.init will be used.

0 commit comments

Comments
 (0)