Class: OCI::Core::Models::InventoryResourceSummary

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

Overview

Lists resources and its properties under a given subnet.

Constant Summary collapse

RESOURCE_TYPE_ENUM = 
[
  RESOURCE_TYPE_RESOURCE = 'Resource'.freeze,
  RESOURCE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InventoryResourceSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/core/models/inventory_resource_summary.rb', line 82

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

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

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

  self.resource_type = attributes[:'resourceType'] if attributes[:'resourceType']

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

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

  self.mac_address = attributes[:'macAddress'] if attributes[:'macAddress']

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

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

  self.ip_address_collection = attributes[:'ipAddressCollection'] if attributes[:'ipAddressCollection']

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

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/core/models/inventory_resource_summary.rb', line 40

def compartment_id
  @compartment_id
end

#ip_address_collection ⇒ Array<OCI::Core::Models::InventoryIpAddressSummary>

Lists the 'IpAddressCollection' object.

Returns:



32
33
34
 
# File 'lib/oci/core/models/inventory_resource_summary.rb', line 32

def ip_address_collection
  @ip_address_collection
end

#mac_address ⇒ String

Mac Address of IP Resource

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/core/models/inventory_resource_summary.rb', line 27

def mac_address
  @mac_address
end

#region ⇒ String

The region name of the corresponding resource.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/core/models/inventory_resource_summary.rb', line 36

def region
  @region
end

#resource_name ⇒ String

The name of the resource created.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/core/models/inventory_resource_summary.rb', line 19

def resource_name
  @resource_name
end

#resource_type ⇒ String

Resource types of the resource.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/core/models/inventory_resource_summary.rb', line 23

def resource_type
  @resource_type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'resource_name': :'resourceName',
    'resource_type': :'resourceType',
    'mac_address': :'macAddress',
    'ip_address_collection': :'ipAddressCollection',
    'region': :'region',
    'compartment_id': :'compartmentId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/core/models/inventory_resource_summary.rb', line 57

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'resource_name': :'String',
    'resource_type': :'String',
    'mac_address': :'String',
    'ip_address_collection': :'Array<OCI::Core::Models::InventoryIpAddressSummary>',
    'region': :'String',
    'compartment_id': :'String'
    # 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



141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/core/models/inventory_resource_summary.rb', line 141

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

  self.class == other.class &&
    resource_name == other.resource_name &&
    resource_type == other.resource_type &&
    mac_address == other.mac_address &&
    ip_address_collection == other.ip_address_collection &&
    region == other.region &&
    compartment_id == other.compartment_id
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



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/core/models/inventory_resource_summary.rb', line 176

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


156
157
158
 
# File 'lib/oci/core/models/inventory_resource_summary.rb', line 156

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



165
166
167
 
# File 'lib/oci/core/models/inventory_resource_summary.rb', line 165

def hash
  [resource_name, resource_type, mac_address, ip_address_collection, region, compartment_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



209
210
211
212
213
214
215
216
217
218
 
# File 'lib/oci/core/models/inventory_resource_summary.rb', line 209

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



203
204
205
 
# File 'lib/oci/core/models/inventory_resource_summary.rb', line 203

def to_s
  to_hash.to_s
end