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

Version 0.12.0

• 1.1.0 (latest)
• 1.0.2
• 0.26.0
• 0.25.0
• 0.24.1
• 0.23.1
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.1
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.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/beta/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/beta/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/beta/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/beta/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/beta/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/beta/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_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.

#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/us-east1-a/machineTypes/n1-standard-2
  • projects/[project_id]/zones/us-east1-a/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/us-east1-a/machineTypes/n1-standard-2
  • projects/[project_id]/zones/us-east1-a/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/us-east1-a/machineTypes/n1-standard-2
  • projects/[project_id]/zones/us-east1-a/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.

#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.