Class InputS3Configuration

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

Contains the Amazon S3 location and format settings for bulk operation input. The S3Bucket and InputFormat fields are required.

See Also:

  • Method Details

    • s3BucketOwner

      public final String s3BucketOwner()

      The Amazon Web Services account ID of the input bucket owner. If you omit this value, DynamoDB uses the Amazon Web Services account ID of the requester.

      S3BucketOwner is required when the bucket is owned by another Amazon Web Services account.

      Returns:
      The Amazon Web Services account ID of the input bucket owner. If you omit this value, DynamoDB uses the Amazon Web Services account ID of the requester.

      S3BucketOwner is required when the bucket is owned by another Amazon Web Services account.

    • s3Bucket

      public final String s3Bucket()

      The name of the Amazon S3 bucket that contains the input objects.

      Returns:
      The name of the Amazon S3 bucket that contains the input objects.

    • s3KeyPrefix

      public final String s3KeyPrefix()

      An optional key prefix that limits the input to matching objects in the Amazon S3 bucket.

      Returns:
      An optional key prefix that limits the input to matching objects in the Amazon S3 bucket.

    • inputFormat

      public final BulkOperationInputFormat inputFormat()

      The format of the input objects. DYNAMODB_JSON uses JSON Lines, with one JSON record per line. ION uses a sequence of Ion structs.

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

      Returns:
      The format of the input objects. DYNAMODB_JSON uses JSON Lines, with one JSON record per line. ION uses a sequence of Ion structs.
      See Also:

    • inputFormatAsString

      public final String inputFormatAsString()

      The format of the input objects. DYNAMODB_JSON uses JSON Lines, with one JSON record per line. ION uses a sequence of Ion structs.

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

      Returns:
      The format of the input objects. DYNAMODB_JSON uses JSON Lines, with one JSON record per line. ION uses a sequence of Ion structs.
      See Also:

    • inputCompressionType

      public final InputCompressionType inputCompressionType()

      The compression type of the input objects. Valid values are GZIP, ZSTD, and NONE. If you don't specify a value, DynamoDB uses NONE.

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

      Returns:
      The compression type of the input objects. Valid values are GZIP, ZSTD, and NONE. If you don't specify a value, DynamoDB uses NONE.
      See Also:

    • inputCompressionTypeAsString

      public final String inputCompressionTypeAsString()

      The compression type of the input objects. Valid values are GZIP, ZSTD, and NONE. If you don't specify a value, DynamoDB uses NONE.

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

      Returns:
      The compression type of the input objects. Valid values are GZIP, ZSTD, and NONE. If you don't specify a value, DynamoDB uses NONE.
      See Also:

    • toBuilder

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

    • builder

      public static InputS3Configuration.Builder builder()

    • serializableBuilderClass

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