ClusterUpdate (Kubernetes Engine API v1 (Rev. 72) 1.23.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.container.model.ClusterUpdate

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class ClusterUpdate
extends com.google.api.client.json.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
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

ClusterUpdate()

Constructors
Constructor and Description
`ClusterUpdate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClusterUpdate`	`clone()`
`AddonsConfig`	`getDesiredAddonsConfig()` Configurations for the various addons available to run in the cluster.
`java.lang.String`	`getDesiredImageType()` The desired image type for the node pool.
`java.util.List<java.lang.String>`	`getDesiredLocations()` The desired list of Google Compute Engine [zones](/compute/docs/zones#available) in which the cluster's nodes should be located.
`MasterAuthorizedNetworksConfig`	`getDesiredMasterAuthorizedNetworksConfig()` The desired configuration options for master authorized networks feature.
`java.lang.String`	`getDesiredMasterVersion()` The Kubernetes version to change the master to.
`java.lang.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.
`java.lang.String`	`getDesiredNodePoolId()` The node pool to be upgraded.
`java.lang.String`	`getDesiredNodeVersion()` The Kubernetes version to change the nodes to (typically an upgrade).
`ClusterUpdate`	`set(java.lang.String fieldName, java.lang.Object value)`
`ClusterUpdate`	`setDesiredAddonsConfig(AddonsConfig desiredAddonsConfig)` Configurations for the various addons available to run in the cluster.
`ClusterUpdate`	`setDesiredImageType(java.lang.String desiredImageType)` The desired image type for the node pool.
`ClusterUpdate`	`setDesiredLocations(java.util.List<java.lang.String> desiredLocations)` The desired list of Google Compute Engine [zones](/compute/docs/zones#available) in which the cluster's nodes should be located.
`ClusterUpdate`	`setDesiredMasterAuthorizedNetworksConfig(MasterAuthorizedNetworksConfig desiredMasterAuthorizedNetworksConfig)` The desired configuration options for master authorized networks feature.
`ClusterUpdate`	`setDesiredMasterVersion(java.lang.String desiredMasterVersion)` The Kubernetes version to change the master to.
`ClusterUpdate`	`setDesiredMonitoringService(java.lang.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(java.lang.String desiredNodePoolId)` The node pool to be upgraded.
`ClusterUpdate`	`setDesiredNodeVersion(java.lang.String desiredNodeVersion)` The Kubernetes version to change the nodes to (typically an upgrade).

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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
  - getDesiredImageType
```
public java.lang.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(java.lang.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
  - getDesiredLocations
```
public java.util.List<java.lang.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(java.util.List<java.lang.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
  - 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 java.lang.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(java.lang.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 java.lang.String getDesiredMonitoringService()
```
    The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster
    
    Returns:
    
    value or null for none
  - setDesiredMonitoringService
```
public ClusterUpdate setDesiredMonitoringService(java.lang.String desiredMonitoringService)
```
    The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster
    
    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 java.lang.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(java.lang.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 java.lang.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(java.lang.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
  - set
```
public ClusterUpdate set(java.lang.String fieldName,
                         java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public ClusterUpdate clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Kubernetes Engine API v1 (revision 72)

Class ClusterUpdate

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

ClusterUpdate

Method Detail

getDesiredAddonsConfig

setDesiredAddonsConfig

getDesiredImageType

setDesiredImageType

getDesiredLocations

setDesiredLocations

getDesiredMasterAuthorizedNetworksConfig

setDesiredMasterAuthorizedNetworksConfig

getDesiredMasterVersion

setDesiredMasterVersion

getDesiredMonitoringService

setDesiredMonitoringService

getDesiredNodePoolAutoscaling

setDesiredNodePoolAutoscaling

getDesiredNodePoolId

setDesiredNodePoolId

getDesiredNodeVersion

setDesiredNodeVersion

set

clone