Class: OCI::LogAnalytics::Models::QueryDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/log_analytics/models/query_details.rb

Overview

Input arguments for running a log anlaytics query. If the request is set to run in asynchronous mode then shouldIncludeColumns and shouldIncludeFields can be overwritten when retrieving the results.

Constant Summary collapse

SUB_SYSTEM_ENUM = 
[
  SUB_SYSTEM_LOG = 'LOG'.freeze
].freeze
ASYNC_MODE_ENUM = 
[
  ASYNC_MODE_FOREGROUND = 'FOREGROUND'.freeze,
  ASYNC_MODE_BACKGROUND = 'BACKGROUND'.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):



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 155

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.compartment_id_in_subtree = attributes[:'compartmentIdInSubtree'] unless attributes[:'compartmentIdInSubtree'].nil?
  self.compartment_id_in_subtree = false if compartment_id_in_subtree.nil? && !attributes.key?(:'compartmentIdInSubtree') # rubocop:disable Style/StringLiterals

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

  self.compartment_id_in_subtree = attributes[:'compartment_id_in_subtree'] unless attributes[:'compartment_id_in_subtree'].nil?
  self.compartment_id_in_subtree = false if compartment_id_in_subtree.nil? && !attributes.key?(:'compartmentIdInSubtree') && !attributes.key?(:'compartment_id_in_subtree') # rubocop:disable Style/StringLiterals

  self.saved_search_id = attributes[:'savedSearchId'] if attributes[:'savedSearchId']

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

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

  self.query_string = attributes[:'queryString'] if attributes[:'queryString']

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

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

  self.sub_system = attributes[:'subSystem'] if attributes[:'subSystem']

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

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

  self.max_total_count = attributes[:'maxTotalCount'] if attributes[:'maxTotalCount']
  self.max_total_count = 500 if max_total_count.nil? && !attributes.key?(:'maxTotalCount') # rubocop:disable Style/StringLiterals

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

  self.max_total_count = attributes[:'max_total_count'] if attributes[:'max_total_count']
  self.max_total_count = 500 if max_total_count.nil? && !attributes.key?(:'maxTotalCount') && !attributes.key?(:'max_total_count') # rubocop:disable Style/StringLiterals

  self.time_filter = attributes[:'timeFilter'] if attributes[:'timeFilter']

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

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

  self.scope_filters = attributes[:'scopeFilters'] if attributes[:'scopeFilters']

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

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

  self.query_timeout_in_seconds = attributes[:'queryTimeoutInSeconds'] if attributes[:'queryTimeoutInSeconds']
  self.query_timeout_in_seconds = 120 if query_timeout_in_seconds.nil? && !attributes.key?(:'queryTimeoutInSeconds') # rubocop:disable Style/StringLiterals

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

  self.query_timeout_in_seconds = attributes[:'query_timeout_in_seconds'] if attributes[:'query_timeout_in_seconds']
  self.query_timeout_in_seconds = 120 if query_timeout_in_seconds.nil? && !attributes.key?(:'queryTimeoutInSeconds') && !attributes.key?(:'query_timeout_in_seconds') # rubocop:disable Style/StringLiterals

  self.should_run_async = attributes[:'shouldRunAsync'] unless attributes[:'shouldRunAsync'].nil?
  self.should_run_async = false if should_run_async.nil? && !attributes.key?(:'shouldRunAsync') # rubocop:disable Style/StringLiterals

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

  self.should_run_async = attributes[:'should_run_async'] unless attributes[:'should_run_async'].nil?
  self.should_run_async = false if should_run_async.nil? && !attributes.key?(:'shouldRunAsync') && !attributes.key?(:'should_run_async') # rubocop:disable Style/StringLiterals

  self.async_mode = attributes[:'asyncMode'] if attributes[:'asyncMode']
  self.async_mode = "FOREGROUND" if async_mode.nil? && !attributes.key?(:'asyncMode') # rubocop:disable Style/StringLiterals

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

  self.async_mode = attributes[:'async_mode'] if attributes[:'async_mode']
  self.async_mode = "FOREGROUND" if async_mode.nil? && !attributes.key?(:'asyncMode') && !attributes.key?(:'async_mode') # rubocop:disable Style/StringLiterals

  self.should_include_total_count = attributes[:'shouldIncludeTotalCount'] unless attributes[:'shouldIncludeTotalCount'].nil?
  self.should_include_total_count = false if should_include_total_count.nil? && !attributes.key?(:'shouldIncludeTotalCount') # rubocop:disable Style/StringLiterals

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

  self.should_include_total_count = attributes[:'should_include_total_count'] unless attributes[:'should_include_total_count'].nil?
  self.should_include_total_count = false if should_include_total_count.nil? && !attributes.key?(:'shouldIncludeTotalCount') && !attributes.key?(:'should_include_total_count') # rubocop:disable Style/StringLiterals

  self.should_include_columns = attributes[:'shouldIncludeColumns'] unless attributes[:'shouldIncludeColumns'].nil?
  self.should_include_columns = true if should_include_columns.nil? && !attributes.key?(:'shouldIncludeColumns') # rubocop:disable Style/StringLiterals

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

  self.should_include_columns = attributes[:'should_include_columns'] unless attributes[:'should_include_columns'].nil?
  self.should_include_columns = true if should_include_columns.nil? && !attributes.key?(:'shouldIncludeColumns') && !attributes.key?(:'should_include_columns') # rubocop:disable Style/StringLiterals

  self.should_include_fields = attributes[:'shouldIncludeFields'] unless attributes[:'shouldIncludeFields'].nil?
  self.should_include_fields = true if should_include_fields.nil? && !attributes.key?(:'shouldIncludeFields') # rubocop:disable Style/StringLiterals

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

  self.should_include_fields = attributes[:'should_include_fields'] unless attributes[:'should_include_fields'].nil?
  self.should_include_fields = true if should_include_fields.nil? && !attributes.key?(:'shouldIncludeFields') && !attributes.key?(:'should_include_fields') # rubocop:disable Style/StringLiterals

  self.should_use_acceleration = attributes[:'shouldUseAcceleration'] unless attributes[:'shouldUseAcceleration'].nil?
  self.should_use_acceleration = true if should_use_acceleration.nil? && !attributes.key?(:'shouldUseAcceleration') # rubocop:disable Style/StringLiterals

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

  self.should_use_acceleration = attributes[:'should_use_acceleration'] unless attributes[:'should_use_acceleration'].nil?
  self.should_use_acceleration = true if should_use_acceleration.nil? && !attributes.key?(:'shouldUseAcceleration') && !attributes.key?(:'should_use_acceleration') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#async_mode ⇒ String

