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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dataflow_v1b3/classes.rb,
lib/google/apis/dataflow_v1b3/representations.rb,
lib/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

Constructor Details

#initialize(**args) ⇒ WorkerPool

Returns a new instance of WorkerPool.



6966
6967
6968
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6966

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

Instance Attribute Details

#autoscaling_settings ⇒ Google::Apis::DataflowV1b3::AutoscalingSettings

Settings for WorkerPool autoscaling. Corresponds to the JSON property autoscalingSettings

Returns:



6831
6832
6833
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6831

def autoscaling_settings
  @autoscaling_settings
end

#data_disks ⇒ Array<Google::Apis::DataflowV1b3::Disk>

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

Returns:



6836
6837
6838
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6836

def data_disks
  @data_disks
end

#default_package_set ⇒ String

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) 


6843
6844
6845
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6843

def default_package_set
  @default_package_set
end

#disk_size_gb ⇒ Fixnum

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) 


6849
6850
6851
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6849

def disk_size_gb
  @disk_size_gb
end

#disk_source_image ⇒ String

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

Returns:

  • (String) 


6854
6855
6856
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6854

def disk_source_image
  @disk_source_image
end

#disk_type ⇒ String

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) 


6860
6861
6862
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6860

def disk_type
  @disk_type
end

#ip_configuration ⇒ String

Configuration for VM IPs. Corresponds to the JSON property ipConfiguration

Returns:

  • (String) 


6865
6866
6867
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6865

def ip_configuration
  @ip_configuration
end

#kind ⇒ String

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

Returns:

  • (String) 


6871
6872
6873
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6871

def kind
  @kind
end

#machine_type ⇒ String

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) 


6877
6878
6879
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6877

def machine_type
  @machine_type
end

#metadata ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


6882
6883
6884
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6882

def metadata
  @metadata
end

#network ⇒ String

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) 


6888
6889
6890
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6888

def network
  @network
end

#num_threads_per_worker ⇒ Fixnum

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) 


6895
6896
6897
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6895

def num_threads_per_worker
  @num_threads_per_worker
end

#num_workers ⇒ Fixnum

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) 


6902
6903
6904
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6902

def num_workers
  @num_workers
end

#on_host_maintenance ⇒ String

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

Returns:

  • (String) 


6908
6909
6910
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6908

def on_host_maintenance
  @on_host_maintenance
end

#packages ⇒ Array<Google::Apis::DataflowV1b3::Package>

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

Returns:



6913
6914
6915
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6913

def packages
  @packages
end

#pool_args ⇒ Hash<String,Object>

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

Returns:

  • (Hash<String,Object>) 


6918
6919
6920
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6918

def pool_args
  @pool_args
end

#sdk_harness_container_images ⇒ Array<Google::Apis::DataflowV1b3::SdkHarnessContainerImage>

Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries. Corresponds to the JSON property sdkHarnessContainerImages

Returns:



6925
6926
6927
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6925

def sdk_harness_container_images
  @sdk_harness_container_images
end

#subnetwork ⇒ String

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) 


6931
6932
6933
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6931

def subnetwork
  @subnetwork
end

#taskrunner_settings ⇒ Google::Apis::DataflowV1b3::TaskRunnerSettings

Taskrunner configuration settings. Corresponds to the JSON property taskrunnerSettings

Returns:



6936
6937
6938
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6936

def taskrunner_settings
  @taskrunner_settings
end

#teardown_policy ⇒ String

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) 


6951
6952
6953
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6951

def teardown_policy
  @teardown_policy
end

#worker_harness_container_image ⇒ String

Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry. Deprecated for the Fn API path. Use sdk_harness_container_images instead. Corresponds to the JSON property workerHarnessContainerImage

Returns:

  • (String) 


6958
6959
6960
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6958

def worker_harness_container_image
  @worker_harness_container_image
end

#zone ⇒ String

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) 


6964
6965
6966
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6964

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6971

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)
  @sdk_harness_container_images = args[:sdk_harness_container_images] if args.key?(:sdk_harness_container_images)
  @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