Package com.google.cloud.dataproc.v1

Interface InstanceGroupConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

InstanceGroupConfig, InstanceGroupConfig.Builder

public interface InstanceGroupConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
AcceleratorConfig	getAccelerators(int index)	Optional.
int	getAcceleratorsCount()	Optional.
List<AcceleratorConfig>	getAcceleratorsList()	Optional.
AcceleratorConfigOrBuilder	getAcceleratorsOrBuilder(int index)	Optional.
List<? extends AcceleratorConfigOrBuilder>	getAcceleratorsOrBuilderList()	Optional.
DiskConfig	getDiskConfig()	Optional.
DiskConfigOrBuilder	getDiskConfigOrBuilder()	Optional.
String	getImageUri()	Optional.
com.google.protobuf.ByteString	getImageUriBytes()	Optional.
InstanceFlexibilityPolicy	getInstanceFlexibilityPolicy()	Optional.
InstanceFlexibilityPolicyOrBuilder	getInstanceFlexibilityPolicyOrBuilder()	Optional.
String	getInstanceNames(int index)	Output only.
com.google.protobuf.ByteString	getInstanceNamesBytes(int index)	Output only.
int	getInstanceNamesCount()	Output only.
List<String>	getInstanceNamesList()	Output only.
InstanceReference	getInstanceReferences(int index)	Output only.
int	getInstanceReferencesCount()	Output only.
List<InstanceReference>	getInstanceReferencesList()	Output only.
InstanceReferenceOrBuilder	getInstanceReferencesOrBuilder(int index)	Output only.
List<? extends InstanceReferenceOrBuilder>	getInstanceReferencesOrBuilderList()	Output only.
boolean	getIsPreemptible()	Output only.
String	getMachineTypeUri()	Optional.
com.google.protobuf.ByteString	getMachineTypeUriBytes()	Optional.
ManagedGroupConfig	getManagedGroupConfig()	Output only.
ManagedGroupConfigOrBuilder	getManagedGroupConfigOrBuilder()	Output only.
String	getMinCpuPlatform()	Optional.
com.google.protobuf.ByteString	getMinCpuPlatformBytes()	Optional.
int	getMinNumInstances()	Optional.
int	getNumInstances()	Optional.
InstanceGroupConfig.Preemptibility	getPreemptibility()	Optional.
int	getPreemptibilityValue()	Optional.
boolean	hasDiskConfig()	Optional.
boolean	hasInstanceFlexibilityPolicy()	Optional.
boolean	hasManagedGroupConfig()	Output only.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getNumInstances

