#include <node_config.h>

Inheritance diagram for google_container_api::NodeConfig:

Public Member Functions
	NodeConfig (const Json::Value &storage)

	NodeConfig (Json::Value *storage)

virtual	~NodeConfig ()

const StringPiece	GetTypeName () const

bool	has_accelerators () const

void	clear_accelerators ()

const client::JsonCppArray< AcceleratorConfig >	get_accelerators () const

client::JsonCppArray< AcceleratorConfig >	mutable_accelerators ()

bool	has_disk_size_gb () const

void	clear_disk_size_gb ()

int32	get_disk_size_gb () const

void	set_disk_size_gb (int32 value)

bool	has_disk_type () const

void	clear_disk_type ()

const StringPiece	get_disk_type () const

void	set_disk_type (const StringPiece &value)

bool	has_image_type () const

void	clear_image_type ()

const StringPiece	get_image_type () const

void	set_image_type (const StringPiece &value)

bool	has_labels () const

void	clear_labels ()

const client::JsonCppAssociativeArray< string >	get_labels () const

client::JsonCppAssociativeArray< string >	mutable_labels ()

bool	has_local_ssd_count () const

void	clear_local_ssd_count ()

int32	get_local_ssd_count () const

void	set_local_ssd_count (int32 value)

bool	has_machine_type () const

void	clear_machine_type ()

const StringPiece	get_machine_type () const

void	set_machine_type (const StringPiece &value)

bool	has_metadata () const

void	clear_metadata ()

const client::JsonCppAssociativeArray< string >	get_metadata () const

client::JsonCppAssociativeArray< string >	mutable_metadata ()

bool	has_min_cpu_platform () const

void	clear_min_cpu_platform ()

const StringPiece	get_min_cpu_platform () const

void	set_min_cpu_platform (const StringPiece &value)

bool	has_oauth_scopes () const

void	clear_oauth_scopes ()

const client::JsonCppArray< string >	get_oauth_scopes () const

client::JsonCppArray< string >	mutable_oauthScopes ()

bool	has_preemptible () const

void	clear_preemptible ()

bool	get_preemptible () const

void	set_preemptible (bool value)

bool	has_reservation_affinity () const

void	clear_reservation_affinity ()

const ReservationAffinity	get_reservation_affinity () const

ReservationAffinity	mutable_reservationAffinity ()

bool	has_sandbox_config () const

void	clear_sandbox_config ()

const SandboxConfig	get_sandbox_config () const

SandboxConfig	mutable_sandboxConfig ()

bool	has_service_account () const

void	clear_service_account ()

const StringPiece	get_service_account () const

void	set_service_account (const StringPiece &value)

bool	has_shielded_instance_config () const

void	clear_shielded_instance_config ()

const ShieldedInstanceConfig	get_shielded_instance_config () const

ShieldedInstanceConfig	mutable_shieldedInstanceConfig ()

bool	has_tags () const

void	clear_tags ()

const client::JsonCppArray< string >	get_tags () const

client::JsonCppArray< string >	mutable_tags ()

bool	has_taints () const

void	clear_taints ()

const client::JsonCppArray< NodeTaint >	get_taints () const

client::JsonCppArray< NodeTaint >	mutable_taints ()

bool	has_workload_metadata_config () const

void	clear_workload_metadata_config ()

const WorkloadMetadataConfig	get_workload_metadata_config () const

WorkloadMetadataConfig	mutable_workloadMetadataConfig ()

Static Public Member Functions
static NodeConfig *	New ()

Detailed Description

Parameters that describe the nodes in a cluster.

Constructor & Destructor Documentation

◆ NodeConfig() [1/2]

google_container_api::NodeConfig::NodeConfig ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ NodeConfig() [2/2]

google_container_api::NodeConfig::NodeConfig ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~NodeConfig()

google_container_api::NodeConfig::~NodeConfig ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_accelerators()

void google_container_api::NodeConfig::clear_accelerators ( )

inline

Clears the 'accelerators' attribute.

◆ clear_disk_size_gb()

void google_container_api::NodeConfig::clear_disk_size_gb ( )

inline

Clears the 'diskSizeGb' attribute.

◆ clear_disk_type()

void google_container_api::NodeConfig::clear_disk_type ( )

inline

Clears the 'diskType' attribute.

◆ clear_image_type()

