Google Cloud Notebooks V1 Client - Class Execution (1.0.1)

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

The definition of a single executed notebook.

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

Namespace

Google \ Cloud \ Notebooks \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ execution_template`	`ExecutionTemplate` execute metadata including name, hardware spec, region, labels, etc.
`↳ name`	`string` Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`
`↳ display_name`	`string` Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.
`↳ description`	`string` A brief description of this execution.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Time the Execution was instantiated.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. Time the Execution was last updated.
`↳ state`	`int` Output only. State of the underlying AI Platform job.
`↳ output_notebook_file`	`string` Output notebook file generated by this execution
`↳ job_uri`	`string` Output only. The URI of the external job used to execute the notebook.

getExecutionTemplate

execute metadata including name, hardware spec, region, labels, etc.

Returns
Type	Description
`ExecutionTemplate\|null`

hasExecutionTemplate

clearExecutionTemplate

setExecutionTemplate

execute metadata including name, hardware spec, region, labels, etc.

Parameter
Name	Description
`var`	`ExecutionTemplate`

Returns
Type	Description
`$this`

getName

Output only. The resource name of the execute. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

Returns
Type	Description
`string`

setName

Output only. The resource name of the execute. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Output only. Name used for UI purposes.

Name can only contain alphanumeric characters and underscores '_'.

Returns
Type	Description
`string`

setDisplayName

Output only. Name used for UI purposes.

Name can only contain alphanumeric characters and underscores '_'.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

A brief description of this execution.

Returns
Type	Description
`string`

setDescription

A brief description of this execution.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. Time the Execution was instantiated.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time the Execution was instantiated.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. Time the Execution was last updated.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Time the Execution was last updated.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getState

Output only. State of the underlying AI Platform job.

Returns
Type	Description
`int`

setState

Output only. State of the underlying AI Platform job.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getOutputNotebookFile

Output notebook file generated by this execution

Returns
Type	Description
`string`

setOutputNotebookFile

Output notebook file generated by this execution

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getJobUri

Output only. The URI of the external job used to execute the notebook.

Returns
Type	Description
`string`

setJobUri

Output only. The URI of the external job used to execute the notebook.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`