Class InstanceGroupConfig.Builder (4.20.0)

public static final class InstanceGroupConfig.Builder extends GeneratedMessageV3.Builder<InstanceGroupConfig.Builder> implements InstanceGroupConfigOrBuilder

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

Protobuf type google.cloud.dataproc.v1.InstanceGroupConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAccelerators(AcceleratorConfig value)

public InstanceGroupConfig.Builder addAccelerators(AcceleratorConfig value)

Optional. The Compute Engine accelerator configuration for these instances.

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

Parameter
NameDescription
valueAcceleratorConfig
Returns
TypeDescription
InstanceGroupConfig.Builder

addAccelerators(AcceleratorConfig.Builder builderForValue)

public InstanceGroupConfig.Builder addAccelerators(AcceleratorConfig.Builder builderForValue)

Optional. The Compute Engine accelerator configuration for these instances.

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

Parameter
NameDescription
builderForValueAcceleratorConfig.Builder
Returns
TypeDescription
InstanceGroupConfig.Builder

addAccelerators(int index, AcceleratorConfig value)

public InstanceGroupConfig.Builder addAccelerators(int index, AcceleratorConfig value)

Optional. The Compute Engine accelerator configuration for these instances.

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

Parameters
NameDescription
indexint
valueAcceleratorConfig
Returns
TypeDescription
InstanceGroupConfig.Builder

addAccelerators(int index, AcceleratorConfig.Builder builderForValue)

public InstanceGroupConfig.Builder addAccelerators(int index, AcceleratorConfig.Builder builderForValue)

Optional. The Compute Engine accelerator configuration for these instances.

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

Parameters
NameDescription
indexint
builderForValueAcceleratorConfig.Builder
Returns
TypeDescription
InstanceGroupConfig.Builder

addAcceleratorsBuilder()

public AcceleratorConfig.Builder addAcceleratorsBuilder()

Optional. The Compute Engine accelerator configuration for these instances.

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

Returns
TypeDescription
AcceleratorConfig.Builder

addAcceleratorsBuilder(int index)

public AcceleratorConfig.Builder addAcceleratorsBuilder(int index)

Optional. The Compute Engine accelerator configuration for these instances.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
AcceleratorConfig.Builder

addAllAccelerators(Iterable<? extends AcceleratorConfig> values)

public InstanceGroupConfig.Builder addAllAccelerators(Iterable<? extends AcceleratorConfig> values)

Optional. The Compute Engine accelerator configuration for these instances.

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

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.dataproc.v1.AcceleratorConfig>
Returns
TypeDescription
InstanceGroupConfig.Builder

addAllInstanceNames(Iterable<String> values)

public InstanceGroupConfig.Builder addAllInstanceNames(Iterable<String> values)

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];

Parameter
NameDescription
valuesIterable<String>

The instanceNames to add.

Returns
TypeDescription
InstanceGroupConfig.Builder

This builder for chaining.

addInstanceNames(String value)

public InstanceGroupConfig.Builder addInstanceNames(String value)

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];

Parameter
NameDescription
valueString

The instanceNames to add.

Returns
TypeDescription
InstanceGroupConfig.Builder

This builder for chaining.

addInstanceNamesBytes(ByteString value)

public InstanceGroupConfig.Builder addInstanceNamesBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes of the instanceNames to add.

Returns
TypeDescription
InstanceGroupConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public InstanceGroupConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
InstanceGroupConfig.Builder
Overrides

build()

public InstanceGroupConfig build()
Returns
TypeDescription
InstanceGroupConfig

buildPartial()

public InstanceGroupConfig buildPartial()
Returns
TypeDescription
InstanceGroupConfig

clear()

public InstanceGroupConfig.Builder clear()
Returns
TypeDescription
InstanceGroupConfig.Builder
Overrides

clearAccelerators()

public InstanceGroupConfig.Builder clearAccelerators()

Optional. The Compute Engine accelerator configuration for these instances.

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

Returns
TypeDescription
InstanceGroupConfig.Builder

clearDiskConfig()

