class OCI::Core::Models::ComputeCapacityReservation
A template that defines the settings to use when creating compute capacity reservations.
Constants
- LIFECYCLE_STATE_ENUM
Attributes
[Required] The availability domain of the compute capacity reservation.
Example: `Uocm:PHX-AD-1`
@return [String]
[Required] The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the compute capacity reservation.
@return [String]
A user-friendly name for the compute capacity reservation. It does not have to be unique, and it's changeable. Avoid entering confidential information.
@return [String]
[Required] The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity reservation. @return [String]
The reservation configurations for the capacity reservation.
To use the reservation for the desired shape, specify the shape, count, and optionally the fault domain where you want this configuration.
@return [Array<OCI::Core::Models::InstanceReservationConfig>]
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).
@return [BOOLEAN]
[Required] The current state of the compute capacity reservation. @return [String]
The number of instances for which capacity will be held with 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.
@return [Integer]
[Required] The date and time the compute capacity reservation was created, in the format defined by [RFC3339](tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
@return [DateTime]
The date and time the compute capacity reservation was updated, in the format defined by [RFC3339](tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
@return [DateTime]
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.
@return [Integer]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/core/models/compute_capacity_reservation.rb, line 110 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'availability_domain': :'availabilityDomain', 'compartment_id': :'compartmentId', 'defined_tags': :'definedTags', 'display_name': :'displayName', 'freeform_tags': :'freeformTags', 'id': :'id', 'is_default_reservation': :'isDefaultReservation', 'instance_reservation_configs': :'instanceReservationConfigs', 'lifecycle_state': :'lifecycleState', 'reserved_instance_count': :'reservedInstanceCount', 'time_updated': :'timeUpdated', 'time_created': :'timeCreated', 'used_instance_count': :'usedInstanceCount' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :availability_domain The value to assign to the {#availability_domain} property @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 [BOOLEAN] :is_default_reservation The value to assign to the {#is_default_reservation} property @option attributes [Array<OCI::Core::Models::InstanceReservationConfig>] :instance_reservation_configs The value to assign to the {#instance_reservation_configs} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [Integer] :reserved_instance_count The value to assign to the {#reserved_instance_count} property @option attributes [DateTime] :time_updated The value to assign to the {#time_updated} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [Integer] :used_instance_count The value to assign to the {#used_instance_count} property
# File lib/oci/core/models/compute_capacity_reservation.rb, line 170 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.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.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.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.instance_reservation_configs = attributes[:'instanceReservationConfigs'] if attributes[:'instanceReservationConfigs'] raise 'You cannot provide both :instanceReservationConfigs and :instance_reservation_configs' if attributes.key?(:'instanceReservationConfigs') && attributes.key?(:'instance_reservation_configs') self.instance_reservation_configs = attributes[:'instance_reservation_configs'] if attributes[:'instance_reservation_configs'] 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.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.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated'] raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated') self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated'] 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.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'] end
Attribute type mapping.
# File lib/oci/core/models/compute_capacity_reservation.rb, line 131 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'availability_domain': :'String', 'compartment_id': :'String', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'display_name': :'String', 'freeform_tags': :'Hash<String, String>', 'id': :'String', 'is_default_reservation': :'BOOLEAN', 'instance_reservation_configs': :'Array<OCI::Core::Models::InstanceReservationConfig>', 'lifecycle_state': :'String', 'reserved_instance_count': :'Integer', 'time_updated': :'DateTime', 'time_created': :'DateTime', 'used_instance_count': :'Integer' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/core/models/compute_capacity_reservation.rb, line 273 def ==(other) return true if equal?(other) self.class == other.class && availability_domain == other.availability_domain && compartment_id == other.compartment_id && defined_tags == other.defined_tags && display_name == other.display_name && freeform_tags == other.freeform_tags && id == other.id && is_default_reservation == other.is_default_reservation && instance_reservation_configs == other.instance_reservation_configs && lifecycle_state == other.lifecycle_state && reserved_instance_count == other.reserved_instance_count && time_updated == other.time_updated && time_created == other.time_created && used_instance_count == other.used_instance_count end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/core/models/compute_capacity_reservation.rb, line 315 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/core/models/compute_capacity_reservation.rb, line 295 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/core/models/compute_capacity_reservation.rb, line 304 def hash [availability_domain, compartment_id, defined_tags, display_name, freeform_tags, id, is_default_reservation, instance_reservation_configs, lifecycle_state, reserved_instance_count, time_updated, time_created, used_instance_count].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state
Object
to be assigned
# File lib/oci/core/models/compute_capacity_reservation.rb, line 257 def lifecycle_state=(lifecycle_state) # rubocop:disable Style/ConditionalAssignment if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state) OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE else @lifecycle_state = lifecycle_state end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/core/models/compute_capacity_reservation.rb, line 348 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/core/models/compute_capacity_reservation.rb, line 342 def to_s to_hash.to_s end
Private Instance Methods
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/core/models/compute_capacity_reservation.rb, line 365 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