Class: OCI::Nosql::Models::QueryDetails

Inherits:
Object
  • Object
show all
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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ QueryDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :statement (String)

    The value to assign to the #statement property

  • :is_prepared (BOOLEAN)

    The value to assign to the #is_prepared property

  • :consistency (String)

    The value to assign to the #consistency property

  • :max_read_in_k_bs (Integer)

    The value to assign to the #max_read_in_k_bs property

  • :variables (Hash<String, Object>)

    The value to assign to the #variables property

  • :timeout_in_ms (Integer)

    The value to assign to the #timeout_in_ms property



92
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
# File 'lib/oci/nosql/models/query_details.rb', line 92

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_idString

[Required] Compartment OCID, to provide context for a table name in the given statement.

Returns:

  • (String)


21
22
23
# File 'lib/oci/nosql/models/query_details.rb', line 21

def compartment_id
  @compartment_id
end

#consistencyString

Consistency requirement for a read operation.

Returns:

  • (String)


34
35
36
# File 'lib/oci/nosql/models/query_details.rb', line 34

def consistency
  @consistency
end

#is_preparedBOOLEAN

If true, the statement is a prepared statement.

Returns:

  • (BOOLEAN)


30
31
32
# File 'lib/oci/nosql/models/query_details.rb', line 30

def is_prepared
  @is_prepared
end

#max_read_in_k_bsInteger

A limit on the total amount of data read during this operation, in KB.

Returns:

  • (Integer)


39
40
41
# File 'lib/oci/nosql/models/query_details.rb', line 39

def max_read_in_k_bs
  @max_read_in_k_bs
end

#statementString

[Required] A NoSQL SQL query statement; or a Base64-encoded prepared statement.

Returns:

  • (String)


26
27
28
# File 'lib/oci/nosql/models/query_details.rb', line 26

def statement
  @statement
end

#timeout_in_msInteger

Timeout setting for the query.

Returns:

  • (Integer)


47
48
49
# File 'lib/oci/nosql/models/query_details.rb', line 47

def timeout_in_ms
  @timeout_in_ms
end

#variablesHash<String, Object>

A map of prepared statement variables to values.

Returns:

  • (Hash<String, Object>)


43
44
45
# File 'lib/oci/nosql/models/query_details.rb', line 43

def variables
  @variables
end

Class Method Details

.attribute_mapObject

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



50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/oci/nosql/models/query_details.rb', line 50

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_typesObject

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/oci/nosql/models/query_details.rb', line 65

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.

Parameters:

  • other (Object)

    the other object to be compared



145
146
147
148
149
150
151
152
153
154
155
156
# File 'lib/oci/nosql/models/query_details.rb', line 145

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

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'lib/oci/nosql/models/query_details.rb', line 181

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


161
162
163
# File 'lib/oci/nosql/models/query_details.rb', line 161

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



170
171
172
# File 'lib/oci/nosql/models/query_details.rb', line 170

def hash
  [compartment_id, statement, is_prepared, consistency, max_read_in_k_bs, variables, timeout_in_ms].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



214
215
216
217
218
219
220
221
222
223
# File 'lib/oci/nosql/models/query_details.rb', line 214

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



208
209
210
# File 'lib/oci/nosql/models/query_details.rb', line 208

def to_s
  to_hash.to_s
end