Class: Google::Apis::DataflowV1b3::WorkerPool

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

Overview

Describes one particular pool of Dataflow workers to be instantiated by the Dataflow service in order to perform the computations required by a job. Note that a workflow job may use multiple pools, in order to match the various computational requirements of the various stages of the job.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ WorkerPool

Returns a new instance of WorkerPool.


484
485
486
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 484

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

Instance Attribute Details

#autoscaling_settingsGoogle::Apis::DataflowV1b3::AutoscalingSettings

Settings for WorkerPool autoscaling. Corresponds to the JSON property autoscalingSettings


447
448
449
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 447

def autoscaling_settings
  @autoscaling_settings
end

#data_disksArray<Google::Apis::DataflowV1b3::Disk>

Data disks that are used by a VM in this workflow. Corresponds to the JSON property dataDisks


437
438
439
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 437

def data_disks
  @data_disks
end

#default_package_setString

The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. Corresponds to the JSON property defaultPackageSet

Returns:

  • (String)

378
379
380
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 378

def default_package_set
  @default_package_set
end

#disk_size_gbFixnum

Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. Corresponds to the JSON property diskSizeGb

Returns:

  • (Fixnum)

404
405
406
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 404

def disk_size_gb
  @disk_size_gb
end

#disk_source_imageString

Fully qualified source image for disks. Corresponds to the JSON property diskSourceImage

Returns:

  • (String)

415
416
417
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 415

def disk_source_image
  @disk_source_image
end

#disk_typeString

Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. Corresponds to the JSON property diskType

Returns:

  • (String)

410
411
412
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 410

def disk_type
  @disk_type
end

#ip_configurationString

Configuration for VM IPs. Corresponds to the JSON property ipConfiguration

Returns:

  • (String)

482
483
484
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 482

def ip_configuration
  @ip_configuration
end

#kindString

The kind of the worker pool; currently only 'harness' and 'shuffle' are supported. Corresponds to the JSON property kind

Returns:

  • (String)

359
360
361
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 359

def kind
  @kind
end

#machine_typeString

Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. Corresponds to the JSON property machineType

Returns:

  • (String)

384
385
386
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 384

def machine_type
  @machine_type
end

#metadataHash<String,String>

Metadata to set on the Google Compute Engine VMs. Corresponds to the JSON property metadata

Returns:

  • (Hash<String,String>)

442
443
444
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 442

def 
  @metadata
end

#networkString

Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". Corresponds to the JSON property network

Returns:

  • (String)

458
459
460
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 458

def network
  @network
end

#num_threads_per_workerFixnum

The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming). Corresponds to the JSON property numThreadsPerWorker

Returns:

  • (Fixnum)

477
478
479
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 477

def num_threads_per_worker
  @num_threads_per_worker
end

#num_workersFixnum

Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default. Corresponds to the JSON property numWorkers

Returns:

  • (Fixnum)

366
367
368
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 366

def num_workers
  @num_workers
end

#on_host_maintenanceString

The action to take on host maintenance, as defined by the Google Compute Engine API. Corresponds to the JSON property onHostMaintenance

Returns:

  • (String)

432
433
434
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 432

def on_host_maintenance
  @on_host_maintenance
end

#packagesArray<Google::Apis::DataflowV1b3::Package>

Packages to be installed on workers. Corresponds to the JSON property packages


371
372
373
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 371

def packages
  @packages
end

#pool_argsHash<String,Object>

Extra arguments for this worker pool. Corresponds to the JSON property poolArgs

Returns:

  • (Hash<String,Object>)

452
453
454
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 452

def pool_args
  @pool_args
end

#subnetworkString

Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK". Corresponds to the JSON property subnetwork

Returns:

  • (String)

464
465
466
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 464

def subnetwork
  @subnetwork
end

#taskrunner_settingsGoogle::Apis::DataflowV1b3::TaskRunnerSettings

Taskrunner configuration settings. Corresponds to the JSON property taskrunnerSettings


426
427
428
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 426

def taskrunner_settings
  @taskrunner_settings
end

#teardown_policyString

Sets the policy for determining when to turndown worker pool. Allowed values are: TEARDOWN_ALWAYS, TEARDOWN_ON_SUCCESS, and TEARDOWN_NEVER. TEARDOWN_ALWAYS means workers are always torn down regardless of whether the job succeeds. TEARDOWN_ON_SUCCESS means workers are torn down if the job succeeds. TEARDOWN_NEVER means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the TEARDOWN_ALWAYS policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default. Corresponds to the JSON property teardownPolicy

Returns:

  • (String)

398
399
400
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 398

def teardown_policy
  @teardown_policy
end

#worker_harness_container_imageString

Docker container image that executes Dataflow worker harness, residing in Google Container Registry. Required. Corresponds to the JSON property workerHarnessContainerImage

Returns:

  • (String)

470
471
472
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 470

def worker_harness_container_image
  @worker_harness_container_image
end

#zoneString

Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default. Corresponds to the JSON property zone

Returns:

  • (String)

421
422
423
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 421

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 489

def update!(**args)
  @kind = args[:kind] if args.key?(:kind)
  @num_workers = args[:num_workers] if args.key?(:num_workers)
  @packages = args[:packages] if args.key?(:packages)
  @default_package_set = args[:default_package_set] if args.key?(:default_package_set)
  @machine_type = args[:machine_type] if args.key?(:machine_type)
  @teardown_policy = args[:teardown_policy] if args.key?(:teardown_policy)
  @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
  @disk_type = args[:disk_type] if args.key?(:disk_type)
  @disk_source_image = args[:disk_source_image] if args.key?(:disk_source_image)
  @zone = args[:zone] if args.key?(:zone)
  @taskrunner_settings = args[:taskrunner_settings] if args.key?(:taskrunner_settings)
  @on_host_maintenance = args[:on_host_maintenance] if args.key?(:on_host_maintenance)
  @data_disks = args[:data_disks] if args.key?(:data_disks)
  @metadata = args[:metadata] if args.key?(:metadata)
  @autoscaling_settings = args[:autoscaling_settings] if args.key?(:autoscaling_settings)
  @pool_args = args[:pool_args] if args.key?(:pool_args)
  @network = args[:network] if args.key?(:network)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @worker_harness_container_image = args[:worker_harness_container_image] if args.key?(:worker_harness_container_image)
  @num_threads_per_worker = args[:num_threads_per_worker] if args.key?(:num_threads_per_worker)
  @ip_configuration = args[:ip_configuration] if args.key?(:ip_configuration)
end