Class: OCI::LogAnalytics::Models::ExportDetails
- Inherits:
-
Object
- Object
- OCI::LogAnalytics::Models::ExportDetails
- Defined in:
- lib/oci/log_analytics/models/export_details.rb
Overview
Input arguments for running a query synchronosly and streaming the results as soon as they become available.
Constant Summary collapse
- SUB_SYSTEM_ENUM =
[ SUB_SYSTEM_LOG = 'LOG'.freeze ].freeze
- OUTPUT_FORMAT_ENUM =
[ OUTPUT_FORMAT_CSV = 'CSV'.freeze, OUTPUT_FORMAT_JSON = 'JSON'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] Compartment Identifier [OCID] (docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
-
#compartment_id_in_subtree ⇒ BOOLEAN
Flag to search all child compartments of the compartment Id specified in the compartmentId query parameter.
-
#max_total_count ⇒ Integer
Maximum number of results retrieved from data source is determined by the specific query used and the maxTotalCount input field.
-
#output_format ⇒ String
Specifies the format for the returned results.
-
#query_string ⇒ String
[Required] Query to perform.
-
#query_timeout_in_seconds ⇒ Integer
Amount of time, in seconds, allowed for a query to execute.
-
#scope_filters ⇒ Array<OCI::LogAnalytics::Models::ScopeFilter>
List of filters to be applied when the query executes.
-
#should_include_columns ⇒ BOOLEAN
Include columns in response.
-
#should_localize ⇒ BOOLEAN
Localize results, including header columns, List-Of-Values and timestamp values.
-
#should_use_acceleration ⇒ BOOLEAN
Controls if query should ignore pre-calculated results if available and only use raw data.
-
#sub_system ⇒ String
[Required] Default subsystem to qualify fields with in the queryString if not specified.
- #time_filter ⇒ OCI::LogAnalytics::Models::TimeRange
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ ExportDetails
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ ExportDetails
Initializes the object
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 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 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 138 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.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.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.max_total_count = attributes[:'maxTotalCount'] if attributes[:'maxTotalCount'] 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.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.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_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.output_format = attributes[:'outputFormat'] if attributes[:'outputFormat'] self.output_format = "CSV" if output_format.nil? && !attributes.key?(:'outputFormat') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :outputFormat and :output_format' if attributes.key?(:'outputFormat') && attributes.key?(:'output_format') self.output_format = attributes[:'output_format'] if attributes[:'output_format'] self.output_format = "CSV" if output_format.nil? && !attributes.key?(:'outputFormat') && !attributes.key?(:'output_format') # rubocop:disable Style/StringLiterals self.should_localize = attributes[:'shouldLocalize'] unless attributes[:'shouldLocalize'].nil? self.should_localize = true if should_localize.nil? && !attributes.key?(:'shouldLocalize') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :shouldLocalize and :should_localize' if attributes.key?(:'shouldLocalize') && attributes.key?(:'should_localize') self.should_localize = attributes[:'should_localize'] unless attributes[:'should_localize'].nil? self.should_localize = true if should_localize.nil? && !attributes.key?(:'shouldLocalize') && !attributes.key?(:'should_localize') # 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
#compartment_id ⇒ String
[Required] Compartment Identifier [OCID] (docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
23 24 25 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 23 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.
28 29 30 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 28 def compartment_id_in_subtree @compartment_id_in_subtree end |
#max_total_count ⇒ Integer
Maximum number of results retrieved from data source is determined by the specific query used and the maxTotalCount input field. If the export results can be streamed, the maximum will be 1,000,000. If the results cannot be streamed, the maximum limit is 500 for queries that include the link command and 10,000 for the queries that do not include the link command.
Queries that include certain commands such as head, tail or stats cannot be streamed and are subject to a maximum of 10,000 results. Queries that include the sort command cannot be streamed unless the sort fields are restricted to id and/or time. The maximum number of results retrieved is the lesser of the maxTotalCount input provided and the applicable limit described above.
54 55 56 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 54 def max_total_count @max_total_count end |
#output_format ⇒ String
Specifies the format for the returned results.
69 70 71 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 69 def output_format @output_format end |
#query_string ⇒ String
[Required] Query to perform.
32 33 34 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 32 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.
61 62 63 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 61 def query_timeout_in_seconds @query_timeout_in_seconds 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.
42 43 44 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 42 def scope_filters @scope_filters end |
#should_include_columns ⇒ BOOLEAN
Include columns in response
65 66 67 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 65 def should_include_columns @should_include_columns end |
#should_localize ⇒ BOOLEAN
Localize results, including header columns, List-Of-Values and timestamp values.
73 74 75 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 73 def should_localize @should_localize end |
#should_use_acceleration ⇒ BOOLEAN
Controls if query should ignore pre-calculated results if available and only use raw data.
78 79 80 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 78 def should_use_acceleration @should_use_acceleration end |
#sub_system ⇒ String
[Required] Default subsystem to qualify fields with in the queryString if not specified.
37 38 39 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 37 def sub_system @sub_system end |
#time_filter ⇒ OCI::LogAnalytics::Models::TimeRange
57 58 59 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 57 def time_filter @time_filter end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 81 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'compartment_id_in_subtree': :'compartmentIdInSubtree', 'query_string': :'queryString', 'sub_system': :'subSystem', 'scope_filters': :'scopeFilters', 'max_total_count': :'maxTotalCount', 'time_filter': :'timeFilter', 'query_timeout_in_seconds': :'queryTimeoutInSeconds', 'should_include_columns': :'shouldIncludeColumns', 'output_format': :'outputFormat', 'should_localize': :'shouldLocalize', 'should_use_acceleration': :'shouldUseAcceleration' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 101 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'String', 'compartment_id_in_subtree': :'BOOLEAN', 'query_string': :'String', 'sub_system': :'String', 'scope_filters': :'Array<OCI::LogAnalytics::Models::ScopeFilter>', 'max_total_count': :'Integer', 'time_filter': :'OCI::LogAnalytics::Models::TimeRange', 'query_timeout_in_seconds': :'Integer', 'should_include_columns': :'BOOLEAN', 'output_format': :'String', 'should_localize': :'BOOLEAN', 'should_use_acceleration': :'BOOLEAN' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 252 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 && query_string == other.query_string && sub_system == other.sub_system && scope_filters == other.scope_filters && max_total_count == other.max_total_count && time_filter == other.time_filter && query_timeout_in_seconds == other.query_timeout_in_seconds && should_include_columns == other.should_include_columns && output_format == other.output_format && should_localize == other.should_localize && should_use_acceleration == other.should_use_acceleration end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 293 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
273 274 275 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 273 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
282 283 284 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 282 def hash [compartment_id, compartment_id_in_subtree, query_string, sub_system, scope_filters, max_total_count, time_filter, query_timeout_in_seconds, should_include_columns, output_format, should_localize, should_use_acceleration].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
326 327 328 329 330 331 332 333 334 335 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 326 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
320 321 322 |
# File 'lib/oci/log_analytics/models/export_details.rb', line 320 def to_s to_hash.to_s end |