Class: Google::Cloud::Dataflow::V1beta3::AutoscalingEvent

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/dataflow/v1beta3/messages.rb

Overview

A structured message reporting an autoscaling decision made by the Dataflow service.

Defined Under Namespace

Modules: AutoscalingEventType

Instance Attribute Summary collapse

Instance Attribute Details

#current_num_workers ⇒ ::Integer

Returns The current number of workers the job has.

Returns:

  • (::Integer) —

    The current number of workers the job has.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/dataflow/v1beta3/messages.rb', line 95

class AutoscalingEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the type of autoscaling event.
  module AutoscalingEventType
    # Default type for the enum.  Value should never be returned.
    TYPE_UNKNOWN = 0

    # The TARGET_NUM_WORKERS_CHANGED type should be used when the target
    # worker pool size has changed at the start of an actuation. An event
    # should always be specified as TARGET_NUM_WORKERS_CHANGED if it reflects
    # a change in the target_num_workers.
    TARGET_NUM_WORKERS_CHANGED = 1

    # The CURRENT_NUM_WORKERS_CHANGED type should be used when actual worker
    # pool size has been changed, but the target_num_workers has not changed.
    CURRENT_NUM_WORKERS_CHANGED = 2

    # The ACTUATION_FAILURE type should be used when we want to report
    # an error to the user indicating why the current number of workers
    # in the pool could not be changed.
    # Displayed in the current status and history widgets.
    ACTUATION_FAILURE = 3

    # Used when we want to report to the user a reason why we are
    # not currently adjusting the number of workers.
    # Should specify both target_num_workers, current_num_workers and a
    # decision_message.
    NO_CHANGE = 4
  end
end

#description ⇒ ::Google::Cloud::Dataflow::V1beta3::StructuredMessage

Returns A message describing why the system decided to adjust the current number of workers, why it failed, or why the system decided to not make any changes to the number of workers.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/dataflow/v1beta3/messages.rb', line 95

class AutoscalingEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the type of autoscaling event.
  module AutoscalingEventType
    # Default type for the enum.  Value should never be returned.
    TYPE_UNKNOWN = 0

    # The TARGET_NUM_WORKERS_CHANGED type should be used when the target
    # worker pool size has changed at the start of an actuation. An event
    # should always be specified as TARGET_NUM_WORKERS_CHANGED if it reflects
    # a change in the target_num_workers.
    TARGET_NUM_WORKERS_CHANGED = 1

    # The CURRENT_NUM_WORKERS_CHANGED type should be used when actual worker
    # pool size has been changed, but the target_num_workers has not changed.
    CURRENT_NUM_WORKERS_CHANGED = 2

    # The ACTUATION_FAILURE type should be used when we want to report
    # an error to the user indicating why the current number of workers
    # in the pool could not be changed.
    # Displayed in the current status and history widgets.
    ACTUATION_FAILURE = 3

    # Used when we want to report to the user a reason why we are
    # not currently adjusting the number of workers.
    # Should specify both target_num_workers, current_num_workers and a
    # decision_message.
    NO_CHANGE = 4
  end
end

#event_type ⇒ ::Google::Cloud::Dataflow::V1beta3::AutoscalingEvent::AutoscalingEventType

Returns The type of autoscaling event to report.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/dataflow/v1beta3/messages.rb', line 95

class AutoscalingEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the type of autoscaling event.
  module AutoscalingEventType
    # Default type for the enum.  Value should never be returned.
    TYPE_UNKNOWN = 0

    # The TARGET_NUM_WORKERS_CHANGED type should be used when the target
    # worker pool size has changed at the start of an actuation. An event
    # should always be specified as TARGET_NUM_WORKERS_CHANGED if it reflects
    # a change in the target_num_workers.
    TARGET_NUM_WORKERS_CHANGED = 1

    # The CURRENT_NUM_WORKERS_CHANGED type should be used when actual worker
    # pool size has been changed, but the target_num_workers has not changed.
    CURRENT_NUM_WORKERS_CHANGED = 2

    # The ACTUATION_FAILURE type should be used when we want to report
    # an error to the user indicating why the current number of workers
    # in the pool could not be changed.
    # Displayed in the current status and history widgets.
    ACTUATION_FAILURE = 3

    # Used when we want to report to the user a reason why we are
    # not currently adjusting the number of workers.
    # Should specify both target_num_workers, current_num_workers and a
    # decision_message.
    NO_CHANGE = 4
  end
