Class: OCI::Autoscaling::Models::AutoScalingConfigurationSummary

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

Overview

Summary information for an autoscaling configuration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AutoScalingConfigurationSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :id (String) —

    The value to assign to the #id property

  • :cool_down_in_seconds (Integer) —

    The value to assign to the #cool_down_in_seconds property

  • :is_enabled (BOOLEAN) —

    The value to assign to the #is_enabled property

  • :resource (OCI::Autoscaling::Models::Resource) —

    The value to assign to the #resource property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :time_created (DateTime) —

    The value to assign to the #time_created property



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/autoscaling/models/auto_scaling_configuration_summary.rb', line 115

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

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the autoscaling configuration.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/autoscaling/models/auto_scaling_configuration_summary.rb', line 15

def compartment_id
  @compartment_id
end

#cool_down_in_seconds ⇒ Integer

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.

Returns:

  • (Integer) 


33
34
35
 
# File 'lib/oci/autoscaling/models/auto_scaling_configuration_summary.rb', line 33

def cool_down_in_seconds
  @cool_down_in_seconds
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

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

Returns:

  • (Hash<String, Hash<String, Object>>) 


49
50
51
 
# File 'lib/oci/autoscaling/models/auto_scaling_configuration_summary.rb', line 49

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

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.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


57
58
59
 
# File 'lib/oci/autoscaling/models/auto_scaling_configuration_summary.rb', line 57

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the autoscaling configuration.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/autoscaling/models/auto_scaling_configuration_summary.rb', line 24

def id
  @id
end

#is_enabled ⇒ BOOLEAN

Whether the autoscaling configuration is enabled.

Returns:

  • (BOOLEAN) 


37
38
39
 
# File 'lib/oci/autoscaling/models/auto_scaling_configuration_summary.rb', line 37

def is_enabled
  @is_enabled
end

#resource ⇒ OCI::Autoscaling::Models::Resource

This attribute is required.

Returns:



41
42
43
 
# File 'lib/oci/autoscaling/models/auto_scaling_configuration_summary.rb', line 41

def resource
  @resource
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) 


64
65
66
 
# File 'lib/oci/autoscaling/models/auto_scaling_configuration_summary.rb', line 64

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/autoscaling/models/auto_scaling_configuration_summary.rb', line 67

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'id': :'id',
    'cool_down_in_seconds': :'coolDownInSeconds',
    'is_enabled': :'isEnabled',
    'resource': :'resource',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/autoscaling/models/auto_scaling_configuration_summary.rb', line 84

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'id': :'String',
    'cool_down_in_seconds': :'Integer',
    'is_enabled': :'BOOLEAN',
    'resource': :'OCI::Autoscaling::Models::Resource',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, 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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/autoscaling/models/auto_scaling_configuration_summary.rb', line 175

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    id == other.id &&
    cool_down_in_seconds == other.cool_down_in_seconds &&
    is_enabled == other.is_enabled &&
    resource == other.resource &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags &&
    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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/oci/autoscaling/models/auto_scaling_configuration_summary.rb', line 213

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


193
194
195
 
# File 'lib/oci/autoscaling/models/auto_scaling_configuration_summary.rb', line 193

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



202
203
204
 
# File 'lib/oci/autoscaling/models/auto_scaling_configuration_summary.rb', line 202

def hash
  [compartment_id, display_name, id, cool_down_in_seconds, is_enabled, resource, defined_tags, freeform_tags, 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



246
247
248
249
250
251
252
253
254
255
 
# File 'lib/oci/autoscaling/models/auto_scaling_configuration_summary.rb', line 246

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



240
241
242
 
# File 'lib/oci/autoscaling/models/auto_scaling_configuration_summary.rb', line 240

def to_s
  to_hash.to_s
end