Class: OCI::DatabaseMigration::Models::MigrationParameterSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_migration/models/migration_parameter_summary.rb

Overview

Migration parameter response object.

Constant Summary collapse

DATABASE_COMBINATION_ENUM = 
[
  DATABASE_COMBINATION_MYSQL = 'MYSQL'.freeze,
  DATABASE_COMBINATION_ORACLE = 'ORACLE'.freeze,
  DATABASE_COMBINATION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
MIGRATION_TYPE_ENUM = 
[
  MIGRATION_TYPE_ONLINE = 'ONLINE'.freeze,
  MIGRATION_TYPE_OFFLINE = 'OFFLINE'.freeze,
  MIGRATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DATA_TYPE_ENUM = 
[
  DATA_TYPE_STRING = 'STRING'.freeze,
  DATA_TYPE_INTEGER = 'INTEGER'.freeze,
  DATA_TYPE_FLOAT = 'FLOAT'.freeze,
  DATA_TYPE_BOOLEAN = 'BOOLEAN'.freeze,
  DATA_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 = {}) ⇒ MigrationParameterSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :database_combination (String) —

    The value to assign to the #database_combination property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :doc_url_link (String) —

    The value to assign to the #doc_url_link property

  • :description (String) —

    The value to assign to the #description property

  • :category_name (String) —

    The value to assign to the #category_name property

  • :category_display_name (String) —

    The value to assign to the #category_display_name property

  • :migration_type (String) —

    The value to assign to the #migration_type property

  • :default_value (String) —

    The value to assign to the #default_value property

  • :min_value (Float) —

    The value to assign to the #min_value property

  • :max_value (Float) —

    The value to assign to the #max_value property

  • :hint_text (String) —

    The value to assign to the #hint_text property

  • :name (String) —

    The value to assign to the #name property

  • :data_type (String) —

    The value to assign to the #data_type property



147
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
218
219
220
221
222
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 147

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

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

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

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

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

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

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

  self.category_name = attributes[:'categoryName'] if attributes[:'categoryName']

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

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

  self.category_display_name = attributes[:'categoryDisplayName'] if attributes[:'categoryDisplayName']

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

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

  self.migration_type = attributes[:'migrationType'] if attributes[:'migrationType']

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

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

  self.default_value = attributes[:'defaultValue'] if attributes[:'defaultValue']

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

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

  self.min_value = attributes[:'minValue'] if attributes[:'minValue']

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

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

  self.max_value = attributes[:'maxValue'] if attributes[:'maxValue']

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

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

  self.hint_text = attributes[:'hintText'] if attributes[:'hintText']

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

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

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

  self.data_type = attributes[:'dataType'] if attributes[:'dataType']

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

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

Instance Attribute Details

#category_display_name ⇒ String

[Required] Parameter category display name.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 56

def category_display_name
  @category_display_name
end

#category_name ⇒ String

[Required] Parameter category name.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 52

def category_name
  @category_name
end

#data_type ⇒ String

[Required] Parameter data type.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 84

def data_type
  @data_type
end

#database_combination ⇒ String

[Required] The combination of source and target databases participating in a migration. Example: ORACLE means the migration is meant for migrating Oracle source and target databases.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 36

def database_combination
  @database_combination
end

#default_value ⇒ String

Default value for a parameter.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 64

def default_value
  @default_value
end

#description ⇒ String

[Required] Parameter name description.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 48

def description
  @description
end

#display_name ⇒ String

[Required] Parameter display name.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 40

def display_name
  @display_name
end

#doc_url_link ⇒ String

Parameter documentation URL link.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 44

def doc_url_link
  @doc_url_link
end

#hint_text ⇒ String

Hint text for parameter value.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 76

def hint_text
  @hint_text
end

#max_value ⇒ Float

Parameter maximum value.

Returns:

  • (Float) 


72
73
74
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 72

def max_value
  @max_value
end

#migration_type ⇒ String

[Required] Migration Stage.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 60

def migration_type
  @migration_type
end

#min_value ⇒ Float

Parameter minimum value.

Returns:

  • (Float) 


68
69
70
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 68

def min_value
  @min_value
end

#name ⇒ String

[Required] Parameter name.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 80

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 87

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'database_combination': :'databaseCombination',
    'display_name': :'displayName',
    'doc_url_link': :'docUrlLink',
    'description': :'description',
    'category_name': :'categoryName',
    'category_display_name': :'categoryDisplayName',
    'migration_type': :'migrationType',
    'default_value': :'defaultValue',
    'min_value': :'minValue',
    'max_value': :'maxValue',
    'hint_text': :'hintText',
    'name': :'name',
    'data_type': :'dataType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'database_combination': :'String',
    'display_name': :'String',
    'doc_url_link': :'String',
    'description': :'String',
    'category_name': :'String',
    'category_display_name': :'String',
    'migration_type': :'String',
    'default_value': :'String',
    'min_value': :'Float',
    'max_value': :'Float',
    'hint_text': :'String',
    'name': :'String',
    'data_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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 270

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

  self.class == other.class &&
    database_combination == other.database_combination &&
    display_name == other.display_name &&
    doc_url_link == other.doc_url_link &&
    description == other.description &&
    category_name == other.category_name &&
    category_display_name == other.category_display_name &&
    migration_type == other.migration_type &&
    default_value == other.default_value &&
    min_value == other.min_value &&
    max_value == other.max_value &&
    hint_text == other.hint_text &&
    name == other.name &&
    data_type == other.data_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



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 312

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


292
293
294
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 292

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



301
302
303
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 301

def hash
  [database_combination, display_name, doc_url_link, description, category_name, category_display_name, migration_type, default_value, min_value, max_value, hint_text, name, data_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



345
346
347
348
349
350
351
352
353
354
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 345

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



339
340
341
 
# File 'lib/oci/database_migration/models/migration_parameter_summary.rb', line 339

def to_s
  to_hash.to_s
end