Class: OCI::CloudMigrations::Models::AssetSource

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

Overview

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

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_VMWARE = 'VMWARE'.freeze,
  TYPE_AWS = 'AWS'.freeze,
  TYPE_OLVM = 'OLVM'.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
ENVIRONMENT_TYPE_ENUM = 
[
  ENVIRONMENT_TYPE_SOURCE = 'SOURCE'.freeze,
  ENVIRONMENT_TYPE_DESTINATION = 'DESTINATION'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AssetSource

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :environment_id (String) —

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

  • :discovery_schedule_id (String) —

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

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

  • :environment_type (String) —

    The value to assign to the #environment_type property



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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 192

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

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

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

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

  self.environment_type = attributes[:'environmentType'] if attributes[:'environmentType']
  self.environment_type = "SOURCE" if environment_type.nil? && !attributes.key?(:'environmentType') # rubocop:disable Style/StringLiterals

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

  self.environment_type = attributes[:'environment_type'] if attributes[:'environment_type']
  self.environment_type = "SOURCE" if environment_type.nil? && !attributes.key?(:'environmentType') && !attributes.key?(:'environment_type') # rubocop:disable Style/StringLiterals
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) 


61
62
63
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 61

def assets_compartment_id
  @assets_compartment_id
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 43

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


93
94
95
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 93

def defined_tags
  @defined_tags
end

#discovery_schedule_id ⇒ String

The OCID of an attached discovery schedule.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 65

def discovery_schedule_id
  @discovery_schedule_id
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) 


49
50
51
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 49

def display_name
  @display_name
end

#environment_id ⇒ String

[Required] The OCID of the environment.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 53

def environment_id
  @environment_id
end

#environment_type ⇒ String

Specifies if this is the Source or Destination point for migration - different assets may be discovered depending on setting.

Returns:

  • (String) 


103
104
105
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 103

def environment_type
  @environment_type
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>) 


87
88
89
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 87

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the resource.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 39

def id
  @id
end

#inventory_id ⇒ String

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

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 57

def inventory_id
  @inventory_id
end

#lifecycle_details ⇒ String

[Required] The detailed state of the asset source.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 73

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the asset source.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 69

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


99
100
101
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 99

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


77
78
79
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 77

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


81
82
83
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 81

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) 


35
36
37
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 35

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 106

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'environment_id': :'environmentId',
    'inventory_id': :'inventoryId',
    'assets_compartment_id': :'assetsCompartmentId',
    'discovery_schedule_id': :'discoveryScheduleId',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'environment_type': :'environmentType'
    # 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.



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 158

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

  return 'OCI::CloudMigrations::Models::VmWareAssetSource' if type == 'VMWARE'
  return 'OCI::CloudMigrations::Models::OlvmAssetSource' if type == 'OLVM'
  return 'OCI::CloudMigrations::Models::AwsAssetSource' if type == 'AWS'

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

.swagger_types ⇒ Object

Attribute type mapping.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 130

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



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.rb', line 320

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

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



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 365

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



354
355
356
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 354

def hash
  [type, id, compartment_id, display_name, environment_id, inventory_id, assets_compartment_id, discovery_schedule_id, lifecycle_state, lifecycle_details, time_created, time_updated, freeform_tags, defined_tags, system_tags, environment_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



398
399
400
401
402
403
404
405
406
407
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 398

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



392
393
394
 
# File 'lib/oci/cloud_migrations/models/asset_source.rb', line 392

def to_s
  to_hash.to_s
end