Class: Google::Apis::DataflowV1b3::RuntimeUpdatableParams

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

Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RuntimeUpdatableParams

Returns a new instance of RuntimeUpdatableParams.



4794
4795
4796
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4794

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

Instance Attribute Details

#max_num_workersFixnum

The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. Corresponds to the JSON property maxNumWorkers

Returns:

  • (Fixnum)


4777
4778
4779
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4777

def max_num_workers
  @max_num_workers
end

#min_num_workersFixnum

The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. Corresponds to the JSON property minNumWorkers

Returns:

  • (Fixnum)


4783
4784
4785
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4783

def min_num_workers
  @min_num_workers
end

#worker_utilization_hintFloat

Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see Update an existing pipeline. Corresponds to the JSON property workerUtilizationHint

Returns:

  • (Float)


4792
4793
4794
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4792

def worker_utilization_hint
  @worker_utilization_hint
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4799
4800
4801
4802
4803
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 4799

def update!(**args)
  @max_num_workers = args[:max_num_workers] if args.key?(:max_num_workers)
  @min_num_workers = args[:min_num_workers] if args.key?(:min_num_workers)
  @worker_utilization_hint = args[:worker_utilization_hint] if args.key?(:worker_utilization_hint)
end