Class CSVInput

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

Describes how an uncompressed comma-separated values (CSV)-formatted input object is formatted.

See Also:

  • Method Details

    • fileHeaderInfo

      public final FileHeaderInfo fileHeaderInfo()

      Describes the first line of input. Valid values are:

      • NONE: First line is not a header.

      • IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column ( SELECT s._1 FROM OBJECT s).

      • Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).

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

      Returns:
      Describes the first line of input. Valid values are:

      • NONE: First line is not a header.

      • IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column ( SELECT s._1 FROM OBJECT s).

      • Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).

      See Also:

    • fileHeaderInfoAsString

      public final String fileHeaderInfoAsString()

      Describes the first line of input. Valid values are:

      • NONE: First line is not a header.

      • IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column ( SELECT s._1 FROM OBJECT s).

      • Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).

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

      Returns:
      Describes the first line of input. Valid values are:

      • NONE: First line is not a header.

      • IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column ( SELECT s._1 FROM OBJECT s).

      • Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).

      See Also:

    • comments

      public final String comments()

      A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line. The default character is #.

      Default: #

      Returns:
      A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line. The default character is #.

      Default: #

    • quoteEscapeCharacter

      public final String quoteEscapeCharacter()

      A single character used for escaping the quotation mark character inside an already escaped value. For example, the value """ a , b """ is parsed as " a , b ".

      Returns:
      A single character used for escaping the quotation mark character inside an already escaped value. For example, the value """ a , b """ is parsed as " a , b ".

    • recordDelimiter

      public final String recordDelimiter()

      A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.

      Returns:
      A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.

    • fieldDelimiter

      public final String fieldDelimiter()

      A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.

      Returns:
      A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.

    • quoteCharacter

      public final String quoteCharacter()

      A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

      Type: String

      Default: "

      Ancestors: CSV

      Returns:
      A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

      Type: String

      Default: "

      Ancestors: CSV

    • allowQuotedRecordDelimiter

      public final Boolean allowQuotedRecordDelimiter()

      Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.

      Returns:
      Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.

    • toBuilder

      public CSVInput.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<CSVInput.Builder,CSVInput>
      Returns:
      a builder for type T

    • builder

      public static CSVInput.Builder builder()

    • serializableBuilderClass

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