Class: OCI::Logging::Models::GrokPattern

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/logging/models/grok_pattern.rb

Overview

Grok pattern object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GrokPattern

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :pattern (String) —

    The value to assign to the #pattern property

  • :name (String) —

    The value to assign to the #name property

  • :field_time_key (String) —

    The value to assign to the #field_time_key property

  • :field_time_format (String) —

    The value to assign to the #field_time_format property

  • :field_time_zone (String) —

    The value to assign to the #field_time_zone property



68
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
 
# File 'lib/oci/logging/models/grok_pattern.rb', line 68

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.pattern = attributes[:'pattern'] if attributes[:'pattern']

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

  self.field_time_key = attributes[:'fieldTimeKey'] if attributes[:'fieldTimeKey']

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

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

  self.field_time_format = attributes[:'fieldTimeFormat'] if attributes[:'fieldTimeFormat']

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

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

  self.field_time_zone = attributes[:'fieldTimeZone'] if attributes[:'fieldTimeZone']

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

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

Instance Attribute Details

#field_time_format ⇒ String

Process value using the specified format. This is available only when time_type is a string.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/logging/models/grok_pattern.rb', line 25

def field_time_format
  @field_time_format
end

#field_time_key ⇒ String

Specify the time field for the event time. If the event doesn't have this field, the current time is used.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/logging/models/grok_pattern.rb', line 21

def field_time_key
  @field_time_key
end

#field_time_zone ⇒ String

Use the specified time zone. The time value can be parsed or formatted in the specified time zone.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/logging/models/grok_pattern.rb', line 29

def field_time_zone
  @field_time_zone
end

#name ⇒ String

The name key to tag this Grok pattern.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/logging/models/grok_pattern.rb', line 17

def name
  @name
end

#pattern ⇒ String

[Required] The Grok pattern.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/logging/models/grok_pattern.rb', line 13

def pattern
  @pattern
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/logging/models/grok_pattern.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'pattern': :'pattern',
    'name': :'name',
    'field_time_key': :'fieldTimeKey',
    'field_time_format': :'fieldTimeFormat',
    'field_time_zone': :'fieldTimeZone'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/logging/models/grok_pattern.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'pattern': :'String',
    'name': :'String',
    'field_time_key': :'String',
    'field_time_format': :'String',
    'field_time_zone': :'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



104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/logging/models/grok_pattern.rb', line 104

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

  self.class == other.class &&
    pattern == other.pattern &&
    name == other.name &&
    field_time_key == other.field_time_key &&
    field_time_format == other.field_time_format &&
    field_time_zone == other.field_time_zone
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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/logging/models/grok_pattern.rb', line 138

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


118
119
120
 
# File 'lib/oci/logging/models/grok_pattern.rb', line 118

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



127
128
129
 
# File 'lib/oci/logging/models/grok_pattern.rb', line 127

def hash
  [pattern, name, field_time_key, field_time_format, field_time_zone].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/logging/models/grok_pattern.rb', line 171

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



165
166
167
 
# File 'lib/oci/logging/models/grok_pattern.rb', line 165

def to_s
  to_hash.to_s
end