Interface NodeConfigOrBuilder (2.56.0) 

public interface NodeConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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
Name Description
key String
Returns
Type Description
boolean

containsMetadata(String key)

public abstract 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
Name Description
key String
Returns
Type Description
boolean

containsResourceLabels(String key)

public abstract 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
Name Description
key String
Returns
Type Description
boolean

getAccelerators(int index)

public abstract 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
Name Description
index int
Returns
Type Description
AcceleratorConfig

getAcceleratorsCount()

public abstract 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
Type Description
int

getAcceleratorsList()

public abstract 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
Type Description
List<AcceleratorConfig>

getAcceleratorsOrBuilder(int index)

public abstract 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
Name Description
index int
Returns
Type Description
AcceleratorConfigOrBuilder

getAcceleratorsOrBuilderList()

public abstract 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
Type Description
List<? extends com.google.container.v1.AcceleratorConfigOrBuilder>

getAdvancedMachineFeatures()

public abstract AdvancedMachineFeatures getAdvancedMachineFeatures()

Advanced features for the Compute Engine VM.

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

Returns
Type Description
AdvancedMachineFeatures

The advancedMachineFeatures.

getAdvancedMachineFeaturesOrBuilder()

public abstract AdvancedMachineFeaturesOrBuilder getAdvancedMachineFeaturesOrBuilder()

Advanced features for the Compute Engine VM.

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

Returns
Type Description
AdvancedMachineFeaturesOrBuilder

getBootDiskKmsKey()

public abstract 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
Type Description
String

The bootDiskKmsKey.

getBootDiskKmsKeyBytes()

public abstract 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
Type Description
ByteString

The bytes for bootDiskKmsKey.

getConfidentialNodes()

public abstract 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
Type Description
ConfidentialNodes

The confidentialNodes.

getConfidentialNodesOrBuilder()

public abstract 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
Type Description
ConfidentialNodesOrBuilder

getContainerdConfig()

public abstract ContainerdConfig getContainerdConfig()

Parameters for containerd customization.

.google.container.v1.ContainerdConfig containerd_config = 43;

Returns
Type Description
ContainerdConfig

The containerdConfig.

getContainerdConfigOrBuilder()

public abstract ContainerdConfigOrBuilder getContainerdConfigOrBuilder()

Parameters for containerd customization.

.google.container.v1.ContainerdConfig containerd_config = 43;

Returns
Type Description
ContainerdConfigOrBuilder

getDiskSizeGb()

public abstract 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
Type Description
int

The diskSizeGb.

getDiskType()

public abstract 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
Type Description
String

The diskType.

getDiskTypeBytes()

public abstract 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
Type Description
ByteString

The bytes for diskType.

getEffectiveCgroupMode()

public abstract NodeConfig.EffectiveCgroupMode getEffectiveCgroupMode()

Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.

.google.container.v1.NodeConfig.EffectiveCgroupMode effective_cgroup_mode = 55 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
NodeConfig.EffectiveCgroupMode

The effectiveCgroupMode.

getEffectiveCgroupModeValue()

public abstract int getEffectiveCgroupModeValue()

Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.

.google.container.v1.NodeConfig.EffectiveCgroupMode effective_cgroup_mode = 55 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for effectiveCgroupMode.

getEnableConfidentialStorage()

public abstract boolean getEnableConfidentialStorage()

Optional. Reserved for future use.

bool enable_confidential_storage = 46 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enableConfidentialStorage.

getEphemeralStorageLocalSsdConfig()

public abstract EphemeralStorageLocalSsdConfig getEphemeralStorageLocalSsdConfig()

Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.

.google.container.v1.EphemeralStorageLocalSsdConfig ephemeral_storage_local_ssd_config = 41;

Returns
Type Description
EphemeralStorageLocalSsdConfig

The ephemeralStorageLocalSsdConfig.

getEphemeralStorageLocalSsdConfigOrBuilder()

public abstract EphemeralStorageLocalSsdConfigOrBuilder getEphemeralStorageLocalSsdConfigOrBuilder()

Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.

.google.container.v1.EphemeralStorageLocalSsdConfig ephemeral_storage_local_ssd_config = 41;

Returns
Type Description
EphemeralStorageLocalSsdConfigOrBuilder

getFastSocket()

public abstract FastSocket getFastSocket()

Enable or disable NCCL fast socket for the node pool.

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

Returns
Type Description
FastSocket

The fastSocket.

getFastSocketOrBuilder()

public abstract FastSocketOrBuilder getFastSocketOrBuilder()

