Class CSV

java.lang.Object
software.amazon.awssdk.services.cloudwatchlogs.model.CSV
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CSV.Builder,CSV>
@Generated("software.amazon.awssdk:codegen") public final class CSV extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CSV.Builder,CSV>

The CSV processor parses comma-separated values (CSV) from the log events into columns.

For more information about this processor including examples, see csv in the CloudWatch Logs User Guide.

See Also:

  • Method Details

    • quoteCharacter

      public final String quoteCharacter()

      The character used used as a text qualifier for a single column of data. If you omit this, the double quotation mark " character is used.

      Returns:
      The character used used as a text qualifier for a single column of data. If you omit this, the double quotation mark " character is used.

    • delimiter

      public final String delimiter()

      The character used to separate each column in the original comma-separated value log event. If you omit this, the processor looks for the comma , character as the delimiter.

      Returns:
      The character used to separate each column in the original comma-separated value log event. If you omit this, the processor looks for the comma , character as the delimiter.

    • hasColumns

      public final boolean hasColumns()
      For responses, this returns true if the service returned a value for the Columns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • columns

      public final List<String> columns()

      An array of names to use for the columns in the transformed log event.

      If you omit this, default column names ([column_1, column_2 ...]) are used.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasColumns() method.

      Returns:
      An array of names to use for the columns in the transformed log event.

      If you omit this, default column names ([column_1, column_2 ...]) are used.

    • source

      public final String source()

      The path to the field in the log event that has the comma separated values to be parsed. If you omit this value, the whole log message is processed.

      Returns:
      The path to the field in the log event that has the comma separated values to be parsed. If you omit this value, the whole log message is processed.

    • toBuilder

      public CSV.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CSV.Builder,CSV>
      Returns:
      a builder for type T

    • builder

      public static CSV.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CSV.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.