Class: OCI::Bds::Models::AutoScalePolicyDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/bds/models/auto_scale_policy_details.rb

Overview

Details of an autoscale policy.

You can create following types of autoscaling policies:

  • MetricBasedVerticalScalingPolicy: Vertical autoscaling action is triggered when a performance metric exceeds a threshold

  • MetricBasedHorizontalScalingPolicy: Horizontal autoscaling action is triggered when a performance metric exceeds a threshold

  • ScheduleBasedVerticalScalingPolicy: Vertical autoscaling action is triggered at the specific times that you schedule.

  • ScheduleBasedHorizontalScalingPolicy: Horizontal autoscaling action is triggered at the specific times that you schedule.

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

POLICY_TYPE_ENUM = 
[
  POLICY_TYPE_METRIC_BASED_VERTICAL_SCALING_POLICY = 'METRIC_BASED_VERTICAL_SCALING_POLICY'.freeze,
  POLICY_TYPE_METRIC_BASED_HORIZONTAL_SCALING_POLICY = 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'.freeze,
  POLICY_TYPE_SCHEDULE_BASED_VERTICAL_SCALING_POLICY = 'SCHEDULE_BASED_VERTICAL_SCALING_POLICY'.freeze,
  POLICY_TYPE_SCHEDULE_BASED_HORIZONTAL_SCALING_POLICY = 'SCHEDULE_BASED_HORIZONTAL_SCALING_POLICY'.freeze,
  POLICY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TRIGGER_TYPE_ENUM = 
[
  TRIGGER_TYPE_METRIC_BASED = 'METRIC_BASED'.freeze,
  TRIGGER_TYPE_SCHEDULE_BASED = 'SCHEDULE_BASED'.freeze,
  TRIGGER_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ACTION_TYPE_ENUM = 
[
  ACTION_TYPE_VERTICAL_SCALING = 'VERTICAL_SCALING'.freeze,
  ACTION_TYPE_HORIZONTAL_SCALING = 'HORIZONTAL_SCALING'.freeze,
  ACTION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AutoScalePolicyDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :policy_type (String) —

    The value to assign to the #policy_type property

  • :trigger_type (String) —

    The value to assign to the #trigger_type property

  • :action_type (String) —

    The value to assign to the #action_type property



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/bds/models/auto_scale_policy_details.rb', line 102

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.policy_type = attributes[:'policyType'] if attributes[:'policyType']

  raise 'You cannot provide both :policyType and :policy_type' if attributes.key?(:'policyType') && attributes.key?(:'policy_type')

  self.policy_type = attributes[:'policy_type'] if attributes[:'policy_type']

  self.trigger_type = attributes[:'triggerType'] if attributes[:'triggerType']

  raise 'You cannot provide both :triggerType and :trigger_type' if attributes.key?(:'triggerType') && attributes.key?(:'trigger_type')

  self.trigger_type = attributes[:'trigger_type'] if attributes[:'trigger_type']

  self.action_type = attributes[:'actionType'] if attributes[:'actionType']

  raise 'You cannot provide both :actionType and :action_type' if attributes.key?(:'actionType') && attributes.key?(:'action_type')

  self.action_type = attributes[:'action_type'] if attributes[:'action_type']
end

Instance Attribute Details

#action_type ⇒ String

[Required] The type of autoscaling action to take.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/bds/models/auto_scale_policy_details.rb', line 51

def action_type
  @action_type
end

#policy_type ⇒ String

[Required] Type of autoscaling policy.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/bds/models/auto_scale_policy_details.rb', line 43

def policy_type
  @policy_type
end

#trigger_type ⇒ String

[Required] The type of autoscaling trigger.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/bds/models/auto_scale_policy_details.rb', line 47

def trigger_type
  @trigger_type
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/bds/models/auto_scale_policy_details.rb', line 54

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'policy_type': :'policyType',
    'trigger_type': :'triggerType',
    'action_type': :'actionType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/bds/models/auto_scale_policy_details.rb', line 80

def self.get_subtype(object_hash)
  type = object_hash[:'policyType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Bds::Models::MetricBasedVerticalScalingPolicyDetails' if type == 'METRIC_BASED_VERTICAL_SCALING_POLICY'
  return 'OCI::Bds::Models::ScheduleBasedVerticalScalingPolicyDetails' if type == 'SCHEDULE_BASED_VERTICAL_SCALING_POLICY'
  return 'OCI::Bds::Models::ScheduleBasedHorizontalScalingPolicyDetails' if type == 'SCHEDULE_BASED_HORIZONTAL_SCALING_POLICY'
  return 'OCI::Bds::Models::MetricBasedHorizontalScalingPolicyDetails' if type == 'METRIC_BASED_HORIZONTAL_SCALING_POLICY'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Bds::Models::AutoScalePolicyDetails'
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/bds/models/auto_scale_policy_details.rb', line 65

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'policy_type': :'String',
    'trigger_type': :'String',
    'action_type': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



173
174
175
176
177
178
179
180
 
# File 'lib/oci/bds/models/auto_scale_policy_details.rb', line 173

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    policy_type == other.policy_type &&
    trigger_type == other.trigger_type &&
    action_type == other.action_type
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/oci/bds/models/auto_scale_policy_details.rb', line 205

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


185
186
187
 
# File 'lib/oci/bds/models/auto_scale_policy_details.rb', line 185

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



194
195
196
 
# File 'lib/oci/bds/models/auto_scale_policy_details.rb', line 194

def hash
  [policy_type, trigger_type, action_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



238
239
240
241
242
243
244
245
246
247
 
# File 'lib/oci/bds/models/auto_scale_policy_details.rb', line 238

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



232
233
234
 
# File 'lib/oci/bds/models/auto_scale_policy_details.rb', line 232

def to_s
  to_hash.to_s
end