Class NodeConfig (2.10.0) 

public final class NodeConfig extends GeneratedMessageV3 implements NodeConfigOrBuilder

Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in NodeConfig. Use AutoprovisioningNodePoolDefaults instead.

Protobuf type google.container.v1.NodeConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > NodeConfig

Implements

NodeConfigOrBuilder

Static Fields

ACCELERATORS_FIELD_NUMBER

public static final int ACCELERATORS_FIELD_NUMBER
Field Value
TypeDescription
int

ADVANCED_MACHINE_FEATURES_FIELD_NUMBER

public static final int ADVANCED_MACHINE_FEATURES_FIELD_NUMBER
Field Value
TypeDescription
int

BOOT_DISK_KMS_KEY_FIELD_NUMBER

public static final int BOOT_DISK_KMS_KEY_FIELD_NUMBER
Field Value
TypeDescription
int

CONFIDENTIAL_NODES_FIELD_NUMBER

public static final int CONFIDENTIAL_NODES_FIELD_NUMBER
Field Value
TypeDescription
int

DISK_SIZE_GB_FIELD_NUMBER

public static final int DISK_SIZE_GB_FIELD_NUMBER
Field Value
TypeDescription
int

DISK_TYPE_FIELD_NUMBER

public static final int DISK_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

FAST_SOCKET_FIELD_NUMBER

public static final int FAST_SOCKET_FIELD_NUMBER
Field Value
TypeDescription
int

GCFS_CONFIG_FIELD_NUMBER

public static final int GCFS_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

GVNIC_FIELD_NUMBER

public static final int GVNIC_FIELD_NUMBER
Field Value
TypeDescription
int

IMAGE_TYPE_FIELD_NUMBER

public static final int IMAGE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

KUBELET_CONFIG_FIELD_NUMBER

public static final int KUBELET_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

LINUX_NODE_CONFIG_FIELD_NUMBER

public static final int LINUX_NODE_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

LOCAL_SSD_COUNT_FIELD_NUMBER

public static final int LOCAL_SSD_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

LOGGING_CONFIG_FIELD_NUMBER

public static final int LOGGING_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

MACHINE_TYPE_FIELD_NUMBER

public static final int MACHINE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

MIN_CPU_PLATFORM_FIELD_NUMBER

public static final int MIN_CPU_PLATFORM_FIELD_NUMBER
Field Value
TypeDescription
int

NODE_GROUP_FIELD_NUMBER

public static final int NODE_GROUP_FIELD_NUMBER
Field Value
TypeDescription
int

OAUTH_SCOPES_FIELD_NUMBER

public static final int OAUTH_SCOPES_FIELD_NUMBER
Field Value
TypeDescription
int

PREEMPTIBLE_FIELD_NUMBER

public static final int PREEMPTIBLE_FIELD_NUMBER
Field Value
TypeDescription
int

RESERVATION_AFFINITY_FIELD_NUMBER

public static final int RESERVATION_AFFINITY_FIELD_NUMBER
Field Value
TypeDescription
int

RESOURCE_LABELS_FIELD_NUMBER

public static final int RESOURCE_LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

SANDBOX_CONFIG_FIELD_NUMBER

public static final int SANDBOX_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
TypeDescription
int

SHIELDED_INSTANCE_CONFIG_FIELD_NUMBER

public static final int SHIELDED_INSTANCE_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

SPOT_FIELD_NUMBER

public static final int SPOT_FIELD_NUMBER
Field Value
TypeDescription
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER
Field Value
TypeDescription
int

TAINTS_FIELD_NUMBER

public static final int TAINTS_FIELD_NUMBER
Field Value
TypeDescription
int

WORKLOAD_METADATA_CONFIG_FIELD_NUMBER

public static final int WORKLOAD_METADATA_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static NodeConfig getDefaultInstance()
Returns
TypeDescription
NodeConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static NodeConfig.Builder newBuilder()
Returns
TypeDescription
NodeConfig.Builder

