Google Cloud Ai Platform V1 Client - Class ListNotebookExecutionJobsRequest (1.54.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 \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}`
`↳ filter`	`string` Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * * `displayName` supports = and != and regex. * * `schedule` supports = and != and regex. Some examples: * * `notebookExecutionJob="123"` * * `notebookExecutionJob="my-execution-job"` * * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"`
`↳ page_size`	`int` Optional. The standard list page size.
`↳ page_token`	`string` Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.
`↳ order_by`	`string` 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_time` Example: `display_name, create_time desc`.
`↳ view`	`int` Optional. 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.

notebookExecutionJob supports = and !=. notebookExecutionJob represents the NotebookExecutionJob ID.
- displayName supports = and != and regex.
- schedule supports = 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.

notebookExecutionJob supports = and !=. notebookExecutionJob represents the NotebookExecutionJob ID.
- displayName supports = and != and regex.
- schedule supports = 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