Class: OCI::Nosql::Models::PreparedStatement

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/nosql/models/prepared_statement.rb

Overview

The result of query preparation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PreparedStatement

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/nosql/models/prepared_statement.rb', line 56

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

  self.query_plan = attributes[:'queryPlan'] if attributes[:'queryPlan']

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

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

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

Instance Attribute Details

#query_plan ⇒ Object

A representation of the query plan as a schema-less JSON object.

Returns:

  • (Object) 


20
21
22
 
# File 'lib/oci/nosql/models/prepared_statement.rb', line 20

def query_plan
  @query_plan
end

#statement ⇒ String

A base64-encoded, compiled and parameterized version of a SQL statement.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/nosql/models/prepared_statement.rb', line 15

def statement
  @statement
end

#usage ⇒ OCI::Nosql::Models::RequestUsage

Returns:



23
24
25
 
# File 'lib/oci/nosql/models/prepared_statement.rb', line 23

def usage
  @usage
end

Class Method Details

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
33
34
 
# File 'lib/oci/nosql/models/prepared_statement.rb', line 26

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'statement': :'statement',
    'query_plan': :'queryPlan',
    'usage': :'usage'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
45
 
# File 'lib/oci/nosql/models/prepared_statement.rb', line 37

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'statement': :'String',
    'query_plan': :'Object',
    'usage': :'OCI::Nosql::Models::RequestUsage'
    # 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



80
81
82
83
84
85
86
87
 
# File 'lib/oci/nosql/models/prepared_statement.rb', line 80

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

  self.class == other.class &&
    statement == other.statement &&
    query_plan == other.query_plan &&
    usage == other.usage
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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/nosql/models/prepared_statement.rb', line 112

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


92
93
94
 
# File 'lib/oci/nosql/models/prepared_statement.rb', line 92

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



101
102
103
 
# File 'lib/oci/nosql/models/prepared_statement.rb', line 101

def hash
  [statement, query_plan, usage].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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



139
140
141
 
# File 'lib/oci/nosql/models/prepared_statement.rb', line 139

def to_s
  to_hash.to_s
end