Class: OCI::DatabaseTools::Models::DatabaseToolsSqlReport

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_tools/models/database_tools_sql_report.rb

Overview

Allows generating a summary of SQL query execution details for database operations. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

DatabaseToolsSqlReportOracleDatabase

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_ORACLE_DATABASE = 'ORACLE_DATABASE'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ DatabaseToolsSqlReport

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
264
265
266
267
268
269
270
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 193

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#columns ⇒ Array<OCI::DatabaseTools::Models::DatabaseToolsSqlReportColumn>

Descriptive information on columns referenced in the Database Tools SQL Report source.

Returns:



62
63
64
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 62

def columns
  @columns
end

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the Database Tools SQL report.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 34

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


84
85
86
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 84

def defined_tags
  @defined_tags
end

#description ⇒ String

A description of the SQL report.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 42

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 38

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


90
91
92
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 90

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Database Tools SQL report.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 26

def id
  @id
end

#instructions ⇒ String

Instructions on how to use the SQL report. Step-by-step guidance for an AI agent on how to execute or fill in parameters for the report.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 54

def instructions
  @instructions
end

#lifecycle_details ⇒ String

A message describing the current state in more detail.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 70

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Database Tools SQL report.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 66

def lifecycle_state
  @lifecycle_state
end

#locks ⇒ Array<OCI::DatabaseTools::Models::ResourceLock>

Locks associated with this resource.

Returns:



100
101
102
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 100

def locks
  @locks
end

#purpose ⇒ String

Purpose of the Database Tools SQL report. Scenario or conditions describing when or why this report should be used. Provides selection criteria to AI agents to improve report selection accuracy.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 50

def purpose
  @purpose
end

#source ⇒ String

[Required] SQL query executed to generate the report.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 46

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


96
97
98
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 96

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time the Database Tools SQL report was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


74
75
76
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 74

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The time the Database Tools SQL report was updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


78
79
80
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 78

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The Database Tools SQL report type.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 30

def type
  @type
end

#variables ⇒ Array<OCI::DatabaseTools::Models::DatabaseToolsSqlReportVariable>

Variables referenced in the Database Tools SQL Report source.

Returns:



58
59
60
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 58

def variables
  @variables
end

Class Method Details

.attribute_map ⇒ Object

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



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_tools/models/database_tools_sql_report.rb', line 103

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'type': :'type',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'source': :'source',
    'purpose': :'purpose',
    'instructions': :'instructions',
    'variables': :'variables',
    'columns': :'columns',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'system_tags': :'systemTags',
    'locks': :'locks'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



159
160
161
162
163
164
165
166
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 159

def self.get_subtype(object_hash)
  type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::DatabaseTools::Models::DatabaseToolsSqlReportOracleDatabase' if type == 'ORACLE_DATABASE'

  # TODO: Log a warning when the subtype is not found.
  'OCI::DatabaseTools::Models::DatabaseToolsSqlReport'
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'type': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'source': :'String',
    'purpose': :'String',
    'instructions': :'String',
    'variables': :'Array<OCI::DatabaseTools::Models::DatabaseToolsSqlReportVariable>',
    'columns': :'Array<OCI::DatabaseTools::Models::DatabaseToolsSqlReportColumn>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'locks': :'Array<OCI::DatabaseTools::Models::ResourceLock>'
    # 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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 305

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

  self.class == other.class &&
    id == other.id &&
    type == other.type &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    source == other.source &&
    purpose == other.purpose &&
    instructions == other.instructions &&
    variables == other.variables &&
    columns == other.columns &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags &&
    system_tags == other.system_tags &&
    locks == other.locks
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



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 352

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


332
333
334
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 332

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



341
342
343
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 341

def hash
  [id, type, compartment_id, display_name, description, source, purpose, instructions, variables, columns, lifecycle_state, lifecycle_details, time_created, time_updated, defined_tags, freeform_tags, system_tags, locks].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



385
386
387
388
389
390
391
392
393
394
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 385

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



379
380
381
 
# File 'lib/oci/database_tools/models/database_tools_sql_report.rb', line 379

def to_s
  to_hash.to_s
end