Cloud Dataproc V1 API - Class Google::Cloud::Dataproc::V1::InstanceGroupConfig (v0.23.1)

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

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#accelerators

def accelerators() -> ::Array<::Google::Cloud::Dataproc::V1::AcceleratorConfig>

Returns

(::Array<::Google::Cloud::Dataproc::V1::AcceleratorConfig>) — Optional. The Compute Engine accelerator configuration for these instances.

#accelerators=

def accelerators=(value) -> ::Array<::Google::Cloud::Dataproc::V1::AcceleratorConfig>

Parameter

value (::Array<::Google::Cloud::Dataproc::V1::AcceleratorConfig>) — Optional. The Compute Engine accelerator configuration for these instances.

Returns

(::Array<::Google::Cloud::Dataproc::V1::AcceleratorConfig>) — Optional. The Compute Engine accelerator configuration for these instances.

#disk_config

def disk_config() -> ::Google::Cloud::Dataproc::V1::DiskConfig

Returns

(::Google::Cloud::Dataproc::V1::DiskConfig) — Optional. Disk option config settings.

#disk_config=

def disk_config=(value) -> ::Google::Cloud::Dataproc::V1::DiskConfig

Parameter

value (::Google::Cloud::Dataproc::V1::DiskConfig) — Optional. Disk option config settings.

Returns

(::Google::Cloud::Dataproc::V1::DiskConfig) — Optional. Disk option config settings.

#image_uri

def image_uri() -> ::String

Returns

(::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.

#image_uri=

def image_uri=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#instance_flexibility_policy

def instance_flexibility_policy() -> ::Google::Cloud::Dataproc::V1::InstanceFlexibilityPolicy

Returns

(::Google::Cloud::Dataproc::V1::InstanceFlexibilityPolicy) — Optional. Instance flexibility Policy allowing a mixture of VM shapes and provisioning models.

#instance_flexibility_policy=

def instance_flexibility_policy=(value) -> ::Google::Cloud::Dataproc::V1::InstanceFlexibilityPolicy

Parameter

value (::Google::Cloud::Dataproc::V1::InstanceFlexibilityPolicy) — Optional. Instance flexibility Policy allowing a mixture of VM shapes and provisioning models.

Returns

(::Google::Cloud::Dataproc::V1::InstanceFlexibilityPolicy) — Optional. Instance flexibility Policy allowing a mixture of VM shapes and provisioning models.

#instance_names

def instance_names() -> ::Array<::String>

Returns

(::Array<::String>) — Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

#instance_references

def instance_references() -> ::Array<::Google::Cloud::Dataproc::V1::InstanceReference>

Returns

(::Array<::Google::Cloud::Dataproc::V1::InstanceReference>) — Output only. List of references to Compute Engine instances.

#is_preemptible

def is_preemptible() -> ::Boolean

Returns

(::Boolean) — Output only. Specifies that this instance group contains preemptible instances.

#machine_type_uri

def machine_type_uri() -> ::String

Returns

(::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.

#machine_type_uri=

def machine_type_uri=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#managed_group_config

def managed_group_config() -> ::Google::Cloud::Dataproc::V1::ManagedGroupConfig

Returns

(::Google::Cloud::Dataproc::V1::ManagedGroupConfig) — Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

#min_cpu_platform

def min_cpu_platform() -> ::String

Returns

(::String) — Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform.

#min_cpu_platform=

def min_cpu_platform=(value) -> ::String

Parameter

value (::String) — Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform.

Returns

(::String) — Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform.

#min_num_instances

def min_num_instances() -> ::Integer

Returns

(::Integer) —
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.

#min_num_instances=

def min_num_instances=(value) -> ::Integer

Parameter

value (::Integer) —
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

(::Integer) —
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.

#num_instances

def num_instances() -> ::Integer

Returns

(::Integer) — 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.

#num_instances=

def num_instances=(value) -> ::Integer

Parameter

value (::Integer) — 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

(::Integer) — 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.

#preemptibility

def preemptibility() -> ::Google::Cloud::Dataproc::V1::InstanceGroupConfig::Preemptibility

Returns

(::Google::Cloud::Dataproc::V1::InstanceGroupConfig::Preemptibility) — 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.

#preemptibility=

def preemptibility=(value) -> ::Google::Cloud::Dataproc::V1::InstanceGroupConfig::Preemptibility

Parameter

value (::Google::Cloud::Dataproc::V1::InstanceGroupConfig::Preemptibility) — 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

(::Google::Cloud::Dataproc::V1::InstanceGroupConfig::Preemptibility) — 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.

#startup_config

def startup_config() -> ::Google::Cloud::Dataproc::V1::StartupConfig

Returns

(::Google::Cloud::Dataproc::V1::StartupConfig) — Optional. Configuration to handle the startup of instances during cluster create and update process.

#startup_config=

def startup_config=(value) -> ::Google::Cloud::Dataproc::V1::StartupConfig

Parameter

value (::Google::Cloud::Dataproc::V1::StartupConfig) — Optional. Configuration to handle the startup of instances during cluster create and update process.

Returns

(::Google::Cloud::Dataproc::V1::StartupConfig) — Optional. Configuration to handle the startup of instances during cluster create and update process.