Package software.amazon.awssdk.services.applicationdiscovery.model

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:

  • Method Details

    • 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_COMPLETE and still have some records fail to import from the overall request. More information can be found in the downloadable archive defined in the errorsAndFailedEntriesZip field, or in the Migration Hub management console.

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

      Returns:
      The status of the import task. An import can have the status of IMPORT_COMPLETE and still have some records fail to import from the overall request. More information can be found in the downloadable archive defined in the errorsAndFailedEntriesZip field, or in the Migration Hub management console.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the import task. An import can have the status of IMPORT_COMPLETE and still have some records fail to import from the overall request. More information can be found in the downloadable archive defined in the errorsAndFailedEntriesZip field, or in the Migration Hub management console.

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

      Returns:
      The status of the import task. An import can have the status of IMPORT_COMPLETE and still have some records fail to import from the overall request. More information can be found in the downloadable archive defined in the errorsAndFailedEntriesZip field, or in the Migration Hub management console.
      See Also:

    • 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()
      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<ImportTask.Builder,ImportTask>
      Returns:
      a builder for type T

    • builder

      public static ImportTask.Builder builder()

    • serializableBuilderClass

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