Enable or disable NCCL fast socket for the node pool.

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

Returns
Type Description
FastSocketOrBuilder

getGcfsConfig()

public abstract GcfsConfig getGcfsConfig()

Google Container File System (image streaming) configs.

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

Returns
Type Description
GcfsConfig

The gcfsConfig.

getGcfsConfigOrBuilder()

public abstract GcfsConfigOrBuilder getGcfsConfigOrBuilder()

Google Container File System (image streaming) configs.

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

Returns
Type Description
GcfsConfigOrBuilder

getGvnic()

public abstract VirtualNIC getGvnic()

Enable or disable gvnic in the node pool.

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

Returns
Type Description
VirtualNIC

The gvnic.

getGvnicOrBuilder()

public abstract VirtualNICOrBuilder getGvnicOrBuilder()

Enable or disable gvnic in the node pool.

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

Returns
Type Description
VirtualNICOrBuilder

getImageType()

public abstract 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. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.

string image_type = 5;

Returns
Type Description
String

The imageType.

getImageTypeBytes()

public abstract 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. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.

string image_type = 5;

Returns
Type Description
ByteString

The bytes for imageType.

getKubeletConfig()

public abstract NodeKubeletConfig getKubeletConfig()

Node kubelet configs.

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

Returns
Type Description
NodeKubeletConfig

The kubeletConfig.

getKubeletConfigOrBuilder()

public abstract NodeKubeletConfigOrBuilder getKubeletConfigOrBuilder()

Node kubelet configs.

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

Returns
Type Description
NodeKubeletConfigOrBuilder

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract 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
Type Description
int

getLabelsMap()

public abstract 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
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract 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
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract 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
Name Description
key String
Returns
Type Description
String

getLinuxNodeConfig()

public abstract LinuxNodeConfig getLinuxNodeConfig()

Parameters that can be configured on Linux nodes.

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

Returns
Type Description
LinuxNodeConfig

The linuxNodeConfig.

getLinuxNodeConfigOrBuilder()

public abstract LinuxNodeConfigOrBuilder getLinuxNodeConfigOrBuilder()

Parameters that can be configured on Linux nodes.

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

Returns
Type Description
LinuxNodeConfigOrBuilder

getLocalNvmeSsdBlockConfig()

public abstract LocalNvmeSsdBlockConfig getLocalNvmeSsdBlockConfig()

Parameters for using raw-block Local NVMe SSDs.

.google.container.v1.LocalNvmeSsdBlockConfig local_nvme_ssd_block_config = 40;

Returns
Type Description
LocalNvmeSsdBlockConfig

The localNvmeSsdBlockConfig.

getLocalNvmeSsdBlockConfigOrBuilder()

public abstract LocalNvmeSsdBlockConfigOrBuilder getLocalNvmeSsdBlockConfigOrBuilder()

Parameters for using raw-block Local NVMe SSDs.

.google.container.v1.LocalNvmeSsdBlockConfig local_nvme_ssd_block_config = 40;

Returns
Type Description
LocalNvmeSsdBlockConfigOrBuilder

getLocalSsdCount()

public abstract 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
Type Description
int

The localSsdCount.

getLoggingConfig()

public abstract NodePoolLoggingConfig getLoggingConfig()

Logging configuration.

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

Returns
Type Description
NodePoolLoggingConfig

The loggingConfig.

getLoggingConfigOrBuilder()

public abstract NodePoolLoggingConfigOrBuilder getLoggingConfigOrBuilder()

Logging configuration.

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

Returns
Type Description
NodePoolLoggingConfigOrBuilder

getMachineType()

public abstract 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
Type Description
String

The machineType.

getMachineTypeBytes()

public abstract 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
Type Description
ByteString

The bytes for machineType.

getMetadata() (deprecated)

public abstract Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
Map<String,String>

getMetadataCount()

public abstract 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
Type Description
int

getMetadataMap()

public abstract 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
Type Description
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public abstract 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
Name Description
key String
defaultValue String
Returns
Type Description
String

getMetadataOrThrow(String key)

public abstract 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
Name Description
key String
Returns
Type Description
String

getMinCpuPlatform()

public abstract 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
Type Description
String

The minCpuPlatform.

getMinCpuPlatformBytes()

public abstract 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
Type Description
ByteString

The bytes for minCpuPlatform.

getNodeGroup()

public abstract 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
Type Description
String

The nodeGroup.

getNodeGroupBytes()

public abstract 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
Type Description
ByteString

