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

Class InstanceGroupConfig

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.InstanceGroupConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class InstanceGroupConfig
extends GenericJson

The config settings for Compute Engine resources in an instance group, such as a master or worker group.

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
InstanceGroupConfig()

Method Summary

Modifier and Type	Method and Description
InstanceGroupConfig	clone()
List<AcceleratorConfig>	getAccelerators() Optional.
DiskConfig	getDiskConfig() Optional.
String	getImageUri() Optional.
List<String>	getInstanceNames() Output only.
List<InstanceReference>	getInstanceReferences() Output only.
Boolean	getIsPreemptible() Output only.
String	getMachineTypeUri() Optional.
ManagedGroupConfig	getManagedGroupConfig() Output only.
String	getMinCpuPlatform() Specifies the minimum cpu platform for the Instance Group.
Integer	getNumInstances() Optional.
String	getPreemptibility() Optional.
InstanceGroupConfig	set(String fieldName, Object value)
InstanceGroupConfig	setAccelerators(List<AcceleratorConfig> accelerators) Optional.
InstanceGroupConfig	setDiskConfig(DiskConfig diskConfig) Optional.
InstanceGroupConfig	setImageUri(String imageUri) Optional.
InstanceGroupConfig	setInstanceNames(List<String> instanceNames) Output only.
InstanceGroupConfig	setInstanceReferences(List<InstanceReference> instanceReferences) Output only.
InstanceGroupConfig	setIsPreemptible(Boolean isPreemptible) Output only.
InstanceGroupConfig	setMachineTypeUri(String machineTypeUri) Optional.
InstanceGroupConfig	setManagedGroupConfig(ManagedGroupConfig managedGroupConfig) Output only.
InstanceGroupConfig	setMinCpuPlatform(String minCpuPlatform) Specifies the minimum cpu platform for the Instance Group.
InstanceGroupConfig	setNumInstances(Integer numInstances) Optional.
InstanceGroupConfig	setPreemptibility(String preemptibility) 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

InstanceGroupConfig

public InstanceGroupConfig()

Method Detail

getAccelerators

public List<AcceleratorConfig> getAccelerators()

Optional. The Compute Engine accelerator configuration for these instances.

Returns:

value or null for none

setAccelerators

public InstanceGroupConfig setAccelerators(List<AcceleratorConfig> accelerators)

Optional. The Compute Engine accelerator configuration for these instances.

Parameters:

accelerators - accelerators or null for none

getDiskConfig

public DiskConfig getDiskConfig()

Optional. Disk option config settings.

Returns:

value or null for none

setDiskConfig

public InstanceGroupConfig setDiskConfig(DiskConfig diskConfig)

Optional. Disk option config settings.

Parameters:

diskConfig - diskConfig or null for none

getImageUri

public String getImageUri()

Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples: https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id] projects/[project_id]/global/images/[image-id] image-idImage family examples. Dataproc will use the most recent image from the family: https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom- image-family-name] projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

Returns:

value or null for none

setImageUri

public InstanceGroupConfig setImageUri(String imageUri)

Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples: https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id] projects/[project_id]/global/images/[image-id] image-idImage family examples. Dataproc will use the most recent image from the family: https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom- image-family-name] projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

Parameters:

imageUri - imageUri or null for none

getInstanceNames

public List<String> getInstanceNames()

Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

Returns:

value or null for none

setInstanceNames

public InstanceGroupConfig setInstanceNames(List<String> instanceNames)

Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

Parameters:

instanceNames - instanceNames or null for none

getInstanceReferences

public List<InstanceReference> getInstanceReferences()

Output only. List of references to Compute Engine instances.

Returns:

value or null for none

setInstanceReferences

public InstanceGroupConfig setInstanceReferences(List<InstanceReference> instanceReferences)

Output only. List of references to Compute Engine instances.

Parameters:

instanceReferences - instanceReferences or null for none

getIsPreemptible

public Boolean getIsPreemptible()

Output only. Specifies that this instance group contains preemptible instances.

Returns:

value or null for none

setIsPreemptible

public InstanceGroupConfig setIsPreemptible(Boolean isPreemptible)

Output only. Specifies that this instance group contains preemptible instances.

Parameters:

isPreemptible - isPreemptible or null for none

getMachineTypeUri

public String getMachineTypeUri()

Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us- east1-a/machineTypes/n1-standard-2 projects/[project_id]/zones/us- east1-a/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring- clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

Returns:

value or null for none

setMachineTypeUri

public InstanceGroupConfig setMachineTypeUri(String machineTypeUri)

Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us- east1-a/machineTypes/n1-standard-2 projects/[project_id]/zones/us- east1-a/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring- clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

Parameters:

machineTypeUri - machineTypeUri or null for none

getManagedGroupConfig

public ManagedGroupConfig getManagedGroupConfig()

Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

Returns:

value or null for none

setManagedGroupConfig

public InstanceGroupConfig setManagedGroupConfig(ManagedGroupConfig managedGroupConfig)

Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

Parameters:

managedGroupConfig - managedGroupConfig or null for none

getMinCpuPlatform

public String getMinCpuPlatform()

Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

Returns:

value or null for none

setMinCpuPlatform

public InstanceGroupConfig setMinCpuPlatform(String minCpuPlatform)

Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

Parameters:

minCpuPlatform - minCpuPlatform or null for none

getNumInstances

public Integer getNumInstances()

Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1.

Returns:

value or null for none

setNumInstances

public InstanceGroupConfig setNumInstances(Integer numInstances)

Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1.

Parameters:

numInstances - numInstances or null for none

getPreemptibility

public String getPreemptibility()

Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

Returns:

value or null for none

setPreemptibility

public InstanceGroupConfig setPreemptibility(String preemptibility)

Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

Parameters:

preemptibility - preemptibility or null for none

set

public InstanceGroupConfig set(String fieldName,
                               Object value)

Overrides:

set in class GenericJson

clone

public InstanceGroupConfig clone()

Overrides:

clone in class GenericJson