public InstanceGroupConfig.Builder clearDiskConfig()

Optional. Disk option config settings.

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

Returns
TypeDescription
InstanceGroupConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public InstanceGroupConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
InstanceGroupConfig.Builder
Overrides

clearImageUri()

public InstanceGroupConfig.Builder clearImageUri()

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

This builder for chaining.

clearInstanceNames()

public InstanceGroupConfig.Builder clearInstanceNames()

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

This builder for chaining.

clearIsPreemptible()

public InstanceGroupConfig.Builder clearIsPreemptible()

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

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

Returns
TypeDescription
InstanceGroupConfig.Builder

This builder for chaining.

clearMachineTypeUri()

public InstanceGroupConfig.Builder clearMachineTypeUri()

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

This builder for chaining.

clearManagedGroupConfig()

public InstanceGroupConfig.Builder clearManagedGroupConfig()

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

clearMinCpuPlatform()

public InstanceGroupConfig.Builder clearMinCpuPlatform()

Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform.

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

Returns
TypeDescription
InstanceGroupConfig.Builder

This builder for chaining.

clearNumInstances()

public InstanceGroupConfig.Builder clearNumInstances()

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.

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

Returns
TypeDescription
InstanceGroupConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public InstanceGroupConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
InstanceGroupConfig.Builder
Overrides

clearPreemptibility()

public InstanceGroupConfig.Builder clearPreemptibility()

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

This builder for chaining.

clone()

public InstanceGroupConfig.Builder clone()
Returns
TypeDescription
InstanceGroupConfig.Builder
Overrides

getAccelerators(int index)

public 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];

Parameter
NameDescription
indexint
Returns
TypeDescription
AcceleratorConfig

getAcceleratorsBuilder(int index)

public AcceleratorConfig.Builder getAcceleratorsBuilder(int index)

Optional. The Compute Engine accelerator configuration for these instances.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
AcceleratorConfig.Builder

getAcceleratorsBuilderList()

public List<AcceleratorConfig.Builder> getAcceleratorsBuilderList()

Optional. The Compute Engine accelerator configuration for these instances.

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

Returns
TypeDescription
List<Builder>

getAcceleratorsCount()

public int getAcceleratorsCount()

Optional. The Compute Engine accelerator configuration for these instances.

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

Returns
TypeDescription
int

getAcceleratorsList()

public 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];

Returns
TypeDescription
List<AcceleratorConfig>

getAcceleratorsOrBuilder(int index)

public 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];

Parameter
NameDescription
indexint
Returns
TypeDescription
AcceleratorConfigOrBuilder

getAcceleratorsOrBuilderList()

public 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];

Returns
TypeDescription
List<? extends com.google.cloud.dataproc.v1.AcceleratorConfigOrBuilder>

getDefaultInstanceForType()

public InstanceGroupConfig getDefaultInstanceForType()
Returns
TypeDescription
InstanceGroupConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDiskConfig()

public DiskConfig getDiskConfig()

Optional. Disk option config settings.

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

Returns
TypeDescription
DiskConfig

The diskConfig.

getDiskConfigBuilder()

public DiskConfig.Builder getDiskConfigBuilder()

Optional. Disk option config settings.

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

Returns
TypeDescription
DiskConfig.Builder

getDiskConfigOrBuilder()

public DiskConfigOrBuilder getDiskConfigOrBuilder()

Optional. Disk option config settings.

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

Returns
TypeDescription
DiskConfigOrBuilder

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/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
TypeDescription
String

The imageUri.

getImageUriBytes()

public 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
TypeDescription
ByteString

The bytes for imageUri.

getInstanceNames(int index)

public 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];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The instanceNames at the given index.

getInstanceNamesBytes(int index)

public 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];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the instanceNames at the given index.

getInstanceNamesCount()

public 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
TypeDescription
int

The count of instanceNames.

getInstanceNamesList()

public ProtocolStringList 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
TypeDescription
ProtocolStringList

A list containing the instanceNames.

getIsPreemptible()

public boolean getIsPreemptible()

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

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

Returns
TypeDescription
boolean

