Class: OCI::DatabaseManagement::Models::CreateSqlJobDetails

Inherits:
CreateJobDetails show all
Defined in:
lib/oci/database_management/models/create_sql_job_details.rb

Overview

The details specific to the SQL job request.

Constant Summary

Constants inherited from CreateJobDetails

OCI::DatabaseManagement::Models::CreateJobDetails::DATABASE_SUB_TYPE_ENUM, OCI::DatabaseManagement::Models::CreateJobDetails::JOB_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateJobDetails

#compartment_id, #database_sub_type, #description, #job_type, #managed_database_group_id, #managed_database_id, #name, #result_location, #schedule_details, #schedule_type, #timeout

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateJobDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateSqlJobDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
223
224
225
226
227
228
229
 
# File 'lib/oci/database_management/models/create_sql_job_details.rb', line 156

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

  self.secret_id = attributes[:'secretId'] if attributes[:'secretId']

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

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

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

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


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

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


57
58
59
 
# File 'lib/oci/database_management/models/create_sql_job_details.rb', line 57

def freeform_tags
  @freeform_tags
end

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

Returns:



17
18
19
 
# File 'lib/oci/database_management/models/create_sql_job_details.rb', line 17

def in_binds
  @in_binds
end

#named_credential_id ⇒ String

The OCID of the Named Credentials containing password secret.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/database_management/models/create_sql_job_details.rb', line 46

def named_credential_id
  @named_credential_id
end

#operation_type ⇒ String

[Required] The SQL operation type.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/database_management/models/create_sql_job_details.rb', line 27

def operation_type
  @operation_type
end

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

Returns:



20
21
22
 
# File 'lib/oci/database_management/models/create_sql_job_details.rb', line 20

def out_binds
  @out_binds
end

#password ⇒ String

The password for the database user name used to execute the SQL job.

Returns:

  • (String) 


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

def password
  @password
end

#role ⇒ String

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

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/database_management/models/create_sql_job_details.rb', line 50

def role
  @role
end

#secret_id ⇒ String

The OCID of the secret containing the user password.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/database_management/models/create_sql_job_details.rb', line 42

def secret_id
  @secret_id
end

#sql_text ⇒ String

The SQL text to be executed as part of the job.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/database_management/models/create_sql_job_details.rb', line 14

def sql_text
  @sql_text
end

#sql_type ⇒ String

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/database_management/models/create_sql_job_details.rb', line 23

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


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

def user_name
  @user_name
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/database_management/models/create_sql_job_details.rb', line 67

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'managed_database_group_id': :'managedDatabaseGroupId',
    'managed_database_id': :'managedDatabaseId',
    'database_sub_type': :'databaseSubType',
    'schedule_type': :'scheduleType',
    'job_type': :'jobType',
    'timeout': :'timeout',
    'result_location': :'resultLocation',
    'schedule_details': :'scheduleDetails',
    'sql_text': :'sqlText',
    'in_binds': :'inBinds',
    'out_binds': :'outBinds',
    'sql_type': :'sqlType',
    'operation_type': :'operationType',
    'user_name': :'userName',
    'password': :'password',
    'secret_id': :'secretId',
    'named_credential_id': :'namedCredentialId',
    'role': :'role',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/oci/database_management/models/create_sql_job_details.rb', line 98

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'managed_database_group_id': :'String',
    'managed_database_id': :'String',
    'database_sub_type': :'String',
    'schedule_type': :'String',
    'job_type': :'String',
    'timeout': :'String',
    'result_location': :'OCI::DatabaseManagement::Models::JobExecutionResultLocation',
    'schedule_details': :'OCI::DatabaseManagement::Models::JobScheduleDetails',
    'sql_text': :'String',
    'in_binds': :'OCI::DatabaseManagement::Models::JobInBindsDetails',
    'out_binds': :'OCI::DatabaseManagement::Models::JobOutBindsDetails',
    'sql_type': :'String',
    'operation_type': :'String',
    'user_name': :'String',
    'password': :'String',
    'secret_id': :'String',
    'named_credential_id': :'String',
    'role': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



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
264
265
 
# File 'lib/oci/database_management/models/create_sql_job_details.rb', line 238

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

  self.class == other.class &&
    name == other.name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    managed_database_group_id == other.managed_database_group_id &&
    managed_database_id == other.managed_database_id &&
    database_sub_type == other.database_sub_type &&
    schedule_type == other.schedule_type &&
    job_type == other.job_type &&
    timeout == other.timeout &&
    result_location == other.result_location &&
    schedule_details == other.schedule_details &&
    sql_text == other.sql_text &&
    in_binds == other.in_binds &&
    out_binds == other.out_binds &&
    sql_type == other.sql_type &&
    operation_type == other.operation_type &&
    user_name == other.user_name &&
    password == other.password &&
    secret_id == other.secret_id &&
    named_credential_id == other.named_credential_id &&
    role == other.role &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



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

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


270
271
272
 
# File 'lib/oci/database_management/models/create_sql_job_details.rb', line 270

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



279
280
281
 
# File 'lib/oci/database_management/models/create_sql_job_details.rb', line 279

def hash
  [name, description, compartment_id, managed_database_group_id, managed_database_id, database_sub_type, schedule_type, job_type, timeout, result_location, schedule_details, sql_text, in_binds, out_binds, sql_type, operation_type, user_name, password, secret_id, named_credential_id, role, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



323
324
325
326
327
328
329
330
331
332
 
# File 'lib/oci/database_management/models/create_sql_job_details.rb', line 323

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



317
318
319
 
# File 'lib/oci/database_management/models/create_sql_job_details.rb', line 317

def to_s
  to_hash.to_s
end