Class: OCI::CloudMigrations::Models::AssetSourceSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cloud_migrations/models/asset_source_summary.rb

Overview

Summary of an asset source provided in the list. 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

VmWareAssetSourceSummary

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_VMWARE = 'VMWARE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AssetSourceSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :type (String) —

    The value to assign to the #type property

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :environment_id (String) —

    The value to assign to the #environment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :inventory_id (String) —

    The value to assign to the #inventory_id property

  • :assets_compartment_id (String) —

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

  • :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



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
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
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 169

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

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

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

  self.environment_id = attributes[:'environment_id'] if attributes[:'environment_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.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.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

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

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

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

  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.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

#assets_compartment_id ⇒ String

[Required] The OCID of the compartment that is going to be used to create assets.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 62

def assets_compartment_id
  @assets_compartment_id
end

#compartment_id ⇒ String

[Required] The OCID of the compartment for the resource.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 36

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. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


82
83
84
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 82

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly name for the asset source. Does not have to be unique, and it's mutable. Avoid entering confidential information.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 46

def display_name
  @display_name
end

#environment_id ⇒ String

[Required] The OCID of the environment.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 40

def environment_id
  @environment_id
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


76
77
78
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 76

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the resourse.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 32

def id
  @id
end

#inventory_id ⇒ String

[Required] The OCID of the inventory that will contain created assets.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 58

def inventory_id
  @inventory_id
end

#lifecycle_details ⇒ String

[Required] The detailed state of the asset source.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 54

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the asset source.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 50

def lifecycle_state
  @lifecycle_state
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


88
89
90
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 88

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The time when the asset source was created in RFC3339 format.

Returns:

  • (DateTime) 


66
67
68
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 66

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The point in time that the asset source was last updated in RFC3339 format.

Returns:

  • (DateTime) 


70
71
72
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 70

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The type of asset source. Indicates external origin of the assets that are read by assigning this asset source.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 28

def type
  @type
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_migrations/models/asset_source_summary.rb', line 91

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'id': :'id',
    'compartment_id': :'compartmentId',
    'environment_id': :'environmentId',
    'display_name': :'displayName',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'inventory_id': :'inventoryId',
    'assets_compartment_id': :'assetsCompartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    '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
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 139

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

  return 'OCI::CloudMigrations::Models::VmWareAssetSourceSummary' if type == 'VMWARE'

  # TODO: Log a warning when the subtype is not found.
  'OCI::CloudMigrations::Models::AssetSourceSummary'
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_migrations/models/asset_source_summary.rb', line 113

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'id': :'String',
    'compartment_id': :'String',
    'environment_id': :'String',
    'display_name': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'inventory_id': :'String',
    'assets_compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 275

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

  self.class == other.class &&
    type == other.type &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    environment_id == other.environment_id &&
    display_name == other.display_name &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    inventory_id == other.inventory_id &&
    assets_compartment_id == other.assets_compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 318

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


298
299
300
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 298

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



307
308
309
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 307

def hash
  [type, id, compartment_id, environment_id, display_name, lifecycle_state, lifecycle_details, inventory_id, assets_compartment_id, time_created, time_updated, 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



351
352
353
354
355
356
357
358
359
360
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 351

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



345
346
347
 
# File 'lib/oci/cloud_migrations/models/asset_source_summary.rb', line 345

def to_s
  to_hash.to_s
end