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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ImportTableDescription.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ImportTableDescription.Builder
builder()
String
clientToken()
The client token that was provided for the import task.String
cloudWatchLogGroupArn()
The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the target table.Instant
endTime()
The time at which the creation of the table associated with this import task completed.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
Long
errorCount()
The number of errors occurred on importing the source file into the target table.String
failureCode()
The error code corresponding to the failure that the import job ran into during execution.String
failureMessage()
The error message corresponding to the failure that the import job ran into during execution.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
importArn()
The Amazon Resource Number (ARN) corresponding to the import request.Long
importedItemCount()
The number of items successfully imported into the new table.ImportStatus
importStatus()
The status of the import.String
importStatusAsString()
The status of the import.InputCompressionType
inputCompressionType()
The compression options for the data that has been imported into the target table.String
inputCompressionTypeAsString()
The compression options for the data that has been imported into the target table.InputFormat
inputFormat()
The format of the source data going into the target table.String
inputFormatAsString()
The format of the source data going into the target table.InputFormatOptions
inputFormatOptions()
The format options for the data that was imported into the target table.Long
processedItemCount()
The total number of items processed from the source file.Long
processedSizeBytes()
The total size of data processed from the source file, in Bytes.S3BucketSource
s3BucketSource()
Values for the S3 bucket the source file is imported from.List<SdkField<?>>
sdkFields()
static Class<? extends ImportTableDescription.Builder>
serializableBuilderClass()
Instant
startTime()
The time when this import task started.String
tableArn()
The Amazon Resource Number (ARN) of the table being imported into.TableCreationParameters
tableCreationParameters()
The parameters for the new table that is being imported into.String
tableId()
The table id corresponding to the table created by import table process.ImportTableDescription.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 returnImportStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimportStatusAsString()
.- Returns:
- The status of the import.
- See Also:
ImportStatus
-
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 returnImportStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimportStatusAsString()
.- Returns:
- The status of the import.
- See Also:
ImportStatus
-
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 returnInputFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominputFormatAsString()
.- Returns:
- The format of the source data going into the target table.
- See Also:
InputFormat
-
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 returnInputFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominputFormatAsString()
.- Returns:
- The format of the source data going into the target table.
- See Also:
InputFormat
-
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 returnInputCompressionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominputCompressionTypeAsString()
.- Returns:
- The compression options for the data that has been imported into the target table. The values are NONE, GZIP, or ZSTD.
- See Also:
InputCompressionType
-
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 returnInputCompressionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominputCompressionTypeAsString()
.- Returns:
- The compression options for the data that has been imported into the target table. The values are NONE, GZIP, or ZSTD.
- See Also:
InputCompressionType
-
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ImportTableDescription.Builder,ImportTableDescription>
-
builder
public static ImportTableDescription.Builder builder()
-
serializableBuilderClass
public static Class<? extends ImportTableDescription.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-