newBuilder(NodeConfig prototype)

public static NodeConfig.Builder newBuilder(NodeConfig prototype)
Parameter
NameDescription
prototypeNodeConfig
Returns
TypeDescription
NodeConfig.Builder

parseDelimitedFrom(InputStream input)

public static NodeConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
NodeConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NodeConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NodeConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static NodeConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
NodeConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static NodeConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NodeConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static NodeConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
NodeConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static NodeConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NodeConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static NodeConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
NodeConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static NodeConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NodeConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static NodeConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
NodeConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NodeConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NodeConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static NodeConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
NodeConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static NodeConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NodeConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<NodeConfig> parser()
Returns
TypeDescription
Parser<NodeConfig>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

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/

map<string, string> labels = 6;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsMetadata(String key)

public boolean containsMetadata(String key)

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

map<string, string> metadata = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsResourceLabels(String key)

public boolean containsResourceLabels(String key)

The resource labels for the node pool to use to annotate any related Google Compute Engine resources.

map<string, string> resource_labels = 37;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAccelerators(int index)

public AcceleratorConfig getAccelerators(int index)

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.

repeated .google.container.v1.AcceleratorConfig accelerators = 11;

Parameter
NameDescription
indexint
Returns
TypeDescription
AcceleratorConfig

getAcceleratorsCount()

public int getAcceleratorsCount()

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.

repeated .google.container.v1.AcceleratorConfig accelerators = 11;

Returns
TypeDescription
int

getAcceleratorsList()

public List<AcceleratorConfig> getAcceleratorsList()

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.

repeated .google.container.v1.AcceleratorConfig accelerators = 11;

Returns
TypeDescription
List<AcceleratorConfig>

getAcceleratorsOrBuilder(int index)

public AcceleratorConfigOrBuilder getAcceleratorsOrBuilder(int index)

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.

repeated .google.container.v1.AcceleratorConfig accelerators = 11;

Parameter
NameDescription
indexint
Returns
TypeDescription
AcceleratorConfigOrBuilder

getAcceleratorsOrBuilderList()

public List<? extends AcceleratorConfigOrBuilder> getAcceleratorsOrBuilderList()

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.

repeated .google.container.v1.AcceleratorConfig accelerators = 11;

Returns
TypeDescription
List<? extends com.google.container.v1.AcceleratorConfigOrBuilder>

getAdvancedMachineFeatures()

public AdvancedMachineFeatures getAdvancedMachineFeatures()

Advanced features for the Compute Engine VM.

.google.container.v1.AdvancedMachineFeatures advanced_machine_features = 26;

Returns
TypeDescription
AdvancedMachineFeatures

The advancedMachineFeatures.

getAdvancedMachineFeaturesOrBuilder()

public AdvancedMachineFeaturesOrBuilder getAdvancedMachineFeaturesOrBuilder()

Advanced features for the Compute Engine VM.

.google.container.v1.AdvancedMachineFeatures advanced_machine_features = 26;

Returns
TypeDescription
AdvancedMachineFeaturesOrBuilder

getBootDiskKmsKey()

public String getBootDiskKmsKey()

The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption

string boot_disk_kms_key = 23;

Returns
TypeDescription
String

The bootDiskKmsKey.

getBootDiskKmsKeyBytes()

public ByteString getBootDiskKmsKeyBytes()

The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption

string boot_disk_kms_key = 23;

Returns
TypeDescription
ByteString

The bytes for bootDiskKmsKey.

getConfidentialNodes()

public ConfidentialNodes getConfidentialNodes()

Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.

.google.container.v1.ConfidentialNodes confidential_nodes = 35;

Returns
TypeDescription
ConfidentialNodes

The confidentialNodes.

getConfidentialNodesOrBuilder()

public ConfidentialNodesOrBuilder getConfidentialNodesOrBuilder()

Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.

