Google Cloud Dataproc V1 Client - Class GkeNodeConfig (3.6.1)

Reference documentation and code samples for the Google Cloud Dataproc V1 Client class GkeNodeConfig.

Parameters that describe cluster nodes.

Generated from protobuf message google.cloud.dataproc.v1.GkeNodePoolConfig.GkeNodeConfig

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ machine_type string

Optional. The name of a Compute Engine machine type.

↳ local_ssd_count int

Optional. The number of local SSD disks to attach to the node, which is limited by the maximum number of disks allowable per zone (see Adding Local SSDs).

↳ preemptible bool

Optional. Whether the nodes are created as legacy preemptible VM instances. Also see Spot VMs, preemptible VM instances without a maximum lifetime. Legacy and Spot preemptible nodes cannot be used in a node pool with the CONTROLLER role or in the DEFAULT node pool if the CONTROLLER role is not assigned (the DEFAULT node pool will assume the CONTROLLER role).

↳ accelerators array<Google\Cloud\Dataproc\V1\GkeNodePoolConfig\GkeNodePoolAcceleratorConfig>

Optional. A list of hardware accelerators to attach to each node.

↳ min_cpu_platform string

Optional. Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or a newer CPU platform. Specify the friendly names of CPU platforms, such as "Intel Haswell"` or Intel Sandy Bridge".

↳ boot_disk_kms_key string

Optional. The Customer Managed Encryption Key (CMEK) used to encrypt the boot disk attached to each node in the node pool. Specify the key using the following format: projects/KEY_PROJECT_ID/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME.

↳ spot bool

Optional. Whether the nodes are created as Spot VM instances. Spot VMs are the latest update to legacy preemptible VMs. Spot VMs do not have a maximum lifetime. Legacy and Spot preemptible nodes cannot be used in a node pool with the CONTROLLER role or in the DEFAULT node pool if the CONTROLLER role is not assigned (the DEFAULT node pool will assume the CONTROLLER role).

getMachineType

Optional. The name of a Compute Engine machine type.

Returns
TypeDescription
string

setMachineType

Optional. The name of a Compute Engine machine type.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLocalSsdCount

Optional. The number of local SSD disks to attach to the node, which is limited by the maximum number of disks allowable per zone (see Adding Local SSDs).

Returns
TypeDescription
int

setLocalSsdCount

Optional. The number of local SSD disks to attach to the node, which is limited by the maximum number of disks allowable per zone (see Adding Local SSDs).

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPreemptible

Optional. Whether the nodes are created as legacy preemptible VM instances.

Also see Spot VMs, preemptible VM instances without a maximum lifetime. Legacy and Spot preemptible nodes cannot be used in a node pool with the CONTROLLER role or in the DEFAULT node pool if the CONTROLLER role is not assigned (the DEFAULT node pool will assume the CONTROLLER role).

Returns
TypeDescription
bool

setPreemptible

Optional. Whether the nodes are created as legacy preemptible VM instances.

Also see Spot VMs, preemptible VM instances without a maximum lifetime. Legacy and Spot preemptible nodes cannot be used in a node pool with the CONTROLLER role or in the DEFAULT node pool if the CONTROLLER role is not assigned (the DEFAULT node pool will assume the CONTROLLER role).

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getAccelerators

Optional. A list of hardware accelerators to attach to each node.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setAccelerators

Optional. A list of hardware accelerators to attach to each node.

Parameter
NameDescription
var array<Google\Cloud\Dataproc\V1\GkeNodePoolConfig\GkeNodePoolAcceleratorConfig>
Returns
TypeDescription
$this

getMinCpuPlatform

Optional. Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or a newer CPU platform. Specify the friendly names of CPU platforms, such as "Intel Haswell"` or Intel Sandy Bridge".

Returns
TypeDescription
string

setMinCpuPlatform

Optional. Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or a newer CPU platform. Specify the friendly names of CPU platforms, such as "Intel Haswell"` or Intel Sandy Bridge".

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getBootDiskKmsKey

Optional. The Customer Managed Encryption Key (CMEK) used to encrypt the boot disk attached to each node in the node pool.

Specify the key using the following format: projects/KEY_PROJECT_ID/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME.

Returns
TypeDescription
string

setBootDiskKmsKey

Optional. The Customer Managed Encryption Key (CMEK) used to encrypt the boot disk attached to each node in the node pool.

Specify the key using the following format: projects/KEY_PROJECT_ID/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSpot

Optional. Whether the nodes are created as Spot VM instances.

Spot VMs are the latest update to legacy preemptible VMs. Spot VMs do not have a maximum lifetime. Legacy and Spot preemptible nodes cannot be used in a node pool with the CONTROLLER role or in the DEFAULT node pool if the CONTROLLER role is not assigned (the DEFAULT node pool will assume the CONTROLLER role).

Returns
TypeDescription
bool

setSpot

Optional. Whether the nodes are created as Spot VM instances.

Spot VMs are the latest update to legacy preemptible VMs. Spot VMs do not have a maximum lifetime. Legacy and Spot preemptible nodes cannot be used in a node pool with the CONTROLLER role or in the DEFAULT node pool if the CONTROLLER role is not assigned (the DEFAULT node pool will assume the CONTROLLER role).

Parameter
NameDescription
var bool
Returns
TypeDescription
$this