The bytes for nodeGroup.

getOauthScopes(int index)

public abstract 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
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The oauthScopes at the given index.

getOauthScopesBytes(int index)

public abstract 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
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the oauthScopes at the given index.

getOauthScopesCount()

public abstract 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
Type Description
int

The count of oauthScopes.

getOauthScopesList()

public abstract List<String> 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
Type Description
List<String>

A list containing the oauthScopes.

getPreemptible()

public abstract 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
Type Description
boolean

The preemptible.

getReservationAffinity()

public abstract 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
Type Description
ReservationAffinity

The reservationAffinity.

getReservationAffinityOrBuilder()

public abstract 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
Type Description
ReservationAffinityOrBuilder

getResourceLabels() (deprecated)

public abstract Map<String,String> getResourceLabels()

Use #getResourceLabelsMap() instead.

Returns
Type Description
Map<String,String>

getResourceLabelsCount()

public abstract 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
Type Description
int

getResourceLabelsMap()

public abstract 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
Type Description
Map<String,String>

getResourceLabelsOrDefault(String key, String defaultValue)

public abstract 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
Name Description
key String
defaultValue String
Returns
Type Description
String

getResourceLabelsOrThrow(String key)

public abstract 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
Name Description
key String
Returns
Type Description
String

getResourceManagerTags()

public abstract ResourceManagerTags getResourceManagerTags()

A map of resource manager tag keys and values to be attached to the nodes.

.google.container.v1.ResourceManagerTags resource_manager_tags = 45;

Returns
Type Description
ResourceManagerTags

The resourceManagerTags.

getResourceManagerTagsOrBuilder()

public abstract ResourceManagerTagsOrBuilder getResourceManagerTagsOrBuilder()

A map of resource manager tag keys and values to be attached to the nodes.

.google.container.v1.ResourceManagerTags resource_manager_tags = 45;

Returns
Type Description
ResourceManagerTagsOrBuilder

getSandboxConfig()

public abstract SandboxConfig getSandboxConfig()

Sandbox configuration for this node.

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

Returns
Type Description
SandboxConfig

The sandboxConfig.

getSandboxConfigOrBuilder()

public abstract SandboxConfigOrBuilder getSandboxConfigOrBuilder()

Sandbox configuration for this node.

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

Returns
Type Description
SandboxConfigOrBuilder

getSecondaryBootDiskUpdateStrategy()

public abstract SecondaryBootDiskUpdateStrategy getSecondaryBootDiskUpdateStrategy()

Secondary boot disk update strategy.

optional .google.container.v1.SecondaryBootDiskUpdateStrategy secondary_boot_disk_update_strategy = 50;

Returns
Type Description
SecondaryBootDiskUpdateStrategy

The secondaryBootDiskUpdateStrategy.

getSecondaryBootDiskUpdateStrategyOrBuilder()

public abstract SecondaryBootDiskUpdateStrategyOrBuilder getSecondaryBootDiskUpdateStrategyOrBuilder()

Secondary boot disk update strategy.

optional .google.container.v1.SecondaryBootDiskUpdateStrategy secondary_boot_disk_update_strategy = 50;

Returns
Type Description
SecondaryBootDiskUpdateStrategyOrBuilder

getSecondaryBootDisks(int index)

public abstract SecondaryBootDisk getSecondaryBootDisks(int index)

List of secondary boot disks attached to the nodes.

repeated .google.container.v1.SecondaryBootDisk secondary_boot_disks = 48;

Parameter
Name Description
index int
Returns
Type Description
SecondaryBootDisk

getSecondaryBootDisksCount()

public abstract int getSecondaryBootDisksCount()

List of secondary boot disks attached to the nodes.

repeated .google.container.v1.SecondaryBootDisk secondary_boot_disks = 48;

Returns
Type Description
int

getSecondaryBootDisksList()

public abstract List<SecondaryBootDisk> getSecondaryBootDisksList()

List of secondary boot disks attached to the nodes.

repeated .google.container.v1.SecondaryBootDisk secondary_boot_disks = 48;

Returns
Type Description
List<SecondaryBootDisk>

getSecondaryBootDisksOrBuilder(int index)

public abstract SecondaryBootDiskOrBuilder getSecondaryBootDisksOrBuilder(int index)

List of secondary boot disks attached to the nodes.

repeated .google.container.v1.SecondaryBootDisk secondary_boot_disks = 48;

Parameter
Name Description
index int
Returns
Type Description
SecondaryBootDiskOrBuilder

