Class ExtendedS3DestinationDescription
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ExtendedS3DestinationDescription.Builder,
ExtendedS3DestinationDescription>
Describes a destination in Amazon S3.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ARN of the S3 bucket.final BufferingHints
The buffering option.builder()
final CloudWatchLoggingOptions
The Amazon CloudWatch logging options for your delivery stream.final CompressionFormat
The compression format.final String
The compression format.final String
The time zone you prefer.The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys.final EncryptionConfiguration
The encryption configuration.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
A prefix that Firehose evaluates and adds to failed records before writing them to S3.final String
Specify a file extension.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
prefix()
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files.final ProcessingConfiguration
The data processing configuration.final String
roleARN()
The Amazon Resource Name (ARN) of the Amazon Web Services credentials.final S3DestinationDescription
The configuration for backup in Amazon S3.final S3BackupMode
The Amazon S3 backup mode.final String
The Amazon S3 backup mode.static Class
<? extends ExtendedS3DestinationDescription.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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
The buffering option.
- Returns:
- The buffering option.
-
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 returnCompressionFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcompressionFormatAsString()
.- Returns:
- The compression format. If no value is specified, the default is
UNCOMPRESSED
. - See Also:
-
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 returnCompressionFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcompressionFormatAsString()
.- Returns:
- The compression format. If no value is specified, the default is
UNCOMPRESSED
. - See Also:
-
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
The Amazon CloudWatch logging options for your delivery stream.
- Returns:
- The Amazon CloudWatch logging options for your delivery stream.
-
processingConfiguration
The data processing configuration.
- Returns:
- The data processing configuration.
-
s3BackupMode
The Amazon S3 backup mode.
If the service returns an enum value that is not available in the current SDK version,
s3BackupMode
will returnS3BackupMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3BackupModeAsString()
.- Returns:
- The Amazon S3 backup mode.
- See Also:
-
s3BackupModeAsString
The Amazon S3 backup mode.
If the service returns an enum value that is not available in the current SDK version,
s3BackupMode
will returnS3BackupMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3BackupModeAsString()
.- Returns:
- The Amazon S3 backup mode.
- See Also:
-
s3BackupDescription
The configuration for backup in Amazon S3.
- Returns:
- The configuration for backup in Amazon S3.
-
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
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
Specify a file extension. It will override the default file extension
- Returns:
- Specify a file extension. It will override the default file extension
-
customTimeZone
The time zone you prefer. UTC is the default.
- Returns:
- The time zone you prefer. UTC is the default.
-
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 interfaceToCopyableBuilder<ExtendedS3DestinationDescription.Builder,
ExtendedS3DestinationDescription> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-