Class: OCI::DatabaseManagement::Models::SqlJob

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

Overview

The details of the SQL job.

Constant Summary collapse

SQL_TYPE_ENUM = 
[
  SQL_TYPE_QUERY = 'QUERY'.freeze,
  SQL_TYPE_DML = 'DML'.freeze,
  SQL_TYPE_DDL = 'DDL'.freeze,
  SQL_TYPE_PLSQL = 'PLSQL'.freeze,
  SQL_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
OPERATION_TYPE_ENUM = 
[
  OPERATION_TYPE_EXECUTE_SQL = 'EXECUTE_SQL'.freeze,
  OPERATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ROLE_ENUM = 
[
  ROLE_NORMAL = 'NORMAL'.freeze,
  ROLE_SYSDBA = 'SYSDBA'.freeze,
  ROLE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from Job

Job::DATABASE_SUB_TYPE_ENUM, Job::JOB_TYPE_ENUM, Job::LIFECYCLE_STATE_ENUM, Job::SCHEDULE_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from Job

#compartment_id, #database_sub_type, #description, #id, #job_type, #lifecycle_state, #managed_database_group_id, #managed_database_id, #managed_databases_details, #name, #result_location, #schedule_details, #schedule_type, #submission_error_message, #time_created, #time_updated, #timeout

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Job

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ SqlJob

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['jobType'] = 'SQL'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.sql_type = attributes[:'sqlType'] if attributes[:'sqlType']

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

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

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

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

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

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

  self.named_credential_id = attributes[:'namedCredentialId'] if attributes[:'namedCredentialId']

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

  self.named_credential_id = attributes[:'named_credential_id'] if attributes[:'named_credential_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']
end

Instance Attribute Details

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


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

def defined_tags
  @defined_tags
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: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


69
70
71
 
# File 'lib/oci/database_management/models/sql_job.rb', line 69

def freeform_tags
  @freeform_tags
end

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

Returns:



41
42
43
 
# File 'lib/oci/database_management/models/sql_job.rb', line 41

def in_binds
  @in_binds
end

#named_credential_id ⇒ String

The OCID of the Named Credentials containing password secret.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/database_management/models/sql_job.rb', line 62

def named_credential_id
  @named_credential_id
end

#operation_type ⇒ String

[Required] The SQL operation type.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/database_management/models/sql_job.rb', line 48

def operation_type
  @operation_type
end

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

Returns:



44
45
46
 
# File 'lib/oci/database_management/models/sql_job.rb', line 44

def out_binds
  @out_binds
end

#role ⇒ String

The role of the database user. Indicates whether the database user is a normal user or sysdba.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/database_management/models/sql_job.rb', line 58

def role
  @role
end

#sql_text ⇒ String

The SQL text to be executed in the job. This is a mandatory field for the EXECUTE_SQL operationType.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/database_management/models/sql_job.rb', line 38

def sql_text
  @sql_text
end

#sql_type ⇒ String

The type of SQL. This is a mandatory field for the EXECUTE_SQL operationType.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/database_management/models/sql_job.rb', line 34

def sql_type
  @sql_type
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


85
86
87
 
# File 'lib/oci/database_management/models/sql_job.rb', line 85

def system_tags
  @system_tags
end

#user_name ⇒ String

The database user name used to execute the SQL job. If the job is being executed on a Managed Database Group, then the user name should exist on all the databases in the group with the same password.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/database_management/models/sql_job.rb', line 54

def user_name
  @user_name
end

Class Method Details

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/database_management/models/sql_job.rb', line 88

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'name': :'name',
    'description': :'description',
    'managed_database_group_id': :'managedDatabaseGroupId',
    'managed_database_id': :'managedDatabaseId',
    'managed_databases_details': :'managedDatabasesDetails',
    'database_sub_type': :'databaseSubType',
    'schedule_type': :'scheduleType',
    'job_type': :'jobType',
    'lifecycle_state': :'lifecycleState',
    'timeout': :'timeout',
    'result_location': :'resultLocation',
    'schedule_details': :'scheduleDetails',
    'submission_error_message': :'submissionErrorMessage',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'sql_type': :'sqlType',
    'sql_text': :'sqlText',
    'in_binds': :'inBinds',
    'out_binds': :'outBinds',
    'operation_type': :'operationType',
    'user_name': :'userName',
    'role': :'role',
    'named_credential_id': :'namedCredentialId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/database_management/models/sql_job.rb', line 124

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'name': :'String',
    'description': :'String',
    'managed_database_group_id': :'String',
    'managed_database_id': :'String',
    'managed_databases_details': :'Array<OCI::DatabaseManagement::Models::JobDatabase>',
    'database_sub_type': :'String',
    'schedule_type': :'String',
    'job_type': :'String',
    'lifecycle_state': :'String',
    'timeout': :'String',
    'result_location': :'OCI::DatabaseManagement::Models::JobExecutionResultLocation',
    'schedule_details': :'OCI::DatabaseManagement::Models::JobScheduleDetails',
    'submission_error_message': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'sql_type': :'String',
    'sql_text': :'String',
    'in_binds': :'OCI::DatabaseManagement::Models::JobInBindsDetails',
    'out_binds': :'OCI::DatabaseManagement::Models::JobOutBindsDetails',
    'operation_type': :'String',
    'user_name': :'String',
    'role': :'String',
    'named_credential_id': :'String',
    '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



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

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    name == other.name &&
    description == other.description &&
    managed_database_group_id == other.managed_database_group_id &&
    managed_database_id == other.managed_database_id &&
    managed_databases_details == other.managed_databases_details &&
    database_sub_type == other.database_sub_type &&
    schedule_type == other.schedule_type &&
    job_type == other.job_type &&
    lifecycle_state == other.lifecycle_state &&
    timeout == other.timeout &&
    result_location == other.result_location &&
    schedule_details == other.schedule_details &&
    submission_error_message == other.submission_error_message &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    sql_type == other.sql_type &&
    sql_text == other.sql_text &&
    in_binds == other.in_binds &&
    out_binds == other.out_binds &&
    operation_type == other.operation_type &&
    user_name == other.user_name &&
    role == other.role &&
    named_credential_id == other.named_credential_id &&
    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



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/oci/database_management/models/sql_job.rb', line 368

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


348
349
350
 
# File 'lib/oci/database_management/models/sql_job.rb', line 348

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



357
358
359
 
# File 'lib/oci/database_management/models/sql_job.rb', line 357

def hash
  [id, compartment_id, name, description, managed_database_group_id, managed_database_id, managed_databases_details, database_sub_type, schedule_type, job_type, lifecycle_state, timeout, result_location, schedule_details, submission_error_message, time_created, time_updated, sql_type, sql_text, in_binds, out_binds, operation_type, user_name, role, named_credential_id, 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



401
402
403
404
405
406
407
408
409
410
 
# File 'lib/oci/database_management/models/sql_job.rb', line 401

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



395
396
397
 
# File 'lib/oci/database_management/models/sql_job.rb', line 395

def to_s
  to_hash.to_s
end