- 1.43.0 (latest)
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListNotebookExecutionJobsRequest.
Request message for [NotebookService.ListNotebookExecutionJobs]
Generated from protobuf message google.cloud.aiplatform.v1.ListNotebookExecutionJobsRequest
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description | 
| data | arrayOptional. Data for populating the Message object. | 
| ↳ parent | stringRequired. The resource name of the Location from which to list the NotebookExecutionJobs. Format:  | 
| ↳ filter | stringOptional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * *  | 
| ↳ page_size | intOptional. The standard list page size. | 
| ↳ page_token | stringOptional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call. | 
| ↳ order_by | stringOptional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * *  | 
| ↳ view | intOptional. The NotebookExecutionJob view. Defaults to BASIC. | 
getParent
Required. The resource name of the Location from which to list the NotebookExecutionJobs.
Format: projects/{project}/locations/{location}
| Returns | |
|---|---|
| Type | Description | 
| string | |
setParent
Required. The resource name of the Location from which to list the NotebookExecutionJobs.
Format: projects/{project}/locations/{location}
| Parameter | |
|---|---|
| Name | Description | 
| var | string | 
| Returns | |
|---|---|
| Type | Description | 
| $this | |
getFilter
Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.
- notebookExecutionJobsupports = and !=.- notebookExecutionJobrepresents the NotebookExecutionJob ID.- displayNamesupports = and != and regex.
- schedulesupports = and != and regex. Some examples:
- notebookExecutionJob="123"
- notebookExecutionJob="my-execution-job"
- displayName="myDisplayName"and- displayName=~"myDisplayNameRegex"
 
| Returns | |
|---|---|
| Type | Description | 
| string | |
setFilter
Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.
- notebookExecutionJobsupports = and !=.- notebookExecutionJobrepresents the NotebookExecutionJob ID.- displayNamesupports = and != and regex.
- schedulesupports = and != and regex. Some examples:
- notebookExecutionJob="123"
- notebookExecutionJob="my-execution-job"
- displayName="myDisplayName"and- displayName=~"myDisplayNameRegex"
 
| Parameter | |
|---|---|
| Name | Description | 
| var | string | 
| Returns | |
|---|---|
| Type | Description | 
| $this | |
getPageSize
Optional. The standard list page size.
| Returns | |
|---|---|
| Type | Description | 
| int | |
setPageSize
Optional. The standard list page size.
| Parameter | |
|---|---|
| Name | Description | 
| var | int | 
| Returns | |
|---|---|
| Type | Description | 
| $this | |
getPageToken
Optional. The standard list page token.
Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.
| Returns | |
|---|---|
| Type | Description | 
| string | |
setPageToken
Optional. The standard list page token.
Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.
| Parameter | |
|---|---|
| Name | Description | 
| var | string | 
| Returns | |
|---|---|
| Type | Description | 
| $this | |
getOrderBy
Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:
- display_name
- create_time
- update_timeExample:- display_name, create_time desc.
| Returns | |
|---|---|
| Type | Description | 
| string | |
setOrderBy
Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:
- display_name
- create_time
- update_timeExample:- display_name, create_time desc.
| Parameter | |
|---|---|
| Name | Description | 
| var | string | 
| Returns | |
|---|---|
| Type | Description | 
| $this | |
getView
Optional. The NotebookExecutionJob view. Defaults to BASIC.
| Returns | |
|---|---|
| Type | Description | 
| int | Enum of type NotebookExecutionJobView. | 
setView
Optional. The NotebookExecutionJob view. Defaults to BASIC.
| Parameter | |
|---|---|
| Name | Description | 
| var | intEnum of type NotebookExecutionJobView. | 
| Returns | |
|---|---|
| Type | Description | 
| $this | |
static::build
| Parameter | |
|---|---|
| Name | Description | 
| parent | stringRequired. The resource name of the Location from which to list the
NotebookExecutionJobs.
Format:  | 
| Returns | |
|---|---|
| Type | Description | 
| ListNotebookExecutionJobsRequest | |