NodeConfig (Kubernetes Engine API v1-rev20200324-1.30.9)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.container.model.NodeConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class NodeConfig
extends GenericJson
```
Parameters that describe the nodes in a cluster.
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 Kubernetes Engine 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

NodeConfig()

Constructors
Constructor and Description
`NodeConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NodeConfig`	`clone()`
`List<AcceleratorConfig>`	`getAccelerators()` A list of hardware accelerators to be attached to each node.
`Integer`	`getDiskSizeGb()` Size of the disk attached to each node, specified in GB.
`String`	`getDiskType()` Type of the disk attached to each node (e.g.
`String`	`getImageType()` The image type to use for this node.
`Map<String,String>`	`getLabels()` The map of Kubernetes labels (key/value pairs) to be applied to each node.
`Integer`	`getLocalSsdCount()` The number of local SSD disks to be attached to the node.
`String`	`getMachineType()` The name of a Google Compute Engine [machine type](/compute/docs/machine-types) (e.g.
`Map<String,String>`	`getMetadata()` The metadata key/value pairs assigned to instances in the cluster.
`String`	`getMinCpuPlatform()` Minimum CPU platform to be used by this instance.
`List<String>`	`getOauthScopes()` The set of Google API scopes to be made available on all of the node VMs under the "default" service account.
`Boolean`	`getPreemptible()` Whether the nodes are created as preemptible VM instances.
`ReservationAffinity`	`getReservationAffinity()` The optional reservation affinity.
`SandboxConfig`	`getSandboxConfig()` Sandbox configuration for this node.
`String`	`getServiceAccount()` The Google Cloud Platform Service Account to be used by the node VMs.
`ShieldedInstanceConfig`	`getShieldedInstanceConfig()` Shielded Instance options.
`List<String>`	`getTags()` The list of instance tags applied to all nodes.
`List<NodeTaint>`	`getTaints()` List of kubernetes taints to be applied to each node.
`WorkloadMetadataConfig`	`getWorkloadMetadataConfig()` The workload metadata configuration for this node.
`NodeConfig`	`set(String fieldName, Object value)`
`NodeConfig`	`setAccelerators(List<AcceleratorConfig> accelerators)` A list of hardware accelerators to be attached to each node.
`NodeConfig`	`setDiskSizeGb(Integer diskSizeGb)` Size of the disk attached to each node, specified in GB.
`NodeConfig`	`setDiskType(String diskType)` Type of the disk attached to each node (e.g.
`NodeConfig`	`setImageType(String imageType)` The image type to use for this node.
`NodeConfig`	`setLabels(Map<String,String> labels)` The map of Kubernetes labels (key/value pairs) to be applied to each node.
`NodeConfig`	`setLocalSsdCount(Integer localSsdCount)` The number of local SSD disks to be attached to the node.
`NodeConfig`	`setMachineType(String machineType)` The name of a Google Compute Engine [machine type](/compute/docs/machine-types) (e.g.
`NodeConfig`	`setMetadata(Map<String,String> metadata)` The metadata key/value pairs assigned to instances in the cluster.
`NodeConfig`	`setMinCpuPlatform(String minCpuPlatform)` Minimum CPU platform to be used by this instance.
`NodeConfig`	`setOauthScopes(List<String> oauthScopes)` The set of Google API scopes to be made available on all of the node VMs under the "default" service account.
`NodeConfig`	`setPreemptible(Boolean preemptible)` Whether the nodes are created as preemptible VM instances.
`NodeConfig`	`setReservationAffinity(ReservationAffinity reservationAffinity)` The optional reservation affinity.
`NodeConfig`	`setSandboxConfig(SandboxConfig sandboxConfig)` Sandbox configuration for this node.
`NodeConfig`	`setServiceAccount(String serviceAccount)` The Google Cloud Platform Service Account to be used by the node VMs.
`NodeConfig`	`setShieldedInstanceConfig(ShieldedInstanceConfig shieldedInstanceConfig)` Shielded Instance options.
`NodeConfig`	`setTags(List<String> tags)` The list of instance tags applied to all nodes.
`NodeConfig`	`setTaints(List<NodeTaint> taints)` List of kubernetes taints to be applied to each node.
`NodeConfig`	`setWorkloadMetadataConfig(WorkloadMetadataConfig workloadMetadataConfig)` The workload metadata configuration for this node.

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
  - NodeConfig
```
public NodeConfig()
```
- Method Detail
  - getAccelerators
```
public List<AcceleratorConfig> getAccelerators()
```
    A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
    
    Returns:
    
    value or null for none
  - setAccelerators
```
public NodeConfig setAccelerators(List<AcceleratorConfig> accelerators)
```
    A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
    
    Parameters:
    
    accelerators - accelerators or null for none
  - getDiskSizeGb
```
public Integer getDiskSizeGb()
```
    Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
    
    Returns:
    
    value or null for none
  - setDiskSizeGb
```
public NodeConfig setDiskSizeGb(Integer diskSizeGb)
```
    Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
    
    Parameters:
    
    diskSizeGb - diskSizeGb or null for none
  - getDiskType
```
public String getDiskType()
```
    Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard'
    
    Returns:
    
    value or null for none
  - setDiskType
```
public NodeConfig setDiskType(String diskType)
```
    Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard'
    
    Parameters:
    
    diskType - diskType or null for none
  - getImageType
```
public String getImageType()
```
    The image type to use for this node. Note that for a given image type, the latest version of it will be used.
    
    Returns:
    
    value or null for none
  - setImageType
```
public NodeConfig setImageType(String imageType)
```
    The image type to use for this node. Note that for a given image type, the latest version of it will be used.
    
    Parameters:
    
    imageType - imageType or null for none
  - getLabels
```
public Map<String,String> getLabels()
```
    The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview /working-with-objects/labels/
    
    Returns:
    
    value or null for none
  - setLabels
```
public NodeConfig setLabels(Map<String,String> labels)
```
    The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview /working-with-objects/labels/
    
    Parameters:
    
    labels - labels or null for none
  - getLocalSsdCount
```
public Integer getLocalSsdCount()
```
    The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
    
    Returns:
    
    value or null for none
  - setLocalSsdCount
```
public NodeConfig setLocalSsdCount(Integer localSsdCount)
```
    The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
    
    Parameters:
    
    localSsdCount - localSsdCount or null for none
  - getMachineType
```
public String getMachineType()
```
    The name of a Google Compute Engine [machine type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`.
    
    Returns:
    
    value or null for none
  - setMachineType