.google.container.v1.ConfidentialNodes confidential_nodes = 35;

Returns
TypeDescription
ConfidentialNodesOrBuilder

getDefaultInstanceForType()

public NodeConfig getDefaultInstanceForType()
Returns
TypeDescription
NodeConfig

getDiskSizeGb()

public int 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.

int32 disk_size_gb = 2;

Returns
TypeDescription
int

The diskSizeGb.

getDiskType()

public String getDiskType()

Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'

string disk_type = 12;

Returns
TypeDescription
String

The diskType.

getDiskTypeBytes()

public ByteString getDiskTypeBytes()

Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'

string disk_type = 12;

Returns
TypeDescription
ByteString

The bytes for diskType.

getFastSocket()

public FastSocket getFastSocket()

Enable or disable NCCL fast socket for the node pool.

optional .google.container.v1.FastSocket fast_socket = 36;

Returns
TypeDescription
FastSocket

The fastSocket.

getFastSocketOrBuilder()

public FastSocketOrBuilder getFastSocketOrBuilder()

Enable or disable NCCL fast socket for the node pool.

optional .google.container.v1.FastSocket fast_socket = 36;

Returns
TypeDescription
FastSocketOrBuilder

getGcfsConfig()

public GcfsConfig getGcfsConfig()

Google Container File System (image streaming) configs.

.google.container.v1.GcfsConfig gcfs_config = 25;

Returns
TypeDescription
GcfsConfig

The gcfsConfig.

getGcfsConfigOrBuilder()

public GcfsConfigOrBuilder getGcfsConfigOrBuilder()

Google Container File System (image streaming) configs.

.google.container.v1.GcfsConfig gcfs_config = 25;

Returns
TypeDescription
GcfsConfigOrBuilder

getGvnic()

public VirtualNIC getGvnic()

Enable or disable gvnic in the node pool.

.google.container.v1.VirtualNIC gvnic = 29;

Returns
TypeDescription
VirtualNIC

The gvnic.

getGvnicOrBuilder()

public VirtualNICOrBuilder getGvnicOrBuilder()

Enable or disable gvnic in the node pool.

.google.container.v1.VirtualNIC gvnic = 29;

Returns
TypeDescription
VirtualNICOrBuilder

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.

string image_type = 5;

Returns
TypeDescription
String

The imageType.

getImageTypeBytes()

public ByteString getImageTypeBytes()

The image type to use for this node. Note that for a given image type, the latest version of it will be used.

string image_type = 5;

Returns
TypeDescription
ByteString

The bytes for imageType.

getKubeletConfig()

public NodeKubeletConfig getKubeletConfig()

Node kubelet configs.

.google.container.v1.NodeKubeletConfig kubelet_config = 22;

Returns
TypeDescription
NodeKubeletConfig

The kubeletConfig.

getKubeletConfigOrBuilder()

public NodeKubeletConfigOrBuilder getKubeletConfigOrBuilder()

Node kubelet configs.

.google.container.v1.NodeKubeletConfig kubelet_config = 22;

Returns
TypeDescription
NodeKubeletConfigOrBuilder

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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/

map<string, string> labels = 6;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

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/

map<string, string> labels = 6;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

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/

map<string, string> labels = 6;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

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/

map<string, string> labels = 6;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getLinuxNodeConfig()

public LinuxNodeConfig getLinuxNodeConfig()

Parameters that can be configured on Linux nodes.

.google.container.v1.LinuxNodeConfig linux_node_config = 21;

Returns
TypeDescription
LinuxNodeConfig

The linuxNodeConfig.

getLinuxNodeConfigOrBuilder()

public LinuxNodeConfigOrBuilder getLinuxNodeConfigOrBuilder()

Parameters that can be configured on Linux nodes.

.google.container.v1.LinuxNodeConfig linux_node_config = 21;

Returns
TypeDescription
LinuxNodeConfigOrBuilder

