#include <cluster_update.h>
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.
◆ ClusterUpdate() [1/2]
google_container_api::ClusterUpdate::ClusterUpdate |
( |
const Json::Value & |
storage | ) |
|
|
explicit |
Standard constructor for an immutable data object instance.
- Parameters
-
[in] | storage | The underlying data storage for this instance. |
◆ ClusterUpdate() [2/2]
google_container_api::ClusterUpdate::ClusterUpdate |
( |
Json::Value * |
storage | ) |
|
|
explicit |
Standard constructor for a mutable data object instance.
- Parameters
-
[in] | storage | The underlying data storage for this instance. |
◆ ~ClusterUpdate()
google_container_api::ClusterUpdate::~ClusterUpdate |
( |
| ) |
|
|
virtual |
◆ clear_desired_addons_config()
void google_container_api::ClusterUpdate::clear_desired_addons_config |
( |
| ) |
|
|
inline |
Clears the 'desiredAddonsConfig
' attribute.
◆ clear_desired_binary_authorization()
void google_container_api::ClusterUpdate::clear_desired_binary_authorization |
( |
| ) |
|
|
inline |
Clears the 'desiredBinaryAuthorization
' attribute.
◆ clear_desired_cluster_autoscaling()
void google_container_api::ClusterUpdate::clear_desired_cluster_autoscaling |
( |
| ) |
|
|
inline |
Clears the 'desiredClusterAutoscaling
' attribute.
◆ clear_desired_database_encryption()
void google_container_api::ClusterUpdate::clear_desired_database_encryption |
( |
| ) |
|
|
inline |
Clears the 'desiredDatabaseEncryption
' attribute.
◆ clear_desired_image_type()
void google_container_api::ClusterUpdate::clear_desired_image_type |
( |
| ) |
|
|
inline |
Clears the 'desiredImageType
' attribute.
◆ clear_desired_intra_node_visibility_config()
void google_container_api::ClusterUpdate::clear_desired_intra_node_visibility_config |
( |
| ) |
|
|
inline |
Clears the 'desiredIntraNodeVisibilityConfig
' attribute.
◆ clear_desired_locations()
void google_container_api::ClusterUpdate::clear_desired_locations |
( |
| ) |
|
|
inline |
Clears the 'desiredLocations
' attribute.
◆ clear_desired_logging_service()
void google_container_api::ClusterUpdate::clear_desired_logging_service |
( |
| ) |
|
|
inline |
Clears the 'desiredLoggingService
' attribute.
◆ clear_desired_master_authorized_networks_config()
void google_container_api::ClusterUpdate::clear_desired_master_authorized_networks_config |
( |
| ) |
|
|
inline |
Clears the 'desiredMasterAuthorizedNetworksConfig
' attribute.
◆ clear_desired_master_version()
void google_container_api::ClusterUpdate::clear_desired_master_version |
( |
| ) |
|
|
inline |
Clears the 'desiredMasterVersion
' attribute.
◆ clear_desired_monitoring_service()
void google_container_api::ClusterUpdate::clear_desired_monitoring_service |
( |
| ) |
|
|
inline |
Clears the 'desiredMonitoringService
' attribute.
◆ clear_desired_node_pool_autoscaling()
void google_container_api::ClusterUpdate::clear_desired_node_pool_autoscaling |
( |
| ) |
|
|
inline |
Clears the 'desiredNodePoolAutoscaling
' attribute.
◆ clear_desired_node_pool_id()
void google_container_api::ClusterUpdate::clear_desired_node_pool_id |
( |
| ) |
|
|
inline |
Clears the 'desiredNodePoolId
' attribute.
◆ clear_desired_node_version()
void google_container_api::ClusterUpdate::clear_desired_node_version |
( |
| ) |
|
|
inline |
Clears the 'desiredNodeVersion
' attribute.
◆ clear_desired_resource_usage_export_config()
void google_container_api::ClusterUpdate::clear_desired_resource_usage_export_config |
( |
| ) |
|
|
inline |
Clears the 'desiredResourceUsageExportConfig
' attribute.
◆ clear_desired_shielded_nodes()
void google_container_api::ClusterUpdate::clear_desired_shielded_nodes |
( |
| ) |
|
|
inline |
Clears the 'desiredShieldedNodes
' attribute.
◆ clear_desired_vertical_pod_autoscaling()
void google_container_api::ClusterUpdate::clear_desired_vertical_pod_autoscaling |
( |
| ) |
|
|
inline |
Clears the 'desiredVerticalPodAutoscaling
' attribute.
◆ clear_desired_workload_identity_config()
void google_container_api::ClusterUpdate::clear_desired_workload_identity_config |
( |
| ) |
|
|
inline |
Clears the 'desiredWorkloadIdentityConfig
' attribute.
◆ get_desired_addons_config()
const AddonsConfig google_container_api::ClusterUpdate::get_desired_addons_config |
( |
| ) |
const |
Get a reference to the value of the 'desiredAddonsConfig
' attribute.
◆ get_desired_binary_authorization()
const BinaryAuthorization google_container_api::ClusterUpdate::get_desired_binary_authorization |
( |
| ) |
const |
Get a reference to the value of the 'desiredBinaryAuthorization
' attribute.
◆ get_desired_cluster_autoscaling()
const ClusterAutoscaling google_container_api::ClusterUpdate::get_desired_cluster_autoscaling |
( |
| ) |
const |
Get a reference to the value of the 'desiredClusterAutoscaling
' attribute.
◆ get_desired_database_encryption()
const DatabaseEncryption google_container_api::ClusterUpdate::get_desired_database_encryption |
( |
| ) |
const |
Get a reference to the value of the 'desiredDatabaseEncryption
' attribute.
◆ get_desired_image_type()
const StringPiece google_container_api::ClusterUpdate::get_desired_image_type |
( |
| ) |
const |
|
inline |
Get the value of the 'desiredImageType
' attribute.
◆ get_desired_intra_node_visibility_config()
Get a reference to the value of the 'desiredIntraNodeVisibilityConfig
' attribute.
◆ get_desired_locations()
const client::JsonCppArray<string > google_container_api::ClusterUpdate::get_desired_locations |
( |
| ) |
const |
|
inline |
Get a reference to the value of the 'desiredLocations
' attribute.
◆ get_desired_logging_service()
const StringPiece google_container_api::ClusterUpdate::get_desired_logging_service |
( |
| ) |
const |
|
inline |
Get the value of the 'desiredLoggingService
' attribute.
◆ get_desired_master_authorized_networks_config()
Get a reference to the value of the 'desiredMasterAuthorizedNetworksConfig
' attribute.
◆ get_desired_master_version()
const StringPiece google_container_api::ClusterUpdate::get_desired_master_version |
( |
| ) |
const |
|
inline |
Get the value of the 'desiredMasterVersion
' attribute.
◆ get_desired_monitoring_service()
const StringPiece google_container_api::ClusterUpdate::get_desired_monitoring_service |
( |
| ) |
const |
|
inline |
Get the value of the 'desiredMonitoringService
' attribute.
◆ get_desired_node_pool_autoscaling()
const NodePoolAutoscaling google_container_api::ClusterUpdate::get_desired_node_pool_autoscaling |
( |
| ) |
const |
Get a reference to the value of the 'desiredNodePoolAutoscaling
' attribute.
◆ get_desired_node_pool_id()
const StringPiece google_container_api::ClusterUpdate::get_desired_node_pool_id |
( |
| ) |
const |
|
inline |
Get the value of the 'desiredNodePoolId
' attribute.
◆ get_desired_node_version()
const StringPiece google_container_api::ClusterUpdate::get_desired_node_version |
( |
| ) |
const |
|
inline |
Get the value of the 'desiredNodeVersion
' attribute.
◆ get_desired_resource_usage_export_config()
Get a reference to the value of the 'desiredResourceUsageExportConfig
' attribute.
◆ get_desired_shielded_nodes()
const ShieldedNodes google_container_api::ClusterUpdate::get_desired_shielded_nodes |
( |
| ) |
const |
Get a reference to the value of the 'desiredShieldedNodes
' attribute.
◆ get_desired_vertical_pod_autoscaling()
const VerticalPodAutoscaling google_container_api::ClusterUpdate::get_desired_vertical_pod_autoscaling |
( |
| ) |
const |
Get a reference to the value of the 'desiredVerticalPodAutoscaling
' attribute.
◆ get_desired_workload_identity_config()
const WorkloadIdentityConfig google_container_api::ClusterUpdate::get_desired_workload_identity_config |
( |
| ) |
const |
Get a reference to the value of the 'desiredWorkloadIdentityConfig
' attribute.
◆ GetTypeName()
const StringPiece google_container_api::ClusterUpdate::GetTypeName |
( |
| ) |
const |
|
inline |
◆ has_desired_addons_config()
bool google_container_api::ClusterUpdate::has_desired_addons_config |
( |
| ) |
const |
|
inline |
Determine if the 'desiredAddonsConfig
' attribute was set.
- Returns
- true if the '
desiredAddonsConfig
' attribute was set.
◆ has_desired_binary_authorization()
bool google_container_api::ClusterUpdate::has_desired_binary_authorization |
( |
| ) |
const |
|
inline |
Determine if the 'desiredBinaryAuthorization
' attribute was set.
- Returns
- true if the '
desiredBinaryAuthorization
' attribute was set.
◆ has_desired_cluster_autoscaling()
bool google_container_api::ClusterUpdate::has_desired_cluster_autoscaling |
( |
| ) |
const |
|
inline |
Determine if the 'desiredClusterAutoscaling
' attribute was set.
- Returns
- true if the '
desiredClusterAutoscaling
' attribute was set.
◆ has_desired_database_encryption()
bool google_container_api::ClusterUpdate::has_desired_database_encryption |
( |
| ) |
const |
|
inline |
Determine if the 'desiredDatabaseEncryption
' attribute was set.
- Returns
- true if the '
desiredDatabaseEncryption
' attribute was set.
◆ has_desired_image_type()
bool google_container_api::ClusterUpdate::has_desired_image_type |
( |
| ) |
const |
|
inline |
Determine if the 'desiredImageType
' attribute was set.
- Returns
- true if the '
desiredImageType
' attribute was set.
◆ has_desired_intra_node_visibility_config()
bool google_container_api::ClusterUpdate::has_desired_intra_node_visibility_config |
( |
| ) |
const |
|
inline |
Determine if the 'desiredIntraNodeVisibilityConfig
' attribute was set.
- Returns
- true if the '
desiredIntraNodeVisibilityConfig
' attribute was set.
◆ has_desired_locations()
bool google_container_api::ClusterUpdate::has_desired_locations |
( |
| ) |
const |
|
inline |
Determine if the 'desiredLocations
' attribute was set.
- Returns
- true if the '
desiredLocations
' attribute was set.
◆ has_desired_logging_service()
bool google_container_api::ClusterUpdate::has_desired_logging_service |
( |
| ) |
const |
|
inline |
Determine if the 'desiredLoggingService
' attribute was set.
- Returns
- true if the '
desiredLoggingService
' attribute was set.
◆ has_desired_master_authorized_networks_config()
bool google_container_api::ClusterUpdate::has_desired_master_authorized_networks_config |
( |
| ) |
const |
|
inline |
Determine if the 'desiredMasterAuthorizedNetworksConfig
' attribute was set.
- Returns
- true if the '
desiredMasterAuthorizedNetworksConfig
' attribute was set.
◆ has_desired_master_version()
bool google_container_api::ClusterUpdate::has_desired_master_version |
( |
| ) |
const |
|
inline |
Determine if the 'desiredMasterVersion
' attribute was set.
- Returns
- true if the '
desiredMasterVersion
' attribute was set.
◆ has_desired_monitoring_service()
bool google_container_api::ClusterUpdate::has_desired_monitoring_service |
( |
| ) |
const |
|
inline |
Determine if the 'desiredMonitoringService
' attribute was set.
- Returns
- true if the '
desiredMonitoringService
' attribute was set.
◆ has_desired_node_pool_autoscaling()
bool google_container_api::ClusterUpdate::has_desired_node_pool_autoscaling |
( |
| ) |
const |
|
inline |
Determine if the 'desiredNodePoolAutoscaling
' attribute was set.
- Returns
- true if the '
desiredNodePoolAutoscaling
' attribute was set.
◆ has_desired_node_pool_id()
bool google_container_api::ClusterUpdate::has_desired_node_pool_id |
( |
| ) |
const |
|
inline |
Determine if the 'desiredNodePoolId
' attribute was set.
- Returns
- true if the '
desiredNodePoolId
' attribute was set.
◆ has_desired_node_version()
bool google_container_api::ClusterUpdate::has_desired_node_version |
( |
| ) |
const |
|
inline |
Determine if the 'desiredNodeVersion
' attribute was set.
- Returns
- true if the '
desiredNodeVersion
' attribute was set.
◆ has_desired_resource_usage_export_config()
bool google_container_api::ClusterUpdate::has_desired_resource_usage_export_config |
( |
| ) |
const |
|
inline |
Determine if the 'desiredResourceUsageExportConfig
' attribute was set.
- Returns
- true if the '
desiredResourceUsageExportConfig
' attribute was set.
◆ has_desired_shielded_nodes()
bool google_container_api::ClusterUpdate::has_desired_shielded_nodes |
( |
| ) |
const |
|
inline |
Determine if the 'desiredShieldedNodes
' attribute was set.
- Returns
- true if the '
desiredShieldedNodes
' attribute was set.
◆ has_desired_vertical_pod_autoscaling()
bool google_container_api::ClusterUpdate::has_desired_vertical_pod_autoscaling |
( |
| ) |
const |
|
inline |
Determine if the 'desiredVerticalPodAutoscaling
' attribute was set.
- Returns
- true if the '
desiredVerticalPodAutoscaling
' attribute was set.
◆ has_desired_workload_identity_config()
bool google_container_api::ClusterUpdate::has_desired_workload_identity_config |
( |
| ) |
const |
|
inline |
Determine if the 'desiredWorkloadIdentityConfig
' attribute was set.
- Returns
- true if the '
desiredWorkloadIdentityConfig
' attribute was set.
◆ mutable_desiredAddonsConfig()
AddonsConfig google_container_api::ClusterUpdate::mutable_desiredAddonsConfig |
( |
| ) |
|
Gets a reference to a mutable value of the 'desiredAddonsConfig
' property.
Configurations for the various addons available to run in the cluster.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_desiredBinaryAuthorization()
BinaryAuthorization google_container_api::ClusterUpdate::mutable_desiredBinaryAuthorization |
( |
| ) |
|
Gets a reference to a mutable value of the 'desiredBinaryAuthorization
' property.
The desired configuration options for the Binary Authorization feature.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_desiredClusterAutoscaling()
ClusterAutoscaling google_container_api::ClusterUpdate::mutable_desiredClusterAutoscaling |
( |
| ) |
|
Gets a reference to a mutable value of the 'desiredClusterAutoscaling
' property.
Cluster-level autoscaling configuration.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_desiredDatabaseEncryption()
DatabaseEncryption google_container_api::ClusterUpdate::mutable_desiredDatabaseEncryption |
( |
| ) |
|
Gets a reference to a mutable value of the 'desiredDatabaseEncryption
' property.
Configuration of etcd encryption.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_desiredIntraNodeVisibilityConfig()
Gets a reference to a mutable value of the 'desiredIntraNodeVisibilityConfig
' property.
The desired config of Intra-node visibility.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_desiredLocations()
client::JsonCppArray<string > google_container_api::ClusterUpdate::mutable_desiredLocations |
( |
| ) |
|
|
inline |
Gets a reference to a mutable value of the 'desiredLocations
' property.
The desired list of Google Compute Engine zones in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed.
This list must always include the cluster's primary zone.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_desiredMasterAuthorizedNetworksConfig()
Gets a reference to a mutable value of the 'desiredMasterAuthorizedNetworksConfig
' property.
The desired configuration options for master authorized networks feature.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_desiredNodePoolAutoscaling()
NodePoolAutoscaling google_container_api::ClusterUpdate::mutable_desiredNodePoolAutoscaling |
( |
| ) |
|
Gets a reference to a mutable value of the 'desiredNodePoolAutoscaling
' property.
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
- The result can be modified to change the attribute value.
◆ mutable_desiredResourceUsageExportConfig()
Gets a reference to a mutable value of the 'desiredResourceUsageExportConfig
' property.
The desired configuration for exporting resource usage.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_desiredShieldedNodes()
ShieldedNodes google_container_api::ClusterUpdate::mutable_desiredShieldedNodes |
( |
| ) |
|
Gets a reference to a mutable value of the 'desiredShieldedNodes
' property.
Configuration for Shielded Nodes.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_desiredVerticalPodAutoscaling()
Gets a reference to a mutable value of the 'desiredVerticalPodAutoscaling
' property.
Cluster-level Vertical Pod Autoscaling configuration.
- Returns
- The result can be modified to change the attribute value.
◆ mutable_desiredWorkloadIdentityConfig()
Gets a reference to a mutable value of the 'desiredWorkloadIdentityConfig
' property.
Configuration for Workload Identity.
- Returns
- The result can be modified to change the attribute value.
◆ New()
Creates a new default instance.
- Returns
- Ownership is passed back to the caller.
◆ set_desired_image_type()
void google_container_api::ClusterUpdate::set_desired_image_type |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'desiredImageType
' attribute.
The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.
- Parameters
-
◆ set_desired_logging_service()
void google_container_api::ClusterUpdate::set_desired_logging_service |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'desiredLoggingService
' attribute.
The logging service the cluster should use to write logs. Currently available options:
- "logging.googleapis.com/kubernetes" - the Google Cloud Logging service with Kubernetes-native resource model
- "logging.googleapis.com" - the Google Cloud Logging service
- "none" - no logs will be exported from the cluster.
- Parameters
-
◆ set_desired_master_version()
void google_container_api::ClusterUpdate::set_desired_master_version |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'desiredMasterVersion
' attribute.
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.
- Parameters
-
◆ set_desired_monitoring_service()
void google_container_api::ClusterUpdate::set_desired_monitoring_service |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'desiredMonitoringService
' attribute.
The monitoring service the cluster should use to write metrics. Currently available options:
- "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring service with Kubernetes-native resource model
- "monitoring.googleapis.com" - the Google Cloud Monitoring service
- "none" - no metrics will be exported from the cluster.
- Parameters
-
◆ set_desired_node_pool_id()
void google_container_api::ClusterUpdate::set_desired_node_pool_id |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'desiredNodePoolId
' attribute.
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.
- Parameters
-
◆ set_desired_node_version()
void google_container_api::ClusterUpdate::set_desired_node_version |
( |
const StringPiece & |
value | ) |
|
|
inline |
Change the 'desiredNodeVersion
' attribute.
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.
- Parameters
-
The documentation for this class was generated from the following files: