- 4.44.0 (latest)
- 4.43.0
- 4.42.0
- 4.41.0
- 4.40.0
- 4.39.0
- 4.38.0
- 4.37.0
- 4.36.0
- 4.34.0
- 4.33.0
- 4.32.0
- 4.31.0
- 4.30.0
- 4.29.0
- 4.28.0
- 4.27.0
- 4.26.0
- 4.25.0
- 4.24.0
- 4.21.0
- 4.20.0
- 4.19.0
- 4.18.0
- 4.17.0
- 4.16.0
- 4.15.0
- 4.14.0
- 4.13.0
- 4.12.0
- 4.11.0
- 4.10.0
- 4.9.0
- 4.8.0
- 4.6.0
- 4.5.0
- 4.4.0
- 4.3.0
- 4.2.0
- 4.1.0
- 4.0.8
- 3.1.2
- 3.0.3
- 2.3.1
public interface InstanceGroupConfigOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getAccelerators(int index)
public abstract 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 |
Returns | |
---|---|
Type | Description |
AcceleratorConfig |
getAcceleratorsCount()
public abstract 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 abstract 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 | |
---|---|
Type | Description |
List<AcceleratorConfig> |
getAcceleratorsOrBuilder(int index)
public abstract 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 |
Returns | |
---|---|
Type | Description |
AcceleratorConfigOrBuilder |
getAcceleratorsOrBuilderList()
public abstract 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> |
getDiskConfig()
public abstract DiskConfig getDiskConfig()
Optional. Disk option config settings.
.google.cloud.dataproc.v1.DiskConfig disk_config = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
DiskConfig | The diskConfig. |
getDiskConfigOrBuilder()
public abstract DiskConfigOrBuilder getDiskConfigOrBuilder()
Optional. Disk option config settings.
.google.cloud.dataproc.v1.DiskConfig disk_config = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
DiskConfigOrBuilder |
getImageUri()
public abstract 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 abstract 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 abstract InstanceFlexibilityPolicy getInstanceFlexibilityPolicy()
Optional. Instance flexibility Policy allowing a mixture of VM shapes and provisioning models.
.google.cloud.dataproc.v1.InstanceFlexibilityPolicy instance_flexibility_policy = 13 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
InstanceFlexibilityPolicy | The instanceFlexibilityPolicy. |
getInstanceFlexibilityPolicyOrBuilder()
public abstract 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];
Returns | |
---|---|
Type | Description |
InstanceFlexibilityPolicyOrBuilder |
getInstanceNames(int index)
public abstract 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 abstract 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 abstract 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 abstract List<String> getInstanceNamesList()
Output only. The list of instance names. Dataproc derives the names
from cluster_name
, num_instances
, and the instance group.
repeated string instance_names = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
List<String> | A list containing the instanceNames. |
getInstanceReferences(int index)
public abstract 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 |
Returns | |
---|---|
Type | Description |
InstanceReference |
getInstanceReferencesCount()
public abstract 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 abstract 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];
Returns | |
---|---|
Type | Description |
List<InstanceReference> |
getInstanceReferencesOrBuilder(int index)
public abstract 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 |
Returns | |
---|---|
Type | Description |
InstanceReferenceOrBuilder |
getInstanceReferencesOrBuilderList()
public abstract 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 abstract 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 abstract 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 | |
---|---|
Type | Description |
String | The machineTypeUri. |
getMachineTypeUriBytes()
public abstract 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 | |
---|---|
Type | Description |
ByteString | The bytes for machineTypeUri. |
getManagedGroupConfig()
public abstract 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 | |
---|---|
Type | Description |
ManagedGroupConfig | The managedGroupConfig. |
getManagedGroupConfigOrBuilder()
public abstract 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 | |
---|---|
Type | Description |
ManagedGroupConfigOrBuilder |
getMinCpuPlatform()
public abstract 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. |
getMinCpuPlatformBytes()
public abstract 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 abstract 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 abstract 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. |
getPreemptibility()
public abstract 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 | |
---|---|
Type | Description |
InstanceGroupConfig.Preemptibility | The preemptibility. |
getPreemptibilityValue()
public abstract 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. |
getStartupConfig()
public abstract 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];
Returns | |
---|---|
Type | Description |
StartupConfig | The startupConfig. |
getStartupConfigOrBuilder()
public abstract 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];
Returns | |
---|---|
Type | Description |
StartupConfigOrBuilder |
hasDiskConfig()
public abstract 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 abstract 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 abstract 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. |
hasStartupConfig()
public abstract 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];
Returns | |
---|---|
Type | Description |
boolean | Whether the startupConfig field is set. |