- 2.57.0 (latest)
- 2.56.0
- 2.55.0
- 2.54.0
- 2.52.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.2
- 2.4.1
- 2.3.8
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 > NodeConfigImplements
NodeConfigOrBuilderStatic Fields
ACCELERATORS_FIELD_NUMBER
public static final int ACCELERATORS_FIELD_NUMBER
Type | Description |
int |
ADVANCED_MACHINE_FEATURES_FIELD_NUMBER
public static final int ADVANCED_MACHINE_FEATURES_FIELD_NUMBER
Type | Description |
int |
BOOT_DISK_KMS_KEY_FIELD_NUMBER
public static final int BOOT_DISK_KMS_KEY_FIELD_NUMBER
Type | Description |
int |
CONFIDENTIAL_NODES_FIELD_NUMBER
public static final int CONFIDENTIAL_NODES_FIELD_NUMBER
Type | Description |
int |
DISK_SIZE_GB_FIELD_NUMBER
public static final int DISK_SIZE_GB_FIELD_NUMBER
Type | Description |
int |
DISK_TYPE_FIELD_NUMBER
public static final int DISK_TYPE_FIELD_NUMBER
Type | Description |
int |
GCFS_CONFIG_FIELD_NUMBER
public static final int GCFS_CONFIG_FIELD_NUMBER
Type | Description |
int |
GVNIC_FIELD_NUMBER
public static final int GVNIC_FIELD_NUMBER
Type | Description |
int |
IMAGE_TYPE_FIELD_NUMBER
public static final int IMAGE_TYPE_FIELD_NUMBER
Type | Description |
int |
KUBELET_CONFIG_FIELD_NUMBER
public static final int KUBELET_CONFIG_FIELD_NUMBER
Type | Description |
int |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Type | Description |
int |
LINUX_NODE_CONFIG_FIELD_NUMBER
public static final int LINUX_NODE_CONFIG_FIELD_NUMBER
Type | Description |
int |
LOCAL_SSD_COUNT_FIELD_NUMBER
public static final int LOCAL_SSD_COUNT_FIELD_NUMBER
Type | Description |
int |
MACHINE_TYPE_FIELD_NUMBER
public static final int MACHINE_TYPE_FIELD_NUMBER
Type | Description |
int |
METADATA_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
Type | Description |
int |
MIN_CPU_PLATFORM_FIELD_NUMBER
public static final int MIN_CPU_PLATFORM_FIELD_NUMBER
Type | Description |
int |
NODE_GROUP_FIELD_NUMBER
public static final int NODE_GROUP_FIELD_NUMBER
Type | Description |
int |
OAUTH_SCOPES_FIELD_NUMBER
public static final int OAUTH_SCOPES_FIELD_NUMBER
Type | Description |
int |
PREEMPTIBLE_FIELD_NUMBER
public static final int PREEMPTIBLE_FIELD_NUMBER
Type | Description |
int |
RESERVATION_AFFINITY_FIELD_NUMBER
public static final int RESERVATION_AFFINITY_FIELD_NUMBER
Type | Description |
int |
SANDBOX_CONFIG_FIELD_NUMBER
public static final int SANDBOX_CONFIG_FIELD_NUMBER
Type | Description |
int |
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Type | Description |
int |
SHIELDED_INSTANCE_CONFIG_FIELD_NUMBER
public static final int SHIELDED_INSTANCE_CONFIG_FIELD_NUMBER
Type | Description |
int |
SPOT_FIELD_NUMBER
public static final int SPOT_FIELD_NUMBER
Type | Description |
int |
TAGS_FIELD_NUMBER
public static final int TAGS_FIELD_NUMBER
Type | Description |
int |
TAINTS_FIELD_NUMBER
public static final int TAINTS_FIELD_NUMBER
Type | Description |
int |
WORKLOAD_METADATA_CONFIG_FIELD_NUMBER
public static final int WORKLOAD_METADATA_CONFIG_FIELD_NUMBER
Type | Description |
int |
Static Methods
getDefaultInstance()
public static NodeConfig getDefaultInstance()
Type | Description |
NodeConfig |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
newBuilder()
public static NodeConfig.Builder newBuilder()
Type | Description |
NodeConfig.Builder |
newBuilder(NodeConfig prototype)
public static NodeConfig.Builder newBuilder(NodeConfig prototype)
Name | Description |
prototype | NodeConfig |
Type | Description |
NodeConfig.Builder |
parseDelimitedFrom(InputStream input)
public static NodeConfig parseDelimitedFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
NodeConfig |
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NodeConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
NodeConfig |
Type | Description |
IOException |
parseFrom(byte[] data)
public static NodeConfig parseFrom(byte[] data)
Name | Description |
data | byte[] |
Type | Description |
NodeConfig |
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static NodeConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
NodeConfig |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static NodeConfig parseFrom(ByteString data)
Name | Description |
data | ByteString |
Type | Description |
NodeConfig |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static NodeConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
NodeConfig |
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static NodeConfig parseFrom(CodedInputStream input)
Name | Description |
input | CodedInputStream |
Type | Description |
NodeConfig |
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static NodeConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
NodeConfig |
Type | Description |
IOException |
parseFrom(InputStream input)
public static NodeConfig parseFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
NodeConfig |
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static NodeConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
NodeConfig |
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static NodeConfig parseFrom(ByteBuffer data)
Name | Description |
data | ByteBuffer |
Type | Description |
NodeConfig |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static NodeConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
NodeConfig |
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<NodeConfig> parser()
Type | Description |
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;
Name | Description |
key | String |
Type | Description |
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;
Name | Description |
key | String |
Type | Description |
boolean |
equals(Object obj)
public boolean equals(Object obj)
Name | Description |
obj | Object |
Type | Description |
boolean |
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;
Name | Description |
index | int |
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Name | Description |
index | int |
Type | Description |
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;
Type | Description |
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;
Type | Description |
AdvancedMachineFeatures | The advancedMachineFeatures. |
getAdvancedMachineFeaturesOrBuilder()
public AdvancedMachineFeaturesOrBuilder getAdvancedMachineFeaturesOrBuilder()
Advanced features for the Compute Engine VM.
.google.container.v1.AdvancedMachineFeatures advanced_machine_features = 26;
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Type | Description |
ConfidentialNodesOrBuilder |
getDefaultInstanceForType()
public NodeConfig getDefaultInstanceForType()
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Type | Description |
ByteString | The bytes for diskType. |
getGcfsConfig()
public GcfsConfig getGcfsConfig()
Google Container File System (image streaming) configs.
.google.container.v1.GcfsConfig gcfs_config = 25;
Type | Description |
GcfsConfig | The gcfsConfig. |
getGcfsConfigOrBuilder()
public GcfsConfigOrBuilder getGcfsConfigOrBuilder()
Google Container File System (image streaming) configs.
.google.container.v1.GcfsConfig gcfs_config = 25;
Type | Description |
GcfsConfigOrBuilder |
getGvnic()
public VirtualNIC getGvnic()
Enable or disable gvnic in the node pool.
.google.container.v1.VirtualNIC gvnic = 29;
Type | Description |
VirtualNIC | The gvnic. |
getGvnicOrBuilder()
public VirtualNICOrBuilder getGvnicOrBuilder()
Enable or disable gvnic in the node pool.
.google.container.v1.VirtualNIC gvnic = 29;
Type | Description |
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;
Type | Description |
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;
Type | Description |
ByteString | The bytes for imageType. |
getKubeletConfig()
public NodeKubeletConfig getKubeletConfig()
Node kubelet configs.
.google.container.v1.NodeKubeletConfig kubelet_config = 22;
Type | Description |
NodeKubeletConfig | The kubeletConfig. |
getKubeletConfigOrBuilder()
public NodeKubeletConfigOrBuilder getKubeletConfigOrBuilder()
Node kubelet configs.
.google.container.v1.NodeKubeletConfig kubelet_config = 22;
Type | Description |
NodeKubeletConfigOrBuilder |
getLabels()
public Map<String,String> getLabels()
Use #getLabelsMap() instead.
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Name | Description |
key | String |
defaultValue | String |
Type | Description |
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;
Name | Description |
key | String |
Type | Description |
String |
getLinuxNodeConfig()
public LinuxNodeConfig getLinuxNodeConfig()
Parameters that can be configured on Linux nodes.
.google.container.v1.LinuxNodeConfig linux_node_config = 21;
Type | Description |
LinuxNodeConfig | The linuxNodeConfig. |
getLinuxNodeConfigOrBuilder()
public LinuxNodeConfigOrBuilder getLinuxNodeConfigOrBuilder()
Parameters that can be configured on Linux nodes.
.google.container.v1.LinuxNodeConfig linux_node_config = 21;
Type | Description |
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;
Type | Description |
int | The localSsdCount. |
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;
Type | Description |
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;
Type | Description |
ByteString | The bytes for machineType. |
getMetadata()
public Map<String,String> getMetadata()
Use #getMetadataMap() instead.
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Name | Description |
key | String |
defaultValue | String |
Type | Description |
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;
Name | Description |
key | String |
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Type | Description |
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:
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). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
repeated string oauth_scopes = 3;
Name | Description |
index | int The index of the element to return. |
Type | Description |
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:
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). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
repeated string oauth_scopes = 3;
Name | Description |
index | int The index of the value to return. |
Type | Description |
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:
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). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
repeated string oauth_scopes = 3;
Type | Description |
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:
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). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
repeated string oauth_scopes = 3;
Type | Description |
ProtocolStringList | A list containing the oauthScopes. |
getParserForType()
public Parser<NodeConfig> getParserForType()
Type | Description |
Parser<NodeConfig> |
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;
Type | Description |
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;
Type | Description |
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;
Type | Description |
ReservationAffinityOrBuilder |
getSandboxConfig()
public SandboxConfig getSandboxConfig()
Sandbox configuration for this node.
.google.container.v1.SandboxConfig sandbox_config = 17;
Type | Description |
SandboxConfig | The sandboxConfig. |
getSandboxConfigOrBuilder()
public SandboxConfigOrBuilder getSandboxConfigOrBuilder()
Sandbox configuration for this node.
.google.container.v1.SandboxConfig sandbox_config = 17;
Type | Description |
SandboxConfigOrBuilder |
getSerializedSize()
public int getSerializedSize()
Type | Description |
int |
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;
Type | Description |
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;
Type | Description |
ByteString | The bytes for serviceAccount. |
getShieldedInstanceConfig()
public ShieldedInstanceConfig getShieldedInstanceConfig()
Shielded Instance options.
.google.container.v1.ShieldedInstanceConfig shielded_instance_config = 20;
Type | Description |
ShieldedInstanceConfig | The shieldedInstanceConfig. |
getShieldedInstanceConfigOrBuilder()
public ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()
Shielded Instance options.
.google.container.v1.ShieldedInstanceConfig shielded_instance_config = 20;
Type | Description |
ShieldedInstanceConfigOrBuilder |
getSpot()
public boolean getSpot()
Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
bool spot = 32;
Type | Description |
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;
Name | Description |
index | int The index of the element to return. |
Type | Description |
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;
Name | Description |
index | int The index of the value to return. |
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Name | Description |
index | int |
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Name | Description |
index | int |
Type | Description |
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;
Type | Description |
List<? extends com.google.container.v1.NodeTaintOrBuilder> |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Type | Description |
UnknownFieldSet |
getWorkloadMetadataConfig()
public WorkloadMetadataConfig getWorkloadMetadataConfig()
The workload metadata configuration for this node.
.google.container.v1.WorkloadMetadataConfig workload_metadata_config = 14;
Type | Description |
WorkloadMetadataConfig | The workloadMetadataConfig. |
getWorkloadMetadataConfigOrBuilder()
public WorkloadMetadataConfigOrBuilder getWorkloadMetadataConfigOrBuilder()
The workload metadata configuration for this node.
.google.container.v1.WorkloadMetadataConfig workload_metadata_config = 14;
Type | Description |
WorkloadMetadataConfigOrBuilder |
hasAdvancedMachineFeatures()
public boolean hasAdvancedMachineFeatures()
Advanced features for the Compute Engine VM.
.google.container.v1.AdvancedMachineFeatures advanced_machine_features = 26;
Type | Description |
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;
Type | Description |
boolean | Whether the confidentialNodes field is set. |
hasGcfsConfig()
public boolean hasGcfsConfig()
Google Container File System (image streaming) configs.
.google.container.v1.GcfsConfig gcfs_config = 25;
Type | Description |
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;
Type | Description |
boolean | Whether the gvnic field is set. |
hasKubeletConfig()
public boolean hasKubeletConfig()
Node kubelet configs.
.google.container.v1.NodeKubeletConfig kubelet_config = 22;
Type | Description |
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;
Type | Description |
boolean | Whether the linuxNodeConfig 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;
Type | Description |
boolean | Whether the reservationAffinity field is set. |
hasSandboxConfig()
public boolean hasSandboxConfig()
Sandbox configuration for this node.
.google.container.v1.SandboxConfig sandbox_config = 17;
Type | Description |
boolean | Whether the sandboxConfig field is set. |
hasShieldedInstanceConfig()
public boolean hasShieldedInstanceConfig()
Shielded Instance options.
.google.container.v1.ShieldedInstanceConfig shielded_instance_config = 20;
Type | Description |
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;
Type | Description |
boolean | Whether the workloadMetadataConfig field is set. |
hashCode()
public int hashCode()
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Name | Description |
number | int |
Type | Description |
MapField |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
newBuilderForType()
public NodeConfig.Builder newBuilderForType()
Type | Description |
NodeConfig.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected NodeConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Name | Description |
parent | BuilderParent |
Type | Description |
NodeConfig.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Name | Description |
unused | UnusedPrivateParameter |
Type | Description |
Object |
toBuilder()
public NodeConfig.Builder toBuilder()
Type | Description |
NodeConfig.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Name | Description |
output | CodedOutputStream |
Type | Description |
IOException |