class OCI::LogAnalytics::Models::ClassifyCommandDescriptor

Command descriptor for querylanguage CLASSIFY command.

Attributes

bottom_count[RW]

Value specified in CLASSIFY command in queryString if set limits the results returned to bottom N.

@return [Integer]

correlate[RW]

Fields specified in CLASSIFY command in queryString if set include / exclude fields in correlate results.

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

top_count[RW]

Value specified in CLASSIFY command in queryString if set limits the results returned to top N.

@return [Integer]

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/classify_command_descriptor.rb, line 28
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'display_query_string': :'displayQueryString',
    'internal_query_string': :'internalQueryString',
    'category': :'category',
    'referenced_fields': :'referencedFields',
    'declared_fields': :'declaredFields',
    'top_count': :'topCount',
    'bottom_count': :'bottomCount',
    'correlate': :'correlate'
    # 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] :display_query_string The value to assign to the {OCI::LogAnalytics::Models::AbstractCommandDescriptor#display_query_string display_query_string} proprety @option attributes [String] :internal_query_string The value to assign to the {OCI::LogAnalytics::Models::AbstractCommandDescriptor#internal_query_string internal_query_string} proprety @option attributes [String] :category The value to assign to the {OCI::LogAnalytics::Models::AbstractCommandDescriptor#category category} proprety @option attributes [Array<OCI::LogAnalytics::Models::AbstractField>] :referenced_fields The value to assign to the {OCI::LogAnalytics::Models::AbstractCommandDescriptor#referenced_fields referenced_fields} proprety @option attributes [Array<OCI::LogAnalytics::Models::AbstractField>] :declared_fields The value to assign to the {OCI::LogAnalytics::Models::AbstractCommandDescriptor#declared_fields declared_fields} proprety @option attributes [Integer] :top_count The value to assign to the {#top_count} property @option attributes [Integer] :bottom_count The value to assign to the {#bottom_count} property @option attributes [Array<OCI::LogAnalytics::Models::FieldsAddRemoveField>] :correlate The value to assign to the {#correlate} property

# File lib/oci/log_analytics/models/classify_command_descriptor.rb, line 75
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['name'] = 'CLASSIFY'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.top_count = attributes[:'topCount'] if attributes[:'topCount']

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

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

  self.bottom_count = attributes[:'bottomCount'] if attributes[:'bottomCount']

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

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

  self.correlate = attributes[:'correlate'] if attributes[:'correlate']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/log_analytics/models/classify_command_descriptor.rb, line 45
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'display_query_string': :'String',
    'internal_query_string': :'String',
    'category': :'String',
    'referenced_fields': :'Array<OCI::LogAnalytics::Models::AbstractField>',
    'declared_fields': :'Array<OCI::LogAnalytics::Models::AbstractField>',
    'top_count': :'Integer',
    'bottom_count': :'Integer',
    'correlate': :'Array<OCI::LogAnalytics::Models::FieldsAddRemoveField>'
    # 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/classify_command_descriptor.rb, line 107
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    display_query_string == other.display_query_string &&
    internal_query_string == other.internal_query_string &&
    category == other.category &&
    referenced_fields == other.referenced_fields &&
    declared_fields == other.declared_fields &&
    top_count == other.top_count &&
    bottom_count == other.bottom_count &&
    correlate == other.correlate
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/classify_command_descriptor.rb, line 145
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/classify_command_descriptor.rb, line 125
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/classify_command_descriptor.rb, line 134
def hash
  [name, display_query_string, internal_query_string, category, referenced_fields, declared_fields, top_count, bottom_count, correlate].hash
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/classify_command_descriptor.rb, line 178
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/classify_command_descriptor.rb, line 172
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/classify_command_descriptor.rb, line 195
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