Class: OCI::DatabaseToolsRuntime::Models::ExecuteSqlInputStandardDetails

Inherits:
ExecuteSqlInputDetails show all
Defined in:
lib/oci/database_tools_runtime/models/execute_sql_input_standard_details.rb

Overview

Contains the details for the Standard SQL statements to execute on the database connection.

Constant Summary

Constants inherited from ExecuteSqlInputDetails

OCI::DatabaseToolsRuntime::Models::ExecuteSqlInputDetails::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ExecuteSqlInputDetails

#type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ExecuteSqlInputDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ ExecuteSqlInputStandardDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# File 'lib/oci/database_tools_runtime/models/execute_sql_input_standard_details.rb', line 77

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

  attributes['type'] = 'STANDARD'

  super(attributes)

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

  self.statement_text = attributes[:'statementText'] if attributes[:'statementText']

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

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

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

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

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

  self.response_format = attributes[:'responseFormat'] if attributes[:'responseFormat']

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

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

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

Instance Attribute Details

#bindsArray<OCI::DatabaseToolsRuntime::Models::ExecuteSqlBind>

Array of objects specifying the bind information.



26
27
28
# File 'lib/oci/database_tools_runtime/models/execute_sql_input_standard_details.rb', line 26

def binds
  @binds
end

#limitInteger

The maximum number of rows to return from the query (-1 disables pagination).

Returns:

  • (Integer)


18
19
20
# File 'lib/oci/database_tools_runtime/models/execute_sql_input_standard_details.rb', line 18

def limit
  @limit
end

#offsetInteger

The first row to return in the result set.

Returns:

  • (Integer)


22
23
24
# File 'lib/oci/database_tools_runtime/models/execute_sql_input_standard_details.rb', line 22

def offset
  @offset
end

#propertiesObject

Client properties returned as-is in the response

Returns:

  • (Object)


33
34
35
# File 'lib/oci/database_tools_runtime/models/execute_sql_input_standard_details.rb', line 33

def properties
  @properties
end

#response_formatOCI::DatabaseToolsRuntime::Models::ExecuteSqlResponseFormat



29
30
31
# File 'lib/oci/database_tools_runtime/models/execute_sql_input_standard_details.rb', line 29

def response_format
  @response_format
end

#statement_textString

[Required] Statements to execute (Can be more than one).

Returns:

  • (String)


14
15
16
# File 'lib/oci/database_tools_runtime/models/execute_sql_input_standard_details.rb', line 14

def statement_text
  @statement_text
end

Class Method Details

.attribute_mapObject

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



36
37
38
39
40
41
42
43
44
45
46
47
48
# File 'lib/oci/database_tools_runtime/models/execute_sql_input_standard_details.rb', line 36

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'statement_text': :'statementText',
    'limit': :'limit',
    'offset': :'offset',
    'binds': :'binds',
    'response_format': :'responseFormat',
    'properties': :'properties'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
62
63
# File 'lib/oci/database_tools_runtime/models/execute_sql_input_standard_details.rb', line 51

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'statement_text': :'String',
    'limit': :'Integer',
    'offset': :'Integer',
    'binds': :'Array<OCI::DatabaseToolsRuntime::Models::ExecuteSqlBind>',
    'response_format': :'OCI::DatabaseToolsRuntime::Models::ExecuteSqlResponseFormat',
    'properties': :'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



115
116
117
118
119
120
121
122
123
124
125
126
# File 'lib/oci/database_tools_runtime/models/execute_sql_input_standard_details.rb', line 115

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

  self.class == other.class &&
    type == other.type &&
    statement_text == other.statement_text &&
    limit == other.limit &&
    offset == other.offset &&
    binds == other.binds &&
    response_format == other.response_format &&
    properties == other.properties
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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/oci/database_tools_runtime/models/execute_sql_input_standard_details.rb', line 151

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


131
132
133
# File 'lib/oci/database_tools_runtime/models/execute_sql_input_standard_details.rb', line 131

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



140
141
142
# File 'lib/oci/database_tools_runtime/models/execute_sql_input_standard_details.rb', line 140

def hash
  [type, statement_text, limit, offset, binds, response_format, properties].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



184
185
186
187
188
189
190
191
192
193
# File 'lib/oci/database_tools_runtime/models/execute_sql_input_standard_details.rb', line 184

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



178
179
180
# File 'lib/oci/database_tools_runtime/models/execute_sql_input_standard_details.rb', line 178

def to_s
  to_hash.to_s
end