void google_container_api::NodeConfig::clear_image_type ( )

inline

Clears the 'imageType' attribute.

◆ clear_labels()

void google_container_api::NodeConfig::clear_labels ( )

inline

Clears the 'labels' attribute.

◆ clear_local_ssd_count()

void google_container_api::NodeConfig::clear_local_ssd_count ( )

inline

Clears the 'localSsdCount' attribute.

◆ clear_machine_type()

void google_container_api::NodeConfig::clear_machine_type ( )

inline

Clears the 'machineType' attribute.

◆ clear_metadata()

void google_container_api::NodeConfig::clear_metadata ( )

inline

Clears the 'metadata' attribute.

◆ clear_min_cpu_platform()

void google_container_api::NodeConfig::clear_min_cpu_platform ( )

inline

Clears the 'minCpuPlatform' attribute.

◆ clear_oauth_scopes()

void google_container_api::NodeConfig::clear_oauth_scopes ( )

inline

Clears the 'oauthScopes' attribute.

◆ clear_preemptible()

void google_container_api::NodeConfig::clear_preemptible ( )

inline

Clears the 'preemptible' attribute.

◆ clear_reservation_affinity()

void google_container_api::NodeConfig::clear_reservation_affinity ( )

inline

Clears the 'reservationAffinity' attribute.

◆ clear_sandbox_config()

void google_container_api::NodeConfig::clear_sandbox_config ( )

inline

Clears the 'sandboxConfig' attribute.

◆ clear_service_account()

void google_container_api::NodeConfig::clear_service_account ( )

inline

Clears the 'serviceAccount' attribute.

◆ clear_shielded_instance_config()

void google_container_api::NodeConfig::clear_shielded_instance_config ( )

inline

Clears the 'shieldedInstanceConfig' attribute.

◆ clear_tags()

void google_container_api::NodeConfig::clear_tags ( )

inline

Clears the 'tags' attribute.

◆ clear_taints()

void google_container_api::NodeConfig::clear_taints ( )

inline

Clears the 'taints' attribute.

◆ clear_workload_metadata_config()

void google_container_api::NodeConfig::clear_workload_metadata_config ( )

inline

Clears the 'workloadMetadataConfig' attribute.

◆ get_accelerators()

const client::JsonCppArray<AcceleratorConfig > google_container_api::NodeConfig::get_accelerators ( ) const

Get a reference to the value of the 'accelerators' attribute.

◆ get_disk_size_gb()

int32 google_container_api::NodeConfig::get_disk_size_gb ( ) const

inline

Get the value of the 'diskSizeGb' attribute.

◆ get_disk_type()

const StringPiece google_container_api::NodeConfig::get_disk_type ( ) const

inline

Get the value of the 'diskType' attribute.

◆ get_image_type()

const StringPiece google_container_api::NodeConfig::get_image_type ( ) const

inline

Get the value of the 'imageType' attribute.

◆ get_labels()

const client::JsonCppAssociativeArray<string > google_container_api::NodeConfig::get_labels ( ) const

inline

Get a reference to the value of the 'labels' attribute.

◆ get_local_ssd_count()

int32 google_container_api::NodeConfig::get_local_ssd_count ( ) const

inline

Get the value of the 'localSsdCount' attribute.

◆ get_machine_type()

const StringPiece google_container_api::NodeConfig::get_machine_type ( ) const

inline

Get the value of the 'machineType' attribute.

◆ get_metadata()

const client::JsonCppAssociativeArray<string > google_container_api::NodeConfig::get_metadata ( ) const

inline

Get a reference to the value of the 'metadata' attribute.

◆ get_min_cpu_platform()

const StringPiece google_container_api::NodeConfig::get_min_cpu_platform ( ) const

inline

Get the value of the 'minCpuPlatform' attribute.

◆ get_oauth_scopes()

const client::JsonCppArray<string > google_container_api::NodeConfig::get_oauth_scopes ( ) const

inline

Get a reference to the value of the 'oauthScopes' attribute.

◆ get_preemptible()

bool google_container_api::NodeConfig::get_preemptible ( ) const

inline

Get the value of the 'preemptible' attribute.

◆ get_reservation_affinity()

const ReservationAffinity google_container_api::NodeConfig::get_reservation_affinity ( ) const

Get a reference to the value of the 'reservationAffinity' attribute.