getLocalSsdCount()

public int 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.

int32 local_ssd_count = 7;

Returns
TypeDescription
int

The localSsdCount.

getLoggingConfig()

public NodePoolLoggingConfig getLoggingConfig()

Logging configuration.

.google.container.v1.NodePoolLoggingConfig logging_config = 38;

Returns
TypeDescription
NodePoolLoggingConfig

The loggingConfig.

getLoggingConfigOrBuilder()

public NodePoolLoggingConfigOrBuilder getLoggingConfigOrBuilder()

Logging configuration.

.google.container.v1.NodePoolLoggingConfig logging_config = 38;

Returns
TypeDescription
NodePoolLoggingConfigOrBuilder

getMachineType()

public String getMachineType()

The name of a Google Compute Engine machine type If unspecified, the default machine type is e2-medium.

string machine_type = 1;

Returns
TypeDescription
String

The machineType.

getMachineTypeBytes()

public ByteString getMachineTypeBytes()

The name of a Google Compute Engine machine type If unspecified, the default machine type is e2-medium.

string machine_type = 1;

Returns
TypeDescription
ByteString

The bytes for machineType.

getMetadata()

public Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
TypeDescription
Map<String,String>

getMetadataCount()

public int getMetadataCount()

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

map<string, string> metadata = 4;

Returns
TypeDescription
int

getMetadataMap()

public Map<String,String> getMetadataMap()

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

map<string, string> metadata = 4;

Returns
TypeDescription
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public String getMetadataOrDefault(String key, String defaultValue)

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

map<string, string> metadata = 4;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getMetadataOrThrow(String key)

public String getMetadataOrThrow(String key)

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

map<string, string> metadata = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

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

string min_cpu_platform = 13;

Returns
TypeDescription
String

The minCpuPlatform.

getMinCpuPlatformBytes()

public ByteString getMinCpuPlatformBytes()

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

string min_cpu_platform = 13;

Returns
TypeDescription
ByteString

The bytes for minCpuPlatform.

getNodeGroup()

public String getNodeGroup()

Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes.

string node_group = 18;

Returns
TypeDescription
String

The nodeGroup.

getNodeGroupBytes()

public ByteString getNodeGroupBytes()

Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes.

string node_group = 18;

Returns
TypeDescription
ByteString

The bytes for nodeGroup.

getOauthScopes(int index)

public String getOauthScopes(int index)

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:

repeated string oauth_scopes = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The oauthScopes at the given index.

getOauthScopesBytes(int index)

public ByteString getOauthScopesBytes(int index)

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:

repeated string oauth_scopes = 3;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the oauthScopes at the given index.

getOauthScopesCount()

public int getOauthScopesCount()

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:

repeated string oauth_scopes = 3;

Returns
TypeDescription
int

The count of oauthScopes.

getOauthScopesList()

public ProtocolStringList getOauthScopesList()

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:

repeated string oauth_scopes = 3;

Returns
TypeDescription
ProtocolStringList

A list containing the oauthScopes.

getParserForType()

public Parser<NodeConfig> getParserForType()
Returns
TypeDescription
Parser<NodeConfig>
Overrides

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.

bool preemptible = 10;

Returns
TypeDescription
boolean

The preemptible.

getReservationAffinity()

public ReservationAffinity getReservationAffinity()

The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this node pool.

.google.container.v1.ReservationAffinity reservation_affinity = 19;

Returns
TypeDescription
ReservationAffinity

The reservationAffinity.

getReservationAffinityOrBuilder()

public ReservationAffinityOrBuilder getReservationAffinityOrBuilder()

The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this node pool.

.google.container.v1.ReservationAffinity reservation_affinity = 19;

Returns
TypeDescription
ReservationAffinityOrBuilder

getResourceLabels()

public Map<String,String> getResourceLabels()

Use #getResourceLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getResourceLabelsCount()

public int getResourceLabelsCount()

