Class NodeConfig (2.5.1)

Stay organized with collections Save and categorize content based on your preferences.
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.v1beta1.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

EPHEMERAL_STORAGE_CONFIG_FIELD_NUMBER

public static final int EPHEMERAL_STORAGE_CONFIG_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

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

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-oslogin"
  • "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

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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.AcceleratorConfig accelerators = 11;

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

getAdvancedMachineFeatures()

public AdvancedMachineFeatures getAdvancedMachineFeatures()

Advanced features for the Compute Engine VM.

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

Returns
TypeDescription
AdvancedMachineFeatures

The advancedMachineFeatures.

getAdvancedMachineFeaturesOrBuilder()

public AdvancedMachineFeaturesOrBuilder getAdvancedMachineFeaturesOrBuilder()

Advanced features for the Compute Engine VM.

.google.container.v1beta1.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.v1beta1.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.v1beta1.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.

getEphemeralStorageConfig()

public EphemeralStorageConfig getEphemeralStorageConfig()

Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.

.google.container.v1beta1.EphemeralStorageConfig ephemeral_storage_config = 24;

Returns
TypeDescription
EphemeralStorageConfig

The ephemeralStorageConfig.

getEphemeralStorageConfigOrBuilder()

public EphemeralStorageConfigOrBuilder getEphemeralStorageConfigOrBuilder()

Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.

.google.container.v1beta1.EphemeralStorageConfig ephemeral_storage_config = 24;

Returns
TypeDescription
EphemeralStorageConfigOrBuilder

getGcfsConfig()

public GcfsConfig getGcfsConfig()

GCFS (Google Container File System) configs.

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

Returns
TypeDescription
GcfsConfig

The gcfsConfig.

getGcfsConfigOrBuilder()

public GcfsConfigOrBuilder getGcfsConfigOrBuilder()

GCFS (Google Container File System) configs.

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

Returns
TypeDescription
GcfsConfigOrBuilder

getGvnic()

public VirtualNIC getGvnic()

Enable or disable gvnic on the node pool.

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

Returns
TypeDescription
VirtualNIC

The gvnic.

getGvnicOrBuilder()

public VirtualNICOrBuilder getGvnicOrBuilder()

Enable or disable gvnic on the node pool.

.google.container.v1beta1.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.v1beta1.NodeKubeletConfig kubelet_config = 22;

Returns
TypeDescription
NodeKubeletConfig

The kubeletConfig.

getKubeletConfigOrBuilder()

public NodeKubeletConfigOrBuilder getKubeletConfigOrBuilder()

Node kubelet configs.

.google.container.v1beta1.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