◆ get_sandbox_config()

const SandboxConfig google_container_api::NodeConfig::get_sandbox_config ( ) const

Get a reference to the value of the 'sandboxConfig' attribute.

◆ get_service_account()

const StringPiece google_container_api::NodeConfig::get_service_account ( ) const

inline

Get the value of the 'serviceAccount' attribute.

◆ get_shielded_instance_config()

const ShieldedInstanceConfig google_container_api::NodeConfig::get_shielded_instance_config ( ) const

Get a reference to the value of the 'shieldedInstanceConfig' attribute.

◆ get_tags()

const client::JsonCppArray<string > google_container_api::NodeConfig::get_tags ( ) const

inline

Get a reference to the value of the 'tags' attribute.

◆ get_taints()

const client::JsonCppArray<NodeTaint > google_container_api::NodeConfig::get_taints ( ) const

Get a reference to the value of the 'taints' attribute.

◆ get_workload_metadata_config()

const WorkloadMetadataConfig google_container_api::NodeConfig::get_workload_metadata_config ( ) const

Get a reference to the value of the 'workloadMetadataConfig' attribute.

◆ GetTypeName()

const StringPiece google_container_api::NodeConfig::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_container_api::NodeConfig

◆ has_accelerators()

bool google_container_api::NodeConfig::has_accelerators ( ) const

inline

Determine if the 'accelerators' attribute was set.

Returns: true if the 'accelerators' attribute was set.

◆ has_disk_size_gb()

bool google_container_api::NodeConfig::has_disk_size_gb ( ) const

inline

Determine if the 'diskSizeGb' attribute was set.

Returns: true if the 'diskSizeGb' attribute was set.

◆ has_disk_type()

bool google_container_api::NodeConfig::has_disk_type ( ) const

inline

Determine if the 'diskType' attribute was set.

Returns: true if the 'diskType' attribute was set.

◆ has_image_type()

bool google_container_api::NodeConfig::has_image_type ( ) const

inline

Determine if the 'imageType' attribute was set.

Returns: true if the 'imageType' attribute was set.

◆ has_labels()

bool google_container_api::NodeConfig::has_labels ( ) const

inline

Determine if the 'labels' attribute was set.

Returns: true if the 'labels' attribute was set.

◆ has_local_ssd_count()

bool google_container_api::NodeConfig::has_local_ssd_count ( ) const

inline

Determine if the 'localSsdCount' attribute was set.

Returns: true if the 'localSsdCount' attribute was set.

◆ has_machine_type()

bool google_container_api::NodeConfig::has_machine_type ( ) const

inline

Determine if the 'machineType' attribute was set.

Returns: true if the 'machineType' attribute was set.

◆ has_metadata()

bool google_container_api::NodeConfig::has_metadata ( ) const

inline

Determine if the 'metadata' attribute was set.

Returns: true if the 'metadata' attribute was set.

◆ has_min_cpu_platform()

bool google_container_api::NodeConfig::has_min_cpu_platform ( ) const

inline

Determine if the 'minCpuPlatform' attribute was set.

Returns: true if the 'minCpuPlatform' attribute was set.

◆ has_oauth_scopes()

bool google_container_api::NodeConfig::has_oauth_scopes ( ) const

inline

Determine if the 'oauthScopes' attribute was set.

Returns: true if the 'oauthScopes' attribute was set.

◆ has_preemptible()

bool google_container_api::NodeConfig::has_preemptible ( ) const

inline

Determine if the 'preemptible' attribute was set.

Returns: true if the 'preemptible' attribute was set.

◆ has_reservation_affinity()

bool google_container_api::NodeConfig::has_reservation_affinity ( ) const

inline

Determine if the 'reservationAffinity' attribute was set.

Returns: true if the 'reservationAffinity' attribute was set.

◆ has_sandbox_config()

bool google_container_api::NodeConfig::has_sandbox_config ( ) const

inline

Determine if the 'sandboxConfig' attribute was set.

Returns: true if the 'sandboxConfig' attribute was set.

◆ has_service_account()

bool google_container_api::NodeConfig::has_service_account ( ) const

inline

Determine if the 'serviceAccount' attribute was set.

Returns: true if the 'serviceAccount' attribute was set.

◆ has_shielded_instance_config()

bool google_container_api::NodeConfig::has_shielded_instance_config ( ) const

inline

