public final class InstanceGroupConfig extends com.google.protobuf.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| Modifier and Type | Class and Description |
|---|---|
static class |
InstanceGroupConfig.Builder
The config settings for Compute Engine resources in
an instance group, such as a master or worker group.
|
static class |
InstanceGroupConfig.Preemptibility
Controls the use of preemptible instances within the group.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
ACCELERATORS_FIELD_NUMBER |
static int |
DISK_CONFIG_FIELD_NUMBER |
static int |
IMAGE_URI_FIELD_NUMBER |
static int |
INSTANCE_FLEXIBILITY_POLICY_FIELD_NUMBER |
static int |
INSTANCE_NAMES_FIELD_NUMBER |
static int |
INSTANCE_REFERENCES_FIELD_NUMBER |
static int |
IS_PREEMPTIBLE_FIELD_NUMBER |
static int |
MACHINE_TYPE_URI_FIELD_NUMBER |
static int |
MANAGED_GROUP_CONFIG_FIELD_NUMBER |
static int |
MIN_CPU_PLATFORM_FIELD_NUMBER |
static int |
MIN_NUM_INSTANCES_FIELD_NUMBER |
static int |
NUM_INSTANCES_FIELD_NUMBER |
static int |
PREEMPTIBILITY_FIELD_NUMBER |
static int |
STARTUP_CONFIG_FIELD_NUMBER |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NUM_INSTANCES_FIELD_NUMBER
public static final int INSTANCE_NAMES_FIELD_NUMBER
public static final int INSTANCE_REFERENCES_FIELD_NUMBER
public static final int IMAGE_URI_FIELD_NUMBER
public static final int MACHINE_TYPE_URI_FIELD_NUMBER
public static final int DISK_CONFIG_FIELD_NUMBER
public static final int IS_PREEMPTIBLE_FIELD_NUMBER
public static final int PREEMPTIBILITY_FIELD_NUMBER
public static final int MANAGED_GROUP_CONFIG_FIELD_NUMBER
public static final int ACCELERATORS_FIELD_NUMBER
public static final int MIN_CPU_PLATFORM_FIELD_NUMBER
public static final int MIN_NUM_INSTANCES_FIELD_NUMBER
public static final int INSTANCE_FLEXIBILITY_POLICY_FIELD_NUMBER
public static final int STARTUP_CONFIG_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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];getNumInstances in interface InstanceGroupConfigOrBuilderpublic com.google.protobuf.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];getInstanceNamesList in interface InstanceGroupConfigOrBuilderpublic 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];getInstanceNamesCount in interface InstanceGroupConfigOrBuilderpublic 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];getInstanceNames in interface InstanceGroupConfigOrBuilderindex - The index of the element to return.public 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];getInstanceNamesBytes in interface InstanceGroupConfigOrBuilderindex - The index of the value to return.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];
getInstanceReferencesList in interface InstanceGroupConfigOrBuilderpublic 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];
getInstanceReferencesOrBuilderList in interface InstanceGroupConfigOrBuilderpublic 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];
getInstanceReferencesCount in interface InstanceGroupConfigOrBuilderpublic 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];
getInstanceReferences in interface InstanceGroupConfigOrBuilderpublic 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];
getInstanceReferencesOrBuilder in interface InstanceGroupConfigOrBuilderpublic 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];getImageUri in interface InstanceGroupConfigOrBuilderpublic 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];getImageUriBytes in interface InstanceGroupConfigOrBuilderpublic 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];getMachineTypeUri in interface InstanceGroupConfigOrBuilderpublic 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];getMachineTypeUriBytes in interface InstanceGroupConfigOrBuilderpublic boolean hasDiskConfig()
Optional. Disk option config settings.
.google.cloud.dataproc.v1.DiskConfig disk_config = 5 [(.google.api.field_behavior) = OPTIONAL];
hasDiskConfig in interface InstanceGroupConfigOrBuilderpublic DiskConfig getDiskConfig()
Optional. Disk option config settings.
.google.cloud.dataproc.v1.DiskConfig disk_config = 5 [(.google.api.field_behavior) = OPTIONAL];
getDiskConfig in interface InstanceGroupConfigOrBuilderpublic DiskConfigOrBuilder getDiskConfigOrBuilder()
Optional. Disk option config settings.
.google.cloud.dataproc.v1.DiskConfig disk_config = 5 [(.google.api.field_behavior) = OPTIONAL];
getDiskConfigOrBuilder in interface InstanceGroupConfigOrBuilderpublic boolean getIsPreemptible()
Output only. Specifies that this instance group contains preemptible instances.
bool is_preemptible = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];getIsPreemptible in interface InstanceGroupConfigOrBuilderpublic 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];
getPreemptibilityValue in interface InstanceGroupConfigOrBuilderpublic 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];
getPreemptibility in interface InstanceGroupConfigOrBuilderpublic 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];
hasManagedGroupConfig in interface InstanceGroupConfigOrBuilderpublic 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];
getManagedGroupConfig in interface InstanceGroupConfigOrBuilderpublic 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];
getManagedGroupConfigOrBuilder in interface InstanceGroupConfigOrBuilderpublic 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];
getAcceleratorsList in interface InstanceGroupConfigOrBuilderpublic 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];
getAcceleratorsOrBuilderList in interface InstanceGroupConfigOrBuilderpublic int getAcceleratorsCount()
Optional. The Compute Engine accelerator configuration for these instances.
repeated .google.cloud.dataproc.v1.AcceleratorConfig accelerators = 8 [(.google.api.field_behavior) = OPTIONAL];
getAcceleratorsCount in interface InstanceGroupConfigOrBuilderpublic 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];
getAccelerators in interface InstanceGroupConfigOrBuilderpublic 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];
getAcceleratorsOrBuilder in interface InstanceGroupConfigOrBuilderpublic 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];getMinCpuPlatform in interface InstanceGroupConfigOrBuilderpublic 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];getMinCpuPlatformBytes in interface InstanceGroupConfigOrBuilderpublic 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];getMinNumInstances in interface InstanceGroupConfigOrBuilderpublic 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];
hasInstanceFlexibilityPolicy in interface InstanceGroupConfigOrBuilderpublic 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];
getInstanceFlexibilityPolicy in interface InstanceGroupConfigOrBuilderpublic 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];
getInstanceFlexibilityPolicyOrBuilder in interface InstanceGroupConfigOrBuilderpublic boolean hasStartupConfig()
Optional. Configuration to handle the startup of instances during cluster create and update process.
.google.cloud.dataproc.v1.StartupConfig startup_config = 14 [(.google.api.field_behavior) = OPTIONAL];
hasStartupConfig in interface InstanceGroupConfigOrBuilderpublic StartupConfig getStartupConfig()
Optional. Configuration to handle the startup of instances during cluster create and update process.
.google.cloud.dataproc.v1.StartupConfig startup_config = 14 [(.google.api.field_behavior) = OPTIONAL];
getStartupConfig in interface InstanceGroupConfigOrBuilderpublic StartupConfigOrBuilder getStartupConfigOrBuilder()
Optional. Configuration to handle the startup of instances during cluster create and update process.
.google.cloud.dataproc.v1.StartupConfig startup_config = 14 [(.google.api.field_behavior) = OPTIONAL];
getStartupConfigOrBuilder in interface InstanceGroupConfigOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static InstanceGroupConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static InstanceGroupConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static InstanceGroupConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static InstanceGroupConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static InstanceGroupConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static InstanceGroupConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static InstanceGroupConfig parseFrom(InputStream input) throws IOException
IOExceptionpublic static InstanceGroupConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static InstanceGroupConfig parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static InstanceGroupConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static InstanceGroupConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static InstanceGroupConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic InstanceGroupConfig.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static InstanceGroupConfig.Builder newBuilder()
public static InstanceGroupConfig.Builder newBuilder(InstanceGroupConfig prototype)
public InstanceGroupConfig.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected InstanceGroupConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static InstanceGroupConfig getDefaultInstance()
public static com.google.protobuf.Parser<InstanceGroupConfig> parser()
public com.google.protobuf.Parser<InstanceGroupConfig> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public InstanceGroupConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.