Class: Google::Cloud::Container::V1::ClusterUpdate

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/container/v1/cluster_service.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#desired_addons_config ⇒ ::Google::Cloud::Container::V1::AddonsConfig

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

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_authenticator_groups_config ⇒ ::Google::Cloud::Container::V1::AuthenticatorGroupsConfig

Returns The desired authenticator groups config for the cluster.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_binary_authorization ⇒ ::Google::Cloud::Container::V1::BinaryAuthorization

Returns The desired configuration options for the Binary Authorization feature.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_cluster_autoscaling ⇒ ::Google::Cloud::Container::V1::ClusterAutoscaling

Returns Cluster-level autoscaling configuration.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_cost_management_config ⇒ ::Google::Cloud::Container::V1::CostManagementConfig

Returns The desired configuration for the fine-grained cost management feature.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_database_encryption ⇒ ::Google::Cloud::Container::V1::DatabaseEncryption

Returns Configuration of etcd encryption.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_datapath_provider ⇒ ::Google::Cloud::Container::V1::DatapathProvider

Returns The desired datapath provider for the cluster.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_default_snat_status ⇒ ::Google::Cloud::Container::V1::DefaultSnatStatus

Returns The desired status of whether to disable default sNAT for this cluster.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_dns_config ⇒ ::Google::Cloud::Container::V1::DNSConfig

Returns DNSConfig contains clusterDNS config for this cluster.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_enable_private_endpoint ⇒ ::Boolean

Returns Enable/Disable private endpoint for the cluster's master.

Returns:

  • (::Boolean) —

    Enable/Disable private endpoint for the cluster's master.



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_gateway_api_config ⇒ ::Google::Cloud::Container::V1::GatewayAPIConfig

Returns The desired config of Gateway API on this cluster.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_gcfs_config ⇒ ::Google::Cloud::Container::V1::GcfsConfig

Returns The desired GCFS config for the cluster.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_identity_service_config ⇒ ::Google::Cloud::Container::V1::IdentityServiceConfig

Returns The desired Identity Service component configuration.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_image_type ⇒ ::String

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



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_intra_node_visibility_config ⇒ ::Google::Cloud::Container::V1::IntraNodeVisibilityConfig

Returns The desired config of Intra-node visibility.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_l4ilb_subsetting_config ⇒ ::Google::Cloud::Container::V1::ILBSubsettingConfig

Returns The desired L4 Internal Load Balancer Subsetting configuration.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_locations ⇒ ::Array<::String>

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



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_logging_config ⇒ ::Google::Cloud::Container::V1::LoggingConfig

Returns The desired logging configuration.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_logging_service ⇒ ::String

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



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_master_authorized_networks_config ⇒ ::Google::Cloud::Container::V1::MasterAuthorizedNetworksConfig

Returns The desired configuration options for master authorized networks feature.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_master_version ⇒ ::String

Returns 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


1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_mesh_certificates ⇒ ::Google::Cloud::Container::V1::MeshCertificates

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

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_monitoring_config ⇒ ::Google::Cloud::Container::V1::MonitoringConfig

Returns The desired monitoring configuration.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_monitoring_service ⇒ ::String

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



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_node_pool_auto_config_network_tags ⇒ ::Google::Cloud::Container::V1::NetworkTags

Returns The desired network tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_node_pool_autoscaling ⇒ ::Google::Cloud::Container::V1::NodePoolAutoscaling

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



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_node_pool_id ⇒ ::String

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



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_node_pool_logging_config ⇒ ::Google::Cloud::Container::V1::NodePoolLoggingConfig

Returns The desired node pool logging configuration defaults for the cluster.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_node_version ⇒ ::String

Returns 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


1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_notification_config ⇒ ::Google::Cloud::Container::V1::NotificationConfig

Returns The desired notification configuration.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_private_cluster_config ⇒ ::Google::Cloud::Container::V1::PrivateClusterConfig

Returns The desired private cluster configuration.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_private_ipv6_google_access ⇒ ::Google::Cloud::Container::V1::PrivateIPv6GoogleAccess

Returns The desired state of IPv6 connectivity to Google Services.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_release_channel ⇒ ::Google::Cloud::Container::V1::ReleaseChannel

Returns The desired release channel configuration.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_resource_usage_export_config ⇒ ::Google::Cloud::Container::V1::ResourceUsageExportConfig

Returns The desired configuration for exporting resource usage.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_service_external_ips_config ⇒ ::Google::Cloud::Container::V1::ServiceExternalIPsConfig

Returns ServiceExternalIPsConfig specifies the config for the use of Services with ExternalIPs field.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_shielded_nodes ⇒ ::Google::Cloud::Container::V1::ShieldedNodes

Returns Configuration for Shielded Nodes.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_stack_type ⇒ ::Google::Cloud::Container::V1::StackType

Returns The desired stack type of the cluster. If a stack type is provided and does not match the current stack type of the cluster, update will attempt to change the stack type to the new type.

Returns:

  • (::Google::Cloud::Container::V1::StackType) —

    The desired stack type of the cluster. If a stack type is provided and does not match the current stack type of the cluster, update will attempt to change the stack type to the new type.



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_vertical_pod_autoscaling ⇒ ::Google::Cloud::Container::V1::VerticalPodAutoscaling

Returns Cluster-level Vertical Pod Autoscaling configuration.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#desired_workload_identity_config ⇒ ::Google::Cloud::Container::V1::WorkloadIdentityConfig

Returns Configuration for Workload Identity.

Returns:



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#etag ⇒ ::String

Returns The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned.

Returns:

  • (::String) —

    The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned.



1724
1725
1726
1727
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1724

class ClusterUpdate
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end