Determine if the 'shieldedInstanceConfig' attribute was set.

Returns: true if the 'shieldedInstanceConfig' attribute was set.

◆ has_tags()

bool google_container_api::NodeConfig::has_tags ( ) const

inline

Determine if the 'tags' attribute was set.

Returns: true if the 'tags' attribute was set.

◆ has_taints()

bool google_container_api::NodeConfig::has_taints ( ) const

inline

Determine if the 'taints' attribute was set.

Returns: true if the 'taints' attribute was set.

◆ has_workload_metadata_config()

bool google_container_api::NodeConfig::has_workload_metadata_config ( ) const

inline

Determine if the 'workloadMetadataConfig' attribute was set.

Returns: true if the 'workloadMetadataConfig' attribute was set.

◆ mutable_accelerators()

client::JsonCppArray<AcceleratorConfig > google_container_api::NodeConfig::mutable_accelerators ( )

Gets a reference to a mutable value of the 'accelerators' property.

A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.

Returns: The result can be modified to change the attribute value.

◆ mutable_labels()

client::JsonCppAssociativeArray<string > google_container_api::NodeConfig::mutable_labels ( )

inline

Gets a reference to a mutable value of the 'labels' property.

The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version – it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/.

Returns: The result can be modified to change the attribute value.

◆ mutable_metadata()

client::JsonCppAssociativeArray<string > google_container_api::NodeConfig::mutable_metadata ( )

inline

Gets a reference to a mutable value of the 'metadata' property.

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 <dd>location".
"cluster <dd>name".

"cluster <dd>uid".
"configure <dd>sh".

"containerd-configure <dd>sh".
"enable-os <dd>login".
"gci-ensure-gke <dd>docker".
"gci-metrics <dd>enabled".
"gci-update <dd>strategy".
"instance <dd>template".

"kube-env"

"startup <dd>script".
"user <dd>data".
"disable-address <dd>manager".
"windows-startup-script <dd>ps1".
"common <dd>psm1".
"k8s-node-setup <dd>psm1".
"install-ssh <dd>psm1".
"user-profile <dd>psm1".
"serial-port-logging <dd>enable".

Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB.

The total size of all keys and values must be less than 512 KB.

Returns: The result can be modified to change the attribute value.

◆ mutable_oauthScopes()

client::JsonCppArray<string > google_container_api::NodeConfig::mutable_oauthScopes ( )

inline

Gets a reference to a mutable value of the 'oauthScopes' property.

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.

Returns: The result can be modified to change the attribute value.

◆ mutable_reservationAffinity()

ReservationAffinity google_container_api::NodeConfig::mutable_reservationAffinity ( )

Gets a reference to a mutable value of the 'reservationAffinity' property.

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

Returns: The result can be modified to change the attribute value.

◆ mutable_sandboxConfig()

SandboxConfig google_container_api::NodeConfig::mutable_sandboxConfig ( )

Gets a reference to a mutable value of the 'sandboxConfig' property.

Sandbox configuration for this node.

Returns: The result can be modified to change the attribute value.

◆ mutable_shieldedInstanceConfig()

ShieldedInstanceConfig google_container_api::NodeConfig::mutable_shieldedInstanceConfig ( )

Gets a reference to a mutable value of the 'shieldedInstanceConfig' property.

Shielded Instance options.

Returns: The result can be modified to change the attribute value.

◆ mutable_tags()

client::JsonCppArray<string > google_container_api::NodeConfig::mutable_tags ( )

inline

Gets a reference to a mutable value of the 'tags' property.

The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.

Returns: The result can be modified to change the attribute value.

◆ mutable_taints()

client::JsonCppArray<NodeTaint > google_container_api::NodeConfig::mutable_taints ( )

Gets a reference to a mutable value of the 'taints' property.

List of kubernetes taints to be applied to each node.

For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/.

Returns: The result can be modified to change the attribute value.

◆ mutable_workloadMetadataConfig()

WorkloadMetadataConfig google_container_api::NodeConfig::mutable_workloadMetadataConfig ( )

Gets a reference to a mutable value of the 'workloadMetadataConfig' property.

The workload metadata configuration for this node.

Returns: The result can be modified to change the attribute value.

◆ New()

NodeConfig * google_container_api::NodeConfig::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_disk_size_gb()

void google_container_api::NodeConfig::set_disk_size_gb ( int32 value )

