Class: OCI::Autoscaling::Models::AutoScalingPolicy

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/autoscaling/models/auto_scaling_policy.rb

Overview

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).

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

Direct Known Subclasses

ThresholdPolicy

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AutoScalingPolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/autoscaling/models/auto_scaling_policy.rb', line 90

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']
end

Instance Attribute Details

#capacity ⇒ OCI::Autoscaling::Models::Capacity

[Required] The capacity requirements of the autoscaling policy.

Returns:



16
17
18
 
# File 'lib/oci/autoscaling/models/auto_scaling_policy.rb', line 16

def capacity
  @capacity
end

#display_name ⇒ String

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

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/autoscaling/models/auto_scaling_policy.rb', line 25

def display_name
  @display_name
end

#id ⇒ String

The ID of the autoscaling policy that is assigned after creation.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/autoscaling/models/auto_scaling_policy.rb', line 20

def id
  @id
end

#policy_type ⇒ String

[Required] The type of autoscaling policy.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/autoscaling/models/auto_scaling_policy.rb', line 29

def policy_type
  @policy_type
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


36
37
38
 
# File 'lib/oci/autoscaling/models/auto_scaling_policy.rb', line 36

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/autoscaling/models/auto_scaling_policy.rb', line 39

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'capacity': :'capacity',
    'id': :'id',
    'display_name': :'displayName',
    'policy_type': :'policyType',
    'time_created': :'timeCreated'
    # 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.



69
70
71
72
73
74
75
76
 
# File 'lib/oci/autoscaling/models/auto_scaling_policy.rb', line 69

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

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

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

.swagger_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/autoscaling/models/auto_scaling_policy.rb', line 52

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'capacity': :'OCI::Autoscaling::Models::Capacity',
    'id': :'String',
    'display_name': :'String',
    'policy_type': :'String',
    'time_created': :'DateTime'
    # 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



126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/autoscaling/models/auto_scaling_policy.rb', line 126

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
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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/autoscaling/models/auto_scaling_policy.rb', line 160

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


140
141
142
 
# File 'lib/oci/autoscaling/models/auto_scaling_policy.rb', line 140

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



149
150
151
 
# File 'lib/oci/autoscaling/models/auto_scaling_policy.rb', line 149

def hash
  [capacity, id, display_name, policy_type, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/autoscaling/models/auto_scaling_policy.rb', line 193

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



187
188
189
 
# File 'lib/oci/autoscaling/models/auto_scaling_policy.rb', line 187

def to_s
  to_hash.to_s
end