class OCI::LogAnalytics::Models::SuggestOutput

Typeahead results

Attributes

commands[RW]

Context specific list of querylanguage commands if input is seeking command suggestions.

@return [Array<String>]

examples[RW]

Context specific list of querylanguage querystring examples if input is seeking queryString example suggestions.

@return [Array<String>]

field_values[RW]

Context specific list of field values if input is seeking field value suggestions.

@return [Array<String>]

fields[RW]

Context specific list of querylanguage fields / columns if input is seeking field / column suggestions.

@return [Array<String>]

options[RW]

Context specific list of querylanguage command options if input is seeking command option suggestions.

@return [Array<String>]

position[RW]

[Required] Character position suggestion should be placed in queryString provided as input.

@return [Integer]

terms[RW]

Context specific list of terms / phrases if input is seeking terms / phrase suggestions.

@return [Array<String>]

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/suggest_output.rb, line 47
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'position': :'position',
    'commands': :'commands',
    'fields': :'fields',
    'field_values': :'fieldValues',
    'terms': :'terms',
    'options': :'options',
    'examples': :'examples'
    # 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 [Integer] :position The value to assign to the {#position} property @option attributes [Array<String>] :commands The value to assign to the {#commands} property @option attributes [Array<String>] :fields The value to assign to the {#fields} property @option attributes [Array<String>] :field_values The value to assign to the {#field_values} property @option attributes [Array<String>] :terms The value to assign to the {#terms} property @option attributes [Array<String>] :options The value to assign to the {#options} property @option attributes [Array<String>] :examples The value to assign to the {#examples} property

# File lib/oci/log_analytics/models/suggest_output.rb, line 89
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.position = attributes[:'position'] if attributes[:'position']

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

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

  self.field_values = attributes[:'fieldValues'] if attributes[:'fieldValues']

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

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

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

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

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

Attribute type mapping.

# File lib/oci/log_analytics/models/suggest_output.rb, line 62
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'position': :'Integer',
    'commands': :'Array<String>',
    'fields': :'Array<String>',
    'field_values': :'Array<String>',
    'terms': :'Array<String>',
    'options': :'Array<String>',
    'examples': :'Array<String>'
    # 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/suggest_output.rb, line 121
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    position == other.position &&
    commands == other.commands &&
    fields == other.fields &&
    field_values == other.field_values &&
    terms == other.terms &&
    options == other.options &&
    examples == other.examples
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/suggest_output.rb, line 157
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/suggest_output.rb, line 137
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/suggest_output.rb, line 146
def hash
  [position, commands, fields, field_values, terms, options, examples].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/suggest_output.rb, line 190
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/suggest_output.rb, line 184
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/suggest_output.rb, line 207
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