class OCI::Logging::Models::UnifiedAgentParser

source parser object. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constants

PARSER_TYPE_ENUM

Attributes

field_time_key[RW]

Specify time field for the event time. If the event doesn't have this field, the current time is used. @return [String]

is_estimate_current_event[RW]

If true, use Fluent::EventTime.now(current time) as a timestamp when time_key is specified. @return [BOOLEAN]

is_keep_time_key[RW]

If true, keep time field in the record. @return [BOOLEAN]

is_null_empty_string[RW]

If true, an empty string field is replaced with nil. @return [BOOLEAN]

null_value_pattern[RW]

Specify the null value pattern. @return [String]

parser_type[R]

[Required] Type of fluent parser. @return [String]

timeout_in_milliseconds[RW]

Specify the timeout for parse processing. This is mainly for detecting an incorrect regexp pattern. @return [Integer]

types[RW]

Specify types for converting a field into another type. @return [Hash<String, String>]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/logging/models/unified_agent_parser.rb, line 62
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'
    # rubocop:enable Style/SymbolLiteral
  }
end
get_subtype(object_hash) click to toggle source

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

# File lib/oci/logging/models/unified_agent_parser.rb, line 98
def self.get_subtype(object_hash)
  type = object_hash[:'parserType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Logging::Models::UnifiedAgentMultilineGrokParser' if type == 'MULTILINE_GROK'
  return 'OCI::Logging::Models::UnifiedJSONParser' if type == 'JSON'
  return 'OCI::Logging::Models::UnifiedAgentGrokParser' if type == 'GROK'
  return 'OCI::Logging::Models::UnifiedAgentNoneParser' if type == 'NONE'
  return 'OCI::Logging::Models::UnifiedAgentSyslogParser' if type == 'SYSLOG'
  return 'OCI::Logging::Models::UnifiedAgentAuditdParser' if type == 'AUDITD'
  return 'OCI::Logging::Models::UnifiedAgentApache2Parser' if type == 'APACHE2'
  return 'OCI::Logging::Models::UnifiedAgentRegexParser' if type == 'REGEXP'
  return 'OCI::Logging::Models::UnifiedAgentMultilineParser' if type == 'MULTILINE'
  return 'OCI::Logging::Models::UnifiedAgentTsvParser' if type == 'TSV'
  return 'OCI::Logging::Models::UnifiedAgentApacheErrorParser' if type == 'APACHE_ERROR'
  return 'OCI::Logging::Models::UnifiedAgentMsgpackParser' if type == 'MSGPACK'
  return 'OCI::Logging::Models::UnifiedAgentCsvParser' if type == 'CSV'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Logging::Models::UnifiedAgentParser'
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :parser_type The value to assign to the {#parser_type} property @option attributes [String] :field_time_key The value to assign to the {#field_time_key} property @option attributes [Hash<String, String>] :types The value to assign to the {#types} property @option attributes [String] :null_value_pattern The value to assign to the {#null_value_pattern} property @option attributes [BOOLEAN] :is_null_empty_string The value to assign to the {#is_null_empty_string} property @option attributes [BOOLEAN] :is_estimate_current_event The value to assign to the {#is_estimate_current_event} property @option attributes [BOOLEAN] :is_keep_time_key The value to assign to the {#is_keep_time_key} property @option attributes [Integer] :timeout_in_milliseconds The value to assign to the {#timeout_in_milliseconds} property

# File lib/oci/logging/models/unified_agent_parser.rb, line 134
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.parser_type = attributes[:'parserType'] if attributes[:'parserType']

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

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

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

  self.null_value_pattern = attributes[:'nullValuePattern'] if attributes[:'nullValuePattern']

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

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

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

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

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

  self.is_estimate_current_event = attributes[:'isEstimateCurrentEvent'] unless attributes[:'isEstimateCurrentEvent'].nil?
  self.is_estimate_current_event = true if is_estimate_current_event.nil? && !attributes.key?(:'isEstimateCurrentEvent') # rubocop:disable Style/StringLiterals

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

  self.is_estimate_current_event = attributes[:'is_estimate_current_event'] unless attributes[:'is_estimate_current_event'].nil?
  self.is_estimate_current_event = true if is_estimate_current_event.nil? && !attributes.key?(:'isEstimateCurrentEvent') && !attributes.key?(:'is_estimate_current_event') # rubocop:disable Style/StringLiterals

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

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

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

  self.timeout_in_milliseconds = attributes[:'timeoutInMilliseconds'] if attributes[:'timeoutInMilliseconds']

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

  self.timeout_in_milliseconds = attributes[:'timeout_in_milliseconds'] if attributes[:'timeout_in_milliseconds']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/logging/models/unified_agent_parser.rb, line 78
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'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/logging/models/unified_agent_parser.rb, line 211
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
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/logging/models/unified_agent_parser.rb, line 248
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/logging/models/unified_agent_parser.rb, line 228
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/logging/models/unified_agent_parser.rb, line 237
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].hash
end
parser_type=(parser_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] parser_type Object to be assigned

# File lib/oci/logging/models/unified_agent_parser.rb, line 195
def parser_type=(parser_type)
  # rubocop:disable Style/ConditionalAssignment
  if parser_type && !PARSER_TYPE_ENUM.include?(parser_type)
    OCI.logger.debug("Unknown value for 'parser_type' [" + parser_type + "]. Mapping to 'PARSER_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @parser_type = PARSER_TYPE_UNKNOWN_ENUM_VALUE
  else
    @parser_type = parser_type
  end
  # rubocop:enable Style/ConditionalAssignment
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/logging/models/unified_agent_parser.rb, line 281
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/logging/models/unified_agent_parser.rb, line 275
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/logging/models/unified_agent_parser.rb, line 298
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end