The resource labels for the node pool to use to annotate any related Google Compute Engine resources.

map<string, string> resource_labels = 37;

Returns
TypeDescription
int

getResourceLabelsMap()

public Map<String,String> getResourceLabelsMap()

The resource labels for the node pool to use to annotate any related Google Compute Engine resources.

map<string, string> resource_labels = 37;

Returns
TypeDescription
Map<String,String>

getResourceLabelsOrDefault(String key, String defaultValue)

public String getResourceLabelsOrDefault(String key, String defaultValue)

The resource labels for the node pool to use to annotate any related Google Compute Engine resources.

map<string, string> resource_labels = 37;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getResourceLabelsOrThrow(String key)

public String getResourceLabelsOrThrow(String key)

The resource labels for the node pool to use to annotate any related Google Compute Engine resources.

map<string, string> resource_labels = 37;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getSandboxConfig()

public SandboxConfig getSandboxConfig()

Sandbox configuration for this node.

.google.container.v1.SandboxConfig sandbox_config = 17;

Returns
TypeDescription
SandboxConfig

The sandboxConfig.

getSandboxConfigOrBuilder()

public SandboxConfigOrBuilder getSandboxConfigOrBuilder()

Sandbox configuration for this node.

.google.container.v1.SandboxConfig sandbox_config = 17;

Returns
TypeDescription
SandboxConfigOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

string service_account = 9;

Returns
TypeDescription
String

The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

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.

string service_account = 9;

Returns
TypeDescription
ByteString

The bytes for serviceAccount.

getShieldedInstanceConfig()

public ShieldedInstanceConfig getShieldedInstanceConfig()

Shielded Instance options.

.google.container.v1.ShieldedInstanceConfig shielded_instance_config = 20;

Returns
TypeDescription
ShieldedInstanceConfig

The shieldedInstanceConfig.

getShieldedInstanceConfigOrBuilder()

public ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()

Shielded Instance options.

.google.container.v1.ShieldedInstanceConfig shielded_instance_config = 20;

Returns
TypeDescription
ShieldedInstanceConfigOrBuilder

getSpot()

public boolean getSpot()

Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.

bool spot = 32;

Returns
TypeDescription
boolean

The spot.

getTags(int index)

public String getTags(int index)

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.

repeated string tags = 8;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The tags at the given index.

getTagsBytes(int index)

public ByteString getTagsBytes(int index)

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.

repeated string tags = 8;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the tags at the given index.

getTagsCount()

public int getTagsCount()

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.

repeated string tags = 8;

Returns
TypeDescription
int

The count of tags.

getTagsList()

public ProtocolStringList getTagsList()

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.

repeated string tags = 8;

Returns
TypeDescription
ProtocolStringList

A list containing the tags.

getTaints(int index)

public NodeTaint getTaints(int index)

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/

repeated .google.container.v1.NodeTaint taints = 15;

Parameter
NameDescription
indexint
Returns
TypeDescription
NodeTaint

getTaintsCount()

public int getTaintsCount()

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/

repeated .google.container.v1.NodeTaint taints = 15;

Returns
TypeDescription
int

getTaintsList()

public List<NodeTaint> getTaintsList()

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/

repeated .google.container.v1.NodeTaint taints = 15;

Returns
TypeDescription
List<NodeTaint>

getTaintsOrBuilder(int index)

public NodeTaintOrBuilder getTaintsOrBuilder(int index)

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/

repeated .google.container.v1.NodeTaint taints = 15;

Parameter
NameDescription
indexint
Returns
TypeDescription
NodeTaintOrBuilder

getTaintsOrBuilderList()

public List<? extends NodeTaintOrBuilder> getTaintsOrBuilderList()

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/

repeated .google.container.v1.NodeTaint taints = 15;

Returns
TypeDescription
List<? extends com.google.container.v1.NodeTaintOrBuilder>

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getWorkloadMetadataConfig()

