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 Cloud Dataflow workers to be instantiated by the Cloud 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



5646
5647
5648
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5646

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

Instance Attribute Details

#autoscaling_settingsGoogle::Apis::DataflowV1b3::AutoscalingSettings

Settings for WorkerPool autoscaling. Corresponds to the JSON property autoscalingSettings



5516
5517
5518
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5516

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



5521
5522
5523
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5521

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)


5528
5529
5530
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5528

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)


5534
5535
5536
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5534

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)


5539
5540
5541
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5539

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)


5545
5546
5547
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5545

def disk_type
  @disk_type
end

#ip_configurationString

Configuration for VM IPs. Corresponds to the JSON property ipConfiguration

Returns:

  • (String)


5550
5551
5552
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5550

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)


5556
5557
5558
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5556

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)


5562
5563
5564
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5562

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>)


5567
5568
5569
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5567

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)


5573
5574
5575
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5573

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)


5580
5581
5582
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5580

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)


5587
5588
5589
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5587

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)


5593
5594
5595
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5593

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



5598
5599
5600
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5598

def packages
  @packages
end

#pool_argsHash<String,Object>

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

Returns:

  • (Hash<String,Object>)


5603
5604
5605
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5603

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)


5609
5610
5611
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5609

def subnetwork
  @subnetwork
end

#taskrunner_settingsGoogle::Apis::DataflowV1b3::TaskRunnerSettings

Taskrunner configuration settings. Corresponds to the JSON property taskrunnerSettings



5614
5615
5616
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5614

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)


5632
5633
5634
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5632

def teardown_policy
  @teardown_policy
end

#worker_harness_container_imageString

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

Returns:

  • (String)


5638
5639
5640
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5638

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)


5644
5645
5646
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5644

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5651

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