com.google.api.services.dataproc.v1beta2.model

Class GceClusterConfig

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.v1beta2.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()

Method Summary

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.
NodeGroupAffinity	getNodeGroupAffinity() Optional.
String	getPrivateIpv6GoogleAccess() Optional.
ReservationAffinity	getReservationAffinity() Optional.
String	getServiceAccount() Optional.
List<String>	getServiceAccountScopes() Optional.
ShieldedInstanceConfig	getShieldedInstanceConfig() Optional.
String	getSubnetworkUri() Optional.
List<String>	getTags() The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
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	setNodeGroupAffinity(NodeGroupAffinity nodeGroupAffinity) Optional.
GceClusterConfig	setPrivateIpv6GoogleAccess(String privateIpv6GoogleAccess) Optional.
GceClusterConfig	setReservationAffinity(ReservationAffinity reservationAffinity) Optional.
GceClusterConfig	setServiceAccount(String serviceAccount) Optional.
GceClusterConfig	setServiceAccountScopes(List<String> serviceAccountScopes) Optional.
GceClusterConfig	setShieldedInstanceConfig(ShieldedInstanceConfig shieldedInstanceConfig) Optional.
GceClusterConfig	setSubnetworkUri(String subnetworkUri) Optional.
GceClusterConfig	setTags(List<String> tags) The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
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, 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

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 (https://cloud.google.com/compute/docs/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 (https://cloud.google.com/compute/docs/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

getNodeGroupAffinity

public NodeGroupAffinity getNodeGroupAffinity()

Optional. Node Group Affinity for sole-tenant clusters.

Returns:

value or null for none

setNodeGroupAffinity

public GceClusterConfig setNodeGroupAffinity(NodeGroupAffinity nodeGroupAffinity)

Optional. Node Group Affinity for sole-tenant clusters.

Parameters:

nodeGroupAffinity - nodeGroupAffinity or null for none

getPrivateIpv6GoogleAccess

public String getPrivateIpv6GoogleAccess()

Optional. The type of IPv6 access for a cluster.

Returns:

value or null for none

setPrivateIpv6GoogleAccess

public GceClusterConfig setPrivateIpv6GoogleAccess(String privateIpv6GoogleAccess)

Optional. The type of IPv6 access for a cluster.

Parameters:

privateIpv6GoogleAccess - privateIpv6GoogleAccess 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 (https://cloud.google.com/dataproc/docs/concepts /configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc- principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.

Returns:

value or null for none

setServiceAccount

public GceClusterConfig setServiceAccount(String serviceAccount)

Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts /configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc- principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#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

getShieldedInstanceConfig

public ShieldedInstanceConfig getShieldedInstanceConfig()

Optional. Shielded Instance Config for clusters using Compute Engine Shielded VMs (https://cloud.google.com/security/shielded-cloud/shielded-vm).

Returns:

value or null for none

setShieldedInstanceConfig

public GceClusterConfig setShieldedInstanceConfig(ShieldedInstanceConfig shieldedInstanceConfig)

Optional. Shielded Instance Config for clusters using Compute Engine Shielded VMs (https://cloud.google.com/security/shielded-cloud/shielded-vm).

Parameters:

shieldedInstanceConfig - shieldedInstanceConfig 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 (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).

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 (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).

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