Google Cloud Notebooks V1 Client - Class ListExecutionsRequest (0.7.4)

Reference documentation and code samples for the Google Cloud Notebooks V1 Client class ListExecutionsRequest.

Request for listing scheduled notebook executions.

Generated from protobuf message google.cloud.notebooks.v1.ListExecutionsRequest

Namespace

Google \ Cloud \ Notebooks \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. Format: parent=projects/{project_id}/locations/{location}

↳ page_size int

Maximum return size of the list call.

↳ page_token string

A previous returned page token that can be used to continue listing from the last result.

↳ filter string

Filter applied to resulting executions. Currently only supports filtering executions by a specified schedule_id. Format: schedule_id=<Schedule_ID>

↳ order_by string

Sort by field.

getParent

Required. Format: parent=projects/{project_id}/locations/{location}

Returns
Type Description
string

setParent

Required. Format: parent=projects/{project_id}/locations/{location}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Maximum return size of the list call.

Returns
Type Description
int

setPageSize

Maximum return size of the list call.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

A previous returned page token that can be used to continue listing from the last result.

Returns
Type Description
string

setPageToken

A previous returned page token that can be used to continue listing from the last result.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Filter applied to resulting executions. Currently only supports filtering executions by a specified schedule_id.

Format: schedule_id=<Schedule_ID>

Returns
Type Description
string

setFilter

Filter applied to resulting executions. Currently only supports filtering executions by a specified schedule_id.

Format: schedule_id=<Schedule_ID>

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Sort by field.

Returns
Type Description
string

setOrderBy

Sort by field.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. Format: parent=projects/{project_id}/locations/{location} Please see Google\Cloud\Notebooks\V1\NotebookServiceClient::executionName() for help formatting this field.

Returns
Type Description
Google\Cloud\Notebooks\V1\ListExecutionsRequest