Class: OCI::DatabaseMigration::Models::Job

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

Overview

Results of a Database Connection search. Contains DatabaseConnectionSummary items.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_EVALUATION = 'EVALUATION'.freeze,
  TYPE_MIGRATION = 'MIGRATION'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_UNKNOWN = 'UNKNOWN'.freeze,
  LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_WAITING = 'WAITING'.freeze,
  LIFECYCLE_STATE_CANCELING = 'CANCELING'.freeze,
  LIFECYCLE_STATE_CANCELED = 'CANCELED'.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 = {}) ⇒ Job

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
256
257
 
# File 'lib/oci/database_migration/models/job.rb', line 174

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

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

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

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

  self.unsupported_objects = attributes[:'unsupportedObjects'] if attributes[:'unsupportedObjects']

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

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

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

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

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

  self.collect_traces_data = attributes[:'collectTracesData'] if attributes[:'collectTracesData']

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

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

  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

#collect_traces_data ⇒ OCI::DatabaseMigration::Models::CollectTracesData

Returns:



87
88
89
 
# File 'lib/oci/database_migration/models/job.rb', line 87

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


99
100
101
 
# File 'lib/oci/database_migration/models/job.rb', line 99

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Name of the job.

Returns:

  • (String) 


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

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: "Finance"

Returns:

  • (Hash<String, String>) 


93
94
95
 
# File 'lib/oci/database_migration/models/job.rb', line 93

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Migration Job.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/database_migration/models/job.rb', line 35

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/database_migration/models/job.rb', line 79

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the migration job.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/database_migration/models/job.rb', line 73

def lifecycle_state
  @lifecycle_state
end

#migration_id ⇒ String

[Required] The OCID of the Migration that this job belongs to.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/database_migration/models/job.rb', line 45

def migration_id
  @migration_id
end

#parameter_file_versions ⇒ Array<OCI::DatabaseMigration::Models::ParameterFileVersionSummary>

A list of parameter file versions that can be viewed or edited for the current job.

Returns:



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

def parameter_file_versions
  @parameter_file_versions
end

#progress ⇒ OCI::DatabaseMigration::Models::MigrationJobProgressResource

Returns:



63
64
65
 
# File 'lib/oci/database_migration/models/job.rb', line 63

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


105
106
107
 
# File 'lib/oci/database_migration/models/job.rb', line 105

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time the Migration Job was created. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


55
56
57
 
# File 'lib/oci/database_migration/models/job.rb', line 55

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time the Migration Job was last updated. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The job type.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/database_migration/models/job.rb', line 50

def type
  @type
end

#unsupported_objects ⇒ Array<OCI::DatabaseMigration::Models::UnsupportedDatabaseObject>

Database objects not supported.

Returns:



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

def unsupported_objects
  @unsupported_objects
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'migration_id': :'migrationId',
    'type': :'type',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'progress': :'progress',
    'unsupported_objects': :'unsupportedObjects',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'parameter_file_versions': :'parameterFileVersions',
    'collect_traces_data': :'collectTracesData',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'migration_id': :'String',
    'type': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'progress': :'OCI::DatabaseMigration::Models::MigrationJobProgressResource',
    'unsupported_objects': :'Array<OCI::DatabaseMigration::Models::UnsupportedDatabaseObject>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'parameter_file_versions': :'Array<OCI::DatabaseMigration::Models::ParameterFileVersionSummary>',
    'collect_traces_data': :'OCI::DatabaseMigration::Models::CollectTracesData',
    '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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/oci/database_migration/models/job.rb', line 292

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    migration_id == other.migration_id &&
    type == other.type &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    progress == other.progress &&
    unsupported_objects == other.unsupported_objects &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    parameter_file_versions == other.parameter_file_versions &&
    collect_traces_data == other.collect_traces_data &&
    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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/oci/database_migration/models/job.rb', line 336

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


316
317
318
 
# File 'lib/oci/database_migration/models/job.rb', line 316

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



325
326
327
 
# File 'lib/oci/database_migration/models/job.rb', line 325

def hash
  [id, display_name, migration_id, type, time_created, time_updated, progress, unsupported_objects, lifecycle_state, lifecycle_details, parameter_file_versions, collect_traces_data, 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



369
370
371
372
373
374
375
376
377
378
 
# File 'lib/oci/database_migration/models/job.rb', line 369

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



363
364
365
 
# File 'lib/oci/database_migration/models/job.rb', line 363

def to_s
  to_hash.to_s
end