Class: OCI::Logging::Models::UnifiedAgentGrokParser

Inherits:
UnifiedAgentParser show all
Defined in:
lib/oci/logging/models/unified_agent_grok_parser.rb

Overview

Grok parser.

Constant Summary

Constants inherited from UnifiedAgentParser

OCI::Logging::Models::UnifiedAgentParser::PARSER_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from UnifiedAgentParser

#field_time_key, #is_estimate_current_event, #is_keep_time_key, #is_null_empty_string, #null_value_pattern, #parser_type, #timeout_in_milliseconds, #types

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from UnifiedAgentParser

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ UnifiedAgentGrokParser

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/logging/models/unified_agent_grok_parser.rb', line 78

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['parserType'] = 'GROK'

  super(attributes)

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

  self.grok_name_key = attributes[:'grokNameKey'] if attributes[:'grokNameKey']

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

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

  self.grok_failure_key = attributes[:'grokFailureKey'] if attributes[:'grokFailureKey']

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

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

  self.patterns = attributes[:'patterns'] if attributes[:'patterns']
end

Instance Attribute Details

#grok_failure_key ⇒ String

Grok failure key.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/logging/models/unified_agent_grok_parser.rb', line 18

def grok_failure_key
  @grok_failure_key
end

#grok_name_key ⇒ String

Grok name key.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/logging/models/unified_agent_grok_parser.rb', line 14

def grok_name_key
  @grok_name_key
end

#patterns ⇒ Array<OCI::Logging::Models::GrokPattern>

[Required] Grok pattern object.

Returns:



22
23
24
 
# File 'lib/oci/logging/models/unified_agent_grok_parser.rb', line 22

def patterns
  @patterns
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/oci/logging/models/unified_agent_grok_parser.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'parser_type': :'parserType',
    'field_time_key': :'fieldTimeKey',
    'types': :'types',
    'null_value_pattern': :'nullValuePattern',
    'is_null_empty_string': :'isNullEmptyString',
    'is_estimate_current_event': :'isEstimateCurrentEvent',
    'is_keep_time_key': :'isKeepTimeKey',
    'timeout_in_milliseconds': :'timeoutInMilliseconds',
    'grok_name_key': :'grokNameKey',
    'grok_failure_key': :'grokFailureKey',
    'patterns': :'patterns'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/oci/logging/models/unified_agent_grok_parser.rb', line 44

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'parser_type': :'String',
    'field_time_key': :'String',
    'types': :'Hash<String, String>',
    'null_value_pattern': :'String',
    'is_null_empty_string': :'BOOLEAN',
    'is_estimate_current_event': :'BOOLEAN',
    'is_keep_time_key': :'BOOLEAN',
    'timeout_in_milliseconds': :'Integer',
    'grok_name_key': :'String',
    'grok_failure_key': :'String',
    'patterns': :'Array<OCI::Logging::Models::GrokPattern>'
    # 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



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/logging/models/unified_agent_grok_parser.rb', line 110

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    parser_type == other.parser_type &&
    field_time_key == other.field_time_key &&
    types == other.types &&
    null_value_pattern == other.null_value_pattern &&
    is_null_empty_string == other.is_null_empty_string &&
    is_estimate_current_event == other.is_estimate_current_event &&
    is_keep_time_key == other.is_keep_time_key &&
    timeout_in_milliseconds == other.timeout_in_milliseconds &&
    grok_name_key == other.grok_name_key &&
    grok_failure_key == other.grok_failure_key &&
    patterns == other.patterns
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



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/logging/models/unified_agent_grok_parser.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


130
131
132
 
# File 'lib/oci/logging/models/unified_agent_grok_parser.rb', line 130

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



139
140
141
 
# File 'lib/oci/logging/models/unified_agent_grok_parser.rb', line 139

def hash
  [parser_type, field_time_key, types, null_value_pattern, is_null_empty_string, is_estimate_current_event, is_keep_time_key, timeout_in_milliseconds, grok_name_key, grok_failure_key, patterns].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



183
184
185
186
187
188
189
190
191
192
 
# File 'lib/oci/logging/models/unified_agent_grok_parser.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



177
178
179
 
# File 'lib/oci/logging/models/unified_agent_grok_parser.rb', line 177

def to_s
  to_hash.to_s
end