Class: OCI::Opsi::Models::DataObjectStandardQuery

Inherits:
DataObjectQuery show all
Defined in:
lib/oci/opsi/models/data_object_standard_query.rb

Overview

Information required to execute query on data objects. Query is given in standard SQL syntax providing flexibility to form complex queries such as queries with joins and nested queries.

Constant Summary

Constants inherited from DataObjectQuery

OCI::Opsi::Models::DataObjectQuery::QUERY_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from DataObjectQuery

#bind_params, #query_execution_timeout_in_seconds, #query_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DataObjectQuery

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DataObjectStandardQuery

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/opsi/models/data_object_standard_query.rb', line 63

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

  attributes['queryType'] = 'STANDARD_QUERY'

  super(attributes)

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

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

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

Instance Attribute Details

#statement ⇒ String

SQL query statement with standard Oracle supported SQL syntax. - When Warehouse (e.g: Awr hub) data objects are queried, use the actual names of underlying data objects (e.g: tables, views) in the query. The same query that works through JDBC connection with the OperationsInsightsWarehouseUsers credentials will work here and vice-versa. SCHEMA.VIEW syntax can also be used here. - When OPSI data objects are queried, use name of the respective OPSI data object, just like how views are used in a query. Identifier of the OPSI data object cannot be used in the query.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/opsi/models/data_object_standard_query.rb', line 22

def statement
  @statement
end

#time_filters ⇒ OCI::Opsi::Models::DataObjectQueryTimeFilters

Returns:



25
26
27
 
# File 'lib/oci/opsi/models/data_object_standard_query.rb', line 25

def time_filters
  @time_filters
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/oci/opsi/models/data_object_standard_query.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'query_type': :'queryType',
    'bind_params': :'bindParams',
    'query_execution_timeout_in_seconds': :'queryExecutionTimeoutInSeconds',
    'statement': :'statement',
    'time_filters': :'timeFilters'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/opsi/models/data_object_standard_query.rb', line 41

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'query_type': :'String',
    'bind_params': :'Array<OCI::Opsi::Models::DataObjectBindParameter>',
    'query_execution_timeout_in_seconds': :'Float',
    'statement': :'String',
    'time_filters': :'OCI::Opsi::Models::DataObjectQueryTimeFilters'
    # 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



89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/opsi/models/data_object_standard_query.rb', line 89

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

  self.class == other.class &&
    query_type == other.query_type &&
    bind_params == other.bind_params &&
    query_execution_timeout_in_seconds == other.query_execution_timeout_in_seconds &&
    statement == other.statement &&
    time_filters == other.time_filters
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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/opsi/models/data_object_standard_query.rb', line 123

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


103
104
105
 
# File 'lib/oci/opsi/models/data_object_standard_query.rb', line 103

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



112
113
114
 
# File 'lib/oci/opsi/models/data_object_standard_query.rb', line 112

def hash
  [query_type, bind_params, query_execution_timeout_in_seconds, statement, time_filters].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/opsi/models/data_object_standard_query.rb', line 156

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



150
151
152
 
# File 'lib/oci/opsi/models/data_object_standard_query.rb', line 150

def to_s
  to_hash.to_s
end