com.google.api.services.notebooks.v1.model

Class Environment

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.notebooks.v1.model.Environment

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Environment
extends com.google.api.client.json.GenericJson

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

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Notebooks API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Environment()

Method Summary

Modifier and Type	Method and Description
Environment	clone()
ContainerImage	getContainerImage() Use a container image to start the notebook instance.
String	getCreateTime() Output only.
String	getDescription() A brief description of this environment.
String	getDisplayName() Display name of this environment for the UI.
String	getName() Output only.
String	getPostStartupScript() Path to a Bash script that automatically runs after a notebook instance fully boots up.
VmImage	getVmImage() Use a Compute Engine VM image to start the notebook instance.
Environment	set(String fieldName, Object value)
Environment	setContainerImage(ContainerImage containerImage) Use a container image to start the notebook instance.
Environment	setCreateTime(String createTime) Output only.
Environment	setDescription(String description) A brief description of this environment.
Environment	setDisplayName(String displayName) Display name of this environment for the UI.
Environment	setName(String name) Output only.
Environment	setPostStartupScript(String postStartupScript) Path to a Bash script that automatically runs after a notebook instance fully boots up.
Environment	setVmImage(VmImage vmImage) Use a Compute Engine VM image to start the notebook instance.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Environment

public Environment()

Method Detail

getContainerImage

public ContainerImage getContainerImage()

Use a container image to start the notebook instance.

Returns:

value or null for none

setContainerImage

public Environment setContainerImage(ContainerImage containerImage)

Use a container image to start the notebook instance.

Parameters:

containerImage - containerImage or null for none

getCreateTime

public String getCreateTime()

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

Returns:

value or null for none

setCreateTime

public Environment setCreateTime(String createTime)

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

Parameters:

createTime - createTime or null for none

getDescription

public String getDescription()

A brief description of this environment.

Returns:

value or null for none

setDescription

public Environment setDescription(String description)

A brief description of this environment.

Parameters:

description - description or null for none

getDisplayName

public String getDisplayName()

Display name of this environment for the UI.

Returns:

value or null for none

setDisplayName

public Environment setDisplayName(String displayName)

Display name of this environment for the UI.

Parameters:

displayName - displayName or null for none

getName

public String getName()

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

Returns:

value or null for none

setName

public Environment setName(String name)

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

Parameters:

name - name or null for none

getPostStartupScript

public String 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:

value or null for none

setPostStartupScript

public Environment setPostStartupScript(String postStartupScript)

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"`

Parameters:

postStartupScript - postStartupScript or null for none

getVmImage

public VmImage getVmImage()

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

Returns:

value or null for none

setVmImage

public Environment setVmImage(VmImage vmImage)

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

Parameters:

vmImage - vmImage or null for none

set

public Environment set(String fieldName,
                       Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Environment clone()

Overrides:

clone in class com.google.api.client.json.GenericJson