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

Class RuntimeSoftwareConfig

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.RuntimeSoftwareConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class RuntimeSoftwareConfig
extends GenericJson

Specifies the selection and configuration of software inside the runtime. The properties to set on runtime. Properties keys are specified in `key:value` format, for example: * `idle_shutdown: true` * `idle_shutdown_timeout: 180` * `report-system-health: true`

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

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
RuntimeSoftwareConfig()

Method Summary

Modifier and Type	Method and Description
RuntimeSoftwareConfig	clone()
String	getCustomGpuDriverPath() Specify a custom Cloud Storage path where the GPU driver is stored.
Boolean	getEnableHealthMonitoring() Verifies core internal services are running.
Boolean	getIdleShutdown() Runtime will automatically shutdown after idle_shutdown_time.
Integer	getIdleShutdownTimeout() Time in minutes to wait before shutting down runtime.
Boolean	getInstallGpuDriver() Install Nvidia Driver automatically.
String	getNotebookUpgradeSchedule() Cron expression in UTC timezone, used to schedule instance auto upgrade.
String	getPostStartupScript() Path to a Bash script that automatically runs after a notebook instance fully boots up.
RuntimeSoftwareConfig	set(String fieldName, Object value)
RuntimeSoftwareConfig	setCustomGpuDriverPath(String customGpuDriverPath) Specify a custom Cloud Storage path where the GPU driver is stored.
RuntimeSoftwareConfig	setEnableHealthMonitoring(Boolean enableHealthMonitoring) Verifies core internal services are running.
RuntimeSoftwareConfig	setIdleShutdown(Boolean idleShutdown) Runtime will automatically shutdown after idle_shutdown_time.
RuntimeSoftwareConfig	setIdleShutdownTimeout(Integer idleShutdownTimeout) Time in minutes to wait before shutting down runtime.
RuntimeSoftwareConfig	setInstallGpuDriver(Boolean installGpuDriver) Install Nvidia Driver automatically.
RuntimeSoftwareConfig	setNotebookUpgradeSchedule(String notebookUpgradeSchedule) Cron expression in UTC timezone, used to schedule instance auto upgrade.
RuntimeSoftwareConfig	setPostStartupScript(String postStartupScript) Path to a Bash script that automatically runs after a notebook instance fully boots up.

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

RuntimeSoftwareConfig

public RuntimeSoftwareConfig()

Method Detail

getCustomGpuDriverPath

public String getCustomGpuDriverPath()

Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.

Returns:

value or null for none

setCustomGpuDriverPath

public RuntimeSoftwareConfig setCustomGpuDriverPath(String customGpuDriverPath)

Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.

Parameters:

customGpuDriverPath - customGpuDriverPath or null for none

getEnableHealthMonitoring

public Boolean getEnableHealthMonitoring()

Verifies core internal services are running. Default: True

Returns:

value or null for none

setEnableHealthMonitoring

public RuntimeSoftwareConfig setEnableHealthMonitoring(Boolean enableHealthMonitoring)

Verifies core internal services are running. Default: True

Parameters:

enableHealthMonitoring - enableHealthMonitoring or null for none

getIdleShutdown

public Boolean getIdleShutdown()

Runtime will automatically shutdown after idle_shutdown_time. Default: True

Returns:

value or null for none

setIdleShutdown

public RuntimeSoftwareConfig setIdleShutdown(Boolean idleShutdown)

Runtime will automatically shutdown after idle_shutdown_time. Default: True

Parameters:

idleShutdown - idleShutdown or null for none

getIdleShutdownTimeout

public Integer getIdleShutdownTimeout()

Time in minutes to wait before shutting down runtime. Default: 180 minutes

Returns:

value or null for none

setIdleShutdownTimeout

public RuntimeSoftwareConfig setIdleShutdownTimeout(Integer idleShutdownTimeout)

Time in minutes to wait before shutting down runtime. Default: 180 minutes

Parameters:

idleShutdownTimeout - idleShutdownTimeout or null for none

getInstallGpuDriver

public Boolean getInstallGpuDriver()

Install Nvidia Driver automatically.

Returns:

value or null for none

setInstallGpuDriver

public RuntimeSoftwareConfig setInstallGpuDriver(Boolean installGpuDriver)

Install Nvidia Driver automatically.

Parameters:

installGpuDriver - installGpuDriver or null for none

getNotebookUpgradeSchedule

public String getNotebookUpgradeSchedule()

Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the [cron format](https://en.wikipedia.org/wiki/Cron).

Returns:

value or null for none

setNotebookUpgradeSchedule

public RuntimeSoftwareConfig setNotebookUpgradeSchedule(String notebookUpgradeSchedule)

Cron expression in UTC timezone, used to schedule instance auto upgrade. Please follow the [cron format](https://en.wikipedia.org/wiki/Cron).

Parameters:

notebookUpgradeSchedule - notebookUpgradeSchedule 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 (`gs://path-to-file/file-name`).

Returns:

value or null for none

setPostStartupScript

public RuntimeSoftwareConfig 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 (`gs://path-to-file/file-name`).

Parameters:

postStartupScript - postStartupScript or null for none

set

public RuntimeSoftwareConfig set(String fieldName,
                                 Object value)

Overrides:

set in class GenericJson

clone

public RuntimeSoftwareConfig clone()

Overrides:

clone in class GenericJson