public final class InstanceGroupConfig extends GeneratedMessageV3 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 Fields
ACCELERATORS_FIELD_NUMBER
public static final int ACCELERATORS_FIELD_NUMBER
Field Value
DISK_CONFIG_FIELD_NUMBER
public static final int DISK_CONFIG_FIELD_NUMBER
Field Value
IMAGE_URI_FIELD_NUMBER
public static final int IMAGE_URI_FIELD_NUMBER
Field Value
INSTANCE_NAMES_FIELD_NUMBER
public static final int INSTANCE_NAMES_FIELD_NUMBER
Field Value
IS_PREEMPTIBLE_FIELD_NUMBER
public static final int IS_PREEMPTIBLE_FIELD_NUMBER
Field Value
MACHINE_TYPE_URI_FIELD_NUMBER
public static final int MACHINE_TYPE_URI_FIELD_NUMBER
Field Value
MANAGED_GROUP_CONFIG_FIELD_NUMBER
public static final int MANAGED_GROUP_CONFIG_FIELD_NUMBER
Field Value
public static final int MIN_CPU_PLATFORM_FIELD_NUMBER
Field Value
NUM_INSTANCES_FIELD_NUMBER
public static final int NUM_INSTANCES_FIELD_NUMBER
Field Value
PREEMPTIBILITY_FIELD_NUMBER
public static final int PREEMPTIBILITY_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static InstanceGroupConfig getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static InstanceGroupConfig.Builder newBuilder()
Returns
newBuilder(InstanceGroupConfig prototype)
public static InstanceGroupConfig.Builder newBuilder(InstanceGroupConfig prototype)
Parameter
Returns
public static InstanceGroupConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static InstanceGroupConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static InstanceGroupConfig parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static InstanceGroupConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static InstanceGroupConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static InstanceGroupConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static InstanceGroupConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static InstanceGroupConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static InstanceGroupConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static InstanceGroupConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static InstanceGroupConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static InstanceGroupConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<InstanceGroupConfig> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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
Returns
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
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
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
Returns
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
Type | Description |
List<? extends com.google.cloud.dataproc.v1.AcceleratorConfigOrBuilder> | |
getDefaultInstanceForType()
public InstanceGroupConfig getDefaultInstanceForType()
Returns
getDiskConfig()
public DiskConfig getDiskConfig()
Optional. Disk option config settings.
.google.cloud.dataproc.v1.DiskConfig disk_config = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns
getDiskConfigOrBuilder()
public DiskConfigOrBuilder getDiskConfigOrBuilder()
Optional. Disk option config settings.
.google.cloud.dataproc.v1.DiskConfig disk_config = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns
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-id
Image 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.
string image_uri = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type | Description |
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/beta/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/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.
string image_uri = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
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
Name | Description |
index | int
The index of the element to return.
|
Returns
Type | Description |
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
Name | Description |
index | int
The index of the value to return.
|
Returns
Type | Description |
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
Type | Description |
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
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
Type | Description |
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/us-east1-a/machineTypes/n1-standard-2
projects/[project_id]/zones/us-east1-a/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
Type | Description |
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/us-east1-a/machineTypes/n1-standard-2
projects/[project_id]/zones/us-east1-a/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
Type | Description |
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
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
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
Type | Description |
String | The minCpuPlatform.
|
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
Type | Description |
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
Type | Description |
int | The numInstances.
|
getParserForType()
public Parser<InstanceGroupConfig> getParserForType()
Returns
Overrides
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
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
Type | Description |
int | The enum numeric value on the wire for preemptibility.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasDiskConfig()
public boolean hasDiskConfig()
Optional. Disk option config settings.
.google.cloud.dataproc.v1.DiskConfig disk_config = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type | Description |
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
Type | Description |
boolean | Whether the managedGroupConfig field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public InstanceGroupConfig.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected InstanceGroupConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public InstanceGroupConfig.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions