Google Cloud Container V1 Client - Class AutoprovisioningNodePoolDefaults (1.31.0)

Reference documentation and code samples for the Google Cloud Container V1 Client class AutoprovisioningNodePoolDefaults.

AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.

Generated from protobuf message google.container.v1.AutoprovisioningNodePoolDefaults

Namespace

Google \ Cloud \ Container \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ oauth_scopes array

Scopes that are used by NAP when creating node pools.
↳ service_account string

The Google Cloud Platform Service Account to be used by the node VMs.
↳ upgrade_settings Google\Cloud\Container\V1\NodePool\UpgradeSettings

Specifies the upgrade settings for NAP created node pools
↳ management Google\Cloud\Container\V1\NodeManagement

Specifies the node management options for NAP created node-pools.
↳ min_cpu_platform string

Deprecated. Minimum CPU platform to be used for NAP created node pools. 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. This field is deprecated, min_cpu_platform should be specified using cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
↳ disk_size_gb int

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.
↳ disk_type string

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'
↳ shielded_instance_config Google\Cloud\Container\V1\ShieldedInstanceConfig

Shielded Instance options.
↳ boot_disk_kms_key string

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
↳ image_type string

The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
↳ insecure_kubelet_readonly_port_enabled bool

Enable or disable Kubelet read only port.

getOauthScopes

Scopes that are used by NAP when creating node pools.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setOauthScopes

Scopes that are used by NAP when creating node pools.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getServiceAccount

The Google Cloud Platform Service Account to be used by the node VMs.

Returns
Type Description
string

setServiceAccount

The Google Cloud Platform Service Account to be used by the node VMs.

Parameter
Name Description
var string
Returns
Type Description
$this

getUpgradeSettings

Specifies the upgrade settings for NAP created node pools

Returns
Type Description
Google\Cloud\Container\V1\NodePool\UpgradeSettings|null

hasUpgradeSettings

clearUpgradeSettings

setUpgradeSettings

Specifies the upgrade settings for NAP created node pools

Parameter
Name Description
var Google\Cloud\Container\V1\NodePool\UpgradeSettings
Returns
Type Description
$this

getManagement

Specifies the node management options for NAP created node-pools.

Returns
Type Description
Google\Cloud\Container\V1\NodeManagement|null

hasManagement

clearManagement

setManagement

Specifies the node management options for NAP created node-pools.

Parameter
Name Description
var Google\Cloud\Container\V1\NodeManagement
Returns
Type Description
$this

getMinCpuPlatform

Deprecated. Minimum CPU platform to be used for NAP created node pools.

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. This field is deprecated, min_cpu_platform should be specified using cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.

Returns
Type Description
string

setMinCpuPlatform

Deprecated. Minimum CPU platform to be used for NAP created node pools.

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. This field is deprecated, min_cpu_platform should be specified using cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
int

setDiskSizeGb

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.

Parameter
Name Description
var int
Returns
Type Description
$this

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'

Returns
Type Description
string

setDiskType

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'

Parameter
Name Description
var string
Returns
Type Description
$this

getShieldedInstanceConfig

Shielded Instance options.

Returns
Type Description
Google\Cloud\Container\V1\ShieldedInstanceConfig|null

hasShieldedInstanceConfig

clearShieldedInstanceConfig

setShieldedInstanceConfig

Shielded Instance options.

Parameter
Name Description
var Google\Cloud\Container\V1\ShieldedInstanceConfig
Returns
Type Description
$this

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

Returns
Type Description
string

setBootDiskKmsKey

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

Parameter
Name Description
var string
Returns
Type Description
$this

getImageType

The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.

Returns
Type Description
string

setImageType

The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.

Parameter
Name Description
var string
Returns
Type Description
$this

getInsecureKubeletReadonlyPortEnabled

Enable or disable Kubelet read only port.

Returns
Type Description
bool

hasInsecureKubeletReadonlyPortEnabled

clearInsecureKubeletReadonlyPortEnabled

setInsecureKubeletReadonlyPortEnabled

Enable or disable Kubelet read only port.

Parameter
Name Description
var bool
Returns
Type Description
$this