The isPreemptible.

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/[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 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
TypeDescription
String

The machineTypeUri.

getMachineTypeUriBytes()

public 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 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
TypeDescription
ByteString

The bytes for machineTypeUri.

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.

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

Returns
TypeDescription
ManagedGroupConfig

The managedGroupConfig.

getManagedGroupConfigBuilder()

public ManagedGroupConfig.Builder getManagedGroupConfigBuilder()

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
TypeDescription
ManagedGroupConfig.Builder

getManagedGroupConfigOrBuilder()

public 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];

Returns
TypeDescription
ManagedGroupConfigOrBuilder

getMinCpuPlatform()

public String getMinCpuPlatform()

Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform.

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

Returns
TypeDescription
String

The minCpuPlatform.

getMinCpuPlatformBytes()

public ByteString getMinCpuPlatformBytes()

Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform.

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

Returns
TypeDescription
ByteString

The bytes for minCpuPlatform.

getNumInstances()

public int 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.

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

Returns
TypeDescription
int

The numInstances.

getPreemptibility()

public 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
TypeDescription
InstanceGroupConfig.Preemptibility

The preemptibility.

getPreemptibilityValue()

public 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
TypeDescription
int

The enum numeric value on the wire for preemptibility.

hasDiskConfig()

public boolean hasDiskConfig()

Optional. Disk option config settings.

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

Returns
TypeDescription
boolean

Whether the diskConfig field is set.

hasManagedGroupConfig()

public 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
TypeDescription
boolean

Whether the managedGroupConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeDiskConfig(DiskConfig value)

public InstanceGroupConfig.Builder mergeDiskConfig(DiskConfig value)

Optional. Disk option config settings.

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

Parameter
NameDescription
valueDiskConfig
Returns
TypeDescription
InstanceGroupConfig.Builder

mergeFrom(InstanceGroupConfig other)

public InstanceGroupConfig.Builder mergeFrom(InstanceGroupConfig other)
Parameter
NameDescription
otherInstanceGroupConfig
Returns
TypeDescription
InstanceGroupConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public InstanceGroupConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceGroupConfig.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public InstanceGroupConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
InstanceGroupConfig.Builder
Overrides

mergeManagedGroupConfig(ManagedGroupConfig value)

public InstanceGroupConfig.Builder mergeManagedGroupConfig(ManagedGroupConfig value)

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];

Parameter
NameDescription
valueManagedGroupConfig
Returns
TypeDescription
InstanceGroupConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final InstanceGroupConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
InstanceGroupConfig.Builder
Overrides

removeAccelerators(int index)

public InstanceGroupConfig.Builder removeAccelerators(int index)

Optional. The Compute Engine accelerator configuration for these instances.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
InstanceGroupConfig.Builder

setAccelerators(int index, AcceleratorConfig value)

public InstanceGroupConfig.Builder setAccelerators(int index, AcceleratorConfig value)

Optional. The Compute Engine accelerator configuration for these instances.

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

Parameters
NameDescription
indexint
valueAcceleratorConfig
Returns
TypeDescription
InstanceGroupConfig.Builder

setAccelerators(int index, AcceleratorConfig.Builder builderForValue)

public InstanceGroupConfig.Builder setAccelerators(int index, AcceleratorConfig.Builder builderForValue)

Optional. The Compute Engine accelerator configuration for these instances.

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

Parameters
NameDescription
indexint
builderForValueAcceleratorConfig.Builder
Returns
TypeDescription
InstanceGroupConfig.Builder

setDiskConfig(DiskConfig value)

public InstanceGroupConfig.Builder setDiskConfig(DiskConfig value)

Optional. Disk option config settings.

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

Parameter
NameDescription
valueDiskConfig
Returns
TypeDescription
InstanceGroupConfig.Builder

setDiskConfig(DiskConfig.Builder builderForValue)

public InstanceGroupConfig.Builder setDiskConfig(DiskConfig.Builder builderForValue)

Optional. Disk option config settings.

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

Parameter
NameDescription
builderForValueDiskConfig.Builder
Returns
TypeDescription
InstanceGroupConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public InstanceGroupConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
InstanceGroupConfig.Builder
Overrides

setImageUri(String value)

public InstanceGroupConfig.Builder setImageUri(String value)

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];

Parameter
NameDescription
valueString

The imageUri to set.

Returns
TypeDescription
InstanceGroupConfig.Builder

This builder for chaining.

setImageUriBytes(ByteString value)

public InstanceGroupConfig.Builder setImageUriBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for imageUri to set.

Returns
TypeDescription
InstanceGroupConfig.Builder

This builder for chaining.

setInstanceNames(int index, String value)

public InstanceGroupConfig.Builder setInstanceNames(int index, String value)

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
NameDescription
indexint

The index to set the value at.

valueString

The instanceNames to set.

Returns
TypeDescription
InstanceGroupConfig.Builder

This builder for chaining.

setIsPreemptible(boolean value)

public InstanceGroupConfig.Builder setIsPreemptible(boolean value)

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

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

Parameter
NameDescription
valueboolean

The isPreemptible to set.

Returns
TypeDescription
InstanceGroupConfig.Builder

This builder for chaining.

setMachineTypeUri(String value)

public InstanceGroupConfig.Builder setMachineTypeUri(String value)

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 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];

Parameter
NameDescription
valueString

The machineTypeUri to set.

Returns
TypeDescription
InstanceGroupConfig.Builder

This builder for chaining.

setMachineTypeUriBytes(ByteString value)

public InstanceGroupConfig.Builder setMachineTypeUriBytes(ByteString value)

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 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];

Parameter
NameDescription
valueByteString

The bytes for machineTypeUri to set.

Returns
TypeDescription
InstanceGroupConfig.Builder

This builder for chaining.

setManagedGroupConfig(ManagedGroupConfig value)

public InstanceGroupConfig.Builder setManagedGroupConfig(ManagedGroupConfig value)

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];

Parameter
NameDescription
valueManagedGroupConfig
Returns
TypeDescription
InstanceGroupConfig.Builder

setManagedGroupConfig(ManagedGroupConfig.Builder builderForValue)

public InstanceGroupConfig.Builder setManagedGroupConfig(ManagedGroupConfig.Builder builderForValue)

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];

Parameter
NameDescription
builderForValueManagedGroupConfig.Builder
Returns
TypeDescription
InstanceGroupConfig.Builder

setMinCpuPlatform(String value)

public InstanceGroupConfig.Builder setMinCpuPlatform(String value)

Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform.

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

Parameter
NameDescription
valueString

The minCpuPlatform to set.

Returns
TypeDescription
InstanceGroupConfig.Builder

This builder for chaining.

setMinCpuPlatformBytes(ByteString value)

public InstanceGroupConfig.Builder setMinCpuPlatformBytes(ByteString value)

Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform.

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

Parameter
NameDescription
valueByteString

The bytes for minCpuPlatform to set.

Returns
TypeDescription
InstanceGroupConfig.Builder

This builder for chaining.

setNumInstances(int value)

public InstanceGroupConfig.Builder setNumInstances(int value)

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.

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

Parameter
NameDescription
valueint

The numInstances to set.

Returns
TypeDescription
InstanceGroupConfig.Builder

This builder for chaining.

setPreemptibility(InstanceGroupConfig.Preemptibility value)

public InstanceGroupConfig.Builder setPreemptibility(InstanceGroupConfig.Preemptibility value)

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];

Parameter
NameDescription
valueInstanceGroupConfig.Preemptibility

The preemptibility to set.

Returns
TypeDescription
InstanceGroupConfig.Builder

This builder for chaining.

setPreemptibilityValue(int value)

public InstanceGroupConfig.Builder setPreemptibilityValue(int value)

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];

Parameter
NameDescription
valueint

The enum numeric value on the wire for preemptibility to set.

Returns
TypeDescription
InstanceGroupConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public InstanceGroupConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
InstanceGroupConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final InstanceGroupConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
InstanceGroupConfig.Builder
Overrides