```
public NodeConfig setMachineType(String machineType)
```
    The name of a Google Compute Engine [machine type](/compute/docs/machine-types) (e.g. `n1-standard-1`). If unspecified, the default machine type is `n1-standard-1`.
    
    Parameters:
    
    machineType - machineType or null for none
  - getMetadata
```
public Map<String,String> getMetadata()
```
    The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: "cluster-location" "cluster-name" "cluster-uid" "configure-sh" "containerd-configure-sh" "enable-os-login" "gci-ensure-gke-docker" "gci-metrics-enabled" "gci-update-strategy" "instance-template" "kube-env" "startup-script" "user-data" "disable-address-manager" "windows-startup-script-ps1" "common-psm1" "k8s-node-setup-psm1" "install-ssh-psm1" "user- profile-psm1" "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
    
    Returns:
    
    value or null for none
  - setMetadata
```
public NodeConfig setMetadata(Map<String,String> metadata)
```
    The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: "cluster-location" "cluster-name" "cluster-uid" "configure-sh" "containerd-configure-sh" "enable-os-login" "gci-ensure-gke-docker" "gci-metrics-enabled" "gci-update-strategy" "instance-template" "kube-env" "startup-script" "user-data" "disable-address-manager" "windows-startup-script-ps1" "common-psm1" "k8s-node-setup-psm1" "install-ssh-psm1" "user- profile-psm1" "serial-port-logging-enable" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
    
    Parameters:
    
    metadata - metadata or null for none
  - getMinCpuPlatform
```
public String getMinCpuPlatform()
```
    Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
    
    Returns:
    
    value or null for none
  - setMinCpuPlatform
```
public NodeConfig setMinCpuPlatform(String minCpuPlatform)
```
    Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
    
    Parameters:
    
    minCpuPlatform - minCpuPlatform or null for none
  - getOauthScopes
