Google Cloud Dataproc v1 API - Class InstanceGroupConfig (5.13.0) 

public sealed class InstanceGroupConfig : IMessage<InstanceGroupConfig>, IEquatable<InstanceGroupConfig>, IDeepCloneable<InstanceGroupConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Dataproc v1 API class InstanceGroupConfig.

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

Inheritance

object > InstanceGroupConfig

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Constructors

InstanceGroupConfig()

public InstanceGroupConfig()

InstanceGroupConfig(InstanceGroupConfig)

public InstanceGroupConfig(InstanceGroupConfig other)
Parameter
Name Description
other InstanceGroupConfig

Properties

Accelerators

public RepeatedField<AcceleratorConfig> Accelerators { get; }

Optional. The Compute Engine accelerator configuration for these instances.

Property Value
Type Description
RepeatedFieldAcceleratorConfig

DiskConfig

public DiskConfig DiskConfig { get; set; }

Optional. Disk option config settings.

Property Value
Type Description
DiskConfig

ImageUri

public string ImageUri { get; set; }

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.

Property Value
Type Description
string

InstanceFlexibilityPolicy

public InstanceFlexibilityPolicy InstanceFlexibilityPolicy { get; set; }

Optional. Instance flexibility Policy allowing a mixture of VM shapes and provisioning models.

Property Value
Type Description
InstanceFlexibilityPolicy

InstanceNames

public RepeatedField<string> InstanceNames { get; }

Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

Property Value
Type Description
RepeatedFieldstring

InstanceReferences

public RepeatedField<InstanceReference> InstanceReferences { get; }

Output only. List of references to Compute Engine instances.

Property Value
Type Description
RepeatedFieldInstanceReference

IsPreemptible

public bool IsPreemptible { get; set; }

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

Property Value
Type Description
bool

MachineTypeUri

public string MachineTypeUri { get; set; }

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.

Property Value
Type Description
string

ManagedGroupConfig

public ManagedGroupConfig ManagedGroupConfig { get; set; }

Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

Property Value
Type Description
ManagedGroupConfig

MinCpuPlatform

public string MinCpuPlatform { get; set; }

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

Property Value
Type Description
string

MinNumInstances

public int MinNumInstances { get; set; }

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.
Property Value
Type Description
int

NumInstances

public int NumInstances { get; set; }

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.

Property Value
Type Description
int

Preemptibility

public InstanceGroupConfig.Types.Preemptibility Preemptibility { get; set; }

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.

Property Value
Type Description
InstanceGroupConfigTypesPreemptibility

StartupConfig

public StartupConfig StartupConfig { get; set; }

Optional. Configuration to handle the startup of instances during cluster create and update process.

Property Value
Type Description
StartupConfig