Class: OCI::DatabaseManagement::Models::JobExecution

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_management/models/job_execution.rb

Overview

The details of a job execution.

Constant Summary collapse

DATABASE_TYPE_ENUM = 
[
  DATABASE_TYPE_EXTERNAL_SIDB = 'EXTERNAL_SIDB'.freeze,
  DATABASE_TYPE_EXTERNAL_RAC = 'EXTERNAL_RAC'.freeze,
  DATABASE_TYPE_CLOUD_SIDB = 'CLOUD_SIDB'.freeze,
  DATABASE_TYPE_CLOUD_RAC = 'CLOUD_RAC'.freeze,
  DATABASE_TYPE_SHARED = 'SHARED'.freeze,
  DATABASE_TYPE_DEDICATED = 'DEDICATED'.freeze,
  DATABASE_TYPE_CLOUD_AT_CUSTOMER = 'CLOUD_AT_CUSTOMER'.freeze,
  DATABASE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DATABASE_SUB_TYPE_ENUM = 
[
  DATABASE_SUB_TYPE_CDB = 'CDB'.freeze,
  DATABASE_SUB_TYPE_PDB = 'PDB'.freeze,
  DATABASE_SUB_TYPE_NON_CDB = 'NON_CDB'.freeze,
  DATABASE_SUB_TYPE_ACD = 'ACD'.freeze,
  DATABASE_SUB_TYPE_ADB = 'ADB'.freeze,
  DATABASE_SUB_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DEPLOYMENT_TYPE_ENUM = 
[
  DEPLOYMENT_TYPE_ONPREMISE = 'ONPREMISE'.freeze,
  DEPLOYMENT_TYPE_BM = 'BM'.freeze,
  DEPLOYMENT_TYPE_VM = 'VM'.freeze,
  DEPLOYMENT_TYPE_EXADATA = 'EXADATA'.freeze,
  DEPLOYMENT_TYPE_EXADATA_CC = 'EXADATA_CC'.freeze,
  DEPLOYMENT_TYPE_AUTONOMOUS = 'AUTONOMOUS'.freeze,
  DEPLOYMENT_TYPE_EXADATA_XS = 'EXADATA_XS'.freeze,
  DEPLOYMENT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
WORKLOAD_TYPE_ENUM = 
[
  WORKLOAD_TYPE_OLTP = 'OLTP'.freeze,
  WORKLOAD_TYPE_DW = 'DW'.freeze,
  WORKLOAD_TYPE_AJD = 'AJD'.freeze,
  WORKLOAD_TYPE_APEX = 'APEX'.freeze,
  WORKLOAD_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_SUCCEEDED = 'SUCCEEDED'.freeze,
  STATUS_FAILED = 'FAILED'.freeze,
  STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JobExecution

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/oci/database_management/models/job_execution.rb', line 246

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

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

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

  self.managed_database_id = attributes[:'managedDatabaseId'] if attributes[:'managedDatabaseId']

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

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

  self.managed_database_name = attributes[:'managedDatabaseName'] if attributes[:'managedDatabaseName']

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

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

  self.database_type = attributes[:'databaseType'] if attributes[:'databaseType']

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

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

  self.database_sub_type = attributes[:'databaseSubType'] if attributes[:'databaseSubType']

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

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

  self.deployment_type = attributes[:'deploymentType'] if attributes[:'deploymentType']

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

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

  self.is_cluster = attributes[:'isCluster'] unless attributes[:'isCluster'].nil?

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

  self.is_cluster = attributes[:'is_cluster'] unless attributes[:'is_cluster'].nil?

  self.workload_type = attributes[:'workloadType'] if attributes[:'workloadType']

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

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

  self.job_id = attributes[:'jobId'] if attributes[:'jobId']

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

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

  self.job_name = attributes[:'jobName'] if attributes[:'jobName']

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

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

  self.job_run_id = attributes[:'jobRunId'] if attributes[:'jobRunId']

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

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

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

  self.error_message = attributes[:'errorMessage'] if attributes[:'errorMessage']

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

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

  self.result_details = attributes[:'resultDetails'] if attributes[:'resultDetails']

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

  self.result_details = attributes[:'result_details'] if attributes[:'result_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_completed = attributes[:'timeCompleted'] if attributes[:'timeCompleted']

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

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

  self.user_name = attributes[:'userName'] if attributes[:'userName']

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

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

  self.sql_text = attributes[:'sqlText'] if attributes[:'sqlText']

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

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

  self.in_binds = attributes[:'inBinds'] if attributes[:'inBinds']

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

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

  self.out_binds = attributes[:'outBinds'] if attributes[:'outBinds']

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

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

  self.schedule_details = attributes[:'scheduleDetails'] if attributes[:'scheduleDetails']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment in which the parent job resides.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/database_management/models/job_execution.rb', line 68

def compartment_id
  @compartment_id
end

#database_sub_type ⇒ String

The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/database_management/models/job_execution.rb', line 88

def database_sub_type
  @database_sub_type
end

#database_type ⇒ String

The type of Oracle Database installation.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/database_management/models/job_execution.rb', line 84

def database_type
  @database_type
end

#deployment_type ⇒ String

A list of the supported infrastructure that can be used to deploy the database.

Returns:

  • (String) 


92
93
94
 
# File 'lib/oci/database_management/models/job_execution.rb', line 92

def deployment_type
  @deployment_type
end

#error_message ⇒ String

The error message that is returned if the job execution fails. Null is returned if the job is still running or if the job execution is successful.

Returns:

  • (String) 


122
123
124
 
# File 'lib/oci/database_management/models/job_execution.rb', line 122

def error_message
  @error_message
end

#id ⇒ String

[Required] The identifier of the job execution.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/database_management/models/job_execution.rb', line 60

def id
  @id
end

#in_binds ⇒ OCI::DatabaseManagement::Models::JobInBindsDetails

Returns:



144
145
146
 
# File 'lib/oci/database_management/models/job_execution.rb', line 144

def in_binds
  @in_binds
end

#is_cluster ⇒ BOOLEAN

Indicates whether the Oracle Database is part of a cluster.

Returns:

  • (BOOLEAN) 


96
97
98
 
# File 'lib/oci/database_management/models/job_execution.rb', line 96

def is_cluster
  @is_cluster
end

#job_id ⇒ String

[Required] The OCID of the parent job.

Returns:

  • (String) 


104
105
106
 
# File 'lib/oci/database_management/models/job_execution.rb', line 104

def job_id
  @job_id
end

#job_name ⇒ String

[Required] The name of the parent job.

Returns:

  • (String) 


108
109
110
 
# File 'lib/oci/database_management/models/job_execution.rb', line 108

def job_name
  @job_name
end

#job_run_id ⇒ String

[Required] The identifier of the associated job run.

Returns:

  • (String) 


112
113
114
 
# File 'lib/oci/database_management/models/job_execution.rb', line 112

def job_run_id
  @job_run_id
end

#managed_database_group_id ⇒ String

The OCID of the Managed Database Group where the parent job has to be executed.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/database_management/models/job_execution.rb', line 72

def managed_database_group_id
  @managed_database_group_id
end

#managed_database_id ⇒ String

[Required] The OCID of the Managed Database associated with the job execution.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/database_management/models/job_execution.rb', line 76

def managed_database_id
  @managed_database_id
end

#managed_database_name ⇒ String

[Required] The name of the Managed Database associated with the job execution.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/database_management/models/job_execution.rb', line 80

def managed_database_name
  @managed_database_name
end

#name ⇒ String

[Required] The name of the job execution.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/database_management/models/job_execution.rb', line 64

def name
  @name
end

#out_binds ⇒ OCI::DatabaseManagement::Models::JobOutBindsDetails

Returns:



147
148
149
 
# File 'lib/oci/database_management/models/job_execution.rb', line 147

def out_binds
  @out_binds
end

#result_details ⇒ OCI::DatabaseManagement::Models::JobExecutionResultDetails

Returns:



125
126
127
 
# File 'lib/oci/database_management/models/job_execution.rb', line 125

def result_details
  @result_details
end

#schedule_details ⇒ OCI::DatabaseManagement::Models::JobScheduleDetails

Returns:



150
151
152
 
# File 'lib/oci/database_management/models/job_execution.rb', line 150

def schedule_details
  @schedule_details
end

#sql_text ⇒ String

The SQL text executed as part of the job.

Returns:

  • (String) 


141
142
143
 
# File 'lib/oci/database_management/models/job_execution.rb', line 141

def sql_text
  @sql_text
end

#status ⇒ String

[Required] The status of the job execution.

Returns:

  • (String) 


116
117
118
 
# File 'lib/oci/database_management/models/job_execution.rb', line 116

def status
  @status
end

#time_completed ⇒ DateTime

The date and time when the job execution completed.

Returns:

  • (DateTime) 


133
134
135
 
# File 'lib/oci/database_management/models/job_execution.rb', line 133

def time_completed
  @time_completed
end

#time_created ⇒ DateTime

[Required] The date and time when the job execution was created.

Returns:

  • (DateTime) 


129
130
131
 
# File 'lib/oci/database_management/models/job_execution.rb', line 129

def time_created
  @time_created
end

#user_name ⇒ String

The database user name used to execute the SQL job.

Returns:

  • (String) 


137
138
139
 
# File 'lib/oci/database_management/models/job_execution.rb', line 137

def user_name
  @user_name
end

#workload_type ⇒ String

The workload type of the Autonomous Database.

Returns:

  • (String) 


100
101
102
 
# File 'lib/oci/database_management/models/job_execution.rb', line 100

def workload_type
  @workload_type
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/database_management/models/job_execution.rb', line 153

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'compartment_id': :'compartmentId',
    'managed_database_group_id': :'managedDatabaseGroupId',
    'managed_database_id': :'managedDatabaseId',
    'managed_database_name': :'managedDatabaseName',
    'database_type': :'databaseType',
    'database_sub_type': :'databaseSubType',
    'deployment_type': :'deploymentType',
    'is_cluster': :'isCluster',
    'workload_type': :'workloadType',
    'job_id': :'jobId',
    'job_name': :'jobName',
    'job_run_id': :'jobRunId',
    'status': :'status',
    'error_message': :'errorMessage',
    'result_details': :'resultDetails',
    'time_created': :'timeCreated',
    'time_completed': :'timeCompleted',
    'user_name': :'userName',
    'sql_text': :'sqlText',
    'in_binds': :'inBinds',
    'out_binds': :'outBinds',
    'schedule_details': :'scheduleDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/database_management/models/job_execution.rb', line 185

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'compartment_id': :'String',
    'managed_database_group_id': :'String',
    'managed_database_id': :'String',
    'managed_database_name': :'String',
    'database_type': :'String',
    'database_sub_type': :'String',
    'deployment_type': :'String',
    'is_cluster': :'BOOLEAN',
    'workload_type': :'String',
    'job_id': :'String',
    'job_name': :'String',
    'job_run_id': :'String',
    'status': :'String',
    'error_message': :'String',
    'result_details': :'OCI::DatabaseManagement::Models::JobExecutionResultDetails',
    'time_created': :'DateTime',
    'time_completed': :'DateTime',
    'user_name': :'String',
    'sql_text': :'String',
    'in_binds': :'OCI::DatabaseManagement::Models::JobInBindsDetails',
    'out_binds': :'OCI::DatabaseManagement::Models::JobOutBindsDetails',
    'schedule_details': :'OCI::DatabaseManagement::Models::JobScheduleDetails'
    # 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



457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/oci/database_management/models/job_execution.rb', line 457

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    compartment_id == other.compartment_id &&
    managed_database_group_id == other.managed_database_group_id &&
    managed_database_id == other.managed_database_id &&
    managed_database_name == other.managed_database_name &&
    database_type == other.database_type &&
    database_sub_type == other.database_sub_type &&
    deployment_type == other.deployment_type &&
    is_cluster == other.is_cluster &&
    workload_type == other.workload_type &&
    job_id == other.job_id &&
    job_name == other.job_name &&
    job_run_id == other.job_run_id &&
    status == other.status &&
    error_message == other.error_message &&
    result_details == other.result_details &&
    time_created == other.time_created &&
    time_completed == other.time_completed &&
    user_name == other.user_name &&
    sql_text == other.sql_text &&
    in_binds == other.in_binds &&
    out_binds == other.out_binds &&
    schedule_details == other.schedule_details
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



510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/oci/database_management/models/job_execution.rb', line 510

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


490
491
492
 
# File 'lib/oci/database_management/models/job_execution.rb', line 490

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



499
500
501
 
# File 'lib/oci/database_management/models/job_execution.rb', line 499

def hash
  [id, name, compartment_id, managed_database_group_id, managed_database_id, managed_database_name, database_type, database_sub_type, deployment_type, is_cluster, workload_type, job_id, job_name, job_run_id, status, error_message, result_details, time_created, time_completed, user_name, sql_text, in_binds, out_binds, schedule_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



543
544
545
546
547
548
549
550
551
552
 
# File 'lib/oci/database_management/models/job_execution.rb', line 543

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



537
538
539
 
# File 'lib/oci/database_management/models/job_execution.rb', line 537

def to_s
  to_hash.to_s
end