Package software.amazon.awssdk.services.cloudwatchlogs.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CSV.Builder

Method Summary

Modifier and Type	Method	Description
static CSV.Builder	builder()
List<String>	columns()	An array of names to use for the columns in the transformed log event.
String	delimiter()	The character used to separate each column in the original comma-separated value log event.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasColumns()	For responses, this returns true if the service returned a value for the Columns property.
int	hashCode()
String	quoteCharacter()	The character used used as a text qualifier for a single column of data.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CSV.Builder>	serializableBuilderClass()
String	source()	The path to the field in the log event that has the comma separated values to be parsed.
CSV.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<CSV.Builder,CSV>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo