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



256
257
258
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 256

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:



166
167
168
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 166

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:



150
151
152
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 150

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) 


183
184
185
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 183

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) 


254
255
256
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 254

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) 


214
215
216
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 214

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) 


139
140
141
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 139

def disk_type
  @disk_type
end

#ip_configuration ⇒ String

Configuration for VM IPs. Corresponds to the JSON property ipConfiguration

Returns:

  • (String) 


161
162
163
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 161

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) 


145
146
147
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 145

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) 


133
134
135
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 133

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


176
177
178
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 176

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) 


189
190
191
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 189

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) 


209
210
211
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 209

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) 


202
203
204
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 202

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) 


243
244
245
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 243

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:



219
220
221
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 219

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


248
249
250
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 248

def pool_args
  @pool_args
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) 


156
157
158
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 156

def subnetwork
  @subnetwork
end

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

Taskrunner configuration settings. Corresponds to the JSON property taskrunnerSettings

Returns:



171
172
173
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 171

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) 


237
238
239
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 237

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

Returns:

  • (String) 


127
128
129
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 127

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) 


195
196
197
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 195

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 261

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