Class ExtendedS3DestinationDescription

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

Describes a destination in Amazon S3.

See Also:

  • Method Details

    • roleARN

      public final String roleARN()

      The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    • bucketARN

      public final String bucketARN()

      The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

      Returns:
      The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    • prefix

      public final String prefix()

      The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

      Returns:
      The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

    • errorOutputPrefix

      public final String errorOutputPrefix()

      A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

      Returns:
      A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

    • bufferingHints

      public final BufferingHints bufferingHints()

      The buffering option.

      Returns:
      The buffering option.

    • compressionFormat

      public final CompressionFormat compressionFormat()

      The compression format. If no value is specified, the default is UNCOMPRESSED.

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

      Returns:
      The compression format. If no value is specified, the default is UNCOMPRESSED.
      See Also:

    • compressionFormatAsString

      public final String compressionFormatAsString()

      The compression format. If no value is specified, the default is UNCOMPRESSED.

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

      Returns:
      The compression format. If no value is specified, the default is UNCOMPRESSED.
      See Also:

    • encryptionConfiguration

      public final EncryptionConfiguration encryptionConfiguration()

      The encryption configuration. If no value is specified, the default is no encryption.

      Returns:
      The encryption configuration. If no value is specified, the default is no encryption.

    • cloudWatchLoggingOptions

      public final CloudWatchLoggingOptions cloudWatchLoggingOptions()

      The Amazon CloudWatch logging options for your Firehose stream.

      Returns:
      The Amazon CloudWatch logging options for your Firehose stream.

    • processingConfiguration

      public final ProcessingConfiguration processingConfiguration()

      The data processing configuration.

      Returns:
      The data processing configuration.

    • s3BackupMode

      public final S3BackupMode s3BackupMode()

      The Amazon S3 backup mode.

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

      Returns:
      The Amazon S3 backup mode.
      See Also:

    • s3BackupModeAsString

      public final String s3BackupModeAsString()

      The Amazon S3 backup mode.

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

      Returns:
      The Amazon S3 backup mode.
      See Also:

    • s3BackupDescription

      public final S3DestinationDescription s3BackupDescription()

      The configuration for backup in Amazon S3.

      Returns:
      The configuration for backup in Amazon S3.

    • dataFormatConversionConfiguration

      public final DataFormatConversionConfiguration dataFormatConversionConfiguration()

      The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

      Returns:
      The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

    • dynamicPartitioningConfiguration

      public final DynamicPartitioningConfiguration dynamicPartitioningConfiguration()

      The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.

      Returns:
      The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.

    • fileExtension

      public final String fileExtension()

      Specify a file extension. It will override the default file extension

      Returns:
      Specify a file extension. It will override the default file extension

    • customTimeZone

      public final String customTimeZone()

      The time zone you prefer. UTC is the default.

      Returns:
      The time zone you prefer. UTC is the default.

    • toBuilder

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

    • builder

      public static ExtendedS3DestinationDescription.Builder builder()

    • serializableBuilderClass

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