```
public List<String> getOauthScopes()
```
    The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
    
    Returns:
    
    value or null for none
  - setOauthScopes
```
public NodeConfig setOauthScopes(List<String> oauthScopes)
```
    The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
    
    Parameters:
    
    oauthScopes - oauthScopes or null for none
  - getPreemptible
```
public Boolean getPreemptible()
```
    Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
    
    Returns:
    
    value or null for none
  - setPreemptible
```
public NodeConfig setPreemptible(Boolean preemptible)
```
    Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
    
    Parameters:
    
    preemptible - preemptible or null for none
  - getReservationAffinity
```
public ReservationAffinity getReservationAffinity()
```
    The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](/compute/docs/instances/reserving-zonal-resources) to this node pool.
    
    Returns:
    
    value or null for none
  - setReservationAffinity
```
public NodeConfig setReservationAffinity(ReservationAffinity reservationAffinity)
```
    The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](/compute/docs/instances/reserving-zonal-resources) to this node pool.
    
    Parameters:
    
    reservationAffinity - reservationAffinity or null for none
  - getSandboxConfig
```
public SandboxConfig getSandboxConfig()
```
    Sandbox configuration for this node.
    
    Returns:
    
    value or null for none
  - setSandboxConfig
```
public NodeConfig setSandboxConfig(SandboxConfig sandboxConfig)
```
    Sandbox configuration for this node.
    
    Parameters:
    
    sandboxConfig - sandboxConfig or null for none
  - getServiceAccount
```
public String getServiceAccount()
```
    The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.
    
    Returns:
    
    value or null for none
  - setServiceAccount
```
public NodeConfig setServiceAccount(String serviceAccount)
```
    The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.
    
    Parameters:
    
    serviceAccount - serviceAccount or null for none
  - getShieldedInstanceConfig
```
public ShieldedInstanceConfig getShieldedInstanceConfig()
```
    Shielded Instance options.
    
    Returns:
    
    value or null for none
  - setShieldedInstanceConfig
```
public NodeConfig setShieldedInstanceConfig(ShieldedInstanceConfig shieldedInstanceConfig)
```
    Shielded Instance options.
    
    Parameters:
    
    shieldedInstanceConfig - shieldedInstanceConfig or null for none
  - getTags
```
public List<String> getTags()
```
    The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
    
    Returns:
    
    value or null for none
  - setTags
```
public NodeConfig setTags(List<String> tags)
```
    The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
    
    Parameters:
    
    tags - tags or null for none
  - getTaints
```
public List<NodeTaint> getTaints()
```
    List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
    
    Returns:
    
    value or null for none
  - setTaints
```
public NodeConfig setTaints(List<NodeTaint> taints)
```
    List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
    
    Parameters:
    
    taints - taints or null for none
  - getWorkloadMetadataConfig
```
public WorkloadMetadataConfig getWorkloadMetadataConfig()
```
    The workload metadata configuration for this node.
    
    Returns:
    
    value or null for none
  - setWorkloadMetadataConfig
```
public NodeConfig setWorkloadMetadataConfig(WorkloadMetadataConfig workloadMetadataConfig)
```
    The workload metadata configuration for this node.
    
    Parameters:
    
    workloadMetadataConfig - workloadMetadataConfig or null for none
  - set
```
public NodeConfig set(String fieldName,
                      Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public NodeConfig clone()
```
    Overrides:
    
    clone in class GenericJson

Class NodeConfig

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

NodeConfig

Method Detail

getAccelerators

setAccelerators

getDiskSizeGb

setDiskSizeGb

getDiskType

setDiskType

getImageType

setImageType

getLabels

setLabels

getLocalSsdCount

setLocalSsdCount

getMachineType

setMachineType

getMetadata

setMetadata

getMinCpuPlatform

setMinCpuPlatform

getOauthScopes

setOauthScopes

getPreemptible

setPreemptible

getReservationAffinity

setReservationAffinity

getSandboxConfig

setSandboxConfig

getServiceAccount

setServiceAccount

getShieldedInstanceConfig

setShieldedInstanceConfig

getTags

setTags

getTaints

setTaints

getWorkloadMetadataConfig

setWorkloadMetadataConfig

set

clone