Class: OCI::Logging::Models::UnifiedJSONParser

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

Overview

JSON parser.

Constant Summary collapse

TIME_TYPE_ENUM =
[
  TIME_TYPE_FLOAT = 'FLOAT'.freeze,
  TIME_TYPE_UNIXTIME = 'UNIXTIME'.freeze,
  TIME_TYPE_STRING = 'STRING'.freeze,
  TIME_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :field_time_key (String)

    The value to assign to the #field_time_key proprety

  • :types (Hash<String, String>)

    The value to assign to the #types proprety

  • :null_value_pattern (String)

    The value to assign to the #null_value_pattern proprety

  • :is_null_empty_string (BOOLEAN)

    The value to assign to the #is_null_empty_string proprety

  • :is_estimate_current_event (BOOLEAN)

    The value to assign to the #is_estimate_current_event proprety

  • :is_keep_time_key (BOOLEAN)

    The value to assign to the #is_keep_time_key proprety

  • :timeout_in_milliseconds (Integer)

    The value to assign to the #timeout_in_milliseconds proprety

  • :time_type (String)

    The value to assign to the #time_type property

  • :time_format (String)

    The value to assign to the #time_format property

  • :parse_nested (BOOLEAN)

    The value to assign to the #parse_nested property

  • :separator (String)

    The value to assign to the #separator property

[View source]

93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/oci/logging/models/unified_json_parser.rb', line 93

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

  attributes['parserType'] = 'JSON'

  super(attributes)

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

  self.time_type = attributes[:'timeType'] if attributes[:'timeType']

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

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

  self.time_format = attributes[:'timeFormat'] if attributes[:'timeFormat']

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

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

  self.parse_nested = attributes[:'parseNested'] unless attributes[:'parseNested'].nil?
  self.parse_nested = false if parse_nested.nil? && !attributes.key?(:'parseNested') # rubocop:disable Style/StringLiterals

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

  self.parse_nested = attributes[:'parse_nested'] unless attributes[:'parse_nested'].nil?
  self.parse_nested = false if parse_nested.nil? && !attributes.key?(:'parseNested') && !attributes.key?(:'parse_nested') # rubocop:disable Style/StringLiterals

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

Instance Attribute Details

#parse_nestedBOOLEAN

If true, a separator parameter can be further defined.

Returns:

  • (BOOLEAN)

30
31
32
# File 'lib/oci/logging/models/unified_json_parser.rb', line 30

def parse_nested
  @parse_nested
end

#separatorString

Keys of adjacent levels are joined by the separator.

Returns:

  • (String)

34
35
36
# File 'lib/oci/logging/models/unified_json_parser.rb', line 34

def separator
  @separator
end

#time_formatString

Process time value using the specified format.

Returns:

  • (String)

26
27
28
# File 'lib/oci/logging/models/unified_json_parser.rb', line 26

def time_format
  @time_format
end

#time_typeString

JSON parser time type.

Returns:

  • (String)

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

def time_type
  @time_type
end

Class Method Details

.attribute_mapObject

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

[View source]

37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/oci/logging/models/unified_json_parser.rb', line 37

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',
    'time_type': :'timeType',
    'time_format': :'timeFormat',
    'parse_nested': :'parseNested',
    'separator': :'separator'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.

[View source]

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

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',
    'time_type': :'String',
    'time_format': :'String',
    'parse_nested': :'BOOLEAN',
    'separator': :'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]

146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/oci/logging/models/unified_json_parser.rb', line 146

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 &&
    time_type == other.time_type &&
    time_format == other.time_format &&
    parse_nested == other.parse_nested &&
    separator == other.separator
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]

187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/oci/logging/models/unified_json_parser.rb', line 187

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]

167
168
169
# File 'lib/oci/logging/models/unified_json_parser.rb', line 167

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code

[View source]

176
177
178
# File 'lib/oci/logging/models/unified_json_parser.rb', line 176

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, time_type, time_format, parse_nested, separator].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash

[View source]

220
221
222
223
224
225
226
227
228
229
# File 'lib/oci/logging/models/unified_json_parser.rb', line 220

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object

[View source]

214
215
216
# File 'lib/oci/logging/models/unified_json_parser.rb', line 214

def to_s
  to_hash.to_s
end