Interface ParseToOCSF.Builder

  • Method Details

    • source

      ParseToOCSF.Builder source(String source)

      The path to the field in the log event that you want to parse. If you omit this value, the whole log message is parsed.

      Parameters:
      source - The path to the field in the log event that you want to parse. If you omit this value, the whole log message is parsed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • eventSource

      ParseToOCSF.Builder eventSource(String eventSource)

      Specify the service or process that produces the log events that will be converted with this processor.

      Parameters:
      eventSource - Specify the service or process that produces the log events that will be converted with this processor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • eventSource

      ParseToOCSF.Builder eventSource(EventSource eventSource)

      Specify the service or process that produces the log events that will be converted with this processor.

      Parameters:
      eventSource - Specify the service or process that produces the log events that will be converted with this processor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • ocsfVersion

      ParseToOCSF.Builder ocsfVersion(String ocsfVersion)

      Specify which version of the OCSF schema to use for the transformed log events.

      Parameters:
      ocsfVersion - Specify which version of the OCSF schema to use for the transformed log events.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • ocsfVersion

      ParseToOCSF.Builder ocsfVersion(OCSFVersion ocsfVersion)

      Specify which version of the OCSF schema to use for the transformed log events.

      Parameters:
      ocsfVersion - Specify which version of the OCSF schema to use for the transformed log events.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • mappingVersion

      ParseToOCSF.Builder mappingVersion(String mappingVersion)

      Identifies the specific release of the Open Cybersecurity Schema Framework (OCSF) transformer being used to parse OCSF data. Defaults to the latest version if not specified. Does not automatically update.

      Parameters:
      mappingVersion - Identifies the specific release of the Open Cybersecurity Schema Framework (OCSF) transformer being used to parse OCSF data. Defaults to the latest version if not specified. Does not automatically update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.