Package software.amazon.awssdk.services.s3.model

Class CSVOutput

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

Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.

See Also:

  • Method Details

    • quoteFields

      public final QuoteFields quoteFields()

      Indicates whether to use quotation marks around output fields.

      • ALWAYS: Always use quotation marks for output fields.

      • ASNEEDED: Use quotation marks for output fields when needed.

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

      Returns:
      Indicates whether to use quotation marks around output fields.

      • ALWAYS: Always use quotation marks for output fields.

      • ASNEEDED: Use quotation marks for output fields when needed.

      See Also:

    • quoteFieldsAsString

      public final String quoteFieldsAsString()

      Indicates whether to use quotation marks around output fields.

      • ALWAYS: Always use quotation marks for output fields.

      • ASNEEDED: Use quotation marks for output fields when needed.

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

      Returns:
      Indicates whether to use quotation marks around output fields.

      • ALWAYS: Always use quotation marks for output fields.

      • ASNEEDED: Use quotation marks for output fields when needed.

      See Also:

    • quoteEscapeCharacter

      public final String quoteEscapeCharacter()

      The single character used for escaping the quote character inside an already escaped value.

      Returns:
      The single character used for escaping the quote character inside an already escaped value.

    • recordDelimiter

      public final String recordDelimiter()

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

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

    • fieldDelimiter

      public final String fieldDelimiter()

      The value used to separate individual fields in a record. You can specify an arbitrary delimiter.

      Returns:
      The value 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 ".

      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 ".

    • toBuilder

      public CSVOutput.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CSVOutput.Builder,CSVOutput>

    • builder

      public static CSVOutput.Builder builder()

    • serializableBuilderClass

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