ExtendedS3DestinationDescription (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.firehose.model.ExtendedS3DestinationDescription

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ExtendedS3DestinationDescription.Builder,ExtendedS3DestinationDescription>

@Generated(value="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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ExtendedS3DestinationDescription.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ExtendedS3DestinationDescription.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`bucketARN()` The ARN of the S3 bucket.
`BufferingHints`	`bufferingHints()` The buffering option.
`static ExtendedS3DestinationDescription.Builder`	`builder()`
`CloudWatchLoggingOptions`	`cloudWatchLoggingOptions()` The Amazon CloudWatch logging options for your delivery stream.
`CompressionFormat`	`compressionFormat()` The compression format.
`String`	`compressionFormatAsString()` The compression format.
`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.
`EncryptionConfiguration`	`encryptionConfiguration()` The encryption configuration.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`prefix()` The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files.
`ProcessingConfiguration`	`processingConfiguration()` The data processing configuration.
`String`	`roleARN()` The Amazon Resource Name (ARN) of the AWS credentials.
`S3DestinationDescription`	`s3BackupDescription()` The configuration for backup in Amazon S3.
`S3BackupMode`	`s3BackupMode()` The Amazon S3 backup mode.
`String`	`s3BackupModeAsString()` The Amazon S3 backup mode.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ExtendedS3DestinationDescription.Builder>`	`serializableBuilderClass()`
`ExtendedS3DestinationDescription.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - roleARN
```
public String roleARN()
```
    The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
  - bucketARN
```
public String bucketARN()
```
    The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Returns:
    
    The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
  - prefix
```
public String prefix()
```
    The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.
    
    Returns:
    
    The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.
  - bufferingHints
```
public BufferingHints bufferingHints()
```
    The buffering option.
    
    Returns:
    
    The buffering option.
  - compressionFormat
```
public 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:
    
    CompressionFormat
  - compressionFormatAsString
```
public 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:
    
    CompressionFormat
  - encryptionConfiguration
```
public 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 CloudWatchLoggingOptions cloudWatchLoggingOptions()
```
    The Amazon CloudWatch logging options for your delivery stream.
    
    Returns:
    
    The Amazon CloudWatch logging options for your delivery stream.
  - processingConfiguration
```
public ProcessingConfiguration processingConfiguration()
```
    The data processing configuration.
    
    Returns:
    
    The data processing configuration.
  - s3BackupMode
```
public 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:
    
    S3BackupMode
  - s3BackupModeAsString
```
public 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:
    
    S3BackupMode
  - s3BackupDescription
```
public S3DestinationDescription s3BackupDescription()
```
    The configuration for backup in Amazon S3.
    
    Returns:
    
    The configuration for backup in Amazon S3.
  - dataFormatConversionConfiguration
```
public 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.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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.

Class ExtendedS3DestinationDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

roleARN

bucketARN

prefix

bufferingHints

compressionFormat

compressionFormatAsString

encryptionConfiguration

cloudWatchLoggingOptions

processingConfiguration

s3BackupMode

s3BackupModeAsString

s3BackupDescription

dataFormatConversionConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields