Google Cloud Container V1 Client - Class Cluster (1.9.1)

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

A Google Kubernetes Engine cluster.

Generated from protobuf message google.container.v1.Cluster

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.

↳ description
string

An optional description of this cluster.

↳ initial_node_count
int

The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.

↳ node_config
Google\Cloud\Container\V1\NodeConfig

Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config ) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

↳ master_auth
Google\Cloud\Container\V1\MasterAuth

The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.

↳ logging_service
string

The logging service the cluster should use to write logs. Currently available options: * logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model * logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15). * none - no logs will be exported from the cluster. If left as an empty string, logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions.

↳ monitoring_service
string

The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * none - No metrics will be exported from the cluster. If left as an empty string, monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.

↳ network
string

The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.

↳ cluster_ipv4_cidr
string

The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14 ). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8 .

↳ addons_config
Google\Cloud\Container\V1\AddonsConfig

Configurations for the various addons available to run in the cluster.

↳ subnetwork
string

The name of the Google Compute Engine subnetwork to which the cluster is connected.

↳ node_pools
array< Google\Cloud\Container\V1\NodePool >

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

↳ locations
array

The list of Google Compute Engine zones in which the cluster's nodes should be located. This field provides a default value if NodePool.Locations are not specified during node pool creation. Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.

↳ enable_kubernetes_alpha
bool

Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.

↳ resource_labels
array|Google\Protobuf\Internal\MapField

The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

↳ label_fingerprint
string

The fingerprint of the set of labels for this cluster.

↳ legacy_abac
Google\Cloud\Container\V1\LegacyAbac

Configuration for the legacy ABAC authorization mode.

↳ network_policy
Google\Cloud\Container\V1\NetworkPolicy

Configuration options for the NetworkPolicy feature.

↳ ip_allocation_policy
Google\Cloud\Container\V1\IPAllocationPolicy

Configuration for cluster IP allocation.

↳ master_authorized_networks_config
Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig

The configuration options for master authorized networks feature.

↳ maintenance_policy
Google\Cloud\Container\V1\MaintenancePolicy

Configure the maintenance policy for this cluster.

↳ binary_authorization
Google\Cloud\Container\V1\BinaryAuthorization

Configuration for Binary Authorization.

↳ autoscaling
Google\Cloud\Container\V1\ClusterAutoscaling

Cluster-level autoscaling configuration.

↳ network_config
Google\Cloud\Container\V1\NetworkConfig

Configuration for cluster networking.

↳ default_max_pods_constraint
Google\Cloud\Container\V1\MaxPodsConstraint

The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

↳ resource_usage_export_config
Google\Cloud\Container\V1\ResourceUsageExportConfig

Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

↳ authenticator_groups_config
Google\Cloud\Container\V1\AuthenticatorGroupsConfig

Configuration controlling RBAC group membership information.

↳ private_cluster_config
Google\Cloud\Container\V1\PrivateClusterConfig

Configuration for private cluster.

↳ database_encryption
Google\Cloud\Container\V1\DatabaseEncryption

Configuration of etcd encryption.

↳ vertical_pod_autoscaling
Google\Cloud\Container\V1\VerticalPodAutoscaling

Cluster-level Vertical Pod Autoscaling configuration.

↳ shielded_nodes
Google\Cloud\Container\V1\ShieldedNodes

Shielded Nodes configuration.

↳ release_channel
Google\Cloud\Container\V1\ReleaseChannel

Release channel configuration.

↳ workload_identity_config
Google\Cloud\Container\V1\WorkloadIdentityConfig

Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.

↳ mesh_certificates
Google\Cloud\Container\V1\MeshCertificates

Configuration for issuance of mTLS keys and certificates to Kubernetes pods.

↳ cost_management_config
Google\Cloud\Container\V1\CostManagementConfig

Configuration for the fine-grained cost management feature.

↳ notification_config
Google\Cloud\Container\V1\NotificationConfig

Notification configuration of the cluster.

↳ confidential_nodes
Google\Cloud\Container\V1\ConfidentialNodes

Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.

↳ identity_service_config
Google\Cloud\Container\V1\IdentityServiceConfig

Configuration for Identity Service component.

↳ self_link
string

[Output only] Server-defined URL for the resource.

↳ zone
string

[Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.

↳ endpoint
string

[Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at https://username:password&#64;endpoint/ . See the masterAuth property of this resource for username and password information.

↳ initial_cluster_version
string

The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version

↳ current_master_version
string

[Output only] The current software version of the master endpoint.

↳ current_node_version
string

[Output only] Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.

↳ create_time
string

[Output only] The time the cluster was created, in RFC3339 text format.

↳ status
int

[Output only] The current status of this cluster.

↳ status_message
string

[Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.

↳ node_ipv4_cidr_size
int

[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. This field will only be set when cluster is in route-based network mode.

↳ services_ipv4_cidr
string

[Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29 ). Service addresses are typically put in the last /16 from the container CIDR.

↳ instance_group_urls
array

Deprecated. Use node_pools.instance_group_urls.

↳ current_node_count
int

[Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.

↳ expire_time
string

[Output only] The time the cluster will be automatically deleted in RFC3339 text format.

↳ location
string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.

↳ enable_tpu
bool

Enable the ability to use Cloud TPUs in this cluster.

↳ tpu_ipv4_cidr_block
string

[Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29 ).

↳ conditions
array< Google\Cloud\Container\V1\StatusCondition >

Which conditions caused the current cluster state.

↳ autopilot
Google\Cloud\Container\V1\Autopilot

Autopilot configuration for the cluster.

↳ id
string

Output only. Unique id for the cluster.

↳ node_pool_defaults
Google\Cloud\Container\V1\NodePoolDefaults

Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.

↳ logging_config
Google\Cloud\Container\V1\LoggingConfig

Logging configuration for the cluster.

↳ monitoring_config
Google\Cloud\Container\V1\MonitoringConfig

Monitoring configuration for the cluster.

↳ node_pool_auto_config
Google\Cloud\Container\V1\NodePoolAutoConfig

Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

getName

The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions:

  • Lowercase letters, numbers, and hyphens only.

  • Must start with a letter.

  • Must end with a number or a letter.

Generated from protobuf field string name = 1;

Returns
Type
Description
string

setName

The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions:

  • Lowercase letters, numbers, and hyphens only.

  • Must start with a letter.

  • Must end with a number or a letter.

Generated from protobuf field string name = 1;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDescription

An optional description of this cluster.

Generated from protobuf field string description = 2;

Returns
Type
Description
string

setDescription

An optional description of this cluster.

Generated from protobuf field string description = 2;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getInitialNodeCount

The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.

For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.

Generated from protobuf field int32 initial_node_count = 3 [deprecated = true];

Returns
Type
Description
int

setInitialNodeCount

The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.

For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.

Generated from protobuf field int32 initial_node_count = 3 [deprecated = true];

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getNodeConfig

Parameters used in creating the cluster's nodes.

For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config ) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

Generated from protobuf field .google.container.v1.NodeConfig node_config = 4 [deprecated = true];

Returns
Type
Description

hasNodeConfig

clearNodeConfig

setNodeConfig

Parameters used in creating the cluster's nodes.

For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config ) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

Generated from protobuf field .google.container.v1.NodeConfig node_config = 4 [deprecated = true];

Parameter
Name
Description
Returns
Type
Description
$this

getMasterAuth

The authentication information for accessing the master endpoint.

If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.

Generated from protobuf field .google.container.v1.MasterAuth master_auth = 5;

Returns
Type
Description

hasMasterAuth

clearMasterAuth

setMasterAuth

The authentication information for accessing the master endpoint.

If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.

Generated from protobuf field .google.container.v1.MasterAuth master_auth = 5;

Parameter
Name
Description
Returns
Type
Description
$this

getLoggingService

The logging service the cluster should use to write logs.

Currently available options:

  • logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model
  • logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15).
  • none - no logs will be exported from the cluster. If left as an empty string, logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions.

Generated from protobuf field string logging_service = 6;

Returns
Type
Description
string

setLoggingService

The logging service the cluster should use to write logs.

Currently available options:

  • logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model
  • logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15).
  • none - no logs will be exported from the cluster. If left as an empty string, logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions.

Generated from protobuf field string logging_service = 6;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getMonitoringService

The monitoring service the cluster should use to write metrics.

Currently available options:

  • "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model
  • monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15).
  • none - No metrics will be exported from the cluster. If left as an empty string, monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.

Generated from protobuf field string monitoring_service = 7;

Returns
Type
Description
string

setMonitoringService

The monitoring service the cluster should use to write metrics.

Currently available options:

  • "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model
  • monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15).
  • none - No metrics will be exported from the cluster. If left as an empty string, monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.

Generated from protobuf field string monitoring_service = 7;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getNetwork

The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.

Generated from protobuf field string network = 8;

Returns
Type
Description
string

setNetwork

The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.

Generated from protobuf field string network = 8;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getClusterIpv4Cidr

The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14 ). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8 .

Generated from protobuf field string cluster_ipv4_cidr = 9;

Returns
Type
Description
string

setClusterIpv4Cidr

The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14 ). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8 .

Generated from protobuf field string cluster_ipv4_cidr = 9;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getAddonsConfig

Configurations for the various addons available to run in the cluster.

Generated from protobuf field .google.container.v1.AddonsConfig addons_config = 10;

Returns
Type
Description

hasAddonsConfig

clearAddonsConfig

setAddonsConfig

Configurations for the various addons available to run in the cluster.

Generated from protobuf field .google.container.v1.AddonsConfig addons_config = 10;

Parameter
Name
Description
Returns
Type
Description
$this

getSubnetwork

The name of the Google Compute Engine subnetwork to which the cluster is connected.

Generated from protobuf field string subnetwork = 11;

Returns
Type
Description
string

setSubnetwork

The name of the Google Compute Engine subnetwork to which the cluster is connected.

Generated from protobuf field string subnetwork = 11;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getNodePools

The node pools associated with this cluster.

This field should not be set if "node_config" or "initial_node_count" are specified.

Generated from protobuf field repeated .google.container.v1.NodePool node_pools = 12;

Returns
Type
Description
Google\Protobuf\Internal\RepeatedField

setNodePools

The node pools associated with this cluster.

This field should not be set if "node_config" or "initial_node_count" are specified.

Generated from protobuf field repeated .google.container.v1.NodePool node_pools = 12;

Parameter
Name
Description
Returns
Type
Description
$this

getLocations

The list of Google Compute Engine zones in which the cluster's nodes should be located.

This field provides a default value if NodePool.Locations are not specified during node pool creation. Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.

Generated from protobuf field repeated string locations = 13;

Returns
Type
Description
Google\Protobuf\Internal\RepeatedField

setLocations

The list of Google Compute Engine zones in which the cluster's nodes should be located.

This field provides a default value if NodePool.Locations are not specified during node pool creation. Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.

Generated from protobuf field repeated string locations = 13;

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

getEnableKubernetesAlpha

Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes.

The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.

Generated from protobuf field bool enable_kubernetes_alpha = 14;

Returns
Type
Description
bool

setEnableKubernetesAlpha

Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes.

The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.

Generated from protobuf field bool enable_kubernetes_alpha = 14;

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getResourceLabels

The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

Generated from protobuf field map<string, string> resource_labels = 15;

Returns
Type
Description
Google\Protobuf\Internal\MapField

setResourceLabels

The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

Generated from protobuf field map<string, string> resource_labels = 15;

Parameter
Name
Description
var
array|Google\Protobuf\Internal\MapField
Returns
Type
Description
$this

getLabelFingerprint

The fingerprint of the set of labels for this cluster.

Generated from protobuf field string label_fingerprint = 16;

Returns
Type
Description
string

setLabelFingerprint

The fingerprint of the set of labels for this cluster.

Generated from protobuf field string label_fingerprint = 16;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getLegacyAbac

Configuration for the legacy ABAC authorization mode.

Generated from protobuf field .google.container.v1.LegacyAbac legacy_abac = 18;

Returns
Type
Description

hasLegacyAbac

clearLegacyAbac

setLegacyAbac

Configuration for the legacy ABAC authorization mode.

Generated from protobuf field .google.container.v1.LegacyAbac legacy_abac = 18;

Parameter
Name
Description
Returns
Type
Description
$this

getNetworkPolicy

Configuration options for the NetworkPolicy feature.

Generated from protobuf field .google.container.v1.NetworkPolicy network_policy = 19;

Returns
Type
Description

hasNetworkPolicy

clearNetworkPolicy

setNetworkPolicy

Configuration options for the NetworkPolicy feature.

Generated from protobuf field .google.container.v1.NetworkPolicy network_policy = 19;

Parameter
Name
Description
Returns
Type
Description
$this

getIpAllocationPolicy

Configuration for cluster IP allocation.

Generated from protobuf field .google.container.v1.IPAllocationPolicy ip_allocation_policy = 20;

Returns
Type
Description

hasIpAllocationPolicy

