Google Cloud Notebooks V1 Client - Class Environment (1.0.0)

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
Name Description
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
Type Description
string

setName

Output only. Name of this environment.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Display name of this environment for the UI.

Returns
Type Description
string

setDisplayName

Display name of this environment for the UI.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

A brief description of this environment.

Returns
Type Description
string

setDescription

A brief description of this environment.

Parameter
Name Description
var string
Returns
Type Description
$this

getVmImage

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

Returns
Type Description
Google\Cloud\Notebooks\V1\VmImage|null

hasVmImage

setVmImage

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

Parameter
Name Description
var Google\Cloud\Notebooks\V1\VmImage
Returns
Type Description
$this

getContainerImage

Use a container image to start the notebook instance.

Returns
Type Description
Google\Cloud\Notebooks\V1\ContainerImage|null

hasContainerImage

setContainerImage

Use a container image to start the notebook instance.

Parameter
Name Description
var Google\Cloud\Notebooks\V1\ContainerImage
Returns
Type Description
$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
Type Description
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
Name Description
var string
Returns
Type Description
$this

getCreateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getImageType

Returns
Type Description
string