Cloud Dataproc V1 API - Class Google::Cloud::Dataproc::V1::InstanceGroupConfig (v1.3.1)
Stay organized with collections
Save and categorize content based on your preferences.
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
defaccelerators()->::Array<::Google::Cloud::Dataproc::V1::AcceleratorConfig>- (::Array<::Google::Cloud::Dataproc::V1::AcceleratorConfig>) — Optional. The Compute Engine accelerator configuration for these instances.
#accelerators=
defaccelerators=(value)->::Array<::Google::Cloud::Dataproc::V1::AcceleratorConfig>- value (::Array<::Google::Cloud::Dataproc::V1::AcceleratorConfig>) — Optional. The Compute Engine accelerator configuration for these instances.
- (::Array<::Google::Cloud::Dataproc::V1::AcceleratorConfig>) — Optional. The Compute Engine accelerator configuration for these instances.
#disk_config
defdisk_config()->::Google::Cloud::Dataproc::V1::DiskConfig- (::Google::Cloud::Dataproc::V1::DiskConfig) — Optional. Disk option config settings.
#disk_config=
defdisk_config=(value)->::Google::Cloud::Dataproc::V1::DiskConfig- value (::Google::Cloud::Dataproc::V1::DiskConfig) — Optional. Disk option config settings.
- (::Google::Cloud::Dataproc::V1::DiskConfig) — Optional. Disk option config settings.
#image_uri
defimage_uri()->::String-
(::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_versionor the system default.
#image_uri=
defimage_uri=(value)->::String-
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_versionor the system default.
-
(::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_versionor the system default.
#instance_flexibility_policy
definstance_flexibility_policy()->::Google::Cloud::Dataproc::V1::InstanceFlexibilityPolicy- (::Google::Cloud::Dataproc::V1::InstanceFlexibilityPolicy) — Optional. Instance flexibility Policy allowing a mixture of VM shapes and provisioning models.
#instance_flexibility_policy=
definstance_flexibility_policy=(value)->::Google::Cloud::Dataproc::V1::InstanceFlexibilityPolicy- value (::Google::Cloud::Dataproc::V1::InstanceFlexibilityPolicy) — Optional. Instance flexibility Policy allowing a mixture of VM shapes and provisioning models.
- (::Google::Cloud::Dataproc::V1::InstanceFlexibilityPolicy) — Optional. Instance flexibility Policy allowing a mixture of VM shapes and provisioning models.
#instance_names
definstance_names()->::Array<::String>-
(::Array<::String>) — Output only. The list of instance names. Dataproc derives the names
from
cluster_name,num_instances, and the instance group.
#instance_references
definstance_references()->::Array<::Google::Cloud::Dataproc::V1::InstanceReference>- (::Array<::Google::Cloud::Dataproc::V1::InstanceReference>) — Output only. List of references to Compute Engine instances.
#is_preemptible
defis_preemptible()->::Boolean- (::Boolean) — Output only. Specifies that this instance group contains preemptible instances.
#machine_type_uri
defmachine_type_uri()->::String-
(::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-2projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2n1-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=
defmachine_type_uri=(value)->::String-
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-2projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2n1-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) — 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-2projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2n1-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
defmanaged_group_config()->::Google::Cloud::Dataproc::V1::ManagedGroupConfig- (::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
defmin_cpu_platform()->::String- (::String) — Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform.
#min_cpu_platform=
defmin_cpu_platform=(value)->::String- value (::String) — Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform.
- (::String) — Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform.
#min_num_instances
defmin_num_instances()->::Integer-
(::Integer) —
Optional. The minimum number of primary worker instances to create. If
min_num_instancesis set, cluster creation will succeed if the number of primary workers created is at least equal to themin_num_instancesnumber.Example: Cluster creation request with
num_instances=5andmin_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
RUNNINGstate. - If 2 instances are created and 3 instances fail,
the cluster in placed in an
ERRORstate. The failed VMs are not deleted.
- 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
#min_num_instances=
defmin_num_instances=(value)->::Integer-
value (::Integer) —
Optional. The minimum number of primary worker instances to create. If
min_num_instancesis set, cluster creation will succeed if the number of primary workers created is at least equal to themin_num_instancesnumber.Example: Cluster creation request with
num_instances=5andmin_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
RUNNINGstate. - If 2 instances are created and 3 instances fail,
the cluster in placed in an
ERRORstate. The failed VMs are not deleted.
- 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
-
(::Integer) —
Optional. The minimum number of primary worker instances to create. If
min_num_instancesis set, cluster creation will succeed if the number of primary workers created is at least equal to themin_num_instancesnumber.Example: Cluster creation request with
num_instances=5andmin_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
RUNNINGstate. - If 2 instances are created and 3 instances fail,
the cluster in placed in an
ERRORstate. The failed VMs are not deleted.
- 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
#num_instances
defnum_instances()->::Integer- (::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=
defnum_instances=(value)->::Integer- 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.
- (::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
defpreemptibility()->::Google::Cloud::Dataproc::V1::InstanceGroupConfig::Preemptibility-
(::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=
defpreemptibility=(value)->::Google::Cloud::Dataproc::V1::InstanceGroupConfig::Preemptibility-
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.
-
(::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
defstartup_config()->::Google::Cloud::Dataproc::V1::StartupConfig- (::Google::Cloud::Dataproc::V1::StartupConfig) — Optional. Configuration to handle the startup of instances during cluster create and update process.
#startup_config=
defstartup_config=(value)->::Google::Cloud::Dataproc::V1::StartupConfig- value (::Google::Cloud::Dataproc::V1::StartupConfig) — Optional. Configuration to handle the startup of instances during cluster create and update process.
- (::Google::Cloud::Dataproc::V1::StartupConfig) — Optional. Configuration to handle the startup of instances during cluster create and update process.