clearIpAllocationPolicy

setIpAllocationPolicy

Configuration for cluster IP allocation.

Generated from protobuf field .google.container.v1.IPAllocationPolicy ip_allocation_policy = 20;

Parameter
Name
Description
Returns
Type
Description
$this

getMasterAuthorizedNetworksConfig

The configuration options for master authorized networks feature.

Generated from protobuf field .google.container.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 22;

hasMasterAuthorizedNetworksConfig

clearMasterAuthorizedNetworksConfig

setMasterAuthorizedNetworksConfig

The configuration options for master authorized networks feature.

Generated from protobuf field .google.container.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 22;

Returns
Type
Description
$this

getMaintenancePolicy

Configure the maintenance policy for this cluster.

Generated from protobuf field .google.container.v1.MaintenancePolicy maintenance_policy = 23;

Returns
Type
Description

hasMaintenancePolicy

clearMaintenancePolicy

setMaintenancePolicy

Configure the maintenance policy for this cluster.

Generated from protobuf field .google.container.v1.MaintenancePolicy maintenance_policy = 23;

Parameter
Name
Description
Returns
Type
Description
$this

getBinaryAuthorization

Configuration for Binary Authorization.

Generated from protobuf field .google.container.v1.BinaryAuthorization binary_authorization = 24;

Returns
Type
Description

hasBinaryAuthorization

clearBinaryAuthorization

setBinaryAuthorization

Configuration for Binary Authorization.

Generated from protobuf field .google.container.v1.BinaryAuthorization binary_authorization = 24;

Parameter
Name
Description
Returns
Type
Description
$this

getAutoscaling

Cluster-level autoscaling configuration.

Generated from protobuf field .google.container.v1.ClusterAutoscaling autoscaling = 26;

Returns
Type
Description

hasAutoscaling

clearAutoscaling

setAutoscaling

Cluster-level autoscaling configuration.

Generated from protobuf field .google.container.v1.ClusterAutoscaling autoscaling = 26;

Parameter
Name
Description
Returns
Type
Description
$this

getNetworkConfig

Configuration for cluster networking.

Generated from protobuf field .google.container.v1.NetworkConfig network_config = 27;

Returns
Type
Description

hasNetworkConfig

clearNetworkConfig

setNetworkConfig

Configuration for cluster networking.

Generated from protobuf field .google.container.v1.NetworkConfig network_config = 27;

Parameter
Name
Description
Returns
Type
Description
$this

getDefaultMaxPodsConstraint

The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

Generated from protobuf field .google.container.v1.MaxPodsConstraint default_max_pods_constraint = 30;

Returns
Type
Description

hasDefaultMaxPodsConstraint

clearDefaultMaxPodsConstraint

setDefaultMaxPodsConstraint

The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

Generated from protobuf field .google.container.v1.MaxPodsConstraint default_max_pods_constraint = 30;

Parameter
Name
Description
Returns
Type
Description
$this

getResourceUsageExportConfig

Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

Generated from protobuf field .google.container.v1.ResourceUsageExportConfig resource_usage_export_config = 33;

hasResourceUsageExportConfig

clearResourceUsageExportConfig

setResourceUsageExportConfig

Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

Generated from protobuf field .google.container.v1.ResourceUsageExportConfig resource_usage_export_config = 33;

Returns
Type
Description
$this

getAuthenticatorGroupsConfig

Configuration controlling RBAC group membership information.

Generated from protobuf field .google.container.v1.AuthenticatorGroupsConfig authenticator_groups_config = 34;

hasAuthenticatorGroupsConfig

clearAuthenticatorGroupsConfig

setAuthenticatorGroupsConfig

Configuration controlling RBAC group membership information.

Generated from protobuf field .google.container.v1.AuthenticatorGroupsConfig authenticator_groups_config = 34;

Returns
Type
Description
$this

getPrivateClusterConfig

Configuration for private cluster.

Generated from protobuf field .google.container.v1.PrivateClusterConfig private_cluster_config = 37;

Returns
Type
Description

hasPrivateClusterConfig

clearPrivateClusterConfig

setPrivateClusterConfig

Configuration for private cluster.

Generated from protobuf field .google.container.v1.PrivateClusterConfig private_cluster_config = 37;

Parameter
Name
Description
Returns
Type
Description
$this

getDatabaseEncryption

Configuration of etcd encryption.

Generated from protobuf field .google.container.v1.DatabaseEncryption database_encryption = 38;

