Kubernetes Engine V1 API - Class Google::Cloud::Container::V1::ClusterUpdate (v0.9.1)

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

ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#desired_addons_config

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

#desired_addons_config=

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

#desired_authenticator_groups_config

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

#desired_authenticator_groups_config=

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

#desired_binary_authorization

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

#desired_binary_authorization=

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

#desired_cluster_autoscaling

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

#desired_cluster_autoscaling=

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

#desired_database_encryption

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

#desired_database_encryption=

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

#desired_datapath_provider

def desired_datapath_provider() -> ::Google::Cloud::Container::V1::DatapathProvider
Returns

#desired_datapath_provider=

def desired_datapath_provider=(value) -> ::Google::Cloud::Container::V1::DatapathProvider
Parameter
Returns

#desired_default_snat_status

def desired_default_snat_status() -> ::Google::Cloud::Container::V1::DefaultSnatStatus
Returns

#desired_default_snat_status=

def desired_default_snat_status=(value) -> ::Google::Cloud::Container::V1::DefaultSnatStatus
Parameter
Returns

#desired_dns_config

def desired_dns_config() -> ::Google::Cloud::Container::V1::DNSConfig
Returns

#desired_dns_config=

def desired_dns_config=(value) -> ::Google::Cloud::Container::V1::DNSConfig
Parameter
Returns

#desired_gcfs_config

def desired_gcfs_config() -> ::Google::Cloud::Container::V1::GcfsConfig
Returns

#desired_gcfs_config=

def desired_gcfs_config=(value) -> ::Google::Cloud::Container::V1::GcfsConfig
Parameter
Returns

#desired_identity_service_config

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

#desired_identity_service_config=

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

#desired_image_type

def desired_image_type() -> ::String
Returns
  • (::String) — The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.

#desired_image_type=

def desired_image_type=(value) -> ::String
Parameter
  • value (::String) — The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.
Returns
  • (::String) — The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.

#desired_intra_node_visibility_config

def desired_intra_node_visibility_config() -> ::Google::Cloud::Container::V1::IntraNodeVisibilityConfig
Returns

#desired_intra_node_visibility_config=

def desired_intra_node_visibility_config=(value) -> ::Google::Cloud::Container::V1::IntraNodeVisibilityConfig
Parameter
Returns

#desired_l4ilb_subsetting_config

def desired_l4ilb_subsetting_config() -> ::Google::Cloud::Container::V1::ILBSubsettingConfig
Returns

#desired_l4ilb_subsetting_config=

def desired_l4ilb_subsetting_config=(value) -> ::Google::Cloud::Container::V1::ILBSubsettingConfig
Parameter
Returns

#desired_locations

def desired_locations() -> ::Array<::String>
Returns
  • (::Array<::String>) — The desired list of Google Compute Engine zones in which the cluster's nodes should be located.

    This list must always include the cluster's primary zone.

    Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.

#desired_locations=

def desired_locations=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — The desired list of Google Compute Engine zones in which the cluster's nodes should be located.

    This list must always include the cluster's primary zone.

    Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.

Returns
  • (::Array<::String>) — The desired list of Google Compute Engine zones in which the cluster's nodes should be located.

    This list must always include the cluster's primary zone.

    Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.

#desired_logging_config

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

#desired_logging_config=

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

#desired_logging_service

def desired_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.

#desired_logging_service=

def desired_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.

#desired_master_authorized_networks_config

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

#desired_master_authorized_networks_config=

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

#desired_master_version

def desired_master_version() -> ::String
Returns
  • (::String) —

    The Kubernetes version to change the master to.

    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

#desired_master_version=

def desired_master_version=(value) -> ::String
Parameter
  • value (::String) —

    The Kubernetes version to change the master to.

    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 Kubernetes version to change the master to.

    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

#desired_mesh_certificates

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

#desired_mesh_certificates=

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

#desired_monitoring_config

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

#desired_monitoring_config=

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

#desired_monitoring_service

def desired_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.

#desired_monitoring_service=

def desired_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.

#desired_node_pool_auto_config_network_tags

def desired_node_pool_auto_config_network_tags() -> ::Google::Cloud::Container::V1::NetworkTags
Returns

#desired_node_pool_auto_config_network_tags=

def desired_node_pool_auto_config_network_tags=(value) -> ::Google::Cloud::Container::V1::NetworkTags
Parameter
Returns

#desired_node_pool_autoscaling

def desired_node_pool_autoscaling() -> ::Google::Cloud::Container::V1::NodePoolAutoscaling
Returns
  • (::Google::Cloud::Container::V1::NodePoolAutoscaling) — Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool.

#desired_node_pool_autoscaling=

def desired_node_pool_autoscaling=(value) -> ::Google::Cloud::Container::V1::NodePoolAutoscaling
Parameter
  • value (::Google::Cloud::Container::V1::NodePoolAutoscaling) — Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool.
Returns
  • (::Google::Cloud::Container::V1::NodePoolAutoscaling) — Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool.

#desired_node_pool_id

def desired_node_pool_id() -> ::String
Returns
  • (::String) — The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster.

#desired_node_pool_id=

def desired_node_pool_id=(value) -> ::String
Parameter
  • value (::String) — The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster.
Returns
  • (::String) — The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster.

#desired_node_version

def desired_node_version() -> ::String
Returns
  • (::String) —

    The Kubernetes version to change the nodes to (typically an upgrade).

    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 Kubernetes master version

#desired_node_version=

def desired_node_version=(value) -> ::String
Parameter
  • value (::String) —

    The Kubernetes version to change the nodes to (typically an upgrade).

    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 Kubernetes master version
Returns
  • (::String) —

    The Kubernetes version to change the nodes to (typically an upgrade).

    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 Kubernetes master version

#desired_notification_config

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

#desired_notification_config=

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

#desired_private_cluster_config

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

#desired_private_cluster_config=

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

#desired_private_ipv6_google_access

def desired_private_ipv6_google_access() -> ::Google::Cloud::Container::V1::PrivateIPv6GoogleAccess
Returns

#desired_private_ipv6_google_access=

def desired_private_ipv6_google_access=(value) -> ::Google::Cloud::Container::V1::PrivateIPv6GoogleAccess
Parameter
Returns

#desired_release_channel

def desired_release_channel() -> ::Google::Cloud::Container::V1::ReleaseChannel
Returns

#desired_release_channel=

def desired_release_channel=(value) -> ::Google::Cloud::Container::V1::ReleaseChannel
Parameter
Returns

#desired_resource_usage_export_config

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

#desired_resource_usage_export_config=

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

#desired_service_external_ips_config

def desired_service_external_ips_config() -> ::Google::Cloud::Container::V1::ServiceExternalIPsConfig
Returns

#desired_service_external_ips_config=

def desired_service_external_ips_config=(value) -> ::Google::Cloud::Container::V1::ServiceExternalIPsConfig
Parameter
Returns

#desired_shielded_nodes

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

#desired_shielded_nodes=

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

#desired_vertical_pod_autoscaling

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

#desired_vertical_pod_autoscaling=

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

#desired_workload_identity_config

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

#desired_workload_identity_config=

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