Google Cloud Notebooks V1 Client - Class Environment (0.6.2)

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

Definition of a software environment that is used to start a notebook instance.

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

Namespace

Google \ Cloud \ Notebooks \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. Name of this environment. Format: projects/{project_id}/locations/{location}/environments/{environment_id}

↳ display_name string

Display name of this environment for the UI.

↳ description string

A brief description of this environment.

↳ vm_image Google\Cloud\Notebooks\V1\VmImage

Use a Compute Engine VM image to start the notebook instance.

↳ container_image Google\Cloud\Notebooks\V1\ContainerImage

Use a container image to start the notebook instance.

↳ post_startup_script string

Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: "gs://path-to-file/file-name"

↳ create_time Google\Protobuf\Timestamp

Output only. The time at which this environment was created.

getName

Output only. Name of this environment.

Format: projects/{project_id}/locations/{location}/environments/{environment_id}

Returns
TypeDescription
string

setName

Output only. Name of this environment.

Format: projects/{project_id}/locations/{location}/environments/{environment_id}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

Display name of this environment for the UI.

Returns
TypeDescription
string

setDisplayName

Display name of this environment for the UI.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

A brief description of this environment.

Returns
TypeDescription
string

setDescription

A brief description of this environment.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getVmImage

Use a Compute Engine VM image to start the notebook instance.

Returns
TypeDescription
Google\Cloud\Notebooks\V1\VmImage|null

hasVmImage

setVmImage

Use a Compute Engine VM image to start the notebook instance.

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

getContainerImage

Use a container image to start the notebook instance.

Returns
TypeDescription
Google\Cloud\Notebooks\V1\ContainerImage|null

hasContainerImage

setContainerImage

Use a container image to start the notebook instance.

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

getPostStartupScript

Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: "gs://path-to-file/file-name"

Returns
TypeDescription
string

setPostStartupScript

Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: "gs://path-to-file/file-name"

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. The time at which this environment was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time at which this environment was created.

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

getImageType

Returns
TypeDescription
string