Package software.amazon.awssdk.services.dynamodb.model

Class ImportTableRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest
software.amazon.awssdk.services.dynamodb.model.ImportTableRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ImportTableRequest.Builder,ImportTableRequest>
@Generated("software.amazon.awssdk:codegen") public final class ImportTableRequest extends DynamoDbRequest implements ToCopyableBuilder<ImportTableRequest.Builder,ImportTableRequest>

  • Method Details

    • clientToken

      public final String clientToken()

      Providing a ClientToken makes the call to ImportTableInput idempotent, meaning that multiple identical calls have the same effect as one single call.

      A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent.

      If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

      Returns:
      Providing a ClientToken makes the call to ImportTableInput idempotent, meaning that multiple identical calls have the same effect as one single call.

      A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent.

      If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

    • s3BucketSource

      public final S3BucketSource s3BucketSource()

      The S3 bucket that provides the source for the import.

      Returns:
      The S3 bucket that provides the source for the import.

    • inputFormat

      public final InputFormat inputFormat()

      The format of the source data. Valid values for ImportFormat are CSV, DYNAMODB_JSON or ION.

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

      Returns:
      The format of the source data. Valid values for ImportFormat are CSV, DYNAMODB_JSON or ION.
      See Also:

    • inputFormatAsString

      public final String inputFormatAsString()

      The format of the source data. Valid values for ImportFormat are CSV, DYNAMODB_JSON or ION.

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

      Returns:
      The format of the source data. Valid values for ImportFormat are CSV, DYNAMODB_JSON or ION.
      See Also:

    • inputFormatOptions

      public final InputFormatOptions inputFormatOptions()

      Additional properties that specify how the input is formatted,

      Returns:
      Additional properties that specify how the input is formatted,

    • inputCompressionType

      public final InputCompressionType inputCompressionType()

      Type of compression to be used on the input coming from the imported table.

      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:
      Type of compression to be used on the input coming from the imported table.
      See Also:

    • inputCompressionTypeAsString

      public final String inputCompressionTypeAsString()

      Type of compression to be used on the input coming from the imported table.

      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:
      Type of compression to be used on the input coming from the imported table.
      See Also:

    • tableCreationParameters

      public final TableCreationParameters tableCreationParameters()

      Parameters for the table to import the data into.

      Returns:
      Parameters for the table to import the data into.

    • toBuilder

      public ImportTableRequest.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<ImportTableRequest.Builder,ImportTableRequest>
      Specified by:
      toBuilder in class DynamoDbRequest
      Returns:
      a builder for type T

    • builder

      public static ImportTableRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ImportTableRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.