class OCI::Autoscaling::Models::AutoScalingPolicy

Autoscaling policies define the criteria that trigger autoscaling actions and the actions to take.

An autoscaling policy is part of an autoscaling configuration. For more information, see [Autoscaling](docs.cloud.oracle.com/iaas/Content/Compute/Tasks/autoscalinginstancepools.htm).

You can create the following types of autoscaling policies:

- **Schedule-based:** Autoscaling events take place at the specific times that you schedule.
- **Threshold-based:** An autoscaling action is triggered when a performance metric meets or exceeds a threshold.

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

Attributes

capacity[RW]

The capacity requirements of the autoscaling policy. @return [OCI::Autoscaling::Models::Capacity]

display_name[RW]

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

@return [String]

id[RW]

The ID of the autoscaling policy that is assigned after creation. @return [String]

is_enabled[RW]

Whether the autoscaling policy is enabled. @return [BOOLEAN]

policy_type[RW]

[Required] The type of autoscaling policy. @return [String]

time_created[RW]

[Required] The date and time the autoscaling configuration was created, in the format defined by RFC3339.

Example: `2016-08-25T21:10:29.600Z`

@return [DateTime]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/autoscaling/models/auto_scaling_policy.rb, line 49
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'capacity': :'capacity',
    'id': :'id',
    'display_name': :'displayName',
    'policy_type': :'policyType',
    'time_created': :'timeCreated',
    'is_enabled': :'isEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end
get_subtype(object_hash) click to toggle source

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

# File lib/oci/autoscaling/models/auto_scaling_policy.rb, line 81
def self.get_subtype(object_hash)
  type = object_hash[:'policyType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Autoscaling::Models::ScheduledPolicy' if type == 'scheduled'
  return 'OCI::Autoscaling::Models::ThresholdPolicy' if type == 'threshold'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Autoscaling::Models::AutoScalingPolicy'
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [OCI::Autoscaling::Models::Capacity] :capacity The value to assign to the {#capacity} property @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :policy_type The value to assign to the {#policy_type} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [BOOLEAN] :is_enabled The value to assign to the {#is_enabled} property

# File lib/oci/autoscaling/models/auto_scaling_policy.rb, line 104
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.capacity = attributes[:'capacity'] if attributes[:'capacity']

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  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.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?

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

  self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil?
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/autoscaling/models/auto_scaling_policy.rb, line 63
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'capacity': :'OCI::Autoscaling::Models::Capacity',
    'id': :'String',
    'display_name': :'String',
    'policy_type': :'String',
    'time_created': :'DateTime',
    'is_enabled': :'BOOLEAN'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/autoscaling/models/auto_scaling_policy.rb, line 146
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    capacity == other.capacity &&
    id == other.id &&
    display_name == other.display_name &&
    policy_type == other.policy_type &&
    time_created == other.time_created &&
    is_enabled == other.is_enabled
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/autoscaling/models/auto_scaling_policy.rb, line 181
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/autoscaling/models/auto_scaling_policy.rb, line 161
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/autoscaling/models/auto_scaling_policy.rb, line 170
def hash
  [capacity, id, display_name, policy_type, time_created, is_enabled].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/autoscaling/models/auto_scaling_policy.rb, line 214
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/autoscaling/models/auto_scaling_policy.rb, line 208
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/autoscaling/models/auto_scaling_policy.rb, line 231
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end