Class: OCI::Core::Models::ComputeCapacityReport

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

Overview

A report of the host capacity within an availability domain that is available for you to create compute instances. Host capacity is the physical infrastructure that resources such as compute instances run on.

Use the capacity report to determine whether sufficient capacity is available for a shape before you create an instance or change the shape of an instance.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ComputeCapacityReport

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/core/models/compute_capacity_report.rb', line 77

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

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

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

  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 for the capacity report.

Example: Uocm:PHX-AD-1

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/core/models/compute_capacity_report.rb', line 28

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID for the compartment. This should always be the root compartment.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/core/models/compute_capacity_report.rb', line 21

def compartment_id
  @compartment_id
end

#shape_availabilities ⇒ Array<OCI::Core::Models::CapacityReportShapeAvailability>

[Required] Information about the available capacity for each shape in a capacity report.

Returns:



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

def shape_availabilities
  @shape_availabilities
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
 
# File 'lib/oci/core/models/compute_capacity_report.rb', line 44

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'availability_domain': :'availabilityDomain',
    'shape_availabilities': :'shapeAvailabilities',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/core/models/compute_capacity_report.rb', line 56

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'availability_domain': :'String',
    'shape_availabilities': :'Array<OCI::Core::Models::CapacityReportShapeAvailability>',
    '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



115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/core/models/compute_capacity_report.rb', line 115

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    availability_domain == other.availability_domain &&
    shape_availabilities == other.shape_availabilities &&
    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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/core/models/compute_capacity_report.rb', line 148

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


128
129
130
 
# File 'lib/oci/core/models/compute_capacity_report.rb', line 128

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



137
138
139
 
# File 'lib/oci/core/models/compute_capacity_report.rb', line 137

def hash
  [compartment_id, availability_domain, shape_availabilities, 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



181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/core/models/compute_capacity_report.rb', line 181

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



175
176
177
 
# File 'lib/oci/core/models/compute_capacity_report.rb', line 175

def to_s
  to_hash.to_s
end