Execution mode for the query if running asynchronously i.e (shouldRunAsync is set to true).

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 69

def async_mode
  @async_mode
end

#compartment_id ⇒ String

[Required] Compartment Identifier [OCID] (docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 24

def compartment_id
  @compartment_id
end

#compartment_id_in_subtree ⇒ BOOLEAN

Flag to search all child compartments of the compartment Id specified in the compartmentId query parameter.

Returns:

  • (BOOLEAN) 


29
30
31
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 29

def compartment_id_in_subtree
  @compartment_id_in_subtree
end

#max_total_count ⇒ Integer

Maximum number of results to count. Note a maximum of 2001 will be enforced; that is, actualMaxTotalCountUsed = Math.min(maxTotalCount, 2001).

Returns:

  • (Integer) 


48
49
50
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 48

def max_total_count
  @max_total_count
end

#query_string ⇒ String

[Required] Query to perform. Must conform to logging analytic querylanguage syntax. Syntax errors will be returned if present.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 38

def query_string
  @query_string
end

#query_timeout_in_seconds ⇒ Integer

Amount of time, in seconds, allowed for a query to execute. If this time expires before the query is complete, any partial results will be returned.

Returns:

  • (Integer) 


60
61
62
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 60

def query_timeout_in_seconds
  @query_timeout_in_seconds
end

#saved_search_id ⇒ String

Saved search OCID for this query if known.

Returns:

  • (String) 


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

def saved_search_id
  @saved_search_id
end

#scope_filters ⇒ Array<OCI::LogAnalytics::Models::ScopeFilter>

List of filters to be applied when the query executes. More than one filter per field is not permitted.

Returns:



56
57
58
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 56

def scope_filters
  @scope_filters
end

#should_include_columns ⇒ BOOLEAN

Include columns in response

Returns:

  • (BOOLEAN) 


77
78
79
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 77

def should_include_columns
  @should_include_columns
end

#should_include_fields ⇒ BOOLEAN

Include fields in response

Returns:

  • (BOOLEAN) 


81
82
83
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 81

def should_include_fields
  @should_include_fields
end

#should_include_total_count ⇒ BOOLEAN

Include the total number of results from the query. Note, this value will always be equal to or less than maxTotalCount.

Returns:

  • (BOOLEAN) 


73
74
75
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 73

def should_include_total_count
  @should_include_total_count
end

#should_run_async ⇒ BOOLEAN

Option to run the query asynchronously. This will lead to a LogAnalyticsQueryJobWorkRequest being submitted and the workRequestId will be returned to use for fetching the results.

Returns:

  • (BOOLEAN) 


65
66
67
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 65

def should_run_async
  @should_run_async
end

#should_use_acceleration ⇒ BOOLEAN

Controls if query should ignore pre-calculated results if available and only use raw data. If set and no acceleration data is found it will fallback to raw data.

Returns:

  • (BOOLEAN) 


86
87
88
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 86

def should_use_acceleration
  @should_use_acceleration
end

#sub_system ⇒ String

[Required] Default subsystem to qualify fields with in the queryString if not specified.

Returns:

  • (String) 


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

def sub_system
  @sub_system
end

#time_filter ⇒ OCI::LogAnalytics::Models::TimeRange

Returns:



51
52
53
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 51

def time_filter
  @time_filter
end

Class Method Details

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 89

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'compartment_id_in_subtree': :'compartmentIdInSubtree',
    'saved_search_id': :'savedSearchId',
    'query_string': :'queryString',
    'sub_system': :'subSystem',
    'max_total_count': :'maxTotalCount',
    'time_filter': :'timeFilter',
    'scope_filters': :'scopeFilters',
    'query_timeout_in_seconds': :'queryTimeoutInSeconds',
    'should_run_async': :'shouldRunAsync',
    'async_mode': :'asyncMode',
    'should_include_total_count': :'shouldIncludeTotalCount',
    'should_include_columns': :'shouldIncludeColumns',
    'should_include_fields': :'shouldIncludeFields',
    'should_use_acceleration': :'shouldUseAcceleration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'compartment_id_in_subtree': :'BOOLEAN',
    'saved_search_id': :'String',
    'query_string': :'String',
    'sub_system': :'String',
    'max_total_count': :'Integer',
    'time_filter': :'OCI::LogAnalytics::Models::TimeRange',
    'scope_filters': :'Array<OCI::LogAnalytics::Models::ScopeFilter>',
    'query_timeout_in_seconds': :'Integer',
    'should_run_async': :'BOOLEAN',
    'async_mode': :'String',
    'should_include_total_count': :'BOOLEAN',
    'should_include_columns': :'BOOLEAN',
    'should_include_fields': :'BOOLEAN',
    'should_use_acceleration': :'BOOLEAN'
    # 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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 293

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    compartment_id_in_subtree == other.compartment_id_in_subtree &&
    saved_search_id == other.saved_search_id &&
    query_string == other.query_string &&
    sub_system == other.sub_system &&
    max_total_count == other.max_total_count &&
    time_filter == other.time_filter &&
    scope_filters == other.scope_filters &&
    query_timeout_in_seconds == other.query_timeout_in_seconds &&
    should_run_async == other.should_run_async &&
    async_mode == other.async_mode &&
    should_include_total_count == other.should_include_total_count &&
    should_include_columns == other.should_include_columns &&
    should_include_fields == other.should_include_fields &&
    should_use_acceleration == other.should_use_acceleration
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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 337

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


317
318
319
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 317

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



326
327
328
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 326

def hash
  [compartment_id, compartment_id_in_subtree, saved_search_id, query_string, sub_system, max_total_count, time_filter, scope_filters, query_timeout_in_seconds, should_run_async, async_mode, should_include_total_count, should_include_columns, should_include_fields, should_use_acceleration].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



370
371
372
373
374
375
376
377
378
379
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 370

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



364
365
366
 
# File 'lib/oci/log_analytics/models/query_details.rb', line 364

def to_s
  to_hash.to_s
end