public WorkloadMetadataConfig getWorkloadMetadataConfig()

The workload metadata configuration for this node.

.google.container.v1.WorkloadMetadataConfig workload_metadata_config = 14;

Returns
TypeDescription
WorkloadMetadataConfig

The workloadMetadataConfig.

getWorkloadMetadataConfigOrBuilder()

public WorkloadMetadataConfigOrBuilder getWorkloadMetadataConfigOrBuilder()

The workload metadata configuration for this node.

.google.container.v1.WorkloadMetadataConfig workload_metadata_config = 14;

Returns
TypeDescription
WorkloadMetadataConfigOrBuilder

hasAdvancedMachineFeatures()

public boolean hasAdvancedMachineFeatures()

Advanced features for the Compute Engine VM.

.google.container.v1.AdvancedMachineFeatures advanced_machine_features = 26;

Returns
TypeDescription
boolean

Whether the advancedMachineFeatures field is set.

hasConfidentialNodes()

public boolean hasConfidentialNodes()

Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.

.google.container.v1.ConfidentialNodes confidential_nodes = 35;

Returns
TypeDescription
boolean

Whether the confidentialNodes field is set.

hasFastSocket()

public boolean hasFastSocket()

Enable or disable NCCL fast socket for the node pool.

optional .google.container.v1.FastSocket fast_socket = 36;

Returns
TypeDescription
boolean

Whether the fastSocket field is set.

hasGcfsConfig()

public boolean hasGcfsConfig()

Google Container File System (image streaming) configs.

.google.container.v1.GcfsConfig gcfs_config = 25;

Returns
TypeDescription
boolean

Whether the gcfsConfig field is set.

hasGvnic()

public boolean hasGvnic()

Enable or disable gvnic in the node pool.

.google.container.v1.VirtualNIC gvnic = 29;

Returns
TypeDescription
boolean

Whether the gvnic field is set.

hasKubeletConfig()

public boolean hasKubeletConfig()

Node kubelet configs.

.google.container.v1.NodeKubeletConfig kubelet_config = 22;

Returns
TypeDescription
boolean

Whether the kubeletConfig field is set.

hasLinuxNodeConfig()

public boolean hasLinuxNodeConfig()

Parameters that can be configured on Linux nodes.

.google.container.v1.LinuxNodeConfig linux_node_config = 21;

Returns
TypeDescription
boolean

Whether the linuxNodeConfig field is set.

hasLoggingConfig()

public boolean hasLoggingConfig()

Logging configuration.

.google.container.v1.NodePoolLoggingConfig logging_config = 38;

Returns
TypeDescription
boolean

Whether the loggingConfig field is set.

hasReservationAffinity()

public boolean hasReservationAffinity()

The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this node pool.

.google.container.v1.ReservationAffinity reservation_affinity = 19;

Returns
TypeDescription
boolean

Whether the reservationAffinity field is set.

hasSandboxConfig()

public boolean hasSandboxConfig()

Sandbox configuration for this node.

.google.container.v1.SandboxConfig sandbox_config = 17;

Returns
TypeDescription
boolean

Whether the sandboxConfig field is set.

hasShieldedInstanceConfig()

public boolean hasShieldedInstanceConfig()

Shielded Instance options.

.google.container.v1.ShieldedInstanceConfig shielded_instance_config = 20;

Returns
TypeDescription
boolean

Whether the shieldedInstanceConfig field is set.

hasWorkloadMetadataConfig()

public boolean hasWorkloadMetadataConfig()

The workload metadata configuration for this node.

.google.container.v1.WorkloadMetadataConfig workload_metadata_config = 14;

Returns
TypeDescription
boolean

Whether the workloadMetadataConfig field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public NodeConfig.Builder newBuilderForType()
Returns
TypeDescription
NodeConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected NodeConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
NodeConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public NodeConfig.Builder toBuilder()
Returns
TypeDescription
NodeConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException