Class: OCI::Nosql::Models::QueryDetails
- Inherits:
-
Object
- Object
- OCI::Nosql::Models::QueryDetails
- Defined in:
- lib/oci/nosql/models/query_details.rb
Overview
All the information surrounding a query, including the query statement, limits, consistency, and so forth.
Constant Summary collapse
- CONSISTENCY_ENUM =
[ CONSISTENCY_EVENTUAL = 'EVENTUAL'.freeze, CONSISTENCY_ABSOLUTE = 'ABSOLUTE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] Compartment OCID, to provide context for a table name in the given statement.
-
#consistency ⇒ String
Consistency requirement for a read operation.
-
#is_prepared ⇒ BOOLEAN
If true, the statement is a prepared statement.
-
#max_read_in_k_bs ⇒ Integer
A limit on the total amount of data read during this operation, in KB.
-
#statement ⇒ String
[Required] A NoSQL SQL query statement; or a Base64-encoded prepared statement.
-
#timeout_in_ms ⇒ Integer
Timeout setting for the query.
-
#variables ⇒ Hash<String, Object>
A map of prepared statement variables to values.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ QueryDetails
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ QueryDetails
Initializes the object
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 122 123 124 125 126 127 128 129 |
# File 'lib/oci/nosql/models/query_details.rb', line 93 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.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.statement = attributes[:'statement'] if attributes[:'statement'] self.is_prepared = attributes[:'isPrepared'] unless attributes[:'isPrepared'].nil? raise 'You cannot provide both :isPrepared and :is_prepared' if attributes.key?(:'isPrepared') && attributes.key?(:'is_prepared') self.is_prepared = attributes[:'is_prepared'] unless attributes[:'is_prepared'].nil? self.consistency = attributes[:'consistency'] if attributes[:'consistency'] self.consistency = "EVENTUAL" if consistency.nil? && !attributes.key?(:'consistency') # rubocop:disable Style/StringLiterals self.max_read_in_k_bs = attributes[:'maxReadInKBs'] if attributes[:'maxReadInKBs'] raise 'You cannot provide both :maxReadInKBs and :max_read_in_k_bs' if attributes.key?(:'maxReadInKBs') && attributes.key?(:'max_read_in_k_bs') self.max_read_in_k_bs = attributes[:'max_read_in_k_bs'] if attributes[:'max_read_in_k_bs'] self.variables = attributes[:'variables'] if attributes[:'variables'] self.timeout_in_ms = attributes[:'timeoutInMs'] if attributes[:'timeoutInMs'] raise 'You cannot provide both :timeoutInMs and :timeout_in_ms' if attributes.key?(:'timeoutInMs') && attributes.key?(:'timeout_in_ms') self.timeout_in_ms = attributes[:'timeout_in_ms'] if attributes[:'timeout_in_ms'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] Compartment OCID, to provide context for a table name in the given statement.
22 23 24 |
# File 'lib/oci/nosql/models/query_details.rb', line 22 def compartment_id @compartment_id end |
#consistency ⇒ String
Consistency requirement for a read operation.
35 36 37 |
# File 'lib/oci/nosql/models/query_details.rb', line 35 def consistency @consistency end |
#is_prepared ⇒ BOOLEAN
If true, the statement is a prepared statement.
31 32 33 |
# File 'lib/oci/nosql/models/query_details.rb', line 31 def is_prepared @is_prepared end |
#max_read_in_k_bs ⇒ Integer
A limit on the total amount of data read during this operation, in KB.
40 41 42 |
# File 'lib/oci/nosql/models/query_details.rb', line 40 def max_read_in_k_bs @max_read_in_k_bs end |
#statement ⇒ String
[Required] A NoSQL SQL query statement; or a Base64-encoded prepared statement.
27 28 29 |
# File 'lib/oci/nosql/models/query_details.rb', line 27 def statement @statement end |
#timeout_in_ms ⇒ Integer
Timeout setting for the query.
48 49 50 |
# File 'lib/oci/nosql/models/query_details.rb', line 48 def timeout_in_ms @timeout_in_ms end |
#variables ⇒ Hash<String, Object>
A map of prepared statement variables to values.
44 45 46 |
# File 'lib/oci/nosql/models/query_details.rb', line 44 def variables @variables end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
51 52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/oci/nosql/models/query_details.rb', line 51 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'statement': :'statement', 'is_prepared': :'isPrepared', 'consistency': :'consistency', 'max_read_in_k_bs': :'maxReadInKBs', 'variables': :'variables', 'timeout_in_ms': :'timeoutInMs' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/oci/nosql/models/query_details.rb', line 66 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'String', 'statement': :'String', 'is_prepared': :'BOOLEAN', 'consistency': :'String', 'max_read_in_k_bs': :'Integer', 'variables': :'Hash<String, Object>', 'timeout_in_ms': :'Integer' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/oci/nosql/models/query_details.rb', line 146 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && statement == other.statement && is_prepared == other.is_prepared && consistency == other.consistency && max_read_in_k_bs == other.max_read_in_k_bs && variables == other.variables && timeout_in_ms == other.timeout_in_ms end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/oci/nosql/models/query_details.rb', line 182 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
162 163 164 |
# File 'lib/oci/nosql/models/query_details.rb', line 162 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
171 172 173 |
# File 'lib/oci/nosql/models/query_details.rb', line 171 def hash [compartment_id, statement, is_prepared, consistency, max_read_in_k_bs, variables, timeout_in_ms].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
215 216 217 218 219 220 221 222 223 224 |
# File 'lib/oci/nosql/models/query_details.rb', line 215 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
209 210 211 |
# File 'lib/oci/nosql/models/query_details.rb', line 209 def to_s to_hash.to_s end |