getSecondaryBootDisksOrBuilderList()

public abstract List<? extends SecondaryBootDiskOrBuilder> getSecondaryBootDisksOrBuilderList()

List of secondary boot disks attached to the nodes.

repeated .google.container.v1.SecondaryBootDisk secondary_boot_disks = 48;

Returns
Type Description
List<? extends com.google.container.v1.SecondaryBootDiskOrBuilder>

getServiceAccount()

public abstract 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
Type Description
String

The serviceAccount.

getServiceAccountBytes()

public abstract 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
Type Description
ByteString

The bytes for serviceAccount.

getShieldedInstanceConfig()

public abstract ShieldedInstanceConfig getShieldedInstanceConfig()

Shielded Instance options.

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

Returns
Type Description
ShieldedInstanceConfig

The shieldedInstanceConfig.

getShieldedInstanceConfigOrBuilder()

public abstract ShieldedInstanceConfigOrBuilder getShieldedInstanceConfigOrBuilder()

Shielded Instance options.

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

Returns
Type Description
ShieldedInstanceConfigOrBuilder

getSoleTenantConfig()

public abstract SoleTenantConfig getSoleTenantConfig()

Parameters for node pools to be backed by shared sole tenant node groups.

.google.container.v1.SoleTenantConfig sole_tenant_config = 42;

Returns
Type Description
SoleTenantConfig

The soleTenantConfig.

getSoleTenantConfigOrBuilder()

public abstract SoleTenantConfigOrBuilder getSoleTenantConfigOrBuilder()

Parameters for node pools to be backed by shared sole tenant node groups.

.google.container.v1.SoleTenantConfig sole_tenant_config = 42;

Returns
Type Description
SoleTenantConfigOrBuilder

getSpot()

public abstract boolean getSpot()

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

bool spot = 32;

Returns
Type Description
boolean

The spot.

getStoragePools(int index)

public abstract String getStoragePools(int index)

List of Storage Pools where boot disks are provisioned.

repeated string storage_pools = 49;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The storagePools at the given index.

getStoragePoolsBytes(int index)

public abstract ByteString getStoragePoolsBytes(int index)

List of Storage Pools where boot disks are provisioned.

repeated string storage_pools = 49;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the storagePools at the given index.

getStoragePoolsCount()

public abstract int getStoragePoolsCount()

List of Storage Pools where boot disks are provisioned.

repeated string storage_pools = 49;

Returns
Type Description
int

The count of storagePools.

getStoragePoolsList()

public abstract List<String> getStoragePoolsList()

List of Storage Pools where boot disks are provisioned.

repeated string storage_pools = 49;

Returns
Type Description
List<String>

A list containing the storagePools.

getTags(int index)

public abstract 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
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The tags at the given index.

getTagsBytes(int index)

public abstract 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
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the tags at the given index.

getTagsCount()

public abstract 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
Type Description
int

The count of tags.

getTagsList()

public abstract List<String> 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
Type Description
List<String>

A list containing the tags.

getTaints(int index)

public abstract 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
Name Description
index int
Returns
Type Description
NodeTaint

getTaintsCount()

public abstract 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
Type Description
int

getTaintsList()

public abstract 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
Type Description
List<NodeTaint>

getTaintsOrBuilder(int index)

public abstract 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
Name Description
index int
Returns
Type Description
NodeTaintOrBuilder

getTaintsOrBuilderList()

public abstract 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
Type Description
List<? extends com.google.container.v1.NodeTaintOrBuilder>

getWindowsNodeConfig()

public abstract WindowsNodeConfig getWindowsNodeConfig()

Parameters that can be configured on Windows nodes.

.google.container.v1.WindowsNodeConfig windows_node_config = 39;

Returns
Type Description
WindowsNodeConfig

The windowsNodeConfig.

getWindowsNodeConfigOrBuilder()

public abstract WindowsNodeConfigOrBuilder getWindowsNodeConfigOrBuilder()

Parameters that can be configured on Windows nodes.

.google.container.v1.WindowsNodeConfig windows_node_config = 39;

Returns
Type Description
WindowsNodeConfigOrBuilder

getWorkloadMetadataConfig()

public abstract WorkloadMetadataConfig getWorkloadMetadataConfig()

The workload metadata configuration for this node.

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

Returns
Type Description
WorkloadMetadataConfig

The workloadMetadataConfig.

getWorkloadMetadataConfigOrBuilder()

public abstract WorkloadMetadataConfigOrBuilder getWorkloadMetadataConfigOrBuilder()

