Class: OCI::Core::Models::ComputeCapacityReservationSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/compute_capacity_reservation_summary.rb

Overview

Summary information for a compute capacity reservation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ComputeCapacityReservationSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name 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

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :reserved_instance_count (Integer) —

    The value to assign to the #reserved_instance_count property

  • :used_instance_count (Integer) —

    The value to assign to the #used_instance_count property

  • :is_default_reservation (BOOLEAN) —

    The value to assign to the #is_default_reservation property

  • :time_created (DateTime) —

    The value to assign to the #time_created property



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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 134

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

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

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

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

  self.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain']

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

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

  self.reserved_instance_count = attributes[:'reservedInstanceCount'] if attributes[:'reservedInstanceCount']

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

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

  self.used_instance_count = attributes[:'usedInstanceCount'] if attributes[:'usedInstanceCount']

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

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

  self.is_default_reservation = attributes[:'isDefaultReservation'] unless attributes[:'isDefaultReservation'].nil?
  self.is_default_reservation = false if is_default_reservation.nil? && !attributes.key?(:'isDefaultReservation') # rubocop:disable Style/StringLiterals

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

  self.is_default_reservation = attributes[:'is_default_reservation'] unless attributes[:'is_default_reservation'].nil?
  self.is_default_reservation = false if is_default_reservation.nil? && !attributes.key?(:'isDefaultReservation') && !attributes.key?(:'is_default_reservation') # rubocop:disable Style/StringLiterals

  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

#availability_domain ⇒ String

[Required] The availability domain of the capacity reservation.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 49

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

The OCID of the compartment.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 17

def compartment_id
  @compartment_id
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](docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

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

Returns:

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


33
34
35
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 33

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Example: ‘My Reservation`

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 25

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](docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


41
42
43
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 41

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the instance reservation configuration.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 13

def id
  @id
end

#is_default_reservation ⇒ BOOLEAN

Whether this capacity reservation is the default. For more information, see [Capacity Reservations](docs.cloud.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm#default).

Returns:

  • (BOOLEAN) 


71
72
73
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 71

def is_default_reservation
  @is_default_reservation
end

#lifecycle_state ⇒ String

The current state of the capacity reservation.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 45

def lifecycle_state
  @lifecycle_state
end

#reserved_instance_count ⇒ Integer

The number of instances for which capacity will be held in this compute capacity reservation. This number is the sum of the values of the reservedCount fields for all of the instance reservation configurations under this reservation. The purpose of this field is to calculate the percentage usage of the reservation.

Returns:

  • (Integer) 


57
58
59
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 57

def reserved_instance_count
  @reserved_instance_count
end

#time_created ⇒ DateTime

[Required] The date and time the capacity reservation was created, in the format defined by [RFC3339](tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


77
78
79
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 77

def time_created
  @time_created
end

#used_instance_count ⇒ Integer

The total number of instances currently consuming space in this compute capacity reservation. This number is the sum of the values of the usedCount fields for all of the instance reservation configurations under this reservation. The purpose of this field is to calculate the percentage usage of the reservation.

Returns:

  • (Integer) 


65
66
67
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 65

def used_instance_count
  @used_instance_count
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 80

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'lifecycle_state': :'lifecycleState',
    'availability_domain': :'availabilityDomain',
    'reserved_instance_count': :'reservedInstanceCount',
    'used_instance_count': :'usedInstanceCount',
    'is_default_reservation': :'isDefaultReservation',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 99

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    'lifecycle_state': :'String',
    'availability_domain': :'String',
    'reserved_instance_count': :'Integer',
    'used_instance_count': :'Integer',
    'is_default_reservation': :'BOOLEAN',
    '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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 212

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags &&
    lifecycle_state == other.lifecycle_state &&
    availability_domain == other.availability_domain &&
    reserved_instance_count == other.reserved_instance_count &&
    used_instance_count == other.used_instance_count &&
    is_default_reservation == other.is_default_reservation &&
    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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 252

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


232
233
234
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 232

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



241
242
243
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 241

def hash
  [id, compartment_id, display_name, defined_tags, freeform_tags, lifecycle_state, availability_domain, reserved_instance_count, used_instance_count, is_default_reservation, 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



285
286
287
288
289
290
291
292
293
294
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 285

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



279
280
281
 
# File 'lib/oci/core/models/compute_capacity_reservation_summary.rb', line 279

def to_s
  to_hash.to_s
end