int getNumInstances()

 Optional. The number of VM instances in the instance group.
 For [HA
 cluster](/dataproc/docs/concepts/configuring-clusters/high-availability)
 [master_config](#FIELDS.master_config) groups, **must be set to 3**.
 For standard cluster [master_config](#FIELDS.master_config) groups,
 **must be set to 1**.
 

int32 num_instances = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The numInstances.

getInstanceNamesList

List<String> getInstanceNamesList()

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

repeated string instance_names = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

A list containing the instanceNames.

getInstanceNamesCount

int getInstanceNamesCount()

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

repeated string instance_names = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The count of instanceNames.

getInstanceNames

String getInstanceNames(int index)

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

repeated string instance_names = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters:

index - The index of the element to return.

Returns:

The instanceNames at the given index.

getInstanceNamesBytes

com.google.protobuf.ByteString getInstanceNamesBytes(int index)

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

repeated string instance_names = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the instanceNames at the given index.

getInstanceReferencesList

List<InstanceReference> getInstanceReferencesList()

 Output only. List of references to Compute Engine instances.
 

repeated .google.cloud.dataproc.v1.InstanceReference instance_references = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

getInstanceReferences

InstanceReference getInstanceReferences(int index)

 Output only. List of references to Compute Engine instances.
 

repeated .google.cloud.dataproc.v1.InstanceReference instance_references = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

getInstanceReferencesCount

int getInstanceReferencesCount()

 Output only. List of references to Compute Engine instances.
 

repeated .google.cloud.dataproc.v1.InstanceReference instance_references = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

getInstanceReferencesOrBuilderList

List<? extends InstanceReferenceOrBuilder> getInstanceReferencesOrBuilderList()

 Output only. List of references to Compute Engine instances.
 

repeated .google.cloud.dataproc.v1.InstanceReference instance_references = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

getInstanceReferencesOrBuilder

InstanceReferenceOrBuilder getInstanceReferencesOrBuilder(int index)

 Output only. List of references to Compute Engine instances.
 

repeated .google.cloud.dataproc.v1.InstanceReference instance_references = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

getImageUri

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/v1/projects/[project_id]/global/images/[image-id]`
 * `projects/[project_id]/global/images/[image-id]`
 * `image-id`

 Image family examples. Dataproc will use the most recent
 image from the family:

 * `https://www.googleapis.com/compute/v1/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.
 

string image_uri = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The imageUri.

getImageUriBytes

com.google.protobuf.ByteString getImageUriBytes()

 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/v1/projects/[project_id]/global/images/[image-id]`
 * `projects/[project_id]/global/images/[image-id]`
 * `image-id`

 Image family examples. Dataproc will use the most recent
 image from the family:

 * `https://www.googleapis.com/compute/v1/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.
 

string image_uri = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for imageUri.

getMachineTypeUri

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/[zone]/machineTypes/n1-standard-2`
 * `projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2`
 * `n1-standard-2`

 **Auto 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`.
 

string machine_type_uri = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The machineTypeUri.

getMachineTypeUriBytes

com.google.protobuf.ByteString getMachineTypeUriBytes()

 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/[zone]/machineTypes/n1-standard-2`
 * `projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2`
 * `n1-standard-2`

 **Auto 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`.
 

string machine_type_uri = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for machineTypeUri.

hasDiskConfig

boolean hasDiskConfig()

 Optional. Disk option config settings.
 

.google.cloud.dataproc.v1.DiskConfig disk_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the diskConfig field is set.

getDiskConfig

DiskConfig getDiskConfig()

 Optional. Disk option config settings.
 

.google.cloud.dataproc.v1.DiskConfig disk_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The diskConfig.

getDiskConfigOrBuilder

DiskConfigOrBuilder getDiskConfigOrBuilder()

 Optional. Disk option config settings.
 

.google.cloud.dataproc.v1.DiskConfig disk_config = 5 [(.google.api.field_behavior) = OPTIONAL];

getIsPreemptible

boolean getIsPreemptible()

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

bool is_preemptible = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The isPreemptible.

getPreemptibilityValue

int getPreemptibilityValue()

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

.google.cloud.dataproc.v1.InstanceGroupConfig.Preemptibility preemptibility = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The enum numeric value on the wire for preemptibility.

getPreemptibility

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

.google.cloud.dataproc.v1.InstanceGroupConfig.Preemptibility preemptibility = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The preemptibility.

hasManagedGroupConfig

boolean hasManagedGroupConfig()

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

.google.cloud.dataproc.v1.ManagedGroupConfig managed_group_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the managedGroupConfig field is set.

getManagedGroupConfig

ManagedGroupConfig getManagedGroupConfig()

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

.google.cloud.dataproc.v1.ManagedGroupConfig managed_group_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The managedGroupConfig.

getManagedGroupConfigOrBuilder

ManagedGroupConfigOrBuilder getManagedGroupConfigOrBuilder()

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

.google.cloud.dataproc.v1.ManagedGroupConfig managed_group_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

getAcceleratorsList

List<AcceleratorConfig> getAcceleratorsList()

 Optional. The Compute Engine accelerator configuration for these
 instances.
 

repeated .google.cloud.dataproc.v1.AcceleratorConfig accelerators = 8 [(.google.api.field_behavior) = OPTIONAL];

getAccelerators

AcceleratorConfig getAccelerators(int index)

 Optional. The Compute Engine accelerator configuration for these
 instances.
 

repeated .google.cloud.dataproc.v1.AcceleratorConfig accelerators = 8 [(.google.api.field_behavior) = OPTIONAL];

getAcceleratorsCount

int getAcceleratorsCount()

 Optional. The Compute Engine accelerator configuration for these
 instances.
 

repeated .google.cloud.dataproc.v1.AcceleratorConfig accelerators = 8 [(.google.api.field_behavior) = OPTIONAL];

getAcceleratorsOrBuilderList

List<? extends AcceleratorConfigOrBuilder> getAcceleratorsOrBuilderList()

 Optional. The Compute Engine accelerator configuration for these
 instances.
 

repeated .google.cloud.dataproc.v1.AcceleratorConfig accelerators = 8 [(.google.api.field_behavior) = OPTIONAL];

getAcceleratorsOrBuilder

AcceleratorConfigOrBuilder getAcceleratorsOrBuilder(int index)

 Optional. The Compute Engine accelerator configuration for these
 instances.
 

repeated .google.cloud.dataproc.v1.AcceleratorConfig accelerators = 8 [(.google.api.field_behavior) = OPTIONAL];

getMinCpuPlatform

String getMinCpuPlatform()

 Optional. 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).
 

string min_cpu_platform = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The minCpuPlatform.

getMinCpuPlatformBytes

com.google.protobuf.ByteString getMinCpuPlatformBytes()

 Optional. 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).
 

string min_cpu_platform = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for minCpuPlatform.

getMinNumInstances

int getMinNumInstances()

 Optional. The minimum number of instances to create.
 If min_num_instances is set, min_num_instances is used for a criteria to
 decide the cluster. Cluster creation will be failed by being an error state
 if the total number of instances created is less than the
 min_num_instances.
 For example, given that num_instances = 5 and min_num_instances = 3,
 * if 4 instances are created and then registered successfully but one
 instance is failed, the failed VM will be deleted and the cluster will be
 resized to 4 instances in running state.
 * if 2 instances are created successfully and 3 instances are failed,
 the cluster will be in an error state and does not delete failed VMs for
 debugging.
 * if 2 instance are created and then registered successfully but 3
 instances are failed to initialize, the cluster will be in an error state
 and does not delete failed VMs for debugging.
 NB: This can only be set for primary workers now.
 

int32 min_num_instances = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The minNumInstances.

hasInstanceFlexibilityPolicy

boolean hasInstanceFlexibilityPolicy()

 Optional. Instance flexibility Policy allowing a mixture of VM shapes and
 provisioning models.
 

.google.cloud.dataproc.v1.InstanceFlexibilityPolicy instance_flexibility_policy = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the instanceFlexibilityPolicy field is set.

getInstanceFlexibilityPolicy

InstanceFlexibilityPolicy getInstanceFlexibilityPolicy()

 Optional. Instance flexibility Policy allowing a mixture of VM shapes and
 provisioning models.
 

.google.cloud.dataproc.v1.InstanceFlexibilityPolicy instance_flexibility_policy = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The instanceFlexibilityPolicy.

getInstanceFlexibilityPolicyOrBuilder

InstanceFlexibilityPolicyOrBuilder getInstanceFlexibilityPolicyOrBuilder()

 Optional. Instance flexibility Policy allowing a mixture of VM shapes and
 provisioning models.
 

.google.cloud.dataproc.v1.InstanceFlexibilityPolicy instance_flexibility_policy = 13 [(.google.api.field_behavior) = OPTIONAL];