The workload metadata configuration for this node.

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

Returns
Type Description
WorkloadMetadataConfigOrBuilder

hasAdvancedMachineFeatures()

public abstract boolean hasAdvancedMachineFeatures()

Advanced features for the Compute Engine VM.

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

Returns
Type Description
boolean

Whether the advancedMachineFeatures field is set.

hasConfidentialNodes()

public abstract 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
Type Description
boolean

Whether the confidentialNodes field is set.

hasContainerdConfig()

public abstract boolean hasContainerdConfig()

Parameters for containerd customization.

.google.container.v1.ContainerdConfig containerd_config = 43;

Returns
Type Description
boolean

Whether the containerdConfig field is set.

hasEphemeralStorageLocalSsdConfig()

public abstract boolean hasEphemeralStorageLocalSsdConfig()

Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.

.google.container.v1.EphemeralStorageLocalSsdConfig ephemeral_storage_local_ssd_config = 41;

Returns
Type Description
boolean

Whether the ephemeralStorageLocalSsdConfig field is set.

hasFastSocket()

public abstract boolean hasFastSocket()

Enable or disable NCCL fast socket for the node pool.

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

Returns
Type Description
boolean

Whether the fastSocket field is set.

hasGcfsConfig()

public abstract boolean hasGcfsConfig()

Google Container File System (image streaming) configs.

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

Returns
Type Description
boolean

Whether the gcfsConfig field is set.

hasGvnic()

public abstract boolean hasGvnic()

Enable or disable gvnic in the node pool.

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

Returns
Type Description
boolean

Whether the gvnic field is set.

hasKubeletConfig()

public abstract boolean hasKubeletConfig()

Node kubelet configs.

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

Returns
Type Description
boolean

Whether the kubeletConfig field is set.

hasLinuxNodeConfig()

public abstract boolean hasLinuxNodeConfig()

Parameters that can be configured on Linux nodes.

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

Returns
Type Description
boolean

Whether the linuxNodeConfig field is set.

hasLocalNvmeSsdBlockConfig()

public abstract boolean hasLocalNvmeSsdBlockConfig()

Parameters for using raw-block Local NVMe SSDs.

.google.container.v1.LocalNvmeSsdBlockConfig local_nvme_ssd_block_config = 40;

Returns
Type Description
boolean

Whether the localNvmeSsdBlockConfig field is set.

hasLoggingConfig()

public abstract boolean hasLoggingConfig()

Logging configuration.

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

Returns
Type Description
boolean

Whether the loggingConfig field is set.

hasReservationAffinity()

public abstract 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
Type Description
boolean

Whether the reservationAffinity field is set.

hasResourceManagerTags()

public abstract boolean hasResourceManagerTags()

A map of resource manager tag keys and values to be attached to the nodes.

.google.container.v1.ResourceManagerTags resource_manager_tags = 45;

Returns
Type Description
boolean

Whether the resourceManagerTags field is set.

hasSandboxConfig()

public abstract boolean hasSandboxConfig()

Sandbox configuration for this node.

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

Returns
Type Description
boolean

Whether the sandboxConfig field is set.

hasSecondaryBootDiskUpdateStrategy()

public abstract boolean hasSecondaryBootDiskUpdateStrategy()

Secondary boot disk update strategy.

optional .google.container.v1.SecondaryBootDiskUpdateStrategy secondary_boot_disk_update_strategy = 50;

Returns
Type Description
boolean

Whether the secondaryBootDiskUpdateStrategy field is set.

hasShieldedInstanceConfig()

public abstract boolean hasShieldedInstanceConfig()

Shielded Instance options.

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

Returns
Type Description
boolean

Whether the shieldedInstanceConfig field is set.

hasSoleTenantConfig()

public abstract boolean hasSoleTenantConfig()

Parameters for node pools to be backed by shared sole tenant node groups.

.google.container.v1.SoleTenantConfig sole_tenant_config = 42;

Returns
Type Description
boolean

Whether the soleTenantConfig field is set.

hasWindowsNodeConfig()

public abstract boolean hasWindowsNodeConfig()

Parameters that can be configured on Windows nodes.

.google.container.v1.WindowsNodeConfig windows_node_config = 39;

Returns
Type Description
boolean

Whether the windowsNodeConfig field is set.

hasWorkloadMetadataConfig()

public abstract boolean hasWorkloadMetadataConfig()

The workload metadata configuration for this node.

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

Returns
Type Description
boolean

Whether the workloadMetadataConfig field is set.