ExtendedS3DestinationDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kinesisfirehose.model.ExtendedS3DestinationDescription

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ExtendedS3DestinationDescription
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes a destination in Amazon S3.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ExtendedS3DestinationDescription()

Constructors
Constructor and Description
`ExtendedS3DestinationDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExtendedS3DestinationDescription`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBucketARN()` The ARN of the S3 bucket.
`BufferingHints`	`getBufferingHints()` The buffering option.
`CloudWatchLoggingOptions`	`getCloudWatchLoggingOptions()` The Amazon CloudWatch logging options for your delivery stream.
`String`	`getCompressionFormat()` The compression format.
`DataFormatConversionConfiguration`	`getDataFormatConversionConfiguration()` 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`	`getEncryptionConfiguration()` The encryption configuration.
`String`	`getErrorOutputPrefix()` A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
`String`	`getPrefix()` The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files.
`ProcessingConfiguration`	`getProcessingConfiguration()` The data processing configuration.
`String`	`getRoleARN()` The Amazon Resource Name (ARN) of the AWS credentials.
`S3DestinationDescription`	`getS3BackupDescription()` The configuration for backup in Amazon S3.
`String`	`getS3BackupMode()` The Amazon S3 backup mode.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBucketARN(String bucketARN)` The ARN of the S3 bucket.
`void`	`setBufferingHints(BufferingHints bufferingHints)` The buffering option.
`void`	`setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)` The Amazon CloudWatch logging options for your delivery stream.
`void`	`setCompressionFormat(CompressionFormat compressionFormat)` The compression format.
`void`	`setCompressionFormat(String compressionFormat)` The compression format.
`void`	`setDataFormatConversionConfiguration(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.
`void`	`setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)` The encryption configuration.
`void`	`setErrorOutputPrefix(String errorOutputPrefix)` A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
`void`	`setPrefix(String prefix)` The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files.
`void`	`setProcessingConfiguration(ProcessingConfiguration processingConfiguration)` The data processing configuration.
`void`	`setRoleARN(String roleARN)` The Amazon Resource Name (ARN) of the AWS credentials.
`void`	`setS3BackupDescription(S3DestinationDescription s3BackupDescription)` The configuration for backup in Amazon S3.
`void`	`setS3BackupMode(S3BackupMode s3BackupMode)` The Amazon S3 backup mode.
`void`	`setS3BackupMode(String s3BackupMode)` The Amazon S3 backup mode.
`String`	`toString()` Returns a string representation of this object.
`ExtendedS3DestinationDescription`	`withBucketARN(String bucketARN)` The ARN of the S3 bucket.
`ExtendedS3DestinationDescription`	`withBufferingHints(BufferingHints bufferingHints)` The buffering option.
`ExtendedS3DestinationDescription`	`withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)` The Amazon CloudWatch logging options for your delivery stream.
`ExtendedS3DestinationDescription`	`withCompressionFormat(CompressionFormat compressionFormat)` The compression format.
`ExtendedS3DestinationDescription`	`withCompressionFormat(String compressionFormat)` The compression format.
`ExtendedS3DestinationDescription`	`withDataFormatConversionConfiguration(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.
`ExtendedS3DestinationDescription`	`withEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)` The encryption configuration.
`ExtendedS3DestinationDescription`	`withErrorOutputPrefix(String errorOutputPrefix)` A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
`ExtendedS3DestinationDescription`	`withPrefix(String prefix)` The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files.
`ExtendedS3DestinationDescription`	`withProcessingConfiguration(ProcessingConfiguration processingConfiguration)` The data processing configuration.
`ExtendedS3DestinationDescription`	`withRoleARN(String roleARN)` The Amazon Resource Name (ARN) of the AWS credentials.
`ExtendedS3DestinationDescription`	`withS3BackupDescription(S3DestinationDescription s3BackupDescription)` The configuration for backup in Amazon S3.
`ExtendedS3DestinationDescription`	`withS3BackupMode(S3BackupMode s3BackupMode)` The Amazon S3 backup mode.
`ExtendedS3DestinationDescription`	`withS3BackupMode(String s3BackupMode)` The Amazon S3 backup mode.

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

- Constructor Detail
  - ExtendedS3DestinationDescription
```
public ExtendedS3DestinationDescription()
```
- Method Detail
  - setRoleARN
```
public void setRoleARN(String roleARN)
```
    The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Parameters:
    
    roleARN - The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
  - getRoleARN
```
public String getRoleARN()
```
    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.
  - withRoleARN
```
public ExtendedS3DestinationDescription withRoleARN(String roleARN)
```
    The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Parameters:
    
    roleARN - The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBucketARN
```
public void setBucketARN(String bucketARN)
```
    The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Parameters:
    
    bucketARN - The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
  - getBucketARN
```
public String getBucketARN()
```
    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.
  - withBucketARN
```
public ExtendedS3DestinationDescription withBucketARN(String bucketARN)
```
    The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Parameters:
    
    bucketARN - The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrefix
```
public void setPrefix(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.
    
    Parameters:
    
    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.
  - getPrefix
```
public String getPrefix()
```
    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.
  - withPrefix
```
public ExtendedS3DestinationDescription withPrefix(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorOutputPrefix
```
public void setErrorOutputPrefix(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.
    
    Parameters:
    
    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.
  - getErrorOutputPrefix
```
public String getErrorOutputPrefix()
```
    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.
  - withErrorOutputPrefix
```
public ExtendedS3DestinationDescription withErrorOutputPrefix(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBufferingHints
```
public void setBufferingHints(BufferingHints bufferingHints)
```
    The buffering option.
    
    Parameters:
    
    bufferingHints - The buffering option.
  - getBufferingHints
```
public BufferingHints getBufferingHints()
```
    The buffering option.
    
    Returns:
    
    The buffering option.
  - withBufferingHints
```
public ExtendedS3DestinationDescription withBufferingHints(BufferingHints bufferingHints)
```
    The buffering option.
    
    Parameters:
    
    bufferingHints - The buffering option.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCompressionFormat
```
public void setCompressionFormat(String compressionFormat)
```
    The compression format. If no value is specified, the default is UNCOMPRESSED.
    
    Parameters:
    
    compressionFormat - The compression format. If no value is specified, the default is UNCOMPRESSED.
    
    See Also:
    
    CompressionFormat
  - getCompressionFormat
```
public String getCompressionFormat()
```
    The compression format. If no value is specified, the default is UNCOMPRESSED.
    
    Returns:
    
    The compression format. If no value is specified, the default is UNCOMPRESSED.
    
    See Also:
    
    CompressionFormat
  - withCompressionFormat
```
public ExtendedS3DestinationDescription withCompressionFormat(String compressionFormat)
```
    The compression format. If no value is specified, the default is UNCOMPRESSED.
    
    Parameters:
    
    compressionFormat - The compression format. If no value is specified, the default is UNCOMPRESSED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CompressionFormat
  - setCompressionFormat
```
public void setCompressionFormat(CompressionFormat compressionFormat)
```
    The compression format. If no value is specified, the default is UNCOMPRESSED.
    
    Parameters:
    
    compressionFormat - The compression format. If no value is specified, the default is UNCOMPRESSED.
    
    See Also:
    
    CompressionFormat
  - withCompressionFormat
```
public ExtendedS3DestinationDescription withCompressionFormat(CompressionFormat compressionFormat)
```
    The compression format. If no value is specified, the default is UNCOMPRESSED.
    
    Parameters:
    
    compressionFormat - The compression format. If no value is specified, the default is UNCOMPRESSED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CompressionFormat
  - setEncryptionConfiguration
```
public void setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
```
    The encryption configuration. If no value is specified, the default is no encryption.
    
    Parameters:
    
    encryptionConfiguration - The encryption configuration. If no value is specified, the default is no encryption.
  - getEncryptionConfiguration
```
public EncryptionConfiguration getEncryptionConfiguration()
```
    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.
  - withEncryptionConfiguration
```
public ExtendedS3DestinationDescription withEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
```
    The encryption configuration. If no value is specified, the default is no encryption.
    
    Parameters:
    
    encryptionConfiguration - The encryption configuration. If no value is specified, the default is no encryption.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCloudWatchLoggingOptions
```
public void setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
```
    The Amazon CloudWatch logging options for your delivery stream.
    
    Parameters:
    
    cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.
  - getCloudWatchLoggingOptions
```
public CloudWatchLoggingOptions getCloudWatchLoggingOptions()
```
    The Amazon CloudWatch logging options for your delivery stream.
    
    Returns:
    
    The Amazon CloudWatch logging options for your delivery stream.
  - withCloudWatchLoggingOptions
```
public ExtendedS3DestinationDescription withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
```
    The Amazon CloudWatch logging options for your delivery stream.
    
    Parameters:
    
    cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProcessingConfiguration
```
public void setProcessingConfiguration(ProcessingConfiguration processingConfiguration)
```
    The data processing configuration.
    
    Parameters:
    
    processingConfiguration - The data processing configuration.
  - getProcessingConfiguration
```
public ProcessingConfiguration getProcessingConfiguration()
```
    The data processing configuration.
    
    Returns:
    
    The data processing configuration.
  - withProcessingConfiguration
```
public ExtendedS3DestinationDescription withProcessingConfiguration(ProcessingConfiguration processingConfiguration)
```
    The data processing configuration.
    
    Parameters:
    
    processingConfiguration - The data processing configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3BackupMode
```
public void setS3BackupMode(String s3BackupMode)
```
    The Amazon S3 backup mode.
    
    Parameters:
    
    s3BackupMode - The Amazon S3 backup mode.
    
    See Also:
    
    S3BackupMode
  - getS3BackupMode
```
public String getS3BackupMode()
```
    The Amazon S3 backup mode.
    
    Returns:
    
    The Amazon S3 backup mode.
    
    See Also:
    
    S3BackupMode
  - withS3BackupMode
```
public ExtendedS3DestinationDescription withS3BackupMode(String s3BackupMode)
```
    The Amazon S3 backup mode.
    
    Parameters:
    
    s3BackupMode - The Amazon S3 backup mode.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3BackupMode
  - setS3BackupMode
```
public void setS3BackupMode(S3BackupMode s3BackupMode)
```
    The Amazon S3 backup mode.
    
    Parameters:
    
    s3BackupMode - The Amazon S3 backup mode.
    
    See Also:
    
    S3BackupMode
  - withS3BackupMode
```
public ExtendedS3DestinationDescription withS3BackupMode(S3BackupMode s3BackupMode)
```
    The Amazon S3 backup mode.
    
    Parameters:
    
    s3BackupMode - The Amazon S3 backup mode.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3BackupMode
  - setS3BackupDescription
```
public void setS3BackupDescription(S3DestinationDescription s3BackupDescription)
```
    The configuration for backup in Amazon S3.
    
    Parameters:
    
    s3BackupDescription - The configuration for backup in Amazon S3.
  - getS3BackupDescription
```
public S3DestinationDescription getS3BackupDescription()
```
    The configuration for backup in Amazon S3.
    
    Returns:
    
    The configuration for backup in Amazon S3.
  - withS3BackupDescription
```
public ExtendedS3DestinationDescription withS3BackupDescription(S3DestinationDescription s3BackupDescription)
```
    The configuration for backup in Amazon S3.
    
    Parameters:
    
    s3BackupDescription - The configuration for backup in Amazon S3.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataFormatConversionConfiguration
```
public void setDataFormatConversionConfiguration(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.
    
    Parameters:
    
    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.
  - getDataFormatConversionConfiguration
```
public DataFormatConversionConfiguration getDataFormatConversionConfiguration()
```
    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.
  - withDataFormatConversionConfiguration
```
public ExtendedS3DestinationDescription withDataFormatConversionConfiguration(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ExtendedS3DestinationDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ExtendedS3DestinationDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExtendedS3DestinationDescription

Method Detail

setRoleARN

getRoleARN

withRoleARN

setBucketARN

getBucketARN

withBucketARN

setPrefix

getPrefix

withPrefix

setErrorOutputPrefix

getErrorOutputPrefix

withErrorOutputPrefix

setBufferingHints

getBufferingHints

withBufferingHints

setCompressionFormat

getCompressionFormat

withCompressionFormat

setCompressionFormat

withCompressionFormat

setEncryptionConfiguration

getEncryptionConfiguration

withEncryptionConfiguration

setCloudWatchLoggingOptions

getCloudWatchLoggingOptions

withCloudWatchLoggingOptions

setProcessingConfiguration

getProcessingConfiguration

withProcessingConfiguration

setS3BackupMode

getS3BackupMode

withS3BackupMode

setS3BackupMode

withS3BackupMode

setS3BackupDescription

getS3BackupDescription

withS3BackupDescription

setDataFormatConversionConfiguration

getDataFormatConversionConfiguration

withDataFormatConversionConfiguration

toString

equals

hashCode

clone

marshall