REST Resource: projects.locations.environments

Resource: Environment

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

JSON representation
 { 
 "name" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "postStartupScript" 
 : 
 string 
 , 
 "createTime" 
 : 
 string 
 , 
 // Union field image_type 
can be only one of the following: 
 "vmImage" 
 : 
 { 
 object (  VmImage 
 
) 
 } 
 , 
 "containerImage" 
 : 
 { 
 object (  ContainerImage 
 
) 
 } 
 // End of list of possible types for union field image_type 
. 
 } 
Fields
name

string

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

displayName

string

Display name of this environment for the UI.

description

string

A brief description of this environment.

postStartupScript

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"

createTime

string ( Timestamp format)

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

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

Union field image_type . Type of the environment; can be one of VM image, or container image. image_type can be only one of the following:
vmImage

object ( VmImage )

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

containerImage

object ( ContainerImage )

Use a container image to start the notebook instance.

Methods

create

Creates a new Environment.

delete

Deletes a single Environment.

get

Gets details of a single Environment.

list

Lists environments in a project.
Design a Mobile Site
View Site in Mobile | Classic
Share by: