Kubernetes Engine V1 API - Class Google::Cloud::Container::V1::Cluster (v0.35.0)

Reference documentation and code samples for the Kubernetes Engine V1 API class Google::Cloud::Container::V1::Cluster.

A Google Kubernetes Engine cluster.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#addons_config

def addons_config() -> ::Google::Cloud::Container::V1::AddonsConfig
Returns

#addons_config=

def addons_config=(value) -> ::Google::Cloud::Container::V1::AddonsConfig
Parameter
Returns

#authenticator_groups_config

def authenticator_groups_config() -> ::Google::Cloud::Container::V1::AuthenticatorGroupsConfig
Returns

#authenticator_groups_config=

def authenticator_groups_config=(value) -> ::Google::Cloud::Container::V1::AuthenticatorGroupsConfig
Parameter
Returns

#autopilot

def autopilot() -> ::Google::Cloud::Container::V1::Autopilot
Returns

#autopilot=

def autopilot=(value) -> ::Google::Cloud::Container::V1::Autopilot
Parameter
Returns

#autoscaling

def autoscaling() -> ::Google::Cloud::Container::V1::ClusterAutoscaling
Returns

#autoscaling=

def autoscaling=(value) -> ::Google::Cloud::Container::V1::ClusterAutoscaling
Parameter
Returns

#binary_authorization

def binary_authorization() -> ::Google::Cloud::Container::V1::BinaryAuthorization
Returns

#binary_authorization=

def binary_authorization=(value) -> ::Google::Cloud::Container::V1::BinaryAuthorization
Parameter
Returns

#cluster_ipv4_cidr

def cluster_ipv4_cidr() -> ::String
Returns
  • (::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.

#cluster_ipv4_cidr=

def cluster_ipv4_cidr=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#conditions

def conditions() -> ::Array<::Google::Cloud::Container::V1::StatusCondition>
Returns

#conditions=

def conditions=(value) -> ::Array<::Google::Cloud::Container::V1::StatusCondition>
Parameter
Returns

#confidential_nodes

def confidential_nodes() -> ::Google::Cloud::Container::V1::ConfidentialNodes
Returns

#confidential_nodes=

def confidential_nodes=(value) -> ::Google::Cloud::Container::V1::ConfidentialNodes
Parameter
Returns

#cost_management_config

def cost_management_config() -> ::Google::Cloud::Container::V1::CostManagementConfig
Returns

#cost_management_config=

def cost_management_config=(value) -> ::Google::Cloud::Container::V1::CostManagementConfig
Parameter
Returns

#create_time

def create_time() -> ::String
Returns
  • (::String) — [Output only] The time the cluster was created, in RFC3339 text format.

#create_time=

def create_time=(value) -> ::String
Parameter
  • value (::String) — [Output only] The time the cluster was created, in RFC3339 text format.
Returns
  • (::String) — [Output only] The time the cluster was created, in RFC3339 text format.

#current_master_version

def current_master_version() -> ::String
Returns
  • (::String) — [Output only] The current software version of the master endpoint.

#current_master_version=

def current_master_version=(value) -> ::String
Parameter
  • value (::String) — [Output only] The current software version of the master endpoint.
Returns
  • (::String) — [Output only] The current software version of the master endpoint.

#current_node_count

def current_node_count() -> ::Integer
Returns
  • (::Integer) — [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.

#current_node_count=

def current_node_count=(value) -> ::Integer
Parameter
  • value (::Integer) — [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
Returns
  • (::Integer) — [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.

#current_node_version

def current_node_version() -> ::String
Returns
  • (::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.

#current_node_version=

def current_node_version=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#database_encryption

def database_encryption() -> ::Google::Cloud::Container::V1::DatabaseEncryption
Returns

#database_encryption=

def database_encryption=(value) -> ::Google::Cloud::Container::V1::DatabaseEncryption
Parameter
Returns

#default_max_pods_constraint

def default_max_pods_constraint() -> ::Google::Cloud::Container::V1::MaxPodsConstraint
Returns

#default_max_pods_constraint=

def default_max_pods_constraint=(value) -> ::Google::Cloud::Container::V1::MaxPodsConstraint
Parameter
  • value (::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.
Returns

#description

def description() -> ::String
Returns
  • (::String) — An optional description of this cluster.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — An optional description of this cluster.
Returns
  • (::String) — An optional description of this cluster.

#enable_k8s_beta_apis

def enable_k8s_beta_apis() -> ::Google::Cloud::Container::V1::K8sBetaAPIConfig
Returns

#enable_k8s_beta_apis=

def enable_k8s_beta_apis=(value) -> ::Google::Cloud::Container::V1::K8sBetaAPIConfig
Parameter
Returns

#enable_kubernetes_alpha

def enable_kubernetes_alpha() -> ::Boolean
Returns
  • (::Boolean) — 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.

#enable_kubernetes_alpha=

def enable_kubernetes_alpha=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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
  • (::Boolean) — 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.

#enable_tpu

def enable_tpu() -> ::Boolean
Returns
  • (::Boolean) — Enable the ability to use Cloud TPUs in this cluster.

#enable_tpu=

def enable_tpu=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Enable the ability to use Cloud TPUs in this cluster.
Returns
  • (::Boolean) — Enable the ability to use Cloud TPUs in this cluster.

#endpoint

def endpoint() -> ::String
Returns
  • (::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.

#endpoint=

def endpoint=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#enterprise_config

def enterprise_config() -> ::Google::Cloud::Container::V1::EnterpriseConfig
Returns

#enterprise_config=

def enterprise_config=(value) -> ::Google::Cloud::Container::V1::EnterpriseConfig
Parameter
Returns

#etag

def etag() -> ::String
Returns
  • (::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.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#expire_time

def expire_time() -> ::String
Returns
  • (::String) — [Output only] The time the cluster will be automatically deleted in RFC3339 text format.

#expire_time=

def expire_time=(value) -> ::String
Parameter
  • value (::String) — [Output only] The time the cluster will be automatically deleted in RFC3339 text format.
Returns
  • (::String) — [Output only] The time the cluster will be automatically deleted in RFC3339 text format.

#fleet

def fleet() -> ::Google::Cloud::Container::V1::Fleet
Returns

#fleet=

def fleet=(value) -> ::Google::Cloud::Container::V1::Fleet
Parameter
Returns

#id

def id() -> ::String
Returns
  • (::String) — Output only. Unique id for the cluster.

#identity_service_config

def identity_service_config() -> ::Google::Cloud::Container::V1::IdentityServiceConfig
Returns

#identity_service_config=

def identity_service_config=(value) -> ::Google::Cloud::Container::V1::IdentityServiceConfig
Parameter
Returns

#initial_cluster_version

def initial_cluster_version() -> ::String
Returns
  • (::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

#initial_cluster_version=

def initial_cluster_version=(value) -> ::String
Parameter
  • value (::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
Returns
  • (::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

#initial_node_count

def initial_node_count() -> ::Integer
Returns
  • (::Integer) — 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.

#initial_node_count=

def initial_node_count=(value) -> ::Integer
Parameter
  • value (::Integer) — 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
  • (::Integer) — 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.

#instance_group_urls

def instance_group_urls() -> ::Array<::String>
Returns
  • (::Array<::String>) — Deprecated. Use node_pools.instance_group_urls.

#instance_group_urls=

def instance_group_urls=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Deprecated. Use node_pools.instance_group_urls.
Returns
  • (::Array<::String>) — Deprecated. Use node_pools.instance_group_urls.

#ip_allocation_policy

def ip_allocation_policy() -> ::Google::Cloud::Container::V1::IPAllocationPolicy
Returns

#ip_allocation_policy=

def ip_allocation_policy=(value) -> ::Google::Cloud::Container::V1::IPAllocationPolicy
Parameter
Returns

#label_fingerprint

def label_fingerprint() -> ::String
Returns
  • (::String) — The fingerprint of the set of labels for this cluster.

#label_fingerprint=

def label_fingerprint=(value) -> ::String
Parameter
  • value (::String) — The fingerprint of the set of labels for this cluster.
Returns
  • (::String) — The fingerprint of the set of labels for this cluster.

#legacy_abac

def legacy_abac() -> ::Google::Cloud::Container::V1::LegacyAbac
Returns

#legacy_abac=

def legacy_abac=(value) -> ::Google::Cloud::Container::V1::LegacyAbac
Parameter
Returns

#location

def location() -> ::String
Returns
  • (::String) — [Output only] The name of the Google Compute Engine zone or region in which the cluster resides.

#location=

def location=(value) -> ::String
Parameter
  • value (::String) — [Output only] The name of the Google Compute Engine zone or region in which the cluster resides.
Returns
  • (::String) — [Output only] The name of the Google Compute Engine zone or region in which the cluster resides.

#locations

def locations() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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.

#locations=

def locations=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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
  • (::Array<::String>) — 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.

#logging_config

def logging_config() -> ::Google::Cloud::Container::V1::LoggingConfig
Returns

#logging_config=

def logging_config=(value) -> ::Google::Cloud::Container::V1::LoggingConfig
Parameter
Returns

#logging_service

def logging_service() -> ::String
Returns
  • (::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.

#logging_service=

def logging_service=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#maintenance_policy

def maintenance_policy() -> ::Google::Cloud::Container::V1::MaintenancePolicy
Returns

#maintenance_policy=

def maintenance_policy=(value) -> ::Google::Cloud::Container::V1::MaintenancePolicy
Parameter
Returns

#master_auth

def master_auth() -> ::Google::Cloud::Container::V1::MasterAuth
Returns
  • (::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.

#master_auth=

def master_auth=(value) -> ::Google::Cloud::Container::V1::MasterAuth
Parameter
  • value (::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.
Returns
  • (::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.

#master_authorized_networks_config

def master_authorized_networks_config() -> ::Google::Cloud::Container::V1::MasterAuthorizedNetworksConfig
Returns

#master_authorized_networks_config=

def master_authorized_networks_config=(value) -> ::Google::Cloud::Container::V1::MasterAuthorizedNetworksConfig
Parameter
Returns

#mesh_certificates

def mesh_certificates() -> ::Google::Cloud::Container::V1::MeshCertificates
Returns

#mesh_certificates=

def mesh_certificates=(value) -> ::Google::Cloud::Container::V1::MeshCertificates
Parameter
Returns

#monitoring_config

def monitoring_config() -> ::Google::Cloud::Container::V1::MonitoringConfig
Returns

#monitoring_config=

def monitoring_config=(value) -> ::Google::Cloud::Container::V1::MonitoringConfig
Parameter
Returns

#monitoring_service

def monitoring_service() -> ::String
Returns
  • (::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.

#monitoring_service=

def monitoring_service=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#name

def name() -> ::String
Returns
  • (::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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#network

def network() -> ::String
Returns
  • (::String) — The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.

#network=

def network=(value) -> ::String
Parameter
  • value (::String) — The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.
Returns
  • (::String) — The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.

#network_config

def network_config() -> ::Google::Cloud::Container::V1::NetworkConfig
Returns

#network_config=

def network_config=(value) -> ::Google::Cloud::Container::V1::NetworkConfig
Parameter
Returns

#network_policy

def network_policy() -> ::Google::Cloud::Container::V1::NetworkPolicy
Returns

#network_policy=

def network_policy=(value) -> ::Google::Cloud::Container::V1::NetworkPolicy
Parameter
Returns

#node_config

def node_config() -> ::Google::Cloud::Container::V1::NodeConfig
Returns
  • (::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.

#node_config=

def node_config=(value) -> ::Google::Cloud::Container::V1::NodeConfig
Parameter
  • value (::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.

Returns
  • (::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.

#node_ipv4_cidr_size

def node_ipv4_cidr_size() -> ::Integer
Returns
  • (::Integer) — [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.

#node_ipv4_cidr_size=

def node_ipv4_cidr_size=(value) -> ::Integer
Parameter
  • value (::Integer) — [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
  • (::Integer) — [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.

#node_pool_auto_config

def node_pool_auto_config() -> ::Google::Cloud::Container::V1::NodePoolAutoConfig
Returns

#node_pool_auto_config=

def node_pool_auto_config=(value) -> ::Google::Cloud::Container::V1::NodePoolAutoConfig
Parameter
Returns

#node_pool_defaults

def node_pool_defaults() -> ::Google::Cloud::Container::V1::NodePoolDefaults
Returns

#node_pool_defaults=

def node_pool_defaults=(value) -> ::Google::Cloud::Container::V1::NodePoolDefaults
Parameter
Returns

#node_pools

def node_pools() -> ::Array<::Google::Cloud::Container::V1::NodePool>
Returns

#node_pools=

def node_pools=(value) -> ::Array<::Google::Cloud::Container::V1::NodePool>
Parameter
Returns

#notification_config

def notification_config() -> ::Google::Cloud::Container::V1::NotificationConfig
Returns

#notification_config=

def notification_config=(value) -> ::Google::Cloud::Container::V1::NotificationConfig
Parameter
Returns

#private_cluster_config

def private_cluster_config() -> ::Google::Cloud::Container::V1::PrivateClusterConfig
Returns

#private_cluster_config=

def private_cluster_config=(value) -> ::Google::Cloud::Container::V1::PrivateClusterConfig
Parameter
Returns

#release_channel

def release_channel() -> ::Google::Cloud::Container::V1::ReleaseChannel
Returns
  • (::Google::Cloud::Container::V1::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.

#release_channel=

def release_channel=(value) -> ::Google::Cloud::Container::V1::ReleaseChannel
Parameter
  • value (::Google::Cloud::Container::V1::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.
Returns
  • (::Google::Cloud::Container::V1::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.

#resource_labels

def resource_labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

#resource_labels=

def resource_labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

#resource_usage_export_config

def resource_usage_export_config() -> ::Google::Cloud::Container::V1::ResourceUsageExportConfig
Returns

#resource_usage_export_config=

def resource_usage_export_config=(value) -> ::Google::Cloud::Container::V1::ResourceUsageExportConfig
Parameter
Returns

#security_posture_config

def security_posture_config() -> ::Google::Cloud::Container::V1::SecurityPostureConfig
Returns

#security_posture_config=

def security_posture_config=(value) -> ::Google::Cloud::Container::V1::SecurityPostureConfig
Parameter
Returns

#self_link

def self_link() -> ::String
Returns
  • (::String) — [Output only] Server-defined URL for the resource.

#self_link=

def self_link=(value) -> ::String
Parameter
  • value (::String) — [Output only] Server-defined URL for the resource.
Returns
  • (::String) — [Output only] Server-defined URL for the resource.

#services_ipv4_cidr

def services_ipv4_cidr() -> ::String
Returns
  • (::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.

#services_ipv4_cidr=

def services_ipv4_cidr=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#shielded_nodes

def shielded_nodes() -> ::Google::Cloud::Container::V1::ShieldedNodes
Returns

#shielded_nodes=

def shielded_nodes=(value) -> ::Google::Cloud::Container::V1::ShieldedNodes
Parameter
Returns

#status

def status() -> ::Google::Cloud::Container::V1::Cluster::Status
Returns

#status=

def status=(value) -> ::Google::Cloud::Container::V1::Cluster::Status
Parameter
Returns

#status_message

def status_message() -> ::String
Returns
  • (::String) — [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.

#status_message=

def status_message=(value) -> ::String
Parameter
  • value (::String) — [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
Returns
  • (::String) — [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.

#subnetwork

def subnetwork() -> ::String
Returns
  • (::String) — The name of the Google Compute Engine subnetwork to which the cluster is connected.

#subnetwork=

def subnetwork=(value) -> ::String
Parameter
  • value (::String) — The name of the Google Compute Engine subnetwork to which the cluster is connected.
Returns
  • (::String) — The name of the Google Compute Engine subnetwork to which the cluster is connected.

#tpu_ipv4_cidr_block

def tpu_ipv4_cidr_block() -> ::String
Returns
  • (::String) — [Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29).

#tpu_ipv4_cidr_block=

def tpu_ipv4_cidr_block=(value) -> ::String
Parameter
  • value (::String) — [Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29).
Returns
  • (::String) — [Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29).

#vertical_pod_autoscaling

def vertical_pod_autoscaling() -> ::Google::Cloud::Container::V1::VerticalPodAutoscaling
Returns

#vertical_pod_autoscaling=

def vertical_pod_autoscaling=(value) -> ::Google::Cloud::Container::V1::VerticalPodAutoscaling
Parameter
Returns

#workload_identity_config

def workload_identity_config() -> ::Google::Cloud::Container::V1::WorkloadIdentityConfig
Returns

#workload_identity_config=

def workload_identity_config=(value) -> ::Google::Cloud::Container::V1::WorkloadIdentityConfig
Parameter
Returns

#zone

def zone() -> ::String
Returns
  • (::String) — [Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.

#zone=

def zone=(value) -> ::String
Parameter
  • value (::String) — [Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.
Returns
  • (::String) — [Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.