com.google.api.services.container.model

Class ClusterUpdate

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.container.model.ClusterUpdate

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ClusterUpdate
extends GenericJson

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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Kubernetes Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ClusterUpdate()

Method Summary

Modifier and Type	Method and Description
ClusterUpdate	clone()
AddonsConfig	getDesiredAddonsConfig() Configurations for the various addons available to run in the cluster.
BinaryAuthorization	getDesiredBinaryAuthorization() The desired configuration options for the Binary Authorization feature.
ClusterAutoscaling	getDesiredClusterAutoscaling() Cluster-level autoscaling configuration.
DatabaseEncryption	getDesiredDatabaseEncryption() Configuration of etcd encryption.
String	getDesiredImageType() The desired image type for the node pool.
IntraNodeVisibilityConfig	getDesiredIntraNodeVisibilityConfig() The desired config of Intra-node visibility.
List<String>	getDesiredLocations() The desired list of Google Compute Engine [zones](/compute/docs/zones#available) in which the cluster's nodes should be located.
String	getDesiredLoggingService() The logging service the cluster should use to write logs.
MasterAuthorizedNetworksConfig	getDesiredMasterAuthorizedNetworksConfig() The desired configuration options for master authorized networks feature.
String	getDesiredMasterVersion() The Kubernetes version to change the master to.
String	getDesiredMonitoringService() The monitoring service the cluster should use to write metrics.
NodePoolAutoscaling	getDesiredNodePoolAutoscaling() Autoscaler configuration for the node pool specified in desired_node_pool_id.
String	getDesiredNodePoolId() The node pool to be upgraded.
String	getDesiredNodeVersion() The Kubernetes version to change the nodes to (typically an upgrade).
ResourceUsageExportConfig	getDesiredResourceUsageExportConfig() The desired configuration for exporting resource usage.
ShieldedNodes	getDesiredShieldedNodes() Configuration for Shielded Nodes.
VerticalPodAutoscaling	getDesiredVerticalPodAutoscaling() Cluster-level Vertical Pod Autoscaling configuration.
WorkloadIdentityConfig	getDesiredWorkloadIdentityConfig() Configuration for Workload Identity.
ClusterUpdate	set(String fieldName, Object value)
ClusterUpdate	setDesiredAddonsConfig(AddonsConfig desiredAddonsConfig) Configurations for the various addons available to run in the cluster.
ClusterUpdate	setDesiredBinaryAuthorization(BinaryAuthorization desiredBinaryAuthorization) The desired configuration options for the Binary Authorization feature.
ClusterUpdate	setDesiredClusterAutoscaling(ClusterAutoscaling desiredClusterAutoscaling) Cluster-level autoscaling configuration.
ClusterUpdate	setDesiredDatabaseEncryption(DatabaseEncryption desiredDatabaseEncryption) Configuration of etcd encryption.
ClusterUpdate	setDesiredImageType(String desiredImageType) The desired image type for the node pool.
ClusterUpdate	setDesiredIntraNodeVisibilityConfig(IntraNodeVisibilityConfig desiredIntraNodeVisibilityConfig) The desired config of Intra-node visibility.
ClusterUpdate	setDesiredLocations(List<String> desiredLocations) The desired list of Google Compute Engine [zones](/compute/docs/zones#available) in which the cluster's nodes should be located.
ClusterUpdate	setDesiredLoggingService(String desiredLoggingService) The logging service the cluster should use to write logs.
ClusterUpdate	setDesiredMasterAuthorizedNetworksConfig(MasterAuthorizedNetworksConfig desiredMasterAuthorizedNetworksConfig) The desired configuration options for master authorized networks feature.
ClusterUpdate	setDesiredMasterVersion(String desiredMasterVersion) The Kubernetes version to change the master to.
ClusterUpdate	setDesiredMonitoringService(String desiredMonitoringService) The monitoring service the cluster should use to write metrics.
ClusterUpdate	setDesiredNodePoolAutoscaling(NodePoolAutoscaling desiredNodePoolAutoscaling) Autoscaler configuration for the node pool specified in desired_node_pool_id.
ClusterUpdate	setDesiredNodePoolId(String desiredNodePoolId) The node pool to be upgraded.
ClusterUpdate	setDesiredNodeVersion(String desiredNodeVersion) The Kubernetes version to change the nodes to (typically an upgrade).
ClusterUpdate	setDesiredResourceUsageExportConfig(ResourceUsageExportConfig desiredResourceUsageExportConfig) The desired configuration for exporting resource usage.
ClusterUpdate	setDesiredShieldedNodes(ShieldedNodes desiredShieldedNodes) Configuration for Shielded Nodes.
ClusterUpdate	setDesiredVerticalPodAutoscaling(VerticalPodAutoscaling desiredVerticalPodAutoscaling) Cluster-level Vertical Pod Autoscaling configuration.
ClusterUpdate	setDesiredWorkloadIdentityConfig(WorkloadIdentityConfig desiredWorkloadIdentityConfig) Configuration for Workload Identity.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ClusterUpdate

public ClusterUpdate()

Method Detail

getDesiredAddonsConfig

public AddonsConfig getDesiredAddonsConfig()

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

Returns:

value or null for none

setDesiredAddonsConfig

public ClusterUpdate setDesiredAddonsConfig(AddonsConfig desiredAddonsConfig)

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

Parameters:

desiredAddonsConfig - desiredAddonsConfig or null for none

getDesiredBinaryAuthorization

public BinaryAuthorization getDesiredBinaryAuthorization()

The desired configuration options for the Binary Authorization feature.

Returns:

value or null for none

setDesiredBinaryAuthorization

public ClusterUpdate setDesiredBinaryAuthorization(BinaryAuthorization desiredBinaryAuthorization)

The desired configuration options for the Binary Authorization feature.

Parameters:

desiredBinaryAuthorization - desiredBinaryAuthorization or null for none

getDesiredClusterAutoscaling

public ClusterAutoscaling getDesiredClusterAutoscaling()

Cluster-level autoscaling configuration.

Returns:

value or null for none

setDesiredClusterAutoscaling

public ClusterUpdate setDesiredClusterAutoscaling(ClusterAutoscaling desiredClusterAutoscaling)

Cluster-level autoscaling configuration.

Parameters:

desiredClusterAutoscaling - desiredClusterAutoscaling or null for none

getDesiredDatabaseEncryption

public DatabaseEncryption getDesiredDatabaseEncryption()

Configuration of etcd encryption.

Returns:

value or null for none

setDesiredDatabaseEncryption

public ClusterUpdate setDesiredDatabaseEncryption(DatabaseEncryption desiredDatabaseEncryption)

Configuration of etcd encryption.

Parameters:

desiredDatabaseEncryption - desiredDatabaseEncryption or null for none

getDesiredImageType

public String getDesiredImageType()

The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.

Returns:

value or null for none

setDesiredImageType

public ClusterUpdate setDesiredImageType(String desiredImageType)

The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.

Parameters:

desiredImageType - desiredImageType or null for none

getDesiredIntraNodeVisibilityConfig

public IntraNodeVisibilityConfig getDesiredIntraNodeVisibilityConfig()

The desired config of Intra-node visibility.

Returns:

value or null for none

setDesiredIntraNodeVisibilityConfig

public ClusterUpdate setDesiredIntraNodeVisibilityConfig(IntraNodeVisibilityConfig desiredIntraNodeVisibilityConfig)

The desired config of Intra-node visibility.

Parameters:

desiredIntraNodeVisibilityConfig - desiredIntraNodeVisibilityConfig or null for none

getDesiredLocations

public List<String> getDesiredLocations()

The desired list of Google Compute Engine [zones](/compute/docs/zones#available) 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:

value or null for none

setDesiredLocations

public ClusterUpdate setDesiredLocations(List<String> desiredLocations)

The desired list of Google Compute Engine [zones](/compute/docs/zones#available) 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.

Parameters:

desiredLocations - desiredLocations or null for none

getDesiredLoggingService

public String getDesiredLoggingService()

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:

value or null for none

setDesiredLoggingService

public ClusterUpdate setDesiredLoggingService(String desiredLoggingService)

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.

Parameters:

desiredLoggingService - desiredLoggingService or null for none

getDesiredMasterAuthorizedNetworksConfig

public MasterAuthorizedNetworksConfig getDesiredMasterAuthorizedNetworksConfig()

The desired configuration options for master authorized networks feature.

Returns:

value or null for none

setDesiredMasterAuthorizedNetworksConfig

public ClusterUpdate setDesiredMasterAuthorizedNetworksConfig(MasterAuthorizedNetworksConfig desiredMasterAuthorizedNetworksConfig)

The desired configuration options for master authorized networks feature.

Parameters:

desiredMasterAuthorizedNetworksConfig - desiredMasterAuthorizedNetworksConfig or null for none

getDesiredMasterVersion

public String getDesiredMasterVersion()

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:

value or null for none

setDesiredMasterVersion

public ClusterUpdate setDesiredMasterVersion(String desiredMasterVersion)

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:

desiredMasterVersion - desiredMasterVersion or null for none

getDesiredMonitoringService

public String getDesiredMonitoringService()

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:

value or null for none

setDesiredMonitoringService

public ClusterUpdate setDesiredMonitoringService(String desiredMonitoringService)

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.

Parameters:

desiredMonitoringService - desiredMonitoringService or null for none

getDesiredNodePoolAutoscaling

public NodePoolAutoscaling getDesiredNodePoolAutoscaling()

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:

value or null for none

setDesiredNodePoolAutoscaling

public ClusterUpdate setDesiredNodePoolAutoscaling(NodePoolAutoscaling desiredNodePoolAutoscaling)

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.

Parameters:

desiredNodePoolAutoscaling - desiredNodePoolAutoscaling or null for none

getDesiredNodePoolId

public String getDesiredNodePoolId()

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:

value or null for none

setDesiredNodePoolId

public ClusterUpdate setDesiredNodePoolId(String desiredNodePoolId)

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:

desiredNodePoolId - desiredNodePoolId or null for none

getDesiredNodeVersion

public String getDesiredNodeVersion()

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:

value or null for none

setDesiredNodeVersion

public ClusterUpdate setDesiredNodeVersion(String desiredNodeVersion)

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:

desiredNodeVersion - desiredNodeVersion or null for none

getDesiredResourceUsageExportConfig

public ResourceUsageExportConfig getDesiredResourceUsageExportConfig()

The desired configuration for exporting resource usage.

Returns:

value or null for none

setDesiredResourceUsageExportConfig

public ClusterUpdate setDesiredResourceUsageExportConfig(ResourceUsageExportConfig desiredResourceUsageExportConfig)

The desired configuration for exporting resource usage.

Parameters:

desiredResourceUsageExportConfig - desiredResourceUsageExportConfig or null for none

getDesiredShieldedNodes

public ShieldedNodes getDesiredShieldedNodes()

Configuration for Shielded Nodes.

Returns:

value or null for none

setDesiredShieldedNodes

public ClusterUpdate setDesiredShieldedNodes(ShieldedNodes desiredShieldedNodes)

Configuration for Shielded Nodes.

Parameters:

desiredShieldedNodes - desiredShieldedNodes or null for none

getDesiredVerticalPodAutoscaling

public VerticalPodAutoscaling getDesiredVerticalPodAutoscaling()

Cluster-level Vertical Pod Autoscaling configuration.

Returns:

value or null for none

setDesiredVerticalPodAutoscaling

public ClusterUpdate setDesiredVerticalPodAutoscaling(VerticalPodAutoscaling desiredVerticalPodAutoscaling)

Cluster-level Vertical Pod Autoscaling configuration.

Parameters:

desiredVerticalPodAutoscaling - desiredVerticalPodAutoscaling or null for none

getDesiredWorkloadIdentityConfig

public WorkloadIdentityConfig getDesiredWorkloadIdentityConfig()

Configuration for Workload Identity.

Returns:

value or null for none

setDesiredWorkloadIdentityConfig

public ClusterUpdate setDesiredWorkloadIdentityConfig(WorkloadIdentityConfig desiredWorkloadIdentityConfig)

Configuration for Workload Identity.

Parameters:

desiredWorkloadIdentityConfig - desiredWorkloadIdentityConfig or null for none

set

public ClusterUpdate set(String fieldName,
                         Object value)

Overrides:

set in class GenericJson

clone

public ClusterUpdate clone()

Overrides:

clone in class GenericJson