Class ImportTableDescription

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

Represents the properties of the table being imported into.

See Also:

  • Method Details

    • importArn

      public final String importArn()

      The Amazon Resource Number (ARN) corresponding to the import request.

      Returns:
      The Amazon Resource Number (ARN) corresponding to the import request.

    • importStatus

      public final ImportStatus importStatus()

      The status of the import.

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

      Returns:
      The status of the import.
      See Also:

    • importStatusAsString

      public final String importStatusAsString()

      The status of the import.

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

      Returns:
      The status of the import.
      See Also:

    • tableArn

      public final String tableArn()

      The Amazon Resource Number (ARN) of the table being imported into.

      Returns:
      The Amazon Resource Number (ARN) of the table being imported into.

    • tableId

      public final String tableId()

      The table id corresponding to the table created by import table process.

      Returns:
      The table id corresponding to the table created by import table process.

    • clientToken

      public final String clientToken()

      The client token that was provided for the import task. Reusing the client token on retry makes a call to ImportTable idempotent.

      Returns:
      The client token that was provided for the import task. Reusing the client token on retry makes a call to ImportTable idempotent.

    • s3BucketSource

      public final S3BucketSource s3BucketSource()

      Values for the S3 bucket the source file is imported from. Includes bucket name (required), key prefix (optional) and bucket account owner ID (optional).

      Returns:
      Values for the S3 bucket the source file is imported from. Includes bucket name (required), key prefix (optional) and bucket account owner ID (optional).

    • errorCount

      public final Long errorCount()

      The number of errors occurred on importing the source file into the target table.

      Returns:
      The number of errors occurred on importing the source file into the target table.

    • cloudWatchLogGroupArn

      public final String cloudWatchLogGroupArn()

      The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the target table.

      Returns:
      The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the target table.

    • inputFormat

      public final InputFormat inputFormat()

      The format of the source data going into the target table.

      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 going into the target table.
      See Also:

    • inputFormatAsString

      public final String inputFormatAsString()

      The format of the source data going into the target table.

      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 going into the target table.
      See Also:

    • inputFormatOptions

      public final InputFormatOptions inputFormatOptions()

      The format options for the data that was imported into the target table. There is one value, CsvOption.

      Returns:
      The format options for the data that was imported into the target table. There is one value, CsvOption.

    • inputCompressionType

      public final InputCompressionType inputCompressionType()

      The compression options for the data that has been imported into the target table. The values are NONE, GZIP, or ZSTD.

      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 options for the data that has been imported into the target table. The values are NONE, GZIP, or ZSTD.
      See Also:

    • inputCompressionTypeAsString

      public final String inputCompressionTypeAsString()

      The compression options for the data that has been imported into the target table. The values are NONE, GZIP, or ZSTD.

      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 options for the data that has been imported into the target table. The values are NONE, GZIP, or ZSTD.
      See Also:

    • tableCreationParameters

      public final TableCreationParameters tableCreationParameters()

      The parameters for the new table that is being imported into.

      Returns:
      The parameters for the new table that is being imported into.

    • startTime

      public final Instant startTime()

      The time when this import task started.

      Returns:
      The time when this import task started.

    • endTime

      public final Instant endTime()

      The time at which the creation of the table associated with this import task completed.

      Returns:
      The time at which the creation of the table associated with this import task completed.

    • processedSizeBytes

      public final Long processedSizeBytes()

      The total size of data processed from the source file, in Bytes.

      Returns:
      The total size of data processed from the source file, in Bytes.

    • processedItemCount

      public final Long processedItemCount()

      The total number of items processed from the source file.

      Returns:
      The total number of items processed from the source file.

    • importedItemCount

      public final Long importedItemCount()

      The number of items successfully imported into the new table.

      Returns:
      The number of items successfully imported into the new table.

    • failureCode

      public final String failureCode()

      The error code corresponding to the failure that the import job ran into during execution.

      Returns:
      The error code corresponding to the failure that the import job ran into during execution.

    • failureMessage

      public final String failureMessage()

      The error message corresponding to the failure that the import job ran into during execution.

      Returns:
      The error message corresponding to the failure that the import job ran into during execution.

    • toBuilder

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

    • builder

      public static ImportTableDescription.Builder builder()

    • serializableBuilderClass

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