software.amazon.awssdk.services.lookoutmetrics.model

Class CsvFormatDescriptor

java.lang.Object

software.amazon.awssdk.services.lookoutmetrics.model.CsvFormatDescriptor

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CsvFormatDescriptor.Builder,CsvFormatDescriptor>

@Generated(value="software.amazon.awssdk:codegen")
public final class CsvFormatDescriptor
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CsvFormatDescriptor.Builder,CsvFormatDescriptor>

Contains information about how a source CSV data file should be analyzed.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CsvFormatDescriptor.Builder

Method Summary

Modifier and Type	Method and Description
static CsvFormatDescriptor.Builder	builder()
String	charset() The character set in which the source CSV file is written.
Boolean	containsHeader() Whether or not the source CSV file contains a header.
String	delimiter() The character used to delimit the source CSV file.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
CSVFileCompression	fileCompression() The level of compression of the source CSV file.
String	fileCompressionAsString() The level of compression of the source CSV file.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasHeaderList() For responses, this returns true if the service returned a value for the HeaderList property.
List<String>	headerList() A list of the source CSV file's headers, if any.
String	quoteSymbol() The character used as a quote character.
List<SdkField<?>>	sdkFields()
static Class<? extends CsvFormatDescriptor.Builder>	serializableBuilderClass()
CsvFormatDescriptor.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

fileCompression

public final CSVFileCompression fileCompression()

The level of compression of the source CSV file.

If the service returns an enum value that is not available in the current SDK version, fileCompression will return CSVFileCompression.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileCompressionAsString().

Returns:

The level of compression of the source CSV file.

See Also:

CSVFileCompression

fileCompressionAsString

public final String fileCompressionAsString()

The level of compression of the source CSV file.

If the service returns an enum value that is not available in the current SDK version, fileCompression will return CSVFileCompression.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileCompressionAsString().

Returns:

The level of compression of the source CSV file.

See Also:

CSVFileCompression

charset

public final String charset()

The character set in which the source CSV file is written.

Returns:

The character set in which the source CSV file is written.

containsHeader

public final Boolean containsHeader()

Whether or not the source CSV file contains a header.

Returns:

Whether or not the source CSV file contains a header.

delimiter

public final String delimiter()

The character used to delimit the source CSV file.

Returns:

The character used to delimit the source CSV file.

hasHeaderList

public final boolean hasHeaderList()

For responses, this returns true if the service returned a value for the HeaderList 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.

headerList

public final List<String> headerList()

A list of the source CSV file's headers, if any.

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 hasHeaderList() method.

Returns:

A list of the source CSV file's headers, if any.

quoteSymbol

public final String quoteSymbol()

The character used as a quote character.

Returns:

The character used as a quote character.

toBuilder

public CsvFormatDescriptor.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CsvFormatDescriptor.Builder,CsvFormatDescriptor>

builder

public static CsvFormatDescriptor.Builder builder()

serializableBuilderClass

public static Class<? extends CsvFormatDescriptor.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