Class: OCI::LogAnalytics::Models::SuggestOutput

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

Overview

Typeahead results

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SuggestOutput

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :position (Integer) —

    The value to assign to the #position property

  • :commands (Array<String>) —

    The value to assign to the #commands property

  • :fields (Array<String>) —

    The value to assign to the #fields property

  • :field_values (Array<String>) —

    The value to assign to the #field_values property

  • :terms (Array<String>) —

    The value to assign to the #terms property

  • :options (Array<String>) —

    The value to assign to the #options property

  • :examples (Array<String>) —

    The value to assign to the #examples property



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

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

Instance Attribute Details

#commands ⇒ Array<String>

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

Returns:

  • (Array<String>) 


20
21
22
 
# File 'lib/oci/log_analytics/models/suggest_output.rb', line 20

def commands
  @commands
end

#examples ⇒ Array<String>

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

Returns:

  • (Array<String>) 


45
46
47
 
# File 'lib/oci/log_analytics/models/suggest_output.rb', line 45

def examples
  @examples
end

#field_values ⇒ Array<String>

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

Returns:

  • (Array<String>) 


30
31
32
 
# File 'lib/oci/log_analytics/models/suggest_output.rb', line 30

def field_values
  @field_values
end

#fields ⇒ Array<String>

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

Returns:

  • (Array<String>) 


25
26
27
 
# File 'lib/oci/log_analytics/models/suggest_output.rb', line 25

def fields
  @fields
end

#options ⇒ Array<String>

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

Returns:

  • (Array<String>) 


40
41
42
 
# File 'lib/oci/log_analytics/models/suggest_output.rb', line 40

def options
  @options
end

#position ⇒ Integer

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

Returns:

  • (Integer) 


15
16
17
 
# File 'lib/oci/log_analytics/models/suggest_output.rb', line 15

def position
  @position
end

#terms ⇒ Array<String>

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

Returns:

  • (Array<String>) 


35
36
37
 
# File 'lib/oci/log_analytics/models/suggest_output.rb', line 35

def terms
  @terms
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/oci/log_analytics/models/suggest_output.rb', line 48

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

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/log_analytics/models/suggest_output.rb', line 63

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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/log_analytics/models/suggest_output.rb', line 122

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/log_analytics/models/suggest_output.rb', line 158

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


138
139
140
 
# File 'lib/oci/log_analytics/models/suggest_output.rb', line 138

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



147
148
149
 
# File 'lib/oci/log_analytics/models/suggest_output.rb', line 147

def hash
  [position, commands, fields, field_values, terms, options, examples].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/log_analytics/models/suggest_output.rb', line 191

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



185
186
187
 
# File 'lib/oci/log_analytics/models/suggest_output.rb', line 185

def to_s
  to_hash.to_s
end