Class: OCI::CloudMigrations::Models::CreateAssetSourceDetails

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

Overview

Asset source creation request. 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
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 = {}) ⇒ CreateAssetSourceDetails

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

  • :display_name (String) —

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

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

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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
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
 
# File 'lib/oci/cloud_migrations/models/create_asset_source_details.rb', line 148

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


48
49
50
 
# File 'lib/oci/cloud_migrations/models/create_asset_source_details.rb', line 48

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/create_asset_source_details.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>>) 


64
65
66
 
# File 'lib/oci/cloud_migrations/models/create_asset_source_details.rb', line 64

def defined_tags
  @defined_tags
end

#discovery_schedule_id ⇒ String

The OCID of the discovery schedule that is going to be attached to the created asset.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/cloud_migrations/models/create_asset_source_details.rb', line 52

def discovery_schedule_id
  @discovery_schedule_id
end

#display_name ⇒ String

A user-friendly name for the asset source. Does not have to be unique, and it's mutable. Avoid entering confidential information. The name is generated by the service if it is not explicitly provided.

Returns:

  • (String) 


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

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/create_asset_source_details.rb', line 40

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) 


74
75
76
 
# File 'lib/oci/cloud_migrations/models/create_asset_source_details.rb', line 74

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


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

def freeform_tags
  @freeform_tags
end

#inventory_id ⇒ String

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

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/cloud_migrations/models/create_asset_source_details.rb', line 44

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


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

def system_tags
  @system_tags
end

#type ⇒ String

[Required] Asset source type.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/cloud_migrations/models/create_asset_source_details.rb', line 25

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/cloud_migrations/models/create_asset_source_details.rb', line 77

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'environment_id': :'environmentId',
    'inventory_id': :'inventoryId',
    'assets_compartment_id': :'assetsCompartmentId',
    'discovery_schedule_id': :'discoveryScheduleId',
    '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.



119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/cloud_migrations/models/create_asset_source_details.rb', line 119

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

  return 'OCI::CloudMigrations::Models::CreateVmWareAssetSourceDetails' if type == 'VMWARE'
  return 'OCI::CloudMigrations::Models::CreateOlvmAssetSourceDetails' if type == 'OLVM'
  return 'OCI::CloudMigrations::Models::CreateAwsAssetSourceDetails' if type == 'AWS'

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

.swagger_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/cloud_migrations/models/create_asset_source_details.rb', line 96

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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/oci/cloud_migrations/models/create_asset_source_details.rb', line 242

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

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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/oci/cloud_migrations/models/create_asset_source_details.rb', line 282

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


262
263
264
 
# File 'lib/oci/cloud_migrations/models/create_asset_source_details.rb', line 262

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



271
272
273
 
# File 'lib/oci/cloud_migrations/models/create_asset_source_details.rb', line 271

def hash
  [type, display_name, compartment_id, environment_id, inventory_id, assets_compartment_id, discovery_schedule_id, 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



315
316
317
318
319
320
321
322
323
324
 
# File 'lib/oci/cloud_migrations/models/create_asset_source_details.rb', line 315

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



309
310
311
 
# File 'lib/oci/cloud_migrations/models/create_asset_source_details.rb', line 309

def to_s
  to_hash.to_s
end