GceClusterConfig (Cloud Dataproc API v1-rev20191219-1.28.0)

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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GceClusterConfig
extends GenericJson
```
Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the 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 Cloud Dataproc 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

GceClusterConfig()

Constructors
Constructor and Description
`GceClusterConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GceClusterConfig`	`clone()`
`Boolean`	`getInternalIpOnly()` Optional.
`Map<String,String>`	`getMetadata()` The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving- metadata#project_and_instance_metadata)).
`String`	`getNetworkUri()` Optional.
`ReservationAffinity`	`getReservationAffinity()` Optional.
`String`	`getServiceAccount()` Optional.
`List<String>`	`getServiceAccountScopes()` Optional.
`String`	`getSubnetworkUri()` Optional.
`List<String>`	`getTags()` The Compute Engine tags to add to all instances (see Tagging instances).
`String`	`getZoneUri()` Optional.
`GceClusterConfig`	`set(String fieldName, Object value)`
`GceClusterConfig`	`setInternalIpOnly(Boolean internalIpOnly)` Optional.
`GceClusterConfig`	`setMetadata(Map<String,String> metadata)` The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving- metadata#project_and_instance_metadata)).
`GceClusterConfig`	`setNetworkUri(String networkUri)` Optional.
`GceClusterConfig`	`setReservationAffinity(ReservationAffinity reservationAffinity)` Optional.
`GceClusterConfig`	`setServiceAccount(String serviceAccount)` Optional.
`GceClusterConfig`	`setServiceAccountScopes(List<String> serviceAccountScopes)` Optional.
`GceClusterConfig`	`setSubnetworkUri(String subnetworkUri)` Optional.
`GceClusterConfig`	`setTags(List<String> tags)` The Compute Engine tags to add to all instances (see Tagging instances).
`GceClusterConfig`	`setZoneUri(String zoneUri)` Optional.

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
  - GceClusterConfig
```
public GceClusterConfig()
```
- Method Detail
  - getInternalIpOnly
```
public Boolean getInternalIpOnly()
```
    Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
    
    Returns:
    
    value or null for none
  - setInternalIpOnly
```
public GceClusterConfig setInternalIpOnly(Boolean internalIpOnly)
```
    Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
    
    Parameters:
    
    internalIpOnly - internalIpOnly or null for none
  - getMetadata
```
public Map<String,String> getMetadata()
```
    The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving- metadata#project_and_instance_metadata)).
    
    Returns:
    
    value or null for none
  - setMetadata
```
public GceClusterConfig setMetadata(Map<String,String> metadata)
```
    The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving- metadata#project_and_instance_metadata)).
    
    Parameters:
    
    metadata - metadata or null for none
  - getNetworkUri
```
public String getNetworkUri()
```
    Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default projects/[project_id]/regions/global/default default
    
    Returns:
    
    value or null for none
  - setNetworkUri
```
public GceClusterConfig setNetworkUri(String networkUri)
```
    Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default projects/[project_id]/regions/global/default default
    
    Parameters:
    
    networkUri - networkUri or null for none
  - getReservationAffinity
```
public ReservationAffinity getReservationAffinity()
```
    Optional. Reservation Affinity for consuming Zonal reservation.
    
    Returns:
    
    value or null for none
  - setReservationAffinity
```
public GceClusterConfig setReservationAffinity(ReservationAffinity reservationAffinity)
```
    Optional. Reservation Affinity for consuming Zonal reservation.
    
    Parameters:
    
    reservationAffinity - reservationAffinity or null for none
  - getServiceAccount
```
public String getServiceAccount()
```
    Optional. The Dataproc service account (also see VM Data Plane identity) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account is used.
    
    Returns:
    
    value or null for none
  - setServiceAccount
```
public GceClusterConfig setServiceAccount(String serviceAccount)
```
    Optional. The Dataproc service account (also see VM Data Plane identity) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account is used.
    
    Parameters:
    
    serviceAccount - serviceAccount or null for none
  - getServiceAccountScopes
```
public List<String> getServiceAccountScopes()
```
    Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control
    
    Returns:
    
    value or null for none
  - setServiceAccountScopes
```
public GceClusterConfig setServiceAccountScopes(List<String> serviceAccountScopes)
```
    Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control
    
    Parameters:
    
    serviceAccountScopes - serviceAccountScopes or null for none
  - getSubnetworkUri
```
public String getSubnetworkUri()
```
    Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0 projects/[project_id]/regions/us-east1/subnetworks/sub0 sub0
    
    Returns:
    
    value or null for none
  - setSubnetworkUri
```
public GceClusterConfig setSubnetworkUri(String subnetworkUri)
```
    Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0 projects/[project_id]/regions/us-east1/subnetworks/sub0 sub0
    
    Parameters:
    
    subnetworkUri - subnetworkUri or null for none
  - getTags
```
public List<String> getTags()
```
    The Compute Engine tags to add to all instances (see Tagging instances).
    
    Returns:
    
    value or null for none
  - setTags
```
public GceClusterConfig setTags(List<String> tags)
```
    The Compute Engine tags to add to all instances (see Tagging instances).
    
    Parameters:
    
    tags - tags or null for none
  - getZoneUri
```
public String getZoneUri()
```
    Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] us-central1-f
    
    Returns:
    
    value or null for none
  - setZoneUri
```
public GceClusterConfig setZoneUri(String zoneUri)
```
    Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] us-central1-f
    
    Parameters:
    
    zoneUri - zoneUri or null for none
  - set
```
public GceClusterConfig set(String fieldName,
                            Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public GceClusterConfig clone()
```
    Overrides:
    
    clone in class GenericJson

Class GceClusterConfig

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

GceClusterConfig

Method Detail

getInternalIpOnly

setInternalIpOnly

getMetadata

setMetadata

getNetworkUri

setNetworkUri

getReservationAffinity

setReservationAffinity

getServiceAccount

setServiceAccount

getServiceAccountScopes

setServiceAccountScopes

getSubnetworkUri

setSubnetworkUri

getTags

setTags

getZoneUri

setZoneUri

set

clone