class OCI::Autoscaling::Models::AutoScalingConfiguration

An autoscaling configuration lets you dynamically scale the resources in a Compute instance pool. For more information, see [Autoscaling](docs.cloud.oracle.com/iaas/Content/Compute/Tasks/autoscalinginstancepools.htm).

Attributes

compartment_id[RW]

[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the autoscaling configuration.

@return [String]

cool_down_in_seconds[RW]

For threshold-based autoscaling policies, this value is the minimum period of time to wait between scaling actions. The cooldown period gives the system time to stabilize before rescaling. The minimum value is 300 seconds, which is also the default. The cooldown period starts when the instance pool reaches the running state.

For schedule-based autoscaling policies, this value is not used.

@return [Integer]

defined_tags[RW]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: `{"Operations": {"CostCenter": "42"}}`

@return [Hash<String, Hash<String, Object>>]

display_name[RW]

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

@return [String]

freeform_tags[RW]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: `{"Department": "Finance"}`

@return [Hash<String, String>]

id[RW]

[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the autoscaling configuration. @return [String]

is_enabled[RW]

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

max_resource_count[RW]

The maximum number of resources to scale out to. @return [Integer]

min_resource_count[RW]

The minimum number of resources to scale in to. @return [Integer]

policies[RW]

[Required] Autoscaling policy definitions for the autoscaling configuration. An autoscaling policy defines the criteria that trigger autoscaling actions and the actions to take.

@return [Array<OCI::Autoscaling::Models::AutoScalingPolicy>]

resource[RW]

This attribute is required. @return [OCI::Autoscaling::Models::Resource]

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_configuration.rb, line 81
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'id': :'id',
    'cool_down_in_seconds': :'coolDownInSeconds',
    'is_enabled': :'isEnabled',
    'resource': :'resource',
    'policies': :'policies',
    'time_created': :'timeCreated',
    'max_resource_count': :'maxResourceCount',
    'min_resource_count': :'minResourceCount'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [String] :id The value to assign to the {#id} property @option attributes [Integer] :cool_down_in_seconds The value to assign to the {#cool_down_in_seconds} property @option attributes [BOOLEAN] :is_enabled The value to assign to the {#is_enabled} property @option attributes [OCI::Autoscaling::Models::Resource] :resource The value to assign to the {#resource} property @option attributes [Array<OCI::Autoscaling::Models::AutoScalingPolicy>] :policies The value to assign to the {#policies} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [Integer] :max_resource_count The value to assign to the {#max_resource_count} property @option attributes [Integer] :min_resource_count The value to assign to the {#min_resource_count} property

# File lib/oci/autoscaling/models/auto_scaling_configuration.rb, line 138
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.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

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

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

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

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

  self.cool_down_in_seconds = attributes[:'coolDownInSeconds'] if attributes[:'coolDownInSeconds']

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

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

  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?

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

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

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

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

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

  self.min_resource_count = attributes[:'minResourceCount'] if attributes[:'minResourceCount']

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

  self.min_resource_count = attributes[:'min_resource_count'] if attributes[:'min_resource_count']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/autoscaling/models/auto_scaling_configuration.rb, line 101
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'id': :'String',
    'cool_down_in_seconds': :'Integer',
    'is_enabled': :'BOOLEAN',
    'resource': :'OCI::Autoscaling::Models::Resource',
    'policies': :'Array<OCI::Autoscaling::Models::AutoScalingPolicy>',
    'time_created': :'DateTime',
    'max_resource_count': :'Integer',
    'min_resource_count': :'Integer'
    # 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_configuration.rb, line 212
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    id == other.id &&
    cool_down_in_seconds == other.cool_down_in_seconds &&
    is_enabled == other.is_enabled &&
    resource == other.resource &&
    policies == other.policies &&
    time_created == other.time_created &&
    max_resource_count == other.max_resource_count &&
    min_resource_count == other.min_resource_count
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_configuration.rb, line 253
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_configuration.rb, line 233
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_configuration.rb, line 242
def hash
  [compartment_id, defined_tags, display_name, freeform_tags, id, cool_down_in_seconds, is_enabled, resource, policies, time_created, max_resource_count, min_resource_count].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_configuration.rb, line 286
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_configuration.rb, line 280
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_configuration.rb, line 303
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