Class ImportTask
- java.lang.Object
-
- software.amazon.awssdk.services.applicationdiscovery.model.ImportTask
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ImportTask.Builder,ImportTask>
@Generated("software.amazon.awssdk:codegen") public final class ImportTask extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ImportTask.Builder,ImportTask>
An array of information related to the import task request that includes status information, times, IDs, the Amazon S3 Object URL for the import file, and more.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceImportTask.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description IntegerapplicationImportFailure()The total number of application records in the import file that failed to be imported.IntegerapplicationImportSuccess()The total number of application records in the import file that were successfully imported.static ImportTask.Builderbuilder()StringclientRequestToken()A unique token used to prevent the same import request from occurring more than once.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringerrorsAndFailedEntriesZip()A link to a compressed archive folder (in the ZIP format) that contains an error log and a file of failed records.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()InstantimportCompletionTime()The time that the import task request finished, presented in the Unix time stamp format.InstantimportDeletedTime()The time that the import task request was deleted, presented in the Unix time stamp format.InstantimportRequestTime()The time that the import task request was made, presented in the Unix time stamp format.StringimportTaskId()The unique ID for a specific import task.StringimportUrl()The URL for your import file that you've uploaded to Amazon S3.Stringname()A descriptive name for an import task.List<SdkField<?>>sdkFields()static Class<? extends ImportTask.Builder>serializableBuilderClass()IntegerserverImportFailure()The total number of server records in the import file that failed to be imported.IntegerserverImportSuccess()The total number of server records in the import file that were successfully imported.ImportStatusstatus()The status of the import task.StringstatusAsString()The status of the import task.ImportTask.BuildertoBuilder()StringtoString()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
-
importTaskId
public final String importTaskId()
The unique ID for a specific import task. These IDs aren't globally unique, but they are unique within an Amazon Web Services account.
- Returns:
- The unique ID for a specific import task. These IDs aren't globally unique, but they are unique within an Amazon Web Services account.
-
clientRequestToken
public final String clientRequestToken()
A unique token used to prevent the same import request from occurring more than once. If you didn't provide a token, a token was automatically generated when the import task request was sent.
- Returns:
- A unique token used to prevent the same import request from occurring more than once. If you didn't provide a token, a token was automatically generated when the import task request was sent.
-
name
public final String name()
A descriptive name for an import task. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task.
- Returns:
- A descriptive name for an import task. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task.
-
importUrl
public final String importUrl()
The URL for your import file that you've uploaded to Amazon S3.
- Returns:
- The URL for your import file that you've uploaded to Amazon S3.
-
status
public final ImportStatus status()
The status of the import task. An import can have the status of
IMPORT_COMPLETEand still have some records fail to import from the overall request. More information can be found in the downloadable archive defined in theerrorsAndFailedEntriesZipfield, or in the Migration Hub management console.If the service returns an enum value that is not available in the current SDK version,
statuswill returnImportStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the import task. An import can have the status of
IMPORT_COMPLETEand still have some records fail to import from the overall request. More information can be found in the downloadable archive defined in theerrorsAndFailedEntriesZipfield, or in the Migration Hub management console. - See Also:
ImportStatus
-
statusAsString
public final String statusAsString()
The status of the import task. An import can have the status of
IMPORT_COMPLETEand still have some records fail to import from the overall request. More information can be found in the downloadable archive defined in theerrorsAndFailedEntriesZipfield, or in the Migration Hub management console.If the service returns an enum value that is not available in the current SDK version,
statuswill returnImportStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the import task. An import can have the status of
IMPORT_COMPLETEand still have some records fail to import from the overall request. More information can be found in the downloadable archive defined in theerrorsAndFailedEntriesZipfield, or in the Migration Hub management console. - See Also:
ImportStatus
-
importRequestTime
public final Instant importRequestTime()
The time that the import task request was made, presented in the Unix time stamp format.
- Returns:
- The time that the import task request was made, presented in the Unix time stamp format.
-
importCompletionTime
public final Instant importCompletionTime()
The time that the import task request finished, presented in the Unix time stamp format.
- Returns:
- The time that the import task request finished, presented in the Unix time stamp format.
-
importDeletedTime
public final Instant importDeletedTime()
The time that the import task request was deleted, presented in the Unix time stamp format.
- Returns:
- The time that the import task request was deleted, presented in the Unix time stamp format.
-
serverImportSuccess
public final Integer serverImportSuccess()
The total number of server records in the import file that were successfully imported.
- Returns:
- The total number of server records in the import file that were successfully imported.
-
serverImportFailure
public final Integer serverImportFailure()
The total number of server records in the import file that failed to be imported.
- Returns:
- The total number of server records in the import file that failed to be imported.
-
applicationImportSuccess
public final Integer applicationImportSuccess()
The total number of application records in the import file that were successfully imported.
- Returns:
- The total number of application records in the import file that were successfully imported.
-
applicationImportFailure
public final Integer applicationImportFailure()
The total number of application records in the import file that failed to be imported.
- Returns:
- The total number of application records in the import file that failed to be imported.
-
errorsAndFailedEntriesZip
public final String errorsAndFailedEntriesZip()
A link to a compressed archive folder (in the ZIP format) that contains an error log and a file of failed records. You can use these two files to quickly identify records that failed, why they failed, and correct those records. Afterward, you can upload the corrected file to your Amazon S3 bucket and create another import task request.
This field also includes authorization information so you can confirm the authenticity of the compressed archive before you download it.
If some records failed to be imported we recommend that you correct the records in the failed entries file and then imports that failed entries file. This prevents you from having to correct and update the larger original file and attempt importing it again.
- Returns:
- A link to a compressed archive folder (in the ZIP format) that contains an error log and a file of failed
records. You can use these two files to quickly identify records that failed, why they failed, and
correct those records. Afterward, you can upload the corrected file to your Amazon S3 bucket and create
another import task request.
This field also includes authorization information so you can confirm the authenticity of the compressed archive before you download it.
If some records failed to be imported we recommend that you correct the records in the failed entries file and then imports that failed entries file. This prevents you from having to correct and update the larger original file and attempt importing it again.
-
toBuilder
public ImportTask.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ImportTask.Builder,ImportTask>
-
builder
public static ImportTask.Builder builder()
-
serializableBuilderClass
public static Class<? extends ImportTask.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin 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.
-
-