Cluster (Google Container Engine API v1 (Rev. 1) 1.20.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.Cluster

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Cluster
extends com.google.api.client.json.GenericJson
```
A Google Container Engine cluster.
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 Google Container Engine API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/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

Cluster()

Constructors
Constructor and Description
`Cluster()`

Method Summary

Methods
Modifier and Type	Method and Description
`Cluster`	`clone()`
`java.lang.String`	`getClusterIpv4Cidr()` The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g.
`java.lang.String`	`getCreateTime()` [Output only] The time the cluster was created, in [RFC3339](href='https://www.ietf.org/rfc/rfc3339.txt) text format.
`java.lang.String`	`getCurrentMasterVersion()` [Output only] The current software version of the master endpoint.
`java.lang.String`	`getCurrentNodeVersion()` [Output only] The current version of the node software components.
`java.lang.String`	`getDescription()` An optional description of this cluster.
`java.lang.String`	`getEndpoint()` [Output only] The IP address of this cluster's Kubernetes master endpoint.
`java.lang.String`	`getInitialClusterVersion()` [Output only] The software version of Kubernetes master and kubelets used in the cluster when it was first created.
`java.lang.Integer`	`getInitialNodeCount()` The number of nodes to create in this cluster.
`java.util.List<java.lang.String>`	`getInstanceGroupUrls()` [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this cluster.
`java.lang.String`	`getLoggingService()` The logging service that the cluster should write logs to.
`MasterAuth`	`getMasterAuth()` The authentication information for accessing the master.
`java.lang.String`	`getMonitoringService()` The monitoring service that the cluster should write metrics to.
`java.lang.String`	`getName()` The name of this cluster.
`java.lang.String`	`getNetwork()` The name of the Google Compute Engine [network](/compute/docs/networking#networks_1) to which the cluster is connected.
`NodeConfig`	`getNodeConfig()` Parameters used in creating the cluster's nodes.
`java.lang.Integer`	`getNodeIpv4CidrSize()` [Output only] The size of the address space on each node for hosting containers.
`java.lang.String`	`getSelfLink()` [Output only] Server-defined URL for the resource.
`java.lang.String`	`getServicesIpv4Cidr()` [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g.
`java.lang.String`	`getStatus()` [Output only] The current status of this cluster.
`java.lang.String`	`getStatusMessage()` [Output only] Additional information about the current status of this cluster, if available.
`java.lang.String`	`getZone()` [Output only] The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.
`Cluster`	`set(java.lang.String fieldName, java.lang.Object value)`
`Cluster`	`setClusterIpv4Cidr(java.lang.String clusterIpv4Cidr)` The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g.
`Cluster`	`setCreateTime(java.lang.String createTime)` [Output only] The time the cluster was created, in [RFC3339](href='https://www.ietf.org/rfc/rfc3339.txt) text format.
`Cluster`	`setCurrentMasterVersion(java.lang.String currentMasterVersion)` [Output only] The current software version of the master endpoint.
`Cluster`	`setCurrentNodeVersion(java.lang.String currentNodeVersion)` [Output only] The current version of the node software components.
`Cluster`	`setDescription(java.lang.String description)` An optional description of this cluster.
`Cluster`	`setEndpoint(java.lang.String endpoint)` [Output only] The IP address of this cluster's Kubernetes master endpoint.
`Cluster`	`setInitialClusterVersion(java.lang.String initialClusterVersion)` [Output only] The software version of Kubernetes master and kubelets used in the cluster when it was first created.
`Cluster`	`setInitialNodeCount(java.lang.Integer initialNodeCount)` The number of nodes to create in this cluster.
`Cluster`	`setInstanceGroupUrls(java.util.List<java.lang.String> instanceGroupUrls)` [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this cluster.
`Cluster`	`setLoggingService(java.lang.String loggingService)` The logging service that the cluster should write logs to.
`Cluster`	`setMasterAuth(MasterAuth masterAuth)` The authentication information for accessing the master.
`Cluster`	`setMonitoringService(java.lang.String monitoringService)` The monitoring service that the cluster should write metrics to.
`Cluster`	`setName(java.lang.String name)` The name of this cluster.
`Cluster`	`setNetwork(java.lang.String network)` The name of the Google Compute Engine [network](/compute/docs/networking#networks_1) to which the cluster is connected.
`Cluster`	`setNodeConfig(NodeConfig nodeConfig)` Parameters used in creating the cluster's nodes.
`Cluster`	`setNodeIpv4CidrSize(java.lang.Integer nodeIpv4CidrSize)` [Output only] The size of the address space on each node for hosting containers.
`Cluster`	`setSelfLink(java.lang.String selfLink)` [Output only] Server-defined URL for the resource.
`Cluster`	`setServicesIpv4Cidr(java.lang.String servicesIpv4Cidr)` [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g.
`Cluster`	`setStatus(java.lang.String status)` [Output only] The current status of this cluster.
`Cluster`	`setStatusMessage(java.lang.String statusMessage)` [Output only] Additional information about the current status of this cluster, if available.
`Cluster`	`setZone(java.lang.String zone)` [Output only] The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides.

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

- Constructor Detail
  - Cluster
```
public Cluster()
```
- Method Detail
  - getClusterIpv4Cidr
```
public java.lang.String getClusterIpv4Cidr()
```
    The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8` or `172.16.0.0/12`.
    
    Returns:
    value or null for none
  - setClusterIpv4Cidr
```
public Cluster setClusterIpv4Cidr(java.lang.String clusterIpv4Cidr)
```
    The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8` or `172.16.0.0/12`.
    
    Parameters:
    clusterIpv4Cidr - clusterIpv4Cidr or null for none
  - getCreateTime
```
public java.lang.String getCreateTime()
```
    [Output only] The time the cluster was created, in [RFC3339](href='https://www.ietf.org/rfc/rfc3339.txt) text format. @OutputOnly.
    
    Returns:
    value or null for none
  - setCreateTime
```
public Cluster setCreateTime(java.lang.String createTime)
```
    [Output only] The time the cluster was created, in [RFC3339](href='https://www.ietf.org/rfc/rfc3339.txt) text format. @OutputOnly.
    
    Parameters:
    createTime - createTime or null for none
  - getCurrentMasterVersion
```
public java.lang.String getCurrentMasterVersion()
```
    [Output only] The current software version of the master endpoint. @OutputOnly.
    
    Returns:
    value or null for none
  - setCurrentMasterVersion
```
public Cluster setCurrentMasterVersion(java.lang.String currentMasterVersion)
```
    [Output only] The current software version of the master endpoint. @OutputOnly.
    
    Parameters:
    currentMasterVersion - currentMasterVersion or null for none
  - getCurrentNodeVersion
```
public java.lang.String getCurrentNodeVersion()
```
    [Output only] The current version of the node software components. If they are currently at different versions because they're in the process of being upgraded, this reflects the minimum version of any of them. @OutputOnly.
    
    Returns:
    value or null for none
  - setCurrentNodeVersion
```
public Cluster setCurrentNodeVersion(java.lang.String currentNodeVersion)
```
    [Output only] The current version of the node software components. If they are currently at different versions because they're in the process of being upgraded, this reflects the minimum version of any of them. @OutputOnly.
    
    Parameters:
    currentNodeVersion - currentNodeVersion or null for none
  - getDescription
```
public java.lang.String getDescription()
```
    An optional description of this cluster.
    
    Returns:
    value or null for none
  - setDescription
```
public Cluster setDescription(java.lang.String description)
```
    An optional description of this cluster.
    
    Parameters:
    description - description or null for none
  - getEndpoint
```
public java.lang.String getEndpoint()
```
    [Output only] The IP address of this cluster's Kubernetes master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. @OutputOnly. See the `masterAuth` property of this resource for username and password information.
    
    Returns:
    value or null for none
  - setEndpoint
```
public Cluster setEndpoint(java.lang.String endpoint)
```
    [Output only] The IP address of this cluster's Kubernetes master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. @OutputOnly. See the `masterAuth` property of this resource for username and password information.
    
    Parameters:
    endpoint - endpoint or null for none
  - getInitialClusterVersion
```
public java.lang.String getInitialClusterVersion()
```
    [Output only] The software version of Kubernetes master and kubelets used in the cluster when it was first created. The version can be upgraded over time. @OutputOnly.
    
    Returns:
    value or null for none
  - setInitialClusterVersion
```
public Cluster setInitialClusterVersion(java.lang.String initialClusterVersion)
```
    [Output only] The software version of Kubernetes master and kubelets used in the cluster when it was first created. The version can be upgraded over time. @OutputOnly.
    
    Parameters:
    initialClusterVersion - initialClusterVersion or null for none
  - getInitialNodeCount
```
public java.lang.Integer getInitialNodeCount()
```
    The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](/compute/docs/resource-quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
    
    Returns:
    value or null for none
  - setInitialNodeCount
```
public Cluster setInitialNodeCount(java.lang.Integer initialNodeCount)
```
    The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](/compute/docs/resource-quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
    
    Parameters:
    initialNodeCount - initialNodeCount or null for none
  - getInstanceGroupUrls
```
public java.util.List<java.lang.String> getInstanceGroupUrls()
```
    [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this cluster. @OutputOnly.
    
    Returns:
    value or null for none
  - setInstanceGroupUrls
```
public Cluster setInstanceGroupUrls(java.util.List<java.lang.String> instanceGroupUrls)
```
    [Output only] The resource URLs of [instance groups](/compute/docs/instance-groups/) associated with this cluster. @OutputOnly.
    
    Parameters:
    instanceGroupUrls - instanceGroupUrls or null for none
  - getLoggingService
```
public java.lang.String getLoggingService()
```
    The logging service that the cluster should write logs to. Currently available options: * "logging.googleapis.com" - the Google Cloud Logging service * "none" - no logs will be exported from the cluster * "" - default value; the default is "logging.googleapis.com"
    
    Returns:
    value or null for none
  - setLoggingService
```
public Cluster setLoggingService(java.lang.String loggingService)
```
    The logging service that the cluster should write logs to. Currently available options: * "logging.googleapis.com" - the Google Cloud Logging service * "none" - no logs will be exported from the cluster * "" - default value; the default is "logging.googleapis.com"
    
    Parameters:
    loggingService - loggingService or null for none
  - getMasterAuth
```
public MasterAuth getMasterAuth()
```
    The authentication information for accessing the master.
    
    Returns:
    value or null for none
  - setMasterAuth
```
public Cluster setMasterAuth(MasterAuth masterAuth)
```
    The authentication information for accessing the master.
    
    Parameters:
    masterAuth - masterAuth or null for none
  - getMonitoringService
```
public java.lang.String getMonitoringService()
```
    The monitoring service that the cluster should write metrics to. Currently available options: * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster * "" - default value; the default is "monitoring.googleapis.com"
    
    Returns:
    value or null for none
  - setMonitoringService
```
public Cluster setMonitoringService(java.lang.String monitoringService)
```
    The monitoring service that the cluster should write metrics to. Currently available options: * "monitoring.googleapis.com" - the Google Cloud Monitoring service * "none" - no metrics will be exported from the cluster * "" - default value; the default is "monitoring.googleapis.com"
    
    Parameters:
    monitoringService - monitoringService or null for none
  - getName
```
public java.lang.String getName()
```
    The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
    
    Returns:
    value or null for none
  - setName
```
public Cluster setName(java.lang.String name)
```
    The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
    
    Parameters:
    name - name or null for none
  - getNetwork
```
public java.lang.String getNetwork()
```
    The name of the Google Compute Engine [network](/compute/docs/networking#networks_1) to which the cluster is connected. If left unspecified, the "default" network will be used.
    
    Returns:
    value or null for none
  - setNetwork
```
public Cluster setNetwork(java.lang.String network)
```
    The name of the Google Compute Engine [network](/compute/docs/networking#networks_1) to which the cluster is connected. If left unspecified, the "default" network will be used.
    
    Parameters:
    network - network or null for none
  - getNodeConfig
```
public NodeConfig getNodeConfig()
```
    Parameters used in creating the cluster's nodes. See the descriptions of the child properties of `nodeConfig`.
    
    Returns:
    value or null for none
  - setNodeConfig
```
public Cluster setNodeConfig(NodeConfig nodeConfig)
```
    Parameters used in creating the cluster's nodes. See the descriptions of the child properties of `nodeConfig`.
    
    Parameters:
    nodeConfig - nodeConfig or null for none
  - getNodeIpv4CidrSize
```
public java.lang.Integer getNodeIpv4CidrSize()
```
    [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. @OutputOnly.
    
    Returns:
    value or null for none
  - setNodeIpv4CidrSize
```
public Cluster setNodeIpv4CidrSize(java.lang.Integer nodeIpv4CidrSize)
```
    [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. @OutputOnly.
    
    Parameters:
    nodeIpv4CidrSize - nodeIpv4CidrSize or null for none
  - getSelfLink
```
public java.lang.String getSelfLink()
```
    [Output only] Server-defined URL for the resource. @OutputOnly.
    
    Returns:
    value or null for none
  - setSelfLink
```
public Cluster setSelfLink(java.lang.String selfLink)
```
    [Output only] Server-defined URL for the resource. @OutputOnly.
    
    Parameters:
    selfLink - selfLink or null for none
  - getServicesIpv4Cidr
```
public java.lang.String getServicesIpv4Cidr()
```
    [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last /16 from the container CIDR.
    
    Returns:
    value or null for none
  - setServicesIpv4Cidr
```
public Cluster setServicesIpv4Cidr(java.lang.String servicesIpv4Cidr)
```
    [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last /16 from the container CIDR.
    
    Parameters:
    servicesIpv4Cidr - servicesIpv4Cidr or null for none
  - getStatus
```
public java.lang.String getStatus()
```
    [Output only] The current status of this cluster. @OutputOnly.
    
    Returns:
    value or null for none
  - setStatus
```
public Cluster setStatus(java.lang.String status)
```
    [Output only] The current status of this cluster. @OutputOnly.
    
    Parameters:
    status - status or null for none
  - getStatusMessage
```
public java.lang.String getStatusMessage()
```
    [Output only] Additional information about the current status of this cluster, if available.
    
    Returns:
    value or null for none
  - setStatusMessage
```
public Cluster setStatusMessage(java.lang.String statusMessage)
```
    [Output only] Additional information about the current status of this cluster, if available.
    
    Parameters:
    statusMessage - statusMessage or null for none
  - getZone
```
public java.lang.String getZone()
```
    [Output only] The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. @OutputOnly.
    
    Returns:
    value or null for none
  - setZone
```
public Cluster setZone(java.lang.String zone)
```
    [Output only] The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. @OutputOnly.
    
    Parameters:
    zone - zone or null for none
  - set
```
public Cluster set(java.lang.String fieldName,
          java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Cluster clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Google Container Engine API v1 (revision 1)

Class Cluster

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

Constructor Detail

Cluster

Method Detail

getClusterIpv4Cidr

setClusterIpv4Cidr

getCreateTime

setCreateTime

getCurrentMasterVersion

setCurrentMasterVersion

getCurrentNodeVersion

setCurrentNodeVersion

getDescription

setDescription

getEndpoint

setEndpoint

getInitialClusterVersion

setInitialClusterVersion

getInitialNodeCount

setInitialNodeCount

getInstanceGroupUrls

setInstanceGroupUrls

getLoggingService

setLoggingService

getMasterAuth

setMasterAuth

getMonitoringService

setMonitoringService

getName

setName

getNetwork

setNetwork

getNodeConfig

setNodeConfig

getNodeIpv4CidrSize

setNodeIpv4CidrSize

getSelfLink

setSelfLink

getServicesIpv4Cidr

setServicesIpv4Cidr

getStatus

setStatus

getStatusMessage

setStatusMessage

getZone

setZone

set

clone