end

#target_num_workers ⇒ ::Integer

Returns The target number of workers the worker pool wants to resize to use.

Returns:

  • (::Integer) —

    The target number of workers the worker pool wants to resize to use.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/dataflow/v1beta3/messages.rb', line 95

class AutoscalingEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the type of autoscaling event.
  module AutoscalingEventType
    # Default type for the enum.  Value should never be returned.
    TYPE_UNKNOWN = 0

    # The TARGET_NUM_WORKERS_CHANGED type should be used when the target
    # worker pool size has changed at the start of an actuation. An event
    # should always be specified as TARGET_NUM_WORKERS_CHANGED if it reflects
    # a change in the target_num_workers.
    TARGET_NUM_WORKERS_CHANGED = 1

    # The CURRENT_NUM_WORKERS_CHANGED type should be used when actual worker
    # pool size has been changed, but the target_num_workers has not changed.
    CURRENT_NUM_WORKERS_CHANGED = 2

    # The ACTUATION_FAILURE type should be used when we want to report
    # an error to the user indicating why the current number of workers
    # in the pool could not be changed.
    # Displayed in the current status and history widgets.
    ACTUATION_FAILURE = 3

    # Used when we want to report to the user a reason why we are
    # not currently adjusting the number of workers.
    # Should specify both target_num_workers, current_num_workers and a
    # decision_message.
    NO_CHANGE = 4
  end
end

#time ⇒ ::Google::Protobuf::Timestamp

Returns The time this event was emitted to indicate a new target or current num_workers value.

Returns:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/dataflow/v1beta3/messages.rb', line 95

class AutoscalingEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the type of autoscaling event.
  module AutoscalingEventType
    # Default type for the enum.  Value should never be returned.
    TYPE_UNKNOWN = 0

    # The TARGET_NUM_WORKERS_CHANGED type should be used when the target
    # worker pool size has changed at the start of an actuation. An event
    # should always be specified as TARGET_NUM_WORKERS_CHANGED if it reflects
    # a change in the target_num_workers.
    TARGET_NUM_WORKERS_CHANGED = 1

    # The CURRENT_NUM_WORKERS_CHANGED type should be used when actual worker
    # pool size has been changed, but the target_num_workers has not changed.
    CURRENT_NUM_WORKERS_CHANGED = 2

    # The ACTUATION_FAILURE type should be used when we want to report
    # an error to the user indicating why the current number of workers
    # in the pool could not be changed.
    # Displayed in the current status and history widgets.
    ACTUATION_FAILURE = 3

    # Used when we want to report to the user a reason why we are
    # not currently adjusting the number of workers.
    # Should specify both target_num_workers, current_num_workers and a
    # decision_message.
    NO_CHANGE = 4
  end
end

#worker_pool ⇒ ::String

Returns A short and friendly name for the worker pool this event refers to.

Returns:

  • (::String) —

    A short and friendly name for the worker pool this event refers to.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/dataflow/v1beta3/messages.rb', line 95

class AutoscalingEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the type of autoscaling event.
  module AutoscalingEventType
    # Default type for the enum.  Value should never be returned.
    TYPE_UNKNOWN = 0

    # The TARGET_NUM_WORKERS_CHANGED type should be used when the target
    # worker pool size has changed at the start of an actuation. An event
    # should always be specified as TARGET_NUM_WORKERS_CHANGED if it reflects
    # a change in the target_num_workers.
    TARGET_NUM_WORKERS_CHANGED = 1

    # The CURRENT_NUM_WORKERS_CHANGED type should be used when actual worker
    # pool size has been changed, but the target_num_workers has not changed.
    CURRENT_NUM_WORKERS_CHANGED = 2

    # The ACTUATION_FAILURE type should be used when we want to report
    # an error to the user indicating why the current number of workers
    # in the pool could not be changed.
    # Displayed in the current status and history widgets.
    ACTUATION_FAILURE = 3

    # Used when we want to report to the user a reason why we are
    # not currently adjusting the number of workers.
    # Should specify both target_num_workers, current_num_workers and a
    # decision_message.
    NO_CHANGE = 4
  end
end