Google Cloud Notebooks V1 Client - Class Execution (0.5.0)

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
NameDescription
data array

Optional. Data for populating the Message object.

↳ execution_template Google\Cloud\Notebooks\V1\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
TypeDescription
Google\Cloud\Notebooks\V1\ExecutionTemplate|null

hasExecutionTemplate

clearExecutionTemplate

setExecutionTemplate

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

Parameter
NameDescription
var Google\Cloud\Notebooks\V1\ExecutionTemplate
Returns
TypeDescription
$this

getName

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

Returns
TypeDescription
string

setName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

Output only. Name used for UI purposes.

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

Returns
TypeDescription
string

setDisplayName

Output only. Name used for UI purposes.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

A brief description of this execution.

Returns
TypeDescription
string

setDescription

A brief description of this execution.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. Time the Execution was instantiated.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time the Execution was instantiated.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. Time the Execution was last updated.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Time the Execution was last updated.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getState

Output only. State of the underlying AI Platform job.

Returns
TypeDescription
int

setState

Output only. State of the underlying AI Platform job.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getOutputNotebookFile

Output notebook file generated by this execution

Returns
TypeDescription
string

setOutputNotebookFile

Output notebook file generated by this execution

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getJobUri

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

Returns
TypeDescription
string

setJobUri

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this