Console
    Contact Us Start free

    Google Cloud Container V1 Client - Class Cluster (2.3.4)

    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

    Namespace

    Google \ Cloud \ Container \ V1

    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
    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
    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
    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< 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
    LegacyAbac

    Configuration for the legacy ABAC authorization mode.

    ↳ network_policy
    NetworkPolicy

    Configuration options for the NetworkPolicy feature.

    ↳ ip_allocation_policy
    IPAllocationPolicy

    Configuration for cluster IP allocation.

    ↳ master_authorized_networks_config
    MasterAuthorizedNetworksConfig

    The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.

    ↳ maintenance_policy
    MaintenancePolicy

    Configure the maintenance policy for this cluster.

    ↳ binary_authorization
    BinaryAuthorization

    Configuration for Binary Authorization.

    ↳ autoscaling
    ClusterAutoscaling

    Cluster-level autoscaling configuration.

    ↳ network_config
    NetworkConfig

    Configuration for cluster networking.

    ↳ default_max_pods_constraint
    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
    ResourceUsageExportConfig

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

    ↳ authenticator_groups_config
    AuthenticatorGroupsConfig

    Configuration controlling RBAC group membership information.

    ↳ private_cluster_config
    PrivateClusterConfig

    Configuration for private cluster.

    ↳ database_encryption
    DatabaseEncryption

    Configuration of etcd encryption.

    ↳ vertical_pod_autoscaling
    VerticalPodAutoscaling

    Cluster-level Vertical Pod Autoscaling configuration.

    ↳ shielded_nodes
    ShieldedNodes

    Shielded Nodes configuration.

    ↳ release_channel
    ReleaseChannel

    Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.

    ↳ workload_identity_config
    WorkloadIdentityConfig

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

    ↳ mesh_certificates
    MeshCertificates

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

    ↳ cost_management_config
    CostManagementConfig

    Configuration for the fine-grained cost management feature.

    ↳ notification_config
    NotificationConfig

    Notification configuration of the cluster.

    ↳ confidential_nodes
    ConfidentialNodes

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

    ↳ identity_service_config
    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@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

    Output only. 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< StatusCondition >

    Which conditions caused the current cluster state.

    ↳ autopilot
    Autopilot

    Autopilot configuration for the cluster.

    ↳ id
    string

    Output only. Unique id for the cluster.

    ↳ node_pool_defaults
    NodePoolDefaults

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

    ↳ logging_config
    LoggingConfig

    Logging configuration for the cluster.

    ↳ monitoring_config
    MonitoringConfig

    Monitoring configuration for the cluster.

    ↳ node_pool_auto_config
    NodePoolAutoConfig

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

    ↳ etag
    string

    This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.

    ↳ fleet
    Fleet

    Fleet information for the cluster.

    ↳ security_posture_config
    SecurityPostureConfig

    Enable/Disable Security Posture API features for the cluster.

    ↳ control_plane_endpoints_config
    ControlPlaneEndpointsConfig

    Configuration for all cluster's control plane endpoints.

    ↳ enable_k8s_beta_apis
    K8sBetaAPIConfig

    Beta APIs Config

    ↳ enterprise_config
    EnterpriseConfig

    GKE Enterprise Configuration.

    ↳ secret_manager_config
    SecretManagerConfig

    Secret CSI driver configuration.

    ↳ compliance_posture_config
    CompliancePostureConfig

    Enable/Disable Compliance Posture features for the cluster.

    ↳ satisfies_pzs
    bool

    Output only. Reserved for future use.

    ↳ satisfies_pzi
    bool

    Output only. Reserved for future use.

    ↳ user_managed_keys_config
    UserManagedKeysConfig

    The Custom keys configuration for the cluster.

    ↳ rbac_binding_config
    RBACBindingConfig

    RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.

    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.
    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.
    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDescription

    An optional description of this cluster.

    Returns
    Type
    Description
    string

    setDescription

    An optional description of this cluster.

    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.

    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.

    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.

    Returns
    Type
    Description
    NodeConfig |null

    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.

    Parameter
    Name
    Description
    var
    NodeConfig
    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.

    Returns
    Type
    Description
    MasterAuth |null

    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.

    Parameter
    Name
    Description
    var
    MasterAuth
    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.
    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.
    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.
    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.
    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.

    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.

    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 .

    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 .

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getAddonsConfig

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

    Returns
    Type
    Description
    AddonsConfig |null

    hasAddonsConfig

    clearAddonsConfig

    setAddonsConfig

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

    Parameter
    Name
    Description
    var
    AddonsConfig
    Returns
    Type
    Description
    $this

    getSubnetwork

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

    Returns
    Type
    Description
    string

    setSubnetwork

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

    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.

    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.

    Parameter
    Name
    Description
    var
    array< NodePool >
    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.

    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.

    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.

    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.

    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.

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setResourceLabels

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

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

    getLabelFingerprint

    The fingerprint of the set of labels for this cluster.

    Returns
    Type
    Description
    string

    setLabelFingerprint

    The fingerprint of the set of labels for this cluster.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getLegacyAbac

    Configuration for the legacy ABAC authorization mode.

    Returns
    Type
    Description
    LegacyAbac |null

    hasLegacyAbac

    clearLegacyAbac

    setLegacyAbac

    Configuration for the legacy ABAC authorization mode.

    Parameter
    Name
    Description
    var
    LegacyAbac
    Returns
    Type
    Description
    $this

    getNetworkPolicy

    Configuration options for the NetworkPolicy feature.

    Returns
    Type
    Description
    NetworkPolicy |null

    hasNetworkPolicy

    clearNetworkPolicy

    setNetworkPolicy

    Configuration options for the NetworkPolicy feature.

    Parameter
    Name
    Description
    var
    NetworkPolicy
    Returns
    Type
    Description
    $this

    getIpAllocationPolicy

    Configuration for cluster IP allocation.

    Returns
    Type
    Description
    IPAllocationPolicy |null

    hasIpAllocationPolicy

    clearIpAllocationPolicy

    setIpAllocationPolicy

    Configuration for cluster IP allocation.

    Parameter
    Name
    Description
    var
    IPAllocationPolicy
    Returns
    Type
    Description
    $this

    getMasterAuthorizedNetworksConfig

    The configuration options for master authorized networks feature.

    Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.

    Returns
    Type
    Description
    MasterAuthorizedNetworksConfig |null

    hasMasterAuthorizedNetworksConfig

    clearMasterAuthorizedNetworksConfig

    setMasterAuthorizedNetworksConfig

    The configuration options for master authorized networks feature.

    Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.

    Parameter
    Name
    Description
    var
    MasterAuthorizedNetworksConfig
    Returns
    Type
    Description
    $this

    getMaintenancePolicy

    Configure the maintenance policy for this cluster.

    Returns
    Type
    Description
    MaintenancePolicy |null

    hasMaintenancePolicy

    clearMaintenancePolicy

    setMaintenancePolicy

    Configure the maintenance policy for this cluster.

    Parameter
    Name
    Description
    var
    MaintenancePolicy
    Returns
    Type
    Description
    $this

    getBinaryAuthorization

    Configuration for Binary Authorization.

    Returns
    Type
    Description
    BinaryAuthorization |null

    hasBinaryAuthorization

    clearBinaryAuthorization

    setBinaryAuthorization

    Configuration for Binary Authorization.

    Parameter
    Name
    Description
    var
    BinaryAuthorization
    Returns
    Type
    Description
    $this

    getAutoscaling

    Cluster-level autoscaling configuration.

    Returns
    Type
    Description
    ClusterAutoscaling |null

    hasAutoscaling

    clearAutoscaling

    setAutoscaling

    Cluster-level autoscaling configuration.

    Parameter
    Name
    Description
    var
    ClusterAutoscaling
    Returns
    Type
    Description
    $this

    getNetworkConfig

    Configuration for cluster networking.

    Returns
    Type
    Description
    NetworkConfig |null

    hasNetworkConfig

    clearNetworkConfig

    setNetworkConfig

    Configuration for cluster networking.

    Parameter
    Name
    Description
    var
    NetworkConfig
    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.

    Returns
    Type
    Description
    MaxPodsConstraint |null

    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.

    Parameter
    Name
    Description
    var
    MaxPodsConstraint
    Returns
    Type
    Description
    $this

    getResourceUsageExportConfig

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

    Returns
    Type
    Description
    ResourceUsageExportConfig |null

    hasResourceUsageExportConfig

    clearResourceUsageExportConfig

    setResourceUsageExportConfig

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

    Parameter
    Name
    Description
    var
    ResourceUsageExportConfig
    Returns
    Type
    Description
    $this

    getAuthenticatorGroupsConfig

    Configuration controlling RBAC group membership information.

    Returns
    Type
    Description
    AuthenticatorGroupsConfig |null

    hasAuthenticatorGroupsConfig

    clearAuthenticatorGroupsConfig

    setAuthenticatorGroupsConfig

    Configuration controlling RBAC group membership information.

    Parameter
    Name
    Description
    var
    AuthenticatorGroupsConfig
    Returns
    Type
    Description
    $this

    getPrivateClusterConfig

    Configuration for private cluster.

    Returns
    Type
    Description
    PrivateClusterConfig |null

    hasPrivateClusterConfig

    clearPrivateClusterConfig

    setPrivateClusterConfig

    Configuration for private cluster.

    Parameter
    Name
    Description
    var
    PrivateClusterConfig
    Returns
    Type
    Description
    $this

    getDatabaseEncryption

    Configuration of etcd encryption.

    Returns
    Type
    Description
    DatabaseEncryption |null

    hasDatabaseEncryption

    clearDatabaseEncryption

    setDatabaseEncryption

    Configuration of etcd encryption.

    Parameter
    Name
    Description
    var
    DatabaseEncryption
    Returns
    Type
    Description
    $this

    getVerticalPodAutoscaling

    Cluster-level Vertical Pod Autoscaling configuration.

    Returns
    Type
    Description
    VerticalPodAutoscaling |null

    hasVerticalPodAutoscaling

    clearVerticalPodAutoscaling

    setVerticalPodAutoscaling

    Cluster-level Vertical Pod Autoscaling configuration.

    Parameter
    Name
    Description
    var
    VerticalPodAutoscaling
    Returns
    Type
    Description
    $this

    getShieldedNodes

    Shielded Nodes configuration.

    Returns
    Type
    Description
    ShieldedNodes |null

    hasShieldedNodes

    clearShieldedNodes

    setShieldedNodes

    Shielded Nodes configuration.

    Parameter
    Name
    Description
    var
    ShieldedNodes
    Returns
    Type
    Description
    $this

    getReleaseChannel

    Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.

    Returns
    Type
    Description
    ReleaseChannel |null

    hasReleaseChannel

    clearReleaseChannel

    setReleaseChannel

    Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.

    Parameter
    Name
    Description
    var
    ReleaseChannel
    Returns
    Type
    Description
    $this

    getWorkloadIdentityConfig

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

    Returns
    Type
    Description
    WorkloadIdentityConfig |null

    hasWorkloadIdentityConfig

    clearWorkloadIdentityConfig

    setWorkloadIdentityConfig

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

    Parameter
    Name
    Description
    var
    WorkloadIdentityConfig
    Returns
    Type
    Description
    $this

    getMeshCertificates

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

    Returns
    Type
    Description
    MeshCertificates |null

    hasMeshCertificates

    clearMeshCertificates

    setMeshCertificates

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

    Parameter
    Name
    Description
    var
    MeshCertificates
    Returns
    Type
    Description
    $this

    getCostManagementConfig

    Configuration for the fine-grained cost management feature.

    Returns
    Type
    Description
    CostManagementConfig |null

    hasCostManagementConfig

    clearCostManagementConfig

    setCostManagementConfig

    Configuration for the fine-grained cost management feature.

    Parameter
    Name
    Description
    var
    CostManagementConfig
    Returns
    Type
    Description
    $this

    getNotificationConfig

    Notification configuration of the cluster.

    Returns
    Type
    Description
    NotificationConfig |null

    hasNotificationConfig

    clearNotificationConfig

    setNotificationConfig

    Notification configuration of the cluster.

    Parameter
    Name
    Description
    var
    NotificationConfig
    Returns
    Type
    Description
    $this

    getConfidentialNodes

    Configuration of Confidential Nodes.

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

    Returns
    Type
    Description
    ConfidentialNodes |null

    hasConfidentialNodes

    clearConfidentialNodes

    setConfidentialNodes

    Configuration of Confidential Nodes.

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

    Parameter
    Name
    Description
    var
    ConfidentialNodes
    Returns
    Type
    Description
    $this

    getIdentityServiceConfig

    Configuration for Identity Service component.

    Returns
    Type
    Description
    IdentityServiceConfig |null

    hasIdentityServiceConfig

    clearIdentityServiceConfig

    setIdentityServiceConfig

    Configuration for Identity Service component.

    Parameter
    Name
    Description
    var
    IdentityServiceConfig
    Returns
    Type
    Description
    $this

    getSelfLink

    Output only. Server-defined URL for the resource.

    Returns
    Type
    Description
    string

    setSelfLink

    Output only. Server-defined URL for the resource.

    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.

    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.

    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.

    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.

    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
    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
    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCurrentMasterVersion

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

    Returns
    Type
    Description
    string

    setCurrentMasterVersion

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

    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.

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCreateTime

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

    Returns
    Type
    Description
    string

    setCreateTime

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getStatus

    Output only. The current status of this cluster.

    Returns
    Type
    Description
    int

    setStatus

    Output only. The current status of this cluster.

    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.

    Returns
    Type
    Description
    string

    setStatusMessage

    Output only. Deprecated. Use conditions instead.

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

    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.

    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.

    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.

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getInstanceGroupUrls

    Output only. Deprecated. Use node_pools.instance_group_urls.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setInstanceGroupUrls

    Output only. Deprecated. Use node_pools.instance_group_urls.

    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.

    Returns
    Type
    Description
    int

    setCurrentNodeCount

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

    Call Kubernetes API directly to retrieve node information.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getExpireTime

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

    Returns
    Type
    Description
    string

    setExpireTime

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

    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.

    Returns
    Type
    Description
    string

    setLocation

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getEnableTpu

    Enable the ability to use Cloud TPUs in this cluster.

    Returns
    Type
    Description
    bool

    setEnableTpu

    Enable the ability to use Cloud TPUs in this cluster.

    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 ).

    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 ).

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getConditions

    Which conditions caused the current cluster state.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setConditions

    Which conditions caused the current cluster state.

    Parameter
    Name
    Description
    var
    array< StatusCondition >
    Returns
    Type
    Description
    $this

    getAutopilot

    Autopilot configuration for the cluster.

    Returns
    Type
    Description
    Autopilot |null

    hasAutopilot

    clearAutopilot

    setAutopilot

    Autopilot configuration for the cluster.

    Parameter
    Name
    Description
    var
    Autopilot
    Returns
    Type
    Description
    $this

    getId

    Output only. Unique id for the cluster.

    Returns
    Type
    Description
    string

    setId

    Output only. Unique id for the cluster.

    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.

    Returns
    Type
    Description
    NodePoolDefaults |null

    hasNodePoolDefaults

    clearNodePoolDefaults

    setNodePoolDefaults

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

    Parameter
    Name
    Description
    var
    NodePoolDefaults
    Returns
    Type
    Description
    $this

    getLoggingConfig

    Logging configuration for the cluster.

    Returns
    Type
    Description
    LoggingConfig |null

    hasLoggingConfig

    clearLoggingConfig

    setLoggingConfig

    Logging configuration for the cluster.

    Parameter
    Name
    Description
    var
    LoggingConfig
    Returns
    Type
    Description
    $this

    getMonitoringConfig

    Monitoring configuration for the cluster.

    Returns
    Type
    Description
    MonitoringConfig |null

    hasMonitoringConfig

    clearMonitoringConfig

    setMonitoringConfig

    Monitoring configuration for the cluster.

    Parameter
    Name
    Description
    var
    MonitoringConfig
    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.

    Returns
    Type
    Description
    NodePoolAutoConfig |null

    hasNodePoolAutoConfig

    clearNodePoolAutoConfig

    setNodePoolAutoConfig

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

    Parameter
    Name
    Description
    var
    NodePoolAutoConfig
    Returns
    Type
    Description
    $this

    getEtag

    This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.

    Returns
    Type
    Description
    string

    setEtag

    This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getFleet

    Fleet information for the cluster.

    Returns
    Type
    Description
    Fleet |null

    hasFleet

    clearFleet

    setFleet

    Fleet information for the cluster.

    Parameter
    Name
    Description
    var
    Fleet
    Returns
    Type
    Description
    $this

    getSecurityPostureConfig

    Enable/Disable Security Posture API features for the cluster.

    Returns
    Type
    Description
    SecurityPostureConfig |null

    hasSecurityPostureConfig

    clearSecurityPostureConfig

    setSecurityPostureConfig

    Enable/Disable Security Posture API features for the cluster.

    Parameter
    Name
    Description
    var
    SecurityPostureConfig
    Returns
    Type
    Description
    $this

    getControlPlaneEndpointsConfig

    Configuration for all cluster's control plane endpoints.

    Returns
    Type
    Description
    ControlPlaneEndpointsConfig |null

    hasControlPlaneEndpointsConfig

    clearControlPlaneEndpointsConfig

    setControlPlaneEndpointsConfig

    Configuration for all cluster's control plane endpoints.

    Parameter
    Name
    Description
    var
    ControlPlaneEndpointsConfig
    Returns
    Type
    Description
    $this

    getEnableK8SBetaApis

    Beta APIs Config

    Returns
    Type
    Description
    K8sBetaAPIConfig |null

    hasEnableK8SBetaApis

    clearEnableK8SBetaApis

    setEnableK8SBetaApis

    Beta APIs Config

    Parameter
    Name
    Description
    var
    K8sBetaAPIConfig
    Returns
    Type
    Description
    $this

    getEnterpriseConfig

    GKE Enterprise Configuration.

    Returns
    Type
    Description
    EnterpriseConfig |null

    hasEnterpriseConfig

    clearEnterpriseConfig

    setEnterpriseConfig

    GKE Enterprise Configuration.

    Parameter
    Name
    Description
    var
    EnterpriseConfig
    Returns
    Type
    Description
    $this

    getSecretManagerConfig

    Secret CSI driver configuration.

    Returns
    Type
    Description
    SecretManagerConfig |null

    hasSecretManagerConfig

    clearSecretManagerConfig

    setSecretManagerConfig

    Secret CSI driver configuration.

    Parameter
    Name
    Description
    var
    SecretManagerConfig
    Returns
    Type
    Description
    $this

    getCompliancePostureConfig

    Enable/Disable Compliance Posture features for the cluster.

    Returns
    Type
    Description
    CompliancePostureConfig |null

    hasCompliancePostureConfig

    clearCompliancePostureConfig

    setCompliancePostureConfig

    Enable/Disable Compliance Posture features for the cluster.

    Parameter
    Name
    Description
    var
    CompliancePostureConfig
    Returns
    Type
    Description
    $this

    getSatisfiesPzs

    Output only. Reserved for future use.

    Returns
    Type
    Description
    bool

    hasSatisfiesPzs

    clearSatisfiesPzs

    setSatisfiesPzs

    Output only. Reserved for future use.

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getSatisfiesPzi

    Output only. Reserved for future use.

    Returns
    Type
    Description
    bool

    hasSatisfiesPzi

    clearSatisfiesPzi

    setSatisfiesPzi

    Output only. Reserved for future use.

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getUserManagedKeysConfig

    The Custom keys configuration for the cluster.

    Returns
    Type
    Description
    UserManagedKeysConfig |null

    hasUserManagedKeysConfig

    clearUserManagedKeysConfig

    setUserManagedKeysConfig

    The Custom keys configuration for the cluster.

    Parameter
    Name
    Description
    var
    UserManagedKeysConfig
    Returns
    Type
    Description
    $this

    getRbacBindingConfig

    RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.

    Returns
    Type
    Description
    RBACBindingConfig |null

    hasRbacBindingConfig

    clearRbacBindingConfig

    setRbacBindingConfig

    RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.

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