inline

Change the 'diskSizeGb' attribute.

Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB.

If unspecified, the default disk size is 100GB.

Parameters

[in] value The new value.

◆ set_disk_type()

void google_container_api::NodeConfig::set_disk_type ( const StringPiece & value )

inline

Change the 'diskType' attribute.

Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

If unspecified, the default disk type is 'pd-standard'.

Parameters

[in] value The new value.

◆ set_image_type()

void google_container_api::NodeConfig::set_image_type ( const StringPiece & value )

inline

Change the 'imageType' attribute.

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

Parameters

[in] value The new value.

◆ set_local_ssd_count()

void google_container_api::NodeConfig::set_local_ssd_count ( int32 value )

inline

Change the 'localSsdCount' attribute.

The number of local SSD disks to be attached to the node.

The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.

Parameters

[in] value The new value.

◆ set_machine_type()

void google_container_api::NodeConfig::set_machine_type ( const StringPiece & value )

inline

Change the 'machineType' attribute.

The name of a Google Compute Engine [machine

type](/compute/docs/machine: types) (e.g.
n1-standard <dd>1).

If unspecified, the default machine type is n1-standard-1.

Parameters

[in] value The new value.

◆ set_min_cpu_platform()

void google_container_api::NodeConfig::set_min_cpu_platform ( const StringPiece & value )

inline

Change the 'minCpuPlatform' attribute.

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.

Parameters

[in] value The new value.

◆ set_preemptible()

void google_container_api::NodeConfig::set_preemptible ( bool value )

inline

Change the 'preemptible' attribute.

Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.

Parameters

[in] value The new value.

◆ set_service_account()

void google_container_api::NodeConfig::set_service_account ( const StringPiece & value )

inline

Change the 'serviceAccount' attribute.

The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.

Parameters

[in] value The new value.

The documentation for this class was generated from the following files:

google/container_api/node_config.h
google/container_api/node_config.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ NodeConfig() [1/2]

◆ NodeConfig() [2/2]

◆ ~NodeConfig()

Member Function Documentation

◆ clear_accelerators()

◆ clear_disk_size_gb()

◆ clear_disk_type()

◆ clear_image_type()

◆ clear_labels()

◆ clear_local_ssd_count()

◆ clear_machine_type()

◆ clear_metadata()

◆ clear_min_cpu_platform()

◆ clear_oauth_scopes()

◆ clear_preemptible()

◆ clear_reservation_affinity()

◆ clear_sandbox_config()

◆ clear_service_account()

◆ clear_shielded_instance_config()

◆ clear_tags()

◆ clear_taints()

◆ clear_workload_metadata_config()

◆ get_accelerators()

◆ get_disk_size_gb()

◆ get_disk_type()

◆ get_image_type()

◆ get_labels()

◆ get_local_ssd_count()

◆ get_machine_type()

◆ get_metadata()

◆ get_min_cpu_platform()

◆ get_oauth_scopes()

◆ get_preemptible()

◆ get_reservation_affinity()

◆ get_sandbox_config()

◆ get_service_account()

◆ get_shielded_instance_config()

◆ get_tags()

◆ get_taints()

◆ get_workload_metadata_config()

◆ GetTypeName()

◆ has_accelerators()

◆ has_disk_size_gb()

◆ has_disk_type()

◆ has_image_type()

◆ has_labels()

◆ has_local_ssd_count()

◆ has_machine_type()

◆ has_metadata()

◆ has_min_cpu_platform()

◆ has_oauth_scopes()

◆ has_preemptible()

◆ has_reservation_affinity()

◆ has_sandbox_config()

◆ has_service_account()

◆ has_shielded_instance_config()

◆ has_tags()

◆ has_taints()

◆ has_workload_metadata_config()

◆ mutable_accelerators()

◆ mutable_labels()

◆ mutable_metadata()

◆ mutable_oauthScopes()

◆ mutable_reservationAffinity()

◆ mutable_sandboxConfig()

◆ mutable_shieldedInstanceConfig()

◆ mutable_tags()

◆ mutable_taints()

◆ mutable_workloadMetadataConfig()

◆ New()

◆ set_disk_size_gb()

◆ set_disk_type()

◆ set_image_type()

◆ set_local_ssd_count()

◆ set_machine_type()

◆ set_min_cpu_platform()