Class: OCI::LogAnalytics::Models::SuggestDetails

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

Overview

Typeahead input.

Constant Summary collapse

SUB_SYSTEM_ENUM = 
[
  SUB_SYSTEM_LOG = 'LOG'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SuggestDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :compartment_id_in_subtree (BOOLEAN) —

    The value to assign to the #compartment_id_in_subtree property

  • :query_string (String) —

    The value to assign to the #query_string property

  • :sub_system (String) —

    The value to assign to the #sub_system property

[View source]

69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/log_analytics/models/suggest_details.rb', line 69

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']
end

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 

18
19
20
 
# File 'lib/oci/log_analytics/models/suggest_details.rb', line 18

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.

Returns:

  • (BOOLEAN) 

23
24
25
 
# File 'lib/oci/log_analytics/models/suggest_details.rb', line 23

def compartment_id_in_subtree
  @compartment_id_in_subtree
end

#query_string ⇒ String

[Required] Query seeking suggestions for.

Returns:

  • (String) 

28
29
30
 
# File 'lib/oci/log_analytics/models/suggest_details.rb', line 28

def query_string
  @query_string
end

#sub_system ⇒ String

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

Returns:

  • (String) 

33
34
35
 
# File 'lib/oci/log_analytics/models/suggest_details.rb', line 33

def sub_system
  @sub_system
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

36
37
38
39
40
41
42
43
44
45
 
# File 'lib/oci/log_analytics/models/suggest_details.rb', line 36

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'compartment_id_in_subtree': :'compartmentIdInSubtree',
    'query_string': :'queryString',
    'sub_system': :'subSystem'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'compartment_id_in_subtree': :'BOOLEAN',
    'query_string': :'String',
    'sub_system': :'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

[View source]

117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/log_analytics/models/suggest_details.rb', line 117

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
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

[View source]

150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oci/log_analytics/models/suggest_details.rb', line 150

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
[View source]

130
131
132
 
# File 'lib/oci/log_analytics/models/suggest_details.rb', line 130

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

139
140
141
 
# File 'lib/oci/log_analytics/models/suggest_details.rb', line 139

def hash
  [compartment_id, compartment_id_in_subtree, query_string, sub_system].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

183
184
185
186
187
188
189
190
191
192
 
# File 'lib/oci/log_analytics/models/suggest_details.rb', line 183

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

[View source]

177
178
179
 
# File 'lib/oci/log_analytics/models/suggest_details.rb', line 177

def to_s
  to_hash.to_s
end