Runtime (Notebooks API v1-rev20241016-2.0.0)

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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Runtime
extends com.google.api.client.json.GenericJson
```
The definition of a Runtime for a managed 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

Runtime()

Constructors
Constructor and Description
`Runtime()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Runtime`	`clone()`
`RuntimeAccessConfig`	`getAccessConfig()` The config settings for accessing runtime.
`String`	`getCreateTime()` Output only.
`String`	`getHealthState()` Output only.
`Map<String,String>`	`getLabels()` Optional.
`RuntimeMetrics`	`getMetrics()` Output only.
`Boolean`	`getMigrated()` Output only.
`String`	`getName()` Output only.
`RuntimeMigrationEligibility`	`getRuntimeMigrationEligibility()` Output only.
`RuntimeSoftwareConfig`	`getSoftwareConfig()` The config settings for software inside the runtime.
`String`	`getState()` Output only.
`String`	`getUpdateTime()` Output only.
`VirtualMachine`	`getVirtualMachine()` Use a Compute Engine VM image to start the managed notebook instance.
`Runtime`	`set(String fieldName, Object value)`
`Runtime`	`setAccessConfig(RuntimeAccessConfig accessConfig)` The config settings for accessing runtime.
`Runtime`	`setCreateTime(String createTime)` Output only.
`Runtime`	`setHealthState(String healthState)` Output only.
`Runtime`	`setLabels(Map<String,String> labels)` Optional.
`Runtime`	`setMetrics(RuntimeMetrics metrics)` Output only.
`Runtime`	`setMigrated(Boolean migrated)` Output only.
`Runtime`	`setName(String name)` Output only.
`Runtime`	`setRuntimeMigrationEligibility(RuntimeMigrationEligibility runtimeMigrationEligibility)` Output only.
`Runtime`	`setSoftwareConfig(RuntimeSoftwareConfig softwareConfig)` The config settings for software inside the runtime.
`Runtime`	`setState(String state)` Output only.
`Runtime`	`setUpdateTime(String updateTime)` Output only.
`Runtime`	`setVirtualMachine(VirtualMachine virtualMachine)` Use a Compute Engine VM image to start the managed 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
  - Runtime
```
public Runtime()
```
- Method Detail
  - getAccessConfig
```
public RuntimeAccessConfig getAccessConfig()
```
    The config settings for accessing runtime.
    
    Returns:
    
    value or null for none
  - setAccessConfig
```
public Runtime setAccessConfig(RuntimeAccessConfig accessConfig)
```
    The config settings for accessing runtime.
    
    Parameters:
    
    accessConfig - accessConfig or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. Runtime creation time.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public Runtime setCreateTime(String createTime)
```
    Output only. Runtime creation time.
    
    Parameters:
    
    createTime - createTime or null for none
  - getHealthState
```
public String getHealthState()
```
    Output only. Runtime health_state.
    
    Returns:
    
    value or null for none
  - setHealthState
```
public Runtime setHealthState(String healthState)
```
    Output only. Runtime health_state.
    
    Parameters:
    
    healthState - healthState or null for none
  - getLabels
```
public Map<String,String> getLabels()
```
    Optional. The labels to associate with this Managed Notebook or Runtime. Label **keys** must contain 1 to 63 characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). Label **values** may be empty, but, if present, must contain 1 to 63 characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.
    
    Returns:
    
    value or null for none
  - setLabels
```
public Runtime setLabels(Map<String,String> labels)
```
    Optional. The labels to associate with this Managed Notebook or Runtime. Label **keys** must contain 1 to 63 characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). Label **values** may be empty, but, if present, must contain 1 to 63 characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.
    
    Parameters:
    
    labels - labels or null for none
  - getMetrics
```
public RuntimeMetrics getMetrics()
```
    Output only. Contains Runtime daemon metrics such as Service status and JupyterLab stats.
    
    Returns:
    
    value or null for none
  - setMetrics
```
public Runtime setMetrics(RuntimeMetrics metrics)
```
    Output only. Contains Runtime daemon metrics such as Service status and JupyterLab stats.
    
    Parameters:
    
    metrics - metrics or null for none
  - getMigrated
```
public Boolean getMigrated()
```
    Output only. Bool indicating whether this notebook has been migrated to a Workbench Instance
    
    Returns:
    
    value or null for none
  - setMigrated
```
public Runtime setMigrated(Boolean migrated)
```
    Output only. Bool indicating whether this notebook has been migrated to a Workbench Instance
    
    Parameters:
    
    migrated - migrated or null for none
  - getName
```
public String getName()
```
    Output only. The resource name of the runtime. Format: `projects/{project}/locations/{location}/runtimes/{runtimeId}`
    
    Returns:
    
    value or null for none
  - setName
```
public Runtime setName(String name)
```
    Output only. The resource name of the runtime. Format: `projects/{project}/locations/{location}/runtimes/{runtimeId}`
    
    Parameters:
    
    name - name or null for none
  - getRuntimeMigrationEligibility
```
public RuntimeMigrationEligibility getRuntimeMigrationEligibility()
```
    Output only. Checks how feasible a migration from GmN to WbI is.
    
    Returns:
    
    value or null for none
  - setRuntimeMigrationEligibility
```
public Runtime setRuntimeMigrationEligibility(RuntimeMigrationEligibility runtimeMigrationEligibility)
```
    Output only. Checks how feasible a migration from GmN to WbI is.
    
    Parameters:
    
    runtimeMigrationEligibility - runtimeMigrationEligibility or null for none
  - getSoftwareConfig
```
public RuntimeSoftwareConfig getSoftwareConfig()
```
    The config settings for software inside the runtime.
    
    Returns:
    
    value or null for none
  - setSoftwareConfig
```
public Runtime setSoftwareConfig(RuntimeSoftwareConfig softwareConfig)
```
    The config settings for software inside the runtime.
    
    Parameters:
    
    softwareConfig - softwareConfig or null for none
  - getState
```
public String getState()
```
    Output only. Runtime state.
    
    Returns:
    
    value or null for none
  - setState
```
public Runtime setState(String state)
```
    Output only. Runtime state.
    
    Parameters:
    
    state - state or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. Runtime update time.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public Runtime setUpdateTime(String updateTime)
```
    Output only. Runtime update time.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - getVirtualMachine
```
public VirtualMachine getVirtualMachine()
```
    Use a Compute Engine VM image to start the managed notebook instance.
    
    Returns:
    
    value or null for none
  - setVirtualMachine
```
public Runtime setVirtualMachine(VirtualMachine virtualMachine)
```
    Use a Compute Engine VM image to start the managed notebook instance.
    
    Parameters:
    
    virtualMachine - virtualMachine or null for none
  - set
```
public Runtime set(String fieldName,
                   Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Runtime clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Runtime

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Runtime

Method Detail

getAccessConfig

setAccessConfig

getCreateTime

setCreateTime

getHealthState

setHealthState

getLabels

setLabels

getMetrics

setMetrics

getMigrated

setMigrated

getName

setName

getRuntimeMigrationEligibility

setRuntimeMigrationEligibility

getSoftwareConfig

setSoftwareConfig

getState

setState

getUpdateTime

setUpdateTime

getVirtualMachine

setVirtualMachine

set

clone