Class: OCI::DatabaseTools::Models::CreateDatabaseToolsSqlReportDetails

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

Overview

Details for the new Database Tools SQL report. 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

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_ORACLE_DATABASE = 'ORACLE_DATABASE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDatabaseToolsSqlReportDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



141
142
143
144
145
146
147
148
149
150
151
152
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
183
184
185
186
 
# File 'lib/oci/database_tools/models/create_database_tools_sql_report_details.rb', line 141

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

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

  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.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.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:



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

def columns
  @columns
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/database_tools/models/create_database_tools_sql_report_details.rb', line 22

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


56
57
58
 
# File 'lib/oci/database_tools/models/create_database_tools_sql_report_details.rb', line 56

def defined_tags
  @defined_tags
end

#description ⇒ String

A description of the SQL report.

Returns:

  • (String) 


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

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) 


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

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


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

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


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

def instructions
  @instructions
end

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

Locks associated with this resource.

Returns:



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

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) 


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

def purpose
  @purpose
end

#source ⇒ String

[Required] SQL query executed to generate the report.

Returns:

  • (String) 


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

def source
  @source
end

#type ⇒ String

[Required] The Database Tools SQL report type.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/database_tools/models/create_database_tools_sql_report_details.rb', line 18

def type
  @type
end

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

Variables referenced in the Database Tools SQL Report source.

Returns:



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

def variables
  @variables
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/database_tools/models/create_database_tools_sql_report_details.rb', line 69

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'source': :'source',
    'description': :'description',
    'purpose': :'purpose',
    'instructions': :'instructions',
    'variables': :'variables',
    'columns': :'columns',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    '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.



113
114
115
116
117
118
119
120
 
# File 'lib/oci/database_tools/models/create_database_tools_sql_report_details.rb', line 113

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

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

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

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/database_tools/models/create_database_tools_sql_report_details.rb', line 89

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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/oci/database_tools/models/create_database_tools_sql_report_details.rb', line 203

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

  self.class == other.class &&
    type == other.type &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    source == other.source &&
    description == other.description &&
    purpose == other.purpose &&
    instructions == other.instructions &&
    variables == other.variables &&
    columns == other.columns &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/oci/database_tools/models/create_database_tools_sql_report_details.rb', line 244

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


224
225
226
 
# File 'lib/oci/database_tools/models/create_database_tools_sql_report_details.rb', line 224

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



233
234
235
 
# File 'lib/oci/database_tools/models/create_database_tools_sql_report_details.rb', line 233

def hash
  [type, compartment_id, display_name, source, description, purpose, instructions, variables, columns, defined_tags, freeform_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



277
278
279
280
281
282
283
284
285
286
 
# File 'lib/oci/database_tools/models/create_database_tools_sql_report_details.rb', line 277

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



271
272
273
 
# File 'lib/oci/database_tools/models/create_database_tools_sql_report_details.rb', line 271

def to_s
  to_hash.to_s
end