Class: OCI::Logging::Models::UnifiedAgentLoggingGrepFilter

Inherits:
UnifiedAgentLoggingFilter show all
Defined in:
lib/oci/logging/models/unified_agent_logging_grep_filter.rb

Overview

Logging grep filter object greps events by the values of specified fields. Ref: docs.fluentd.org/filter/grep

Constant Summary

Constants inherited from UnifiedAgentLoggingFilter

OCI::Logging::Models::UnifiedAgentLoggingFilter::FILTER_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from UnifiedAgentLoggingFilter

#filter_type, #name

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from UnifiedAgentLoggingFilter

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ UnifiedAgentLoggingGrepFilter

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/logging/models/unified_agent_logging_grep_filter.rb', line 55

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

  attributes['filterType'] = 'GREP_FILTER'

  super(attributes)

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

  self.allow_list = attributes[:'allowList'] if attributes[:'allowList']

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

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

  self.deny_list = attributes[:'denyList'] if attributes[:'denyList']

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

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

Instance Attribute Details

#allow_list ⇒ Array<OCI::Logging::Models::GrepFilterAllowRule>

A list of filtering rules to include logs

Returns:



16
17
18
 
# File 'lib/oci/logging/models/unified_agent_logging_grep_filter.rb', line 16

def allow_list
  @allow_list
end

#deny_list ⇒ Array<OCI::Logging::Models::GrepFilterDenyRule>

A list of filtering rules to reject logs

Returns:



20
21
22
 
# File 'lib/oci/logging/models/unified_agent_logging_grep_filter.rb', line 20

def deny_list
  @deny_list
end

Class Method Details

.attribute_map ⇒ Object

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



23
24
25
26
27
28
29
30
31
32
 
# File 'lib/oci/logging/models/unified_agent_logging_grep_filter.rb', line 23

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'filter_type': :'filterType',
    'allow_list': :'allowList',
    'deny_list': :'denyList'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/oci/logging/models/unified_agent_logging_grep_filter.rb', line 35

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'filter_type': :'String',
    'allow_list': :'Array<OCI::Logging::Models::GrepFilterAllowRule>',
    'deny_list': :'Array<OCI::Logging::Models::GrepFilterDenyRule>'
    # 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



85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/logging/models/unified_agent_logging_grep_filter.rb', line 85

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

  self.class == other.class &&
    name == other.name &&
    filter_type == other.filter_type &&
    allow_list == other.allow_list &&
    deny_list == other.deny_list
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



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/logging/models/unified_agent_logging_grep_filter.rb', line 118

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


98
99
100
 
# File 'lib/oci/logging/models/unified_agent_logging_grep_filter.rb', line 98

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



107
108
109
 
# File 'lib/oci/logging/models/unified_agent_logging_grep_filter.rb', line 107

def hash
  [name, filter_type, allow_list, deny_list].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/logging/models/unified_agent_logging_grep_filter.rb', line 151

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



145
146
147
 
# File 'lib/oci/logging/models/unified_agent_logging_grep_filter.rb', line 145

def to_s
  to_hash.to_s
end