Returns
Type
Description

hasDatabaseEncryption

clearDatabaseEncryption

setDatabaseEncryption

Configuration of etcd encryption.

Generated from protobuf field .google.container.v1.DatabaseEncryption database_encryption = 38;

Parameter
Name
Description
Returns
Type
Description
$this

getVerticalPodAutoscaling

Cluster-level Vertical Pod Autoscaling configuration.

Generated from protobuf field .google.container.v1.VerticalPodAutoscaling vertical_pod_autoscaling = 39;

Returns
Type
Description

hasVerticalPodAutoscaling

clearVerticalPodAutoscaling

setVerticalPodAutoscaling

Cluster-level Vertical Pod Autoscaling configuration.

Generated from protobuf field .google.container.v1.VerticalPodAutoscaling vertical_pod_autoscaling = 39;

Parameter
Name
Description
Returns
Type
Description
$this

getShieldedNodes

Shielded Nodes configuration.

Generated from protobuf field .google.container.v1.ShieldedNodes shielded_nodes = 40;

Returns
Type
Description

hasShieldedNodes

clearShieldedNodes

setShieldedNodes

Shielded Nodes configuration.

Generated from protobuf field .google.container.v1.ShieldedNodes shielded_nodes = 40;

Parameter
Name
Description
Returns
Type
Description
$this

getReleaseChannel

Release channel configuration.

Generated from protobuf field .google.container.v1.ReleaseChannel release_channel = 41;

Returns
Type
Description

hasReleaseChannel

clearReleaseChannel

setReleaseChannel

Release channel configuration.

Generated from protobuf field .google.container.v1.ReleaseChannel release_channel = 41;

Parameter
Name
Description
Returns
Type
Description
$this

getWorkloadIdentityConfig

Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.

Generated from protobuf field .google.container.v1.WorkloadIdentityConfig workload_identity_config = 43;

Returns
Type
Description

hasWorkloadIdentityConfig

clearWorkloadIdentityConfig

setWorkloadIdentityConfig

Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.

Generated from protobuf field .google.container.v1.WorkloadIdentityConfig workload_identity_config = 43;

Parameter
Name
Description
Returns
Type
Description
$this

getMeshCertificates

Configuration for issuance of mTLS keys and certificates to Kubernetes pods.

Generated from protobuf field .google.container.v1.MeshCertificates mesh_certificates = 67;

Returns
Type
Description

hasMeshCertificates

clearMeshCertificates

setMeshCertificates

Configuration for issuance of mTLS keys and certificates to Kubernetes pods.

Generated from protobuf field .google.container.v1.MeshCertificates mesh_certificates = 67;

Parameter
Name
Description
Returns
Type
Description
$this

getCostManagementConfig

Configuration for the fine-grained cost management feature.

Generated from protobuf field .google.container.v1.CostManagementConfig cost_management_config = 45;

Returns
Type
Description

hasCostManagementConfig

clearCostManagementConfig

setCostManagementConfig

Configuration for the fine-grained cost management feature.

Generated from protobuf field .google.container.v1.CostManagementConfig cost_management_config = 45;

Parameter
Name
Description
Returns
Type
Description
$this

getNotificationConfig

Notification configuration of the cluster.

Generated from protobuf field .google.container.v1.NotificationConfig notification_config = 49;

Returns
Type
Description

hasNotificationConfig

clearNotificationConfig

setNotificationConfig

Notification configuration of the cluster.

Generated from protobuf field .google.container.v1.NotificationConfig notification_config = 49;

Parameter
Name
Description
Returns
Type
Description
$this

getConfidentialNodes

Configuration of Confidential Nodes.

All the nodes in the cluster will be Confidential VM once enabled.

Generated from protobuf field .google.container.v1.ConfidentialNodes confidential_nodes = 50;

Returns
Type
Description

hasConfidentialNodes

clearConfidentialNodes

setConfidentialNodes

Configuration of Confidential Nodes.

All the nodes in the cluster will be Confidential VM once enabled.

Generated from protobuf field .google.container.v1.ConfidentialNodes confidential_nodes = 50;

Parameter
Name
Description
Returns
Type
Description
$this

getIdentityServiceConfig

Configuration for Identity Service component.

Generated from protobuf field .google.container.v1.IdentityServiceConfig identity_service_config = 54;

Returns
Type
Description

hasIdentityServiceConfig

