class OCI::LogAnalytics::Models::ExportDetails

Input arguments for running a query synchronosly and streaming the results as soon as they become available.

Constants

OUTPUT_FORMAT_ENUM
SUB_SYSTEM_ENUM

Attributes

compartment_id[RW]

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

compartment_id_in_subtree[RW]

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

@return [BOOLEAN]

max_total_count[RW]

Maximum number of results retrieved from data source. Note a maximum value will be enforced; if the export results can be streamed, the maximum will be 50000000, otherwise 10000; that is, if not streamed, actualMaxTotalCountUsed = Math.min(maxTotalCount, 10000).

Export will incrementally stream results depending on the queryString.

Some commands including head/tail are not compatible with streaming result delivery and therefore enforce a reduced limit on overall maxtotalcount.

no sort command or sort by id, e.g. ' | sort id ' - is streaming compatible
sort by time and id, e.g. ' | sort -time, id ' - is streaming compatible

all other cases, e.g. ' | sort -time, id, mtgtguid ' - is not streaming compatible due to the additional sort field

@return [Integer]

output_format[R]

Specifies the format for the returned results. @return [String]

query_string[RW]

[Required] Query to perform. @return [String]

query_timeout_in_seconds[RW]

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. @return [Integer]

scope_filters[RW]

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

@return [Array<OCI::LogAnalytics::Models::ScopeFilter>]

should_include_columns[RW]

Include columns in response @return [BOOLEAN]

should_localize[RW]

Localize results, including header columns, List-Of-Values and timestamp values. @return [BOOLEAN]

should_use_acceleration[RW]

Controls if query should ignore pre-calculated results if available and only use raw data.

@return [BOOLEAN]

sub_system[R]

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

@return [String]

time_filter[RW]

@return [OCI::LogAnalytics::Models::TimeRange]

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [BOOLEAN] :compartment_id_in_subtree The value to assign to the {#compartment_id_in_subtree} property @option attributes [String] :query_string The value to assign to the {#query_string} property @option attributes [String] :sub_system The value to assign to the {#sub_system} property @option attributes [Array<OCI::LogAnalytics::Models::ScopeFilter>] :scope_filters The value to assign to the {#scope_filters} property @option attributes [Integer] :max_total_count The value to assign to the {#max_total_count} property @option attributes [OCI::LogAnalytics::Models::TimeRange] :time_filter The value to assign to the {#time_filter} property @option attributes [Integer] :query_timeout_in_seconds The value to assign to the {#query_timeout_in_seconds} property @option attributes [BOOLEAN] :should_include_columns The value to assign to the {#should_include_columns} property @option attributes [String] :output_format The value to assign to the {#output_format} property @option attributes [BOOLEAN] :should_localize The value to assign to the {#should_localize} property @option attributes [BOOLEAN] :should_use_acceleration The value to assign to the {#should_use_acceleration} property

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/log_analytics/models/export_details.rb, line 273
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# 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
output_format=(output_format) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] output_format Object to be assigned

# File lib/oci/log_analytics/models/export_details.rb, line 241
def output_format=(output_format)
  raise "Invalid value for 'output_format': this must be one of the values in OUTPUT_FORMAT_ENUM." if output_format && !OUTPUT_FORMAT_ENUM.include?(output_format)

  @output_format = output_format
end
sub_system=(sub_system) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] sub_system Object to be assigned

# File lib/oci/log_analytics/models/export_details.rb, line 233
def sub_system=(sub_system)
  raise "Invalid value for 'sub_system': this must be one of the values in SUB_SYSTEM_ENUM." if sub_system && !SUB_SYSTEM_ENUM.include?(sub_system)

  @sub_system = sub_system
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/log_analytics/models/export_details.rb, line 320
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/log_analytics/models/export_details.rb, line 343
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end