Package 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("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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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<CsvFormatDescriptor.Builder,CsvFormatDescriptor>
      Returns:
      a builder for type T

    • 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)
      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.