Class: OCI::ApmTraces::Models::QueryResultResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apm_traces/models/query_result_response.rb

Overview

A response containing a collection of query rows (selected attributes and aggregations) filtered, grouped and sorted by the specified criteria from the query that is run, and the associated summary describing the corresponding query result metadata.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ QueryResultResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/apm_traces/models/query_result_response.rb', line 69

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

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

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

  self.query_result_rows = attributes[:'queryResultRows'] if attributes[:'queryResultRows']

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

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

  self.query_result_metadata = attributes[:'queryResultMetadata'] if attributes[:'queryResultMetadata']

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

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

  self.query_result_warnings = attributes[:'queryResultWarnings'] if attributes[:'queryResultWarnings']

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

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

Instance Attribute Details

#query_result_metadata ⇒ Hash<String, Object>

A map containing metadata or additional information.

Returns:

  • (Hash<String, Object>) 


28
29
30
 
# File 'lib/oci/apm_traces/models/query_result_response.rb', line 28

def query_result_metadata
  @query_result_metadata
end

#query_result_metadata_summary ⇒ OCI::ApmTraces::Models::QueryResultMetadataSummary

This attribute is required.

Returns:



16
17
18
 
# File 'lib/oci/apm_traces/models/query_result_response.rb', line 16

def query_result_metadata_summary
  @query_result_metadata_summary
end

#query_result_rows ⇒ Array<OCI::ApmTraces::Models::QueryResultRow>

[Required] A collection of objects with each object representing an individual row of the query result set. The total number of objects returned in this collection correspond to the total number of rows returned by the actual query that is run against the queried entity.

Returns:



23
24
25
 
# File 'lib/oci/apm_traces/models/query_result_response.rb', line 23

def query_result_rows
  @query_result_rows
end

#query_result_warnings ⇒ Array<OCI::ApmTraces::Models::QueryResultWarning>

A structure that provides warnings, if any, along with the query results.

Returns:



33
34
35
 
# File 'lib/oci/apm_traces/models/query_result_response.rb', line 33

def query_result_warnings
  @query_result_warnings
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'query_result_metadata_summary': :'queryResultMetadataSummary',
    'query_result_rows': :'queryResultRows',
    'query_result_metadata': :'queryResultMetadata',
    'query_result_warnings': :'queryResultWarnings'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/apm_traces/models/query_result_response.rb', line 48

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'query_result_metadata_summary': :'OCI::ApmTraces::Models::QueryResultMetadataSummary',
    'query_result_rows': :'Array<OCI::ApmTraces::Models::QueryResultRow>',
    'query_result_metadata': :'Hash<String, Object>',
    'query_result_warnings': :'Array<OCI::ApmTraces::Models::QueryResultWarning>'
    # 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



107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/apm_traces/models/query_result_response.rb', line 107

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

  self.class == other.class &&
    query_result_metadata_summary == other.query_result_metadata_summary &&
    query_result_rows == other.query_result_rows &&
    query_result_metadata == other.query_result_metadata &&
    query_result_warnings == other.query_result_warnings
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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/apm_traces/models/query_result_response.rb', line 140

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


120
121
122
 
# File 'lib/oci/apm_traces/models/query_result_response.rb', line 120

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



129
130
131
 
# File 'lib/oci/apm_traces/models/query_result_response.rb', line 129

def hash
  [query_result_metadata_summary, query_result_rows, query_result_metadata, query_result_warnings].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/apm_traces/models/query_result_response.rb', line 173

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



167
168
169
 
# File 'lib/oci/apm_traces/models/query_result_response.rb', line 167

def to_s
  to_hash.to_s
end