Class: Google::Apis::DataprocV1::InstanceGroupConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dataproc_v1/classes.rb,
lib/google/apis/dataproc_v1/representations.rb,
lib/google/apis/dataproc_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ InstanceGroupConfig

Returns a new instance of InstanceGroupConfig.



2402
2403
2404
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 2402

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#accelerators ⇒ Array<Google::Apis::DataprocV1::AcceleratorConfig>

Optional. The Compute Engine accelerator configuration for these instances. Corresponds to the JSON property accelerators

Returns:



2303
2304
2305
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 2303

def accelerators
  @accelerators
end

#disk_config ⇒ Google::Apis::DataprocV1::DiskConfig

Specifies the config of disk options for a group of VM instances. Corresponds to the JSON property diskConfig

Returns:



2308
2309
2310
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 2308

def disk_config
  @disk_config
end

#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-idImage 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. Corresponds to the JSON property imageUri

Returns:

  • (String) 


2321
2322
2323
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 2321

def image_uri
  @image_uri
end

#instance_flexibility_policy ⇒ Google::Apis::DataprocV1::InstanceFlexibilityPolicy

Instance flexibility Policy allowing a mixture of VM shapes and provisioning models. Corresponds to the JSON property instanceFlexibilityPolicy

Returns:



2327
2328
2329
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 2327

def instance_flexibility_policy
  @instance_flexibility_policy
end

#instance_names ⇒ Array<String>

Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group. Corresponds to the JSON property instanceNames

Returns:

  • (Array<String>) 


2333
2334
2335
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 2333

def instance_names
  @instance_names
end

#instance_references ⇒ Array<Google::Apis::DataprocV1::InstanceReference>

Output only. List of references to Compute Engine instances. Corresponds to the JSON property instanceReferences

Returns:



2338
2339
2340
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 2338

def instance_references
  @instance_references
end

#is_preemptible ⇒ Boolean Also known as: is_preemptible?

Output only. Specifies that this instance group contains preemptible instances. Corresponds to the JSON property isPreemptible

Returns:

  • (Boolean) 


2343
2344
2345
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 2343

def is_preemptible
  @is_preemptible
end

#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- 2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https: //cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone# using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2. Corresponds to the JSON property machineTypeUri

Returns:

  • (String) 


2356
2357
2358
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 2356

def machine_type_uri
  @machine_type_uri
end

#managed_group_config ⇒ Google::Apis::DataprocV1::ManagedGroupConfig

Specifies the resources used to actively manage an instance group. Corresponds to the JSON property managedGroupConfig

Returns:



2361
2362
2363
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 2361

def managed_group_config
  @managed_group_config
end

#min_cpu_platform ⇒ String

Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform (https://cloud.google.com/dataproc/docs/ concepts/compute/dataproc-min-cpu). Corresponds to the JSON property minCpuPlatform

Returns:

  • (String) 


2368
2369
2370
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 2368

def min_cpu_platform
  @min_cpu_platform
end

#min_num_instances ⇒ Fixnum

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. Corresponds to the JSON property minNumInstances

Returns:

  • (Fixnum) 


2380
2381
2382
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 2380

def min_num_instances
  @min_num_instances
end

#num_instances ⇒ Fixnum

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. Corresponds to the JSON property numInstances

Returns:

  • (Fixnum) 


2387
2388
2389
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 2387

def num_instances
  @num_instances
end

#preemptibility ⇒ String

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. Corresponds to the JSON property preemptibility

Returns:

  • (String) 


2394
2395
2396
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 2394

def preemptibility
  @preemptibility
end

#startup_config ⇒ Google::Apis::DataprocV1::StartupConfig

Configuration to handle the startup of instances during cluster create and update process. Corresponds to the JSON property startupConfig

Returns:



2400
2401
2402
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 2400

def startup_config
  @startup_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
 
# File 'lib/google/apis/dataproc_v1/classes.rb', line 2407

def update!(**args)
  @accelerators = args[:accelerators] if args.key?(:accelerators)
  @disk_config = args[:disk_config] if args.key?(:disk_config)
  @image_uri = args[:image_uri] if args.key?(:image_uri)
  @instance_flexibility_policy = args[:instance_flexibility_policy] if args.key?(:instance_flexibility_policy)
  @instance_names = args[:instance_names] if args.key?(:instance_names)
  @instance_references = args[:instance_references] if args.key?(:instance_references)
  @is_preemptible = args[:is_preemptible] if args.key?(:is_preemptible)
  @machine_type_uri = args[:machine_type_uri] if args.key?(:machine_type_uri)
  @managed_group_config = args[:managed_group_config] if args.key?(:managed_group_config)
  @min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform)
  @min_num_instances = args[:min_num_instances] if args.key?(:min_num_instances)
  @num_instances = args[:num_instances] if args.key?(:num_instances)
  @preemptibility = args[:preemptibility] if args.key?(:preemptibility)
  @startup_config = args[:startup_config] if args.key?(:startup_config)
end