Google Cloud Dataproc V1 Client - Class InstanceGroupConfig (2.2.2)

Reference documentation and code samples for the Google Cloud Dataproc V1 Client class InstanceGroupConfig.

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

Generated from protobuf message google.cloud.dataproc.v1.InstanceGroupConfig

Namespace

Google \ Cloud \ Dataproc \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ num_instances int

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.
↳ instance_names array

Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
↳ instance_references array<InstanceReference>

Output only. List of references to Compute Engine instances.
↳ image_uri string

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.
↳ machine_type_uri string

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.
↳ disk_config DiskConfig

Optional. Disk option config settings.
↳ is_preemptible bool

Output only. Specifies that this instance group contains preemptible instances.
↳ preemptibility int

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.
↳ managed_group_config ManagedGroupConfig

Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
↳ accelerators array<AcceleratorConfig>

Optional. The Compute Engine accelerator configuration for these instances.
↳ min_cpu_platform string

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

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.
↳ instance_flexibility_policy InstanceFlexibilityPolicy

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

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

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.

Returns
Type Description
int

setNumInstances

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getInstanceNames

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setInstanceNames

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

Parameter
Name Description
var string[]
Returns
Type Description
$this

getInstanceReferences

Output only. List of references to Compute Engine instances.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setInstanceReferences

Output only. List of references to Compute Engine instances.

Parameter
Name Description
var array<InstanceReference>
Returns
Type Description
$this

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.
Returns
Type Description
string

setImageUri

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.
Parameter
Name Description
var string
Returns
Type Description
$this

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.
Returns
Type Description
string

setMachineTypeUri

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.
Parameter
Name Description
var string
Returns
Type Description
$this

getDiskConfig

Optional. Disk option config settings.

Returns
Type Description
DiskConfig|null

hasDiskConfig

clearDiskConfig

setDiskConfig

Optional. Disk option config settings.

Parameter
Name Description
var DiskConfig
Returns
Type Description
$this

getIsPreemptible

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

Returns
Type Description
bool

setIsPreemptible

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

Parameter
Name Description
var bool
Returns
Type Description
$this

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.

Returns
Type Description
int

setPreemptibility

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getManagedGroupConfig

Output only. The config for Compute Engine Instance Group Manager that manages this group.

This is only used for preemptible instance groups.

Returns
Type Description
ManagedGroupConfig|null

hasManagedGroupConfig

clearManagedGroupConfig

setManagedGroupConfig

Output only. The config for Compute Engine Instance Group Manager that manages this group.

This is only used for preemptible instance groups.

Parameter
Name Description
var ManagedGroupConfig
Returns
Type Description
$this

getAccelerators

Optional. The Compute Engine accelerator configuration for these instances.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAccelerators

Optional. The Compute Engine accelerator configuration for these instances.

Parameter
Name Description
var array<AcceleratorConfig>
Returns
Type Description
$this

getMinCpuPlatform

Optional. Specifies the minimum cpu platform for the Instance Group.

See Dataproc -> Minimum CPU Platform.

Returns
Type Description
string

setMinCpuPlatform

Optional. Specifies the minimum cpu platform for the Instance Group.

See Dataproc -> Minimum CPU Platform.

Parameter
Name Description
var string
Returns
Type Description
$this

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

setMinNumInstances

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.
Parameter
Name Description
var int
Returns
Type Description
$this

getInstanceFlexibilityPolicy

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

Returns
Type Description
InstanceFlexibilityPolicy|null

hasInstanceFlexibilityPolicy

clearInstanceFlexibilityPolicy

setInstanceFlexibilityPolicy

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

Parameter
Name Description
var InstanceFlexibilityPolicy
Returns
Type Description
$this

getStartupConfig

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

Returns
Type Description
StartupConfig|null

hasStartupConfig

clearStartupConfig

setStartupConfig

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

Parameter
Name Description
var StartupConfig
Returns
Type Description
$this