Interface ImportTask.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<ImportTask.Builder,ImportTask>,SdkBuilder<ImportTask.Builder,ImportTask>,SdkPojo
- Enclosing class:
- ImportTask
public static interface ImportTask.Builder extends SdkPojo, CopyableBuilder<ImportTask.Builder,ImportTask>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ImportTask.BuilderapplicationImportFailure(Integer applicationImportFailure)The total number of application records in the import file that failed to be imported.ImportTask.BuilderapplicationImportSuccess(Integer applicationImportSuccess)The total number of application records in the import file that were successfully imported.ImportTask.BuilderclientRequestToken(String clientRequestToken)A unique token used to prevent the same import request from occurring more than once.ImportTask.BuildererrorsAndFailedEntriesZip(String errorsAndFailedEntriesZip)A link to a compressed archive folder (in the ZIP format) that contains an error log and a file of failed records.ImportTask.BuilderimportCompletionTime(Instant importCompletionTime)The time that the import task request finished, presented in the Unix time stamp format.ImportTask.BuilderimportDeletedTime(Instant importDeletedTime)The time that the import task request was deleted, presented in the Unix time stamp format.ImportTask.BuilderimportRequestTime(Instant importRequestTime)The time that the import task request was made, presented in the Unix time stamp format.ImportTask.BuilderimportTaskId(String importTaskId)The unique ID for a specific import task.ImportTask.BuilderimportUrl(String importUrl)The URL for your import file that you've uploaded to Amazon S3.ImportTask.Buildername(String name)A descriptive name for an import task.ImportTask.BuilderserverImportFailure(Integer serverImportFailure)The total number of server records in the import file that failed to be imported.ImportTask.BuilderserverImportSuccess(Integer serverImportSuccess)The total number of server records in the import file that were successfully imported.ImportTask.Builderstatus(String status)The status of the import task.ImportTask.Builderstatus(ImportStatus status)The status of the import task.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
importTaskId
ImportTask.Builder importTaskId(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
clientRequestToken
ImportTask.Builder clientRequestToken(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
name
ImportTask.Builder name(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
importUrl
ImportTask.Builder importUrl(String importUrl)
The URL for your import file that you've uploaded to Amazon S3.
- Parameters:
importUrl- The URL for your import file that you've uploaded to Amazon S3.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
ImportTask.Builder status(String 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.- Parameters:
status- The status of the import task. An import can have the status ofIMPORT_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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ImportStatus,ImportStatus
-
status
ImportTask.Builder status(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.- Parameters:
status- The status of the import task. An import can have the status ofIMPORT_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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ImportStatus,ImportStatus
-
importRequestTime
ImportTask.Builder importRequestTime(Instant importRequestTime)
The time that the import task request was made, presented in the Unix time stamp format.
- Parameters:
importRequestTime- The time that the import task request was made, presented in the Unix time stamp format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
importCompletionTime
ImportTask.Builder importCompletionTime(Instant importCompletionTime)
The time that the import task request finished, presented in the Unix time stamp format.
- Parameters:
importCompletionTime- The time that the import task request finished, presented in the Unix time stamp format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
importDeletedTime
ImportTask.Builder importDeletedTime(Instant importDeletedTime)
The time that the import task request was deleted, presented in the Unix time stamp format.
- Parameters:
importDeletedTime- The time that the import task request was deleted, presented in the Unix time stamp format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serverImportSuccess
ImportTask.Builder serverImportSuccess(Integer serverImportSuccess)
The total number of server records in the import file that were successfully imported.
- Parameters:
serverImportSuccess- The total number of server records in the import file that were successfully imported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serverImportFailure
ImportTask.Builder serverImportFailure(Integer serverImportFailure)
The total number of server records in the import file that failed to be imported.
- Parameters:
serverImportFailure- The total number of server records in the import file that failed to be imported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
applicationImportSuccess
ImportTask.Builder applicationImportSuccess(Integer applicationImportSuccess)
The total number of application records in the import file that were successfully imported.
- Parameters:
applicationImportSuccess- The total number of application records in the import file that were successfully imported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
applicationImportFailure
ImportTask.Builder applicationImportFailure(Integer applicationImportFailure)
The total number of application records in the import file that failed to be imported.
- Parameters:
applicationImportFailure- The total number of application records in the import file that failed to be imported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
errorsAndFailedEntriesZip
ImportTask.Builder errorsAndFailedEntriesZip(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
-