Package software.amazon.awssdk.services.databasemigration.model

Class ReplicationTaskAssessmentRun

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

Provides information that describes a premigration assessment run that you have started using the StartReplicationTaskAssessmentRun operation.

Some of the information appears based on other operations that can return the ReplicationTaskAssessmentRun object.

See Also:

  • Method Details

    • replicationTaskAssessmentRunArn

      public final String replicationTaskAssessmentRunArn()

      Amazon Resource Name (ARN) of this assessment run.

      Returns:
      Amazon Resource Name (ARN) of this assessment run.

    • replicationTaskArn

      public final String replicationTaskArn()

      ARN of the migration task associated with this premigration assessment run.

      Returns:
      ARN of the migration task associated with this premigration assessment run.

    • status

      public final String status()

      Assessment run status.

      This status can have one of the following values:

      • "cancelling" – The assessment run was canceled by the CancelReplicationTaskAssessmentRun operation.

      • "deleting" – The assessment run was deleted by the DeleteReplicationTaskAssessmentRun operation.

      • "failed" – At least one individual assessment completed with a failed status.

      • "error-provisioning" – An internal error occurred while resources were provisioned (during provisioning status).

      • "error-executing" – An internal error occurred while individual assessments ran (during running status).

      • "invalid state" – The assessment run is in an unknown state.

      • "passed" – All individual assessments have completed, and none has a failed status.

      • "provisioning" – Resources required to run individual assessments are being provisioned.

      • "running" – Individual assessments are being run.

      • "starting" – The assessment run is starting, but resources are not yet being provisioned for individual assessments.

      • "warning" – At least one individual assessment completed with a warning status or all individual assessments were skipped (completed with a skipped status).

      Returns:
      Assessment run status.

      This status can have one of the following values:

      • "cancelling" – The assessment run was canceled by the CancelReplicationTaskAssessmentRun operation.

      • "deleting" – The assessment run was deleted by the DeleteReplicationTaskAssessmentRun operation.

      • "failed" – At least one individual assessment completed with a failed status.

      • "error-provisioning" – An internal error occurred while resources were provisioned (during provisioning status).

      • "error-executing" – An internal error occurred while individual assessments ran (during running status).

      • "invalid state" – The assessment run is in an unknown state.

      • "passed" – All individual assessments have completed, and none has a failed status.

      • "provisioning" – Resources required to run individual assessments are being provisioned.

      • "running" – Individual assessments are being run.

      • "starting" – The assessment run is starting, but resources are not yet being provisioned for individual assessments.

      • "warning" – At least one individual assessment completed with a warning status or all individual assessments were skipped (completed with a skipped status).

    • replicationTaskAssessmentRunCreationDate

      public final Instant replicationTaskAssessmentRunCreationDate()

      Date on which the assessment run was created using the StartReplicationTaskAssessmentRun operation.

      Returns:
      Date on which the assessment run was created using the StartReplicationTaskAssessmentRun operation.

    • assessmentProgress

      public final ReplicationTaskAssessmentRunProgress assessmentProgress()

      Indication of the completion progress for the individual assessments specified to run.

      Returns:
      Indication of the completion progress for the individual assessments specified to run.

    • lastFailureMessage

      public final String lastFailureMessage()

      Last message generated by an individual assessment failure.

      Returns:
      Last message generated by an individual assessment failure.

    • serviceAccessRoleArn

      public final String serviceAccessRoleArn()

      ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation. The role must allow the iam:PassRole action.

      Returns:
      ARN of the service role used to start the assessment run using the StartReplicationTaskAssessmentRun operation. The role must allow the iam:PassRole action.

    • resultLocationBucket

      public final String resultLocationBucket()

      Amazon S3 bucket where DMS stores the results of this assessment run.

      Returns:
      Amazon S3 bucket where DMS stores the results of this assessment run.

    • resultLocationFolder

      public final String resultLocationFolder()

      Folder in an Amazon S3 bucket where DMS stores the results of this assessment run.

      Returns:
      Folder in an Amazon S3 bucket where DMS stores the results of this assessment run.

    • resultEncryptionMode

      public final String resultEncryptionMode()

      Encryption mode used to encrypt the assessment run results.

      Returns:
      Encryption mode used to encrypt the assessment run results.

    • resultKmsKeyArn

      public final String resultKmsKeyArn()

      ARN of the KMS encryption key used to encrypt the assessment run results.

      Returns:
      ARN of the KMS encryption key used to encrypt the assessment run results.

    • assessmentRunName

      public final String assessmentRunName()

      Unique name of the assessment run.

      Returns:
      Unique name of the assessment run.

    • isLatestTaskAssessmentRun

      public final Boolean isLatestTaskAssessmentRun()

      Indicates that the following PreflightAssessmentRun is the latest for the ReplicationTask. The status is either true or false.

      Returns:
      Indicates that the following PreflightAssessmentRun is the latest for the ReplicationTask. The status is either true or false.

    • resultStatistic

      public final ReplicationTaskAssessmentRunResultStatistic resultStatistic()

      Result statistics for a completed assessment run, showing aggregated statistics of IndividualAssessments for how many assessments were passed, failed, or encountered issues such as errors or warnings.

      Returns:
      Result statistics for a completed assessment run, showing aggregated statistics of IndividualAssessments for how many assessments were passed, failed, or encountered issues such as errors or warnings.

    • toBuilder

      public ReplicationTaskAssessmentRun.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ReplicationTaskAssessmentRun.Builder,ReplicationTaskAssessmentRun>

    • builder

      public static ReplicationTaskAssessmentRun.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ReplicationTaskAssessmentRun.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo