Class S3Storage

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

Storage configuration for an Amazon S3 destination bucket.

See Also:

  • Method Details

    • bucketArn

      public final String bucketArn()

      The Amazon Resource Name (ARN) of the destination Amazon S3 bucket.

      Returns:
      The Amazon Resource Name (ARN) of the destination Amazon S3 bucket.

    • compressionType

      public final S3CompressionType compressionType()

      The compression codec applied to delivered Amazon S3 objects.

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

      Returns:
      The compression codec applied to delivered Amazon S3 objects.
      See Also:

    • compressionTypeAsString

      public final String compressionTypeAsString()

      The compression codec applied to delivered Amazon S3 objects.

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

      Returns:
      The compression codec applied to delivered Amazon S3 objects.
      See Also:

    • outputPrefix

      public final String outputPrefix()

      An optional prefix prepended to every Amazon S3 object key written by the channel.

      Returns:
      An optional prefix prepended to every Amazon S3 object key written by the channel.

    • outputKeyTemplate

      public final String outputKeyTemplate()

      An optional template that controls the Amazon S3 object key for each delivered record. Supports the placeholders !{partition-id}, !{sequence-number}, and !{kafka-offset}.

      Returns:
      An optional template that controls the Amazon S3 object key for each delivered record. Supports the placeholders !{partition-id}, !{sequence-number}, and !{kafka-offset}.

    • storageClass

      public final S3StorageClass storageClass()

      The Amazon S3 storage class for delivered objects.

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

      Returns:
      The Amazon S3 storage class for delivered objects.
      See Also:

    • storageClassAsString

      public final String storageClassAsString()

      The Amazon S3 storage class for delivered objects.

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

      Returns:
      The Amazon S3 storage class for delivered objects.
      See Also:

    • expectedBucketOwner

      public final String expectedBucketOwner()

      Optional 12-digit AWS account ID expected to own the Amazon S3 bucket.

      Returns:
      Optional 12-digit AWS account ID expected to own the Amazon S3 bucket.

    • toBuilder

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

    • builder

      public static S3Storage.Builder builder()

    • serializableBuilderClass

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