clearIdentityServiceConfig

setIdentityServiceConfig

Configuration for Identity Service component.

Generated from protobuf field .google.container.v1.IdentityServiceConfig identity_service_config = 54;

Parameter
Name
Description
Returns
Type
Description
$this

[Output only] Server-defined URL for the resource.

Generated from protobuf field string self_link = 100;

Returns
Type
Description
string

[Output only] Server-defined URL for the resource.

Generated from protobuf field string self_link = 100;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getZone

[Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.

Generated from protobuf field string zone = 101 [deprecated = true];

Returns
Type
Description
string

setZone

[Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.

Generated from protobuf field string zone = 101 [deprecated = true];

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getEndpoint

[Output only] The IP address of this cluster's master endpoint.

The endpoint can be accessed from the internet at https://username:password@endpoint/ . See the masterAuth property of this resource for username and password information.

Generated from protobuf field string endpoint = 102;

Returns
Type
Description
string

setEndpoint

[Output only] The IP address of this cluster's master endpoint.

The endpoint can be accessed from the internet at https://username:password@endpoint/ . See the masterAuth property of this resource for username and password information.

Generated from protobuf field string endpoint = 102;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getInitialClusterVersion

The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion.

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

  • "latest": picks the highest valid Kubernetes version
  • "1.X": picks the highest valid patch+gke.N patch in the 1.X version
  • "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
  • "1.X.Y-gke.N": picks an explicit Kubernetes version
  • "","-": picks the default Kubernetes version

Generated from protobuf field string initial_cluster_version = 103;

Returns
Type
Description
string

setInitialClusterVersion

The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion.

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

  • "latest": picks the highest valid Kubernetes version
  • "1.X": picks the highest valid patch+gke.N patch in the 1.X version
  • "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
  • "1.X.Y-gke.N": picks an explicit Kubernetes version
  • "","-": picks the default Kubernetes version

Generated from protobuf field string initial_cluster_version = 103;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCurrentMasterVersion

[Output only] The current software version of the master endpoint.

Generated from protobuf field string current_master_version = 104;

Returns
Type
Description
string

setCurrentMasterVersion

[Output only] The current software version of the master endpoint.

Generated from protobuf field string current_master_version = 104;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCurrentNodeVersion

[Output only] Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.

Generated from protobuf field string current_node_version = 105 [deprecated = true];

Returns
Type
Description
string

setCurrentNodeVersion

[Output only] Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.

Generated from protobuf field string current_node_version = 105 [deprecated = true];

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCreateTime

[Output only] The time the cluster was created, in RFC3339 text format.

Generated from protobuf field string create_time = 106;

Returns
Type
Description
string

setCreateTime

[Output only] The time the cluster was created, in RFC3339 text format.

Generated from protobuf field string create_time = 106;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getStatus

[Output only] The current status of this cluster.

Generated from protobuf field .google.container.v1.Cluster.Status status = 107;

Returns
Type
Description
int

setStatus

[Output only] The current status of this cluster.

Generated from protobuf field .google.container.v1.Cluster.Status status = 107;

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getStatusMessage

[Output only] Deprecated. Use conditions instead.

Additional information about the current status of this cluster, if available.

Generated from protobuf field string status_message = 108 [deprecated = true];

Returns
Type
Description
string

setStatusMessage

[Output only] Deprecated. Use conditions instead.

Additional information about the current status of this cluster, if available.

Generated from protobuf field string status_message = 108 [deprecated = true];

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getNodeIpv4CidrSize

[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. This field will only be set when cluster is in route-based network mode.

Generated from protobuf field int32 node_ipv4_cidr_size = 109;

Returns
Type
Description
int

setNodeIpv4CidrSize

[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. This field will only be set when cluster is in route-based network mode.

Generated from protobuf field int32 node_ipv4_cidr_size = 109;

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getServicesIpv4Cidr

[Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29 ). Service addresses are typically put in the last /16 from the container CIDR.

Generated from protobuf field string services_ipv4_cidr = 110;

Returns
Type
Description
string

setServicesIpv4Cidr

[Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29 ). Service addresses are typically put in the last /16 from the container CIDR.

Generated from protobuf field string services_ipv4_cidr = 110;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getInstanceGroupUrls

Deprecated. Use node_pools.instance_group_urls.

Generated from protobuf field repeated string instance_group_urls = 111 [deprecated = true];

Returns
Type
Description
Google\Protobuf\Internal\RepeatedField

setInstanceGroupUrls

Deprecated. Use node_pools.instance_group_urls.

Generated from protobuf field repeated string instance_group_urls = 111 [deprecated = true];

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

getCurrentNodeCount

[Output only] The number of nodes currently in the cluster. Deprecated.

Call Kubernetes API directly to retrieve node information.

Generated from protobuf field int32 current_node_count = 112 [deprecated = true];

Returns
Type
Description
int

setCurrentNodeCount

[Output only] The number of nodes currently in the cluster. Deprecated.

Call Kubernetes API directly to retrieve node information.

Generated from protobuf field int32 current_node_count = 112 [deprecated = true];

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getExpireTime

[Output only] The time the cluster will be automatically deleted in RFC3339 text format.

Generated from protobuf field string expire_time = 113;

Returns
Type
Description
string

setExpireTime

[Output only] The time the cluster will be automatically deleted in RFC3339 text format.

Generated from protobuf field string expire_time = 113;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getLocation

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.

Generated from protobuf field string location = 114;

Returns
Type
Description
string

setLocation

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.

Generated from protobuf field string location = 114;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getEnableTpu

Enable the ability to use Cloud TPUs in this cluster.

Generated from protobuf field bool enable_tpu = 115;

Returns
Type
Description
bool

setEnableTpu

Enable the ability to use Cloud TPUs in this cluster.

Generated from protobuf field bool enable_tpu = 115;

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getTpuIpv4CidrBlock

[Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29 ).

Generated from protobuf field string tpu_ipv4_cidr_block = 116;

Returns
Type
Description
string

setTpuIpv4CidrBlock

[Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29 ).

Generated from protobuf field string tpu_ipv4_cidr_block = 116;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getConditions

Which conditions caused the current cluster state.

Generated from protobuf field repeated .google.container.v1.StatusCondition conditions = 118;

Returns
Type
Description
Google\Protobuf\Internal\RepeatedField

setConditions

Which conditions caused the current cluster state.

Generated from protobuf field repeated .google.container.v1.StatusCondition conditions = 118;

Parameter
Name
Description
Returns
Type
Description
$this

getAutopilot

Autopilot configuration for the cluster.

Generated from protobuf field .google.container.v1.Autopilot autopilot = 128;

Returns
Type
Description

hasAutopilot

clearAutopilot

setAutopilot

Autopilot configuration for the cluster.

Generated from protobuf field .google.container.v1.Autopilot autopilot = 128;

Parameter
Name
Description
Returns
Type
Description
$this

getId

Output only. Unique id for the cluster.

Generated from protobuf field string id = 129 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description
string

setId

Output only. Unique id for the cluster.

Generated from protobuf field string id = 129 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getNodePoolDefaults

Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.

Generated from protobuf field optional .google.container.v1.NodePoolDefaults node_pool_defaults = 131;

Returns
Type
Description

hasNodePoolDefaults

clearNodePoolDefaults

setNodePoolDefaults

Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.

Generated from protobuf field optional .google.container.v1.NodePoolDefaults node_pool_defaults = 131;

Parameter
Name
Description
Returns
Type
Description
$this

getLoggingConfig

Logging configuration for the cluster.

Generated from protobuf field .google.container.v1.LoggingConfig logging_config = 132;

Returns
Type
Description

hasLoggingConfig

clearLoggingConfig

setLoggingConfig

Logging configuration for the cluster.

Generated from protobuf field .google.container.v1.LoggingConfig logging_config = 132;

Parameter
Name
Description
Returns
Type
Description
$this

getMonitoringConfig

Monitoring configuration for the cluster.

Generated from protobuf field .google.container.v1.MonitoringConfig monitoring_config = 133;

Returns
Type
Description

hasMonitoringConfig

clearMonitoringConfig

setMonitoringConfig

Monitoring configuration for the cluster.

Generated from protobuf field .google.container.v1.MonitoringConfig monitoring_config = 133;

Parameter
Name
Description
Returns
Type
Description
$this

getNodePoolAutoConfig

Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

Generated from protobuf field .google.container.v1.NodePoolAutoConfig node_pool_auto_config = 136;

Returns
Type
Description

hasNodePoolAutoConfig

clearNodePoolAutoConfig

setNodePoolAutoConfig

Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

Generated from protobuf field .google.container.v1.NodePoolAutoConfig node_pool_auto_config = 136;

Parameter
Name
Description
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: