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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
ACCELERATORS_FIELD_NUMBER
public static final int ACCELERATORS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISK_CONFIG_FIELD_NUMBER
public static final int DISK_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
IMAGE_URI_FIELD_NUMBER
public static final int IMAGE_URI_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INSTANCE_FLEXIBILITY_POLICY_FIELD_NUMBER
public static final int INSTANCE_FLEXIBILITY_POLICY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INSTANCE_NAMES_FIELD_NUMBER
public static final int INSTANCE_NAMES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INSTANCE_REFERENCES_FIELD_NUMBER
public static final int INSTANCE_REFERENCES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
IS_PREEMPTIBLE_FIELD_NUMBER
public static final int IS_PREEMPTIBLE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MACHINE_TYPE_URI_FIELD_NUMBER
public static final int MACHINE_TYPE_URI_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MANAGED_GROUP_CONFIG_FIELD_NUMBER
public static final int MANAGED_GROUP_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int MIN_CPU_PLATFORM_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MIN_NUM_INSTANCES_FIELD_NUMBER
public static final int MIN_NUM_INSTANCES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NUM_INSTANCES_FIELD_NUMBER
public static final int NUM_INSTANCES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PREEMPTIBILITY_FIELD_NUMBER
public static final int PREEMPTIBILITY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static InstanceGroupConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static InstanceGroupConfig.Builder newBuilder()
newBuilder(InstanceGroupConfig prototype)
public static InstanceGroupConfig.Builder newBuilder(InstanceGroupConfig prototype)
public static InstanceGroupConfig parseDelimitedFrom(InputStream input)
public static InstanceGroupConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static InstanceGroupConfig parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static InstanceGroupConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static InstanceGroupConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static InstanceGroupConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static InstanceGroupConfig parseFrom(CodedInputStream input)
public static InstanceGroupConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static InstanceGroupConfig parseFrom(InputStream input)
public static InstanceGroupConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static InstanceGroupConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static InstanceGroupConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<InstanceGroupConfig> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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 |
|---|
| Name | Description |
index | int
|
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 |
|---|
| Type | Description |
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];
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 |
|---|
| Name | Description |
index | int
|
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()
getDiskConfig()
public DiskConfig getDiskConfig()
Optional. Disk option config settings.
.google.cloud.dataproc.v1.DiskConfig disk_config = 5 [(.google.api.field_behavior) = OPTIONAL];
getDiskConfigOrBuilder()
public DiskConfigOrBuilder getDiskConfigOrBuilder()
Optional. Disk option config settings.
.google.cloud.dataproc.v1.DiskConfig disk_config = 5 [(.google.api.field_behavior) = OPTIONAL];
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 |
|---|
| 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/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 |
|---|
| Type | Description |
ByteString | The bytes for imageUri.
|
getInstanceFlexibilityPolicy()
public 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];
getInstanceFlexibilityPolicyOrBuilder()
public 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];
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];
getInstanceReferences(int index)
public 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];
| Parameter |
|---|
| Name | Description |
index | int
|
getInstanceReferencesCount()
public 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];
| Returns |
|---|
| Type | Description |
int | |
getInstanceReferencesList()
public 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];
getInstanceReferencesOrBuilder(int index)
public 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];
| Parameter |
|---|
| Name | Description |
index | int
|
getInstanceReferencesOrBuilderList()
public 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];
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.dataproc.v1.InstanceReferenceOrBuilder> | |
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/[zone]/machineTypes/n1-standard-2projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2n1-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/[zone]/machineTypes/n1-standard-2projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2n1-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];
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];
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.
|
getMinNumInstances()
public int getMinNumInstances()
Optional. The minimum number of primary worker instances to create.
If min_num_instances is set, cluster creation will succeed if
the number of primary workers created is at least equal to the
min_num_instances number.
Example: Cluster creation request with num_instances = 5 and
min_num_instances = 3:
- If 4 VMs are created and 1 instance fails,
the failed VM is deleted. The cluster is
resized to 4 instances and placed in a
RUNNING state.
- If 2 instances are created and 3 instances fail,
the cluster in placed in an
ERROR state. The failed VMs
are not deleted.
int32 min_num_instances = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
int | The minNumInstances.
|
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()
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];
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 |
|---|
| Type | Description |
int | |
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.
|
hasInstanceFlexibilityPolicy()
public 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 |
|---|
| Type | Description |
boolean | Whether the instanceFlexibilityPolicy 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 |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public InstanceGroupConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected InstanceGroupConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public InstanceGroupConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
