VirtualMachineConfig (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.VirtualMachineConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class VirtualMachineConfig
extends com.google.api.client.json.GenericJson
```
The config settings for virtual machine.
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

VirtualMachineConfig()

Constructors
Constructor and Description
`VirtualMachineConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VirtualMachineConfig`	`clone()`
`RuntimeAcceleratorConfig`	`getAcceleratorConfig()` Optional.
`BootImage`	`getBootImage()` Optional.
`List<ContainerImage>`	`getContainerImages()` Optional.
`LocalDisk`	`getDataDisk()` Required.
`EncryptionConfig`	`getEncryptionConfig()` Optional.
`Map<String,String>`	`getGuestAttributes()` Output only.
`Boolean`	`getInternalIpOnly()` Optional.
`Map<String,String>`	`getLabels()` Optional.
`String`	`getMachineType()` Required.
`Map<String,String>`	`getMetadata()` Optional.
`String`	`getNetwork()` Optional.
`String`	`getNicType()` Optional.
`String`	`getReservedIpRange()` Optional.
`RuntimeShieldedInstanceConfig`	`getShieldedInstanceConfig()` Optional.
`String`	`getSubnet()` Optional.
`List<String>`	`getTags()` Optional.
`String`	`getZone()` Output only.
`VirtualMachineConfig`	`set(String fieldName, Object value)`
`VirtualMachineConfig`	`setAcceleratorConfig(RuntimeAcceleratorConfig acceleratorConfig)` Optional.
`VirtualMachineConfig`	`setBootImage(BootImage bootImage)` Optional.
`VirtualMachineConfig`	`setContainerImages(List<ContainerImage> containerImages)` Optional.
`VirtualMachineConfig`	`setDataDisk(LocalDisk dataDisk)` Required.
`VirtualMachineConfig`	`setEncryptionConfig(EncryptionConfig encryptionConfig)` Optional.
`VirtualMachineConfig`	`setGuestAttributes(Map<String,String> guestAttributes)` Output only.
`VirtualMachineConfig`	`setInternalIpOnly(Boolean internalIpOnly)` Optional.
`VirtualMachineConfig`	`setLabels(Map<String,String> labels)` Optional.
`VirtualMachineConfig`	`setMachineType(String machineType)` Required.
`VirtualMachineConfig`	`setMetadata(Map<String,String> metadata)` Optional.
`VirtualMachineConfig`	`setNetwork(String network)` Optional.
`VirtualMachineConfig`	`setNicType(String nicType)` Optional.
`VirtualMachineConfig`	`setReservedIpRange(String reservedIpRange)` Optional.
`VirtualMachineConfig`	`setShieldedInstanceConfig(RuntimeShieldedInstanceConfig shieldedInstanceConfig)` Optional.
`VirtualMachineConfig`	`setSubnet(String subnet)` Optional.
`VirtualMachineConfig`	`setTags(List<String> tags)` Optional.
`VirtualMachineConfig`	`setZone(String zone)` Output only.

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
  - VirtualMachineConfig
```
public VirtualMachineConfig()
```
- Method Detail
  - getAcceleratorConfig
```
public RuntimeAcceleratorConfig getAcceleratorConfig()
```
    Optional. The Compute Engine accelerator configuration for this runtime.
    
    Returns:
    
    value or null for none
  - setAcceleratorConfig
```
public VirtualMachineConfig setAcceleratorConfig(RuntimeAcceleratorConfig acceleratorConfig)
```
    Optional. The Compute Engine accelerator configuration for this runtime.
    
    Parameters:
    
    acceleratorConfig - acceleratorConfig or null for none
  - getBootImage
```
public BootImage getBootImage()
```
    Optional. Boot image metadata used for runtime upgradeability.
    
    Returns:
    
    value or null for none
  - setBootImage
```
public VirtualMachineConfig setBootImage(BootImage bootImage)
```
    Optional. Boot image metadata used for runtime upgradeability.
    
    Parameters:
    
    bootImage - bootImage or null for none
  - getContainerImages
```
public List<ContainerImage> getContainerImages()
```
    Optional. Use a list of container images to use as Kernels in the notebook instance.
    
    Returns:
    
    value or null for none
  - setContainerImages
```
public VirtualMachineConfig setContainerImages(List<ContainerImage> containerImages)
```
    Optional. Use a list of container images to use as Kernels in the notebook instance.
    
    Parameters:
    
    containerImages - containerImages or null for none
  - getDataDisk
```
public LocalDisk getDataDisk()
```
    Required. Data disk option configuration settings.
    
    Returns:
    
    value or null for none
  - setDataDisk
```
public VirtualMachineConfig setDataDisk(LocalDisk dataDisk)
```
    Required. Data disk option configuration settings.
    
    Parameters:
    
    dataDisk - dataDisk or null for none
  - getEncryptionConfig
```
public EncryptionConfig getEncryptionConfig()
```
    Optional. Encryption settings for virtual machine data disk.
    
    Returns:
    
    value or null for none
  - setEncryptionConfig
```
public VirtualMachineConfig setEncryptionConfig(EncryptionConfig encryptionConfig)
```
    Optional. Encryption settings for virtual machine data disk.
    
    Parameters:
    
    encryptionConfig - encryptionConfig or null for none
  - getGuestAttributes
```
public Map<String,String> getGuestAttributes()
```
    Output only. The Compute Engine guest attributes. (see [Project and instance guest attributes](https://cloud.google.com/compute/docs/storing-retrieving- metadata#guest_attributes)).
    
    Returns:
    
    value or null for none
  - setGuestAttributes
```
public VirtualMachineConfig setGuestAttributes(Map<String,String> guestAttributes)
```
    Output only. The Compute Engine guest attributes. (see [Project and instance guest attributes](https://cloud.google.com/compute/docs/storing-retrieving- metadata#guest_attributes)).
    
    Parameters:
    
    guestAttributes - guestAttributes or null for none
  - getInternalIpOnly
```
public Boolean getInternalIpOnly()
```
    Optional. If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This `internal_ip_only` restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.
    
    Returns:
    
    value or null for none
  - setInternalIpOnly
```
public VirtualMachineConfig setInternalIpOnly(Boolean internalIpOnly)
```
    Optional. If true, runtime will only have internal IP addresses. By default, runtimes are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each vm. This `internal_ip_only` restriction can only be enabled for subnetwork enabled networks, and all dependencies must be configured to be accessible without external IP addresses.
    
    Parameters:
    
    internalIpOnly - internalIpOnly or null for none
  - getLabels
```
public Map<String,String> getLabels()
```
    Optional. The labels to associate with this 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 VirtualMachineConfig setLabels(Map<String,String> labels)
```
    Optional. The labels to associate with this 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
  - getMachineType
```
public String getMachineType()
```
    Required. The Compute Engine machine type used for runtimes. Short name is valid. Examples: * `n1-standard-2` * `e2-standard-8`
    
    Returns:
    
    value or null for none
  - setMachineType
```
public VirtualMachineConfig setMachineType(String machineType)
```
    Required. The Compute Engine machine type used for runtimes. Short name is valid. Examples: * `n1-standard-2` * `e2-standard-8`
    
    Parameters:
    
    machineType - machineType or null for none
  - getMetadata
```
public Map<String,String> getMetadata()
```
    Optional. The Compute Engine metadata entries to add to virtual machine. (see [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving- metadata#project_and_instance_metadata)).
    
    Returns:
    
    value or null for none
  - setMetadata
```
public VirtualMachineConfig setMetadata(Map<String,String> metadata)
```
    Optional. The Compute Engine metadata entries to add to virtual machine. (see [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving- metadata#project_and_instance_metadata)).
    
    Parameters:
    
    metadata - metadata or null for none
  - getNetwork
```
public String getNetwork()
```
    Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither `network` nor `subnet` is specified, the "default" network of the project is used, if it exists. A full URL or partial URI. Examples: * `https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default` * `projects/[project_id]/global/networks/default` Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations: * Google Managed Network (Network & subnet are empty) * Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access. * Shared VPC (network & subnet are required). Requires configuring Private Service Access.
    
    Returns:
    
    value or null for none
  - setNetwork
```
public VirtualMachineConfig setNetwork(String network)
```
    Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork. If neither `network` nor `subnet` is specified, the "default" network of the project is used, if it exists. A full URL or partial URI. Examples: * `https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default` * `projects/[project_id]/global/networks/default` Runtimes are managed resources inside Google Infrastructure. Runtimes support the following network configurations: * Google Managed Network (Network & subnet are empty) * Consumer Project VPC (network & subnet are required). Requires configuring Private Service Access. * Shared VPC (network & subnet are required). Requires configuring Private Service Access.
    
    Parameters:
    
    network - network or null for none
  - getNicType
```
public String getNicType()
```
    Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
    
    Returns:
    
    value or null for none
  - setNicType
```
public VirtualMachineConfig setNicType(String nicType)
```
    Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
    
    Parameters:
    
    nicType - nicType or null for none
  - getReservedIpRange
```
public String getReservedIpRange()
```
    Optional. Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range *name* if it's assigned. Example: managed-notebooks-range-c PEERING_RANGE_NAME_3=managed-notebooks-range-c gcloud compute addresses create $PEERING_RANGE_NAME_3 \ --global \ --prefix-length=24 \ --description="Google Cloud Managed Notebooks Range 24 c" \ --network=$NETWORK \ --addresses=192.168.0.0 \ --purpose=VPC_PEERING Field value will be: `managed-notebooks-range-c`
    
    Returns:
    
    value or null for none
  - setReservedIpRange
```
public VirtualMachineConfig setReservedIpRange(String reservedIpRange)
```
    Optional. Reserved IP Range name is used for VPC Peering. The subnetwork allocation will use the range *name* if it's assigned. Example: managed-notebooks-range-c PEERING_RANGE_NAME_3=managed-notebooks-range-c gcloud compute addresses create $PEERING_RANGE_NAME_3 \ --global \ --prefix-length=24 \ --description="Google Cloud Managed Notebooks Range 24 c" \ --network=$NETWORK \ --addresses=192.168.0.0 \ --purpose=VPC_PEERING Field value will be: `managed-notebooks-range-c`
    
    Parameters:
    
    reservedIpRange - reservedIpRange or null for none
  - getShieldedInstanceConfig
```
public RuntimeShieldedInstanceConfig getShieldedInstanceConfig()
```
    Optional. Shielded VM Instance configuration settings.
    
    Returns:
    
    value or null for none
  - setShieldedInstanceConfig
```
public VirtualMachineConfig setShieldedInstanceConfig(RuntimeShieldedInstanceConfig shieldedInstanceConfig)
```
    Optional. Shielded VM Instance configuration settings.
    
    Parameters:
    
    shieldedInstanceConfig - shieldedInstanceConfig or null for none
  - getSubnet
```
public String getSubnet()
```
    Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network. A full URL or partial URI are valid. Examples: * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0` * `projects/[project_id]/regions/us-east1/subnetworks/sub0`
    
    Returns:
    
    value or null for none
  - setSubnet
```
public VirtualMachineConfig setSubnet(String subnet)
```
    Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network. A full URL or partial URI are valid. Examples: * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0` * `projects/[project_id]/regions/us-east1/subnetworks/sub0`
    
    Parameters:
    
    subnet - subnet or null for none
  - getTags
```
public List<String> getTags()
```
    Optional. The Compute Engine network tags to add to runtime (see [Add network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
    
    Returns:
    
    value or null for none
  - setTags
```
public VirtualMachineConfig setTags(List<String> tags)
```
    Optional. The Compute Engine network tags to add to runtime (see [Add network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
    
    Parameters:
    
    tags - tags or null for none
  - getZone
```
public String getZone()
```
    Output only. The zone where the virtual machine is located. If using regional request, the notebooks service will pick a location in the corresponding runtime region. On a get request, zone will always be present. Example: * `us-central1-b`
    
    Returns:
    
    value or null for none
  - setZone
```
public VirtualMachineConfig setZone(String zone)
```
    Output only. The zone where the virtual machine is located. If using regional request, the notebooks service will pick a location in the corresponding runtime region. On a get request, zone will always be present. Example: * `us-central1-b`
    
    Parameters:
    
    zone - zone or null for none
  - set
```
public VirtualMachineConfig set(String fieldName,
                                Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public VirtualMachineConfig clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class VirtualMachineConfig

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

VirtualMachineConfig

Method Detail

getAcceleratorConfig

setAcceleratorConfig

getBootImage

setBootImage

getContainerImages

setContainerImages

getDataDisk

setDataDisk

getEncryptionConfig

setEncryptionConfig

getGuestAttributes

setGuestAttributes

getInternalIpOnly

setInternalIpOnly

getLabels

setLabels

getMachineType

setMachineType

getMetadata

setMetadata

getNetwork

setNetwork

getNicType

setNicType

getReservedIpRange

setReservedIpRange

getShieldedInstanceConfig

setShieldedInstanceConfig

getSubnet

setSubnet

getTags

setTags

getZone

setZone

set

clone