Class: OCI::CloudBridge::Models::Asset

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cloud_bridge/models/asset.rb

Overview

Description of an asset. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

VmAsset, VmwareVmAsset

Constant Summary collapse

ASSET_TYPE_ENUM = 
[
  ASSET_TYPE_VMWARE_VM = 'VMWARE_VM'.freeze,
  ASSET_TYPE_VM = 'VM'.freeze,
  ASSET_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Asset

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :inventory_id (String) —

    The value to assign to the #inventory_id property

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :source_key (String) —

    The value to assign to the #source_key property

  • :external_asset_key (String) —

    The value to assign to the #external_asset_key property

  • :asset_type (String) —

    The value to assign to the #asset_type property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :asset_source_ids (Array<String>) —

    The value to assign to the #asset_source_ids property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

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

    The value to assign to the #freeform_tags property

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

    The value to assign to the #defined_tags property

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

    The value to assign to the #system_tags property



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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/oci/cloud_bridge/models/asset.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.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.inventory_id = attributes[:'inventoryId'] if attributes[:'inventoryId']

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

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

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

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

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

  self.external_asset_key = attributes[:'externalAssetKey'] if attributes[:'externalAssetKey']

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

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

  self.asset_type = attributes[:'assetType'] if attributes[:'assetType']

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

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

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

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

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

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

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

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']
end

Instance Attribute Details

#asset_source_ids ⇒ Array<String>

List of asset source OCID.

Returns:

  • (Array<String>) 


63
64
65
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 63

def asset_source_ids
  @asset_source_ids
end

#asset_type ⇒ String

[Required] The type of asset.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 51

def asset_type
  @asset_type
end

#compartment_id ⇒ String

[Required] The OCID of the compartment to which an asset belongs to.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 39

def compartment_id
  @compartment_id
end

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

The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


81
82
83
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 81

def defined_tags
  @defined_tags
end

#display_name ⇒ String

Asset display name.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 27

def display_name
  @display_name
end

#external_asset_key ⇒ String

[Required] The key of the asset from the external environment.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 47

def external_asset_key
  @external_asset_key
end

#freeform_tags ⇒ Hash<String, String>

The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


74
75
76
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 74

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Asset OCID that is immutable on creation.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 35

def id
  @id
end

#inventory_id ⇒ String

[Required] Inventory ID to which an asset belongs to.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 31

def inventory_id
  @inventory_id
end

#lifecycle_state ⇒ String

[Required] The current state of the asset.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 67

def lifecycle_state
  @lifecycle_state
end

#source_key ⇒ String

[Required] The source key that the asset belongs to.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 43

def source_key
  @source_key
end

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

The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

Returns:

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


88
89
90
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 88

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time when the asset was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


55
56
57
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 55

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The time when the asset was updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


59
60
61
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 59

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 91

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'inventory_id': :'inventoryId',
    'id': :'id',
    'compartment_id': :'compartmentId',
    'source_key': :'sourceKey',
    'external_asset_key': :'externalAssetKey',
    'asset_type': :'assetType',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'asset_source_ids': :'assetSourceIds',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 139

def self.get_subtype(object_hash)
  type = object_hash[:'assetType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::CloudBridge::Models::VmwareVmAsset' if type == 'VMWARE_VM'
  return 'OCI::CloudBridge::Models::VmAsset' if type == 'VM'

  # TODO: Log a warning when the subtype is not found.
  'OCI::CloudBridge::Models::Asset'
end

.swagger_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 113

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'inventory_id': :'String',
    'id': :'String',
    'compartment_id': :'String',
    'source_key': :'String',
    'external_asset_key': :'String',
    'asset_type': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'asset_source_ids': :'Array<String>',
    'lifecycle_state': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 290

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

  self.class == other.class &&
    display_name == other.display_name &&
    inventory_id == other.inventory_id &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    source_key == other.source_key &&
    external_asset_key == other.external_asset_key &&
    asset_type == other.asset_type &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    asset_source_ids == other.asset_source_ids &&
    lifecycle_state == other.lifecycle_state &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 333

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


313
314
315
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 313

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



322
323
324
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 322

def hash
  [display_name, inventory_id, id, compartment_id, source_key, external_asset_key, asset_type, time_created, time_updated, asset_source_ids, lifecycle_state, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



366
367
368
369
370
371
372
373
374
375
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 366

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



360
361
362
 
# File 'lib/oci/cloud_bridge/models/asset.rb', line 360

def to_s
  to_hash.to_s
end