AI Platform Notebooks v1 API - Class Environment (2.3.0)

public sealed class Environment : IMessage<Environment>, IEquatable<Environment>, IDeepCloneable<Environment>, IBufferMessage, IMessage

Reference documentation and code samples for the AI Platform Notebooks v1 API class Environment.

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

Inheritance

object > Environment

Implements

IMessage Environment, IEquatable Environment, IDeepCloneable Environment, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Notebooks.V1

Assembly

Google.Cloud.Notebooks.V1.dll

Constructors

Environment()

public Environment()

Environment(Environment)

public Environment(Environment other)

Parameter
Name	Description
`other`	`Environment`

Properties

ContainerImage

public ContainerImage ContainerImage { get; set; }

Use a container image to start the notebook instance.

Property Value
Type	Description
`ContainerImage`

CreateTime

public Timestamp CreateTime { get; set; }

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

Property Value
Type	Description
`Timestamp`

Description

public string Description { get; set; }

A brief description of this environment.

Property Value
Type	Description
`string`

DisplayName

public string DisplayName { get; set; }

Display name of this environment for the UI.

Property Value
Type	Description
`string`

EnvironmentName

public EnvironmentName EnvironmentName { get; set; }

EnvironmentName-typed view over the Name resource name property.

Property Value
Type	Description
`EnvironmentName`

ImageTypeCase

public Environment.ImageTypeOneofCase ImageTypeCase { get; }

Property Value
Type	Description
`EnvironmentImageTypeOneofCase`

Name

public string Name { get; set; }

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

Property Value
Type	Description
`string`

PostStartupScript

public string PostStartupScript { get; set; }

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"

Property Value
Type	Description
`string`

VmImage

public VmImage VmImage { get; set; }

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

Property Value
Type	Description
`VmImage`