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
- (::Google::Cloud::Container::V1::AddonsConfig) — Configurations for the various addons available to run in the cluster.
#desired_addons_config=
def desired_addons_config=(value) -> ::Google::Cloud::Container::V1::AddonsConfig
- value (::Google::Cloud::Container::V1::AddonsConfig) — Configurations for the various addons available to run in the cluster.
- (::Google::Cloud::Container::V1::AddonsConfig) — Configurations for the various addons available to run in the cluster.
#desired_authenticator_groups_config
def desired_authenticator_groups_config() -> ::Google::Cloud::Container::V1::AuthenticatorGroupsConfig
- (::Google::Cloud::Container::V1::AuthenticatorGroupsConfig) — The desired authenticator groups config for the cluster.
#desired_authenticator_groups_config=
def desired_authenticator_groups_config=(value) -> ::Google::Cloud::Container::V1::AuthenticatorGroupsConfig
- value (::Google::Cloud::Container::V1::AuthenticatorGroupsConfig) — The desired authenticator groups config for the cluster.
- (::Google::Cloud::Container::V1::AuthenticatorGroupsConfig) — The desired authenticator groups config for the cluster.
#desired_binary_authorization
def desired_binary_authorization() -> ::Google::Cloud::Container::V1::BinaryAuthorization
- (::Google::Cloud::Container::V1::BinaryAuthorization) — The desired configuration options for the Binary Authorization feature.
#desired_binary_authorization=
def desired_binary_authorization=(value) -> ::Google::Cloud::Container::V1::BinaryAuthorization
- value (::Google::Cloud::Container::V1::BinaryAuthorization) — The desired configuration options for the Binary Authorization feature.
- (::Google::Cloud::Container::V1::BinaryAuthorization) — The desired configuration options for the Binary Authorization feature.
#desired_cluster_autoscaling
def desired_cluster_autoscaling() -> ::Google::Cloud::Container::V1::ClusterAutoscaling
- (::Google::Cloud::Container::V1::ClusterAutoscaling) — Cluster-level autoscaling configuration.
#desired_cluster_autoscaling=
def desired_cluster_autoscaling=(value) -> ::Google::Cloud::Container::V1::ClusterAutoscaling
- value (::Google::Cloud::Container::V1::ClusterAutoscaling) — Cluster-level autoscaling configuration.
- (::Google::Cloud::Container::V1::ClusterAutoscaling) — Cluster-level autoscaling configuration.
#desired_database_encryption
def desired_database_encryption() -> ::Google::Cloud::Container::V1::DatabaseEncryption
- (::Google::Cloud::Container::V1::DatabaseEncryption) — Configuration of etcd encryption.
#desired_database_encryption=
def desired_database_encryption=(value) -> ::Google::Cloud::Container::V1::DatabaseEncryption
- value (::Google::Cloud::Container::V1::DatabaseEncryption) — Configuration of etcd encryption.
- (::Google::Cloud::Container::V1::DatabaseEncryption) — Configuration of etcd encryption.
#desired_datapath_provider
def desired_datapath_provider() -> ::Google::Cloud::Container::V1::DatapathProvider
- (::Google::Cloud::Container::V1::DatapathProvider) — The desired datapath provider for the cluster.
#desired_datapath_provider=
def desired_datapath_provider=(value) -> ::Google::Cloud::Container::V1::DatapathProvider
- value (::Google::Cloud::Container::V1::DatapathProvider) — The desired datapath provider for the cluster.
- (::Google::Cloud::Container::V1::DatapathProvider) — The desired datapath provider for the cluster.
#desired_default_snat_status
def desired_default_snat_status() -> ::Google::Cloud::Container::V1::DefaultSnatStatus
- (::Google::Cloud::Container::V1::DefaultSnatStatus) — The desired status of whether to disable default sNAT for this cluster.
#desired_default_snat_status=
def desired_default_snat_status=(value) -> ::Google::Cloud::Container::V1::DefaultSnatStatus
- value (::Google::Cloud::Container::V1::DefaultSnatStatus) — The desired status of whether to disable default sNAT for this cluster.
- (::Google::Cloud::Container::V1::DefaultSnatStatus) — The desired status of whether to disable default sNAT for this cluster.
#desired_dns_config
def desired_dns_config() -> ::Google::Cloud::Container::V1::DNSConfig
- (::Google::Cloud::Container::V1::DNSConfig) — DNSConfig contains clusterDNS config for this cluster.
#desired_dns_config=
def desired_dns_config=(value) -> ::Google::Cloud::Container::V1::DNSConfig
- value (::Google::Cloud::Container::V1::DNSConfig) — DNSConfig contains clusterDNS config for this cluster.
- (::Google::Cloud::Container::V1::DNSConfig) — DNSConfig contains clusterDNS config for this cluster.
#desired_gcfs_config
def desired_gcfs_config() -> ::Google::Cloud::Container::V1::GcfsConfig
- (::Google::Cloud::Container::V1::GcfsConfig) — The desired GCFS config for the cluster
#desired_gcfs_config=
def desired_gcfs_config=(value) -> ::Google::Cloud::Container::V1::GcfsConfig
- value (::Google::Cloud::Container::V1::GcfsConfig) — The desired GCFS config for the cluster
- (::Google::Cloud::Container::V1::GcfsConfig) — The desired GCFS config for the cluster
#desired_image_type
def desired_image_type() -> ::String
- (::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
- value (::String) — The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.
- (::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
- (::Google::Cloud::Container::V1::IntraNodeVisibilityConfig) — The desired config of Intra-node visibility.
#desired_intra_node_visibility_config=
def desired_intra_node_visibility_config=(value) -> ::Google::Cloud::Container::V1::IntraNodeVisibilityConfig
- value (::Google::Cloud::Container::V1::IntraNodeVisibilityConfig) — The desired config of Intra-node visibility.
- (::Google::Cloud::Container::V1::IntraNodeVisibilityConfig) — The desired config of Intra-node visibility.
#desired_l4ilb_subsetting_config
def desired_l4ilb_subsetting_config() -> ::Google::Cloud::Container::V1::ILBSubsettingConfig
- (::Google::Cloud::Container::V1::ILBSubsettingConfig) — The desired L4 Internal Load Balancer Subsetting configuration.
#desired_l4ilb_subsetting_config=
def desired_l4ilb_subsetting_config=(value) -> ::Google::Cloud::Container::V1::ILBSubsettingConfig
- value (::Google::Cloud::Container::V1::ILBSubsettingConfig) — The desired L4 Internal Load Balancer Subsetting configuration.
- (::Google::Cloud::Container::V1::ILBSubsettingConfig) — The desired L4 Internal Load Balancer Subsetting configuration.
#desired_locations
def desired_locations() -> ::Array<::String>
-
(::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>
-
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.
-
(::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
- (::Google::Cloud::Container::V1::LoggingConfig) — The desired logging configuration.
#desired_logging_config=
def desired_logging_config=(value) -> ::Google::Cloud::Container::V1::LoggingConfig
- value (::Google::Cloud::Container::V1::LoggingConfig) — The desired logging configuration.
- (::Google::Cloud::Container::V1::LoggingConfig) — The desired logging configuration.
#desired_logging_service
def desired_logging_service() -> ::String
-
(::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 modellogging.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+ orlogging.googleapis.com
for earlier versions.
#desired_logging_service=
def desired_logging_service=(value) -> ::String
-
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 modellogging.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+ orlogging.googleapis.com
for earlier versions.
-
(::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 modellogging.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+ orlogging.googleapis.com
for earlier versions.
#desired_master_authorized_networks_config
def desired_master_authorized_networks_config() -> ::Google::Cloud::Container::V1::MasterAuthorizedNetworksConfig
- (::Google::Cloud::Container::V1::MasterAuthorizedNetworksConfig) — The desired configuration options for master authorized networks feature.
#desired_master_authorized_networks_config=
def desired_master_authorized_networks_config=(value) -> ::Google::Cloud::Container::V1::MasterAuthorizedNetworksConfig
- value (::Google::Cloud::Container::V1::MasterAuthorizedNetworksConfig) — The desired configuration options for master authorized networks feature.
- (::Google::Cloud::Container::V1::MasterAuthorizedNetworksConfig) — The desired configuration options for master authorized networks feature.
#desired_master_version
def desired_master_version() -> ::String
-
(::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
-
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
-
(::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
- (::Google::Cloud::Container::V1::MeshCertificates) — Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
#desired_mesh_certificates=
def desired_mesh_certificates=(value) -> ::Google::Cloud::Container::V1::MeshCertificates
- value (::Google::Cloud::Container::V1::MeshCertificates) — Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
- (::Google::Cloud::Container::V1::MeshCertificates) — Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
#desired_monitoring_config
def desired_monitoring_config() -> ::Google::Cloud::Container::V1::MonitoringConfig
- (::Google::Cloud::Container::V1::MonitoringConfig) — The desired monitoring configuration.
#desired_monitoring_config=
def desired_monitoring_config=(value) -> ::Google::Cloud::Container::V1::MonitoringConfig
- value (::Google::Cloud::Container::V1::MonitoringConfig) — The desired monitoring configuration.
- (::Google::Cloud::Container::V1::MonitoringConfig) — The desired monitoring configuration.
#desired_monitoring_service
def desired_monitoring_service() -> ::String
-
(::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+ ormonitoring.googleapis.com
for earlier versions.
#desired_monitoring_service=
def desired_monitoring_service=(value) -> ::String
-
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+ ormonitoring.googleapis.com
for earlier versions.
-
(::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+ ormonitoring.googleapis.com
for earlier versions.
#desired_node_pool_autoscaling
def desired_node_pool_autoscaling() -> ::Google::Cloud::Container::V1::NodePoolAutoscaling
- (::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
- 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.
- (::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
- (::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
- 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.
- (::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
-
(::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
-
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
-
(::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
- (::Google::Cloud::Container::V1::NotificationConfig) — The desired notification configuration.
#desired_notification_config=
def desired_notification_config=(value) -> ::Google::Cloud::Container::V1::NotificationConfig
- value (::Google::Cloud::Container::V1::NotificationConfig) — The desired notification configuration.
- (::Google::Cloud::Container::V1::NotificationConfig) — The desired notification configuration.
#desired_private_cluster_config
def desired_private_cluster_config() -> ::Google::Cloud::Container::V1::PrivateClusterConfig
- (::Google::Cloud::Container::V1::PrivateClusterConfig) — The desired private cluster configuration.
#desired_private_cluster_config=
def desired_private_cluster_config=(value) -> ::Google::Cloud::Container::V1::PrivateClusterConfig
- value (::Google::Cloud::Container::V1::PrivateClusterConfig) — The desired private cluster configuration.
- (::Google::Cloud::Container::V1::PrivateClusterConfig) — The desired private cluster configuration.
#desired_private_ipv6_google_access
def desired_private_ipv6_google_access() -> ::Google::Cloud::Container::V1::PrivateIPv6GoogleAccess
- (::Google::Cloud::Container::V1::PrivateIPv6GoogleAccess) — The desired state of IPv6 connectivity to Google Services.
#desired_private_ipv6_google_access=
def desired_private_ipv6_google_access=(value) -> ::Google::Cloud::Container::V1::PrivateIPv6GoogleAccess
- value (::Google::Cloud::Container::V1::PrivateIPv6GoogleAccess) — The desired state of IPv6 connectivity to Google Services.
- (::Google::Cloud::Container::V1::PrivateIPv6GoogleAccess) — The desired state of IPv6 connectivity to Google Services.
#desired_release_channel
def desired_release_channel() -> ::Google::Cloud::Container::V1::ReleaseChannel
- (::Google::Cloud::Container::V1::ReleaseChannel) — The desired release channel configuration.
#desired_release_channel=
def desired_release_channel=(value) -> ::Google::Cloud::Container::V1::ReleaseChannel
- value (::Google::Cloud::Container::V1::ReleaseChannel) — The desired release channel configuration.
- (::Google::Cloud::Container::V1::ReleaseChannel) — The desired release channel configuration.
#desired_resource_usage_export_config
def desired_resource_usage_export_config() -> ::Google::Cloud::Container::V1::ResourceUsageExportConfig
- (::Google::Cloud::Container::V1::ResourceUsageExportConfig) — The desired configuration for exporting resource usage.
#desired_resource_usage_export_config=
def desired_resource_usage_export_config=(value) -> ::Google::Cloud::Container::V1::ResourceUsageExportConfig
- value (::Google::Cloud::Container::V1::ResourceUsageExportConfig) — The desired configuration for exporting resource usage.
- (::Google::Cloud::Container::V1::ResourceUsageExportConfig) — The desired configuration for exporting resource usage.
#desired_service_external_ips_config
def desired_service_external_ips_config() -> ::Google::Cloud::Container::V1::ServiceExternalIPsConfig
- (::Google::Cloud::Container::V1::ServiceExternalIPsConfig) — ServiceExternalIPsConfig specifies the config for the use of Services with ExternalIPs field.
#desired_service_external_ips_config=
def desired_service_external_ips_config=(value) -> ::Google::Cloud::Container::V1::ServiceExternalIPsConfig
- value (::Google::Cloud::Container::V1::ServiceExternalIPsConfig) — ServiceExternalIPsConfig specifies the config for the use of Services with ExternalIPs field.
- (::Google::Cloud::Container::V1::ServiceExternalIPsConfig) — ServiceExternalIPsConfig specifies the config for the use of Services with ExternalIPs field.
#desired_shielded_nodes
def desired_shielded_nodes() -> ::Google::Cloud::Container::V1::ShieldedNodes
- (::Google::Cloud::Container::V1::ShieldedNodes) — Configuration for Shielded Nodes.
#desired_shielded_nodes=
def desired_shielded_nodes=(value) -> ::Google::Cloud::Container::V1::ShieldedNodes
- value (::Google::Cloud::Container::V1::ShieldedNodes) — Configuration for Shielded Nodes.
- (::Google::Cloud::Container::V1::ShieldedNodes) — Configuration for Shielded Nodes.
#desired_vertical_pod_autoscaling
def desired_vertical_pod_autoscaling() -> ::Google::Cloud::Container::V1::VerticalPodAutoscaling
- (::Google::Cloud::Container::V1::VerticalPodAutoscaling) — Cluster-level Vertical Pod Autoscaling configuration.
#desired_vertical_pod_autoscaling=
def desired_vertical_pod_autoscaling=(value) -> ::Google::Cloud::Container::V1::VerticalPodAutoscaling
- value (::Google::Cloud::Container::V1::VerticalPodAutoscaling) — Cluster-level Vertical Pod Autoscaling configuration.
- (::Google::Cloud::Container::V1::VerticalPodAutoscaling) — Cluster-level Vertical Pod Autoscaling configuration.
#desired_workload_identity_config
def desired_workload_identity_config() -> ::Google::Cloud::Container::V1::WorkloadIdentityConfig
- (::Google::Cloud::Container::V1::WorkloadIdentityConfig) — Configuration for Workload Identity.
#desired_workload_identity_config=
def desired_workload_identity_config=(value) -> ::Google::Cloud::Container::V1::WorkloadIdentityConfig
- value (::Google::Cloud::Container::V1::WorkloadIdentityConfig) — Configuration for Workload Identity.
- (::Google::Cloud::Container::V1::WorkloadIdentityConfig) — Configuration for Workload Identity.