software.amazon.awssdk.services.firehose.model

Class ExtendedS3DestinationUpdate

java.lang.Object

software.amazon.awssdk.services.firehose.model.ExtendedS3DestinationUpdate

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ExtendedS3DestinationUpdate.Builder,ExtendedS3DestinationUpdate>

@Generated(value="software.amazon.awssdk:codegen")
public final class ExtendedS3DestinationUpdate
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ExtendedS3DestinationUpdate.Builder,ExtendedS3DestinationUpdate>

Describes an update for a destination in Amazon S3.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExtendedS3DestinationUpdate.Builder

Method Summary

Modifier and Type	Method and Description
String	bucketARN() The ARN of the S3 bucket.
BufferingHints	bufferingHints() The buffering option.
static ExtendedS3DestinationUpdate.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.
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.
EncryptionConfiguration	encryptionConfiguration() The encryption configuration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	errorOutputPrefix() A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
<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.
S3BackupMode	s3BackupMode() You can update a delivery stream to enable Amazon S3 backup if it is disabled.
String	s3BackupModeAsString() You can update a delivery stream to enable Amazon S3 backup if it is disabled.
S3DestinationUpdate	s3BackupUpdate() The Amazon S3 destination for backup.
List<SdkField<?>>	sdkFields()
static Class<? extends ExtendedS3DestinationUpdate.Builder>	serializableBuilderClass()
ExtendedS3DestinationUpdate.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

roleARN

public final 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 final 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 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 Kinesis Data 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 Kinesis Data 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:

CompressionFormat

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:

CompressionFormat

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 delivery stream.

Returns:

The Amazon CloudWatch logging options for your delivery stream.

processingConfiguration

public final ProcessingConfiguration processingConfiguration()

The data processing configuration.

Returns:

The data processing configuration.

s3BackupMode

public final S3BackupMode s3BackupMode()

You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

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:

You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

See Also:

S3BackupMode

s3BackupModeAsString

public final String s3BackupModeAsString()

You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

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:

You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

See Also:

S3BackupMode

s3BackupUpdate

public final S3DestinationUpdate s3BackupUpdate()

The Amazon S3 destination for backup.

Returns:

The Amazon S3 destination for backup.

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. For more information, see https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html

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. For more information, see https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html

toBuilder

public ExtendedS3DestinationUpdate.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExtendedS3DestinationUpdate.Builder,ExtendedS3DestinationUpdate>

builder

public static ExtendedS3DestinationUpdate.Builder builder()

serializableBuilderClass

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