Class S3OutputFormatConfig

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

The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.

See Also:

  • Method Details

    • fileType

      public final FileType fileType()

      Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.

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

      Returns:
      Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.
      See Also:

    • fileTypeAsString

      public final String fileTypeAsString()

      Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.

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

      Returns:
      Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.
      See Also:

    • prefixConfig

      public final PrefixConfig prefixConfig()

      Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name folders according to the flow frequency and date.

      Returns:
      Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name folders according to the flow frequency and date.

    • aggregationConfig

      public final AggregationConfig aggregationConfig()
      Returns the value of the AggregationConfig property for this object.
      Returns:
      The value of the AggregationConfig property for this object.

    • preserveSourceDataTyping

      public final Boolean preserveSourceDataTyping()

      If your file output format is Parquet, use this parameter to set whether Amazon AppFlow preserves the data types in your source data when it writes the output to Amazon S3.

      • true: Amazon AppFlow preserves the data types when it writes to Amazon S3. For example, an integer or 1 in your source data is still an integer in your output.

      • false: Amazon AppFlow converts all of the source data into strings when it writes to Amazon S3. For example, an integer of 1 in your source data becomes the string "1" in the output.

      Returns:
      If your file output format is Parquet, use this parameter to set whether Amazon AppFlow preserves the data types in your source data when it writes the output to Amazon S3.

      • true: Amazon AppFlow preserves the data types when it writes to Amazon S3. For example, an integer or 1 in your source data is still an integer in your output.

      • false: Amazon AppFlow converts all of the source data into strings when it writes to Amazon S3. For example, an integer of 1 in your source data becomes the string "1" in the output.

    • toBuilder

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

    • builder

      public static S3OutputFormatConfig.Builder builder()

    • serializableBuilderClass

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