Class: OCI::Logging::Models::UnifiedAgentCustomFilter

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

Overview

Logging custom filter plugin.

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 = {}) ⇒ UnifiedAgentCustomFilter

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/logging/models/unified_agent_custom_filter.rb', line 60

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

  attributes['filterType'] = 'CUSTOM_FILTER'

  super(attributes)

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

  self.custom_filter_type = attributes[:'customFilterType'] if attributes[:'customFilterType']

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

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

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

  self.custom_sections = attributes[:'customSections'] if attributes[:'customSections']

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

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

Instance Attribute Details

#custom_filter_type ⇒ String

[Required] Type of the custom filter

Returns:

  • (String) 


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

def custom_filter_type
  @custom_filter_type
end

#custom_sections ⇒ Array<OCI::Logging::Models::UnifiedAgentCustomSection>

List of custom sections in custom filter

Returns:



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

def custom_sections
  @custom_sections
end

#params ⇒ Hash<String, String>

Parameters of the custom filter

Returns:

  • (Hash<String, String>) 


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

def params
  @params
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
 
# File 'lib/oci/logging/models/unified_agent_custom_filter.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'filter_type': :'filterType',
    'custom_filter_type': :'customFilterType',
    'params': :'params',
    'custom_sections': :'customSections'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/logging/models/unified_agent_custom_filter.rb', line 38

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'filter_type': :'String',
    'custom_filter_type': :'String',
    'params': :'Hash<String, String>',
    'custom_sections': :'Array<OCI::Logging::Models::UnifiedAgentCustomSection>'
    # 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



92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/logging/models/unified_agent_custom_filter.rb', line 92

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

  self.class == other.class &&
    name == other.name &&
    filter_type == other.filter_type &&
    custom_filter_type == other.custom_filter_type &&
    params == other.params &&
    custom_sections == other.custom_sections
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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/logging/models/unified_agent_custom_filter.rb', line 126

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


106
107
108
 
# File 'lib/oci/logging/models/unified_agent_custom_filter.rb', line 106

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



115
116
117
 
# File 'lib/oci/logging/models/unified_agent_custom_filter.rb', line 115

def hash
  [name, filter_type, custom_filter_type, params, custom_sections].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/logging/models/unified_agent_custom_filter.rb', line 159

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



153
154
155
 
# File 'lib/oci/logging/models/unified_agent_custom_filter.rb', line 153

def to_s
  to_hash.to_s
end