Class PremigrationAssessmentStatus
- java.lang.Object
-
- software.amazon.awssdk.services.databasemigration.model.PremigrationAssessmentStatus
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<PremigrationAssessmentStatus.Builder,PremigrationAssessmentStatus>
@Generated("software.amazon.awssdk:codegen") public final class PremigrationAssessmentStatus extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PremigrationAssessmentStatus.Builder,PremigrationAssessmentStatus>
The results returned in
describe-replicationsto display the results of the premigration assessment from the replication configuration.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePremigrationAssessmentStatus.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ReplicationTaskAssessmentRunProgressassessmentProgress()Returns the value of the AssessmentProgress property for this object.static PremigrationAssessmentStatus.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)BooleanfailOnAssessmentFailure()A configurable setting you can set totrue(the defualt setting) orfalse.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringlastFailureMessage()The last message generated by an individual assessment failure.StringpremigrationAssessmentRunArn()The Amazon Resource Name (ARN) of this assessment run.InstantpremigrationAssessmentRunCreationDate()The date which the assessment run was created.StringresultEncryptionMode()The supported values areSSE_KMSandSSE_S3.StringresultKmsKeyArn()The ARN of a custom KMS encryption key that you specify when you setResultEncryptionModetoSSE_KMS.StringresultLocationBucket()The Amazon S3 bucket that Database Migration Service Serverless created to store the results of this assessment run.StringresultLocationFolder()The folder within an Amazon S3 bucket where you want Database Migration Service to store the results of this assessment run.ReplicationTaskAssessmentRunResultStatisticresultStatistic()Returns the value of the ResultStatistic property for this object.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends PremigrationAssessmentStatus.Builder>serializableBuilderClass()Stringstatus()This describes the assessment run status.PremigrationAssessmentStatus.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
-
premigrationAssessmentRunArn
public final String premigrationAssessmentRunArn()
The Amazon Resource Name (ARN) of this assessment run.
- Returns:
- The Amazon Resource Name (ARN) of this assessment run.
-
failOnAssessmentFailure
public final Boolean failOnAssessmentFailure()
A configurable setting you can set to
true(the defualt setting) orfalse. Use this setting to to stop the replication from starting automatically if the assessment fails. This can help you evaluate the issue that is preventing the replication from running successfully.- Returns:
- A configurable setting you can set to
true(the defualt setting) orfalse. Use this setting to to stop the replication from starting automatically if the assessment fails. This can help you evaluate the issue that is preventing the replication from running successfully.
-
status
public final String status()
This describes the assessment run status. The status can be one of the following values:
-
cancelling: The assessment run was canceled. -
deleting: The assessment run was deleted. -
failed: At least one individual assessment completed with a failed status. -
error-provisioning: An internal error occurred while resources were provisioned (during theprovisioningstatus). -
error-executingAn internal error occurred while individual assessments ran (during therunningstatus). -
invalid state: The assessment run is in an unknown state. -
passed: All individual assessments have completed and none have a failed status. -
provisioning: The 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.
- Returns:
- This describes the assessment run status. The status can be one of the following values:
-
cancelling: The assessment run was canceled. -
deleting: The assessment run was deleted. -
failed: At least one individual assessment completed with a failed status. -
error-provisioning: An internal error occurred while resources were provisioned (during theprovisioningstatus). -
error-executingAn internal error occurred while individual assessments ran (during therunningstatus). -
invalid state: The assessment run is in an unknown state. -
passed: All individual assessments have completed and none have a failed status. -
provisioning: The 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.
-
-
-
premigrationAssessmentRunCreationDate
public final Instant premigrationAssessmentRunCreationDate()
The date which the assessment run was created.
- Returns:
- The date which the assessment run was created.
-
assessmentProgress
public final ReplicationTaskAssessmentRunProgress assessmentProgress()
Returns the value of the AssessmentProgress property for this object.- Returns:
- The value of the AssessmentProgress property for this object.
-
lastFailureMessage
public final String lastFailureMessage()
The last message generated by an individual assessment failure.
- Returns:
- The last message generated by an individual assessment failure.
-
resultLocationBucket
public final String resultLocationBucket()
The Amazon S3 bucket that Database Migration Service Serverless created to store the results of this assessment run.
- Returns:
- The Amazon S3 bucket that Database Migration Service Serverless created to store the results of this assessment run.
-
resultLocationFolder
public final String resultLocationFolder()
The folder within an Amazon S3 bucket where you want Database Migration Service to store the results of this assessment run.
- Returns:
- The folder within an Amazon S3 bucket where you want Database Migration Service to store the results of this assessment run.
-
resultEncryptionMode
public final String resultEncryptionMode()
The supported values are
SSE_KMSandSSE_S3. If these values are not provided, then the files are not encrypted at rest. For more information, see Creating Amazon Web Services KMS keys to encrypt Amazon S3 target objects.- Returns:
- The supported values are
SSE_KMSandSSE_S3. If these values are not provided, then the files are not encrypted at rest. For more information, see Creating Amazon Web Services KMS keys to encrypt Amazon S3 target objects.
-
resultKmsKeyArn
public final String resultKmsKeyArn()
The ARN of a custom KMS encryption key that you specify when you set
ResultEncryptionModetoSSE_KMS.- Returns:
- The ARN of a custom KMS encryption key that you specify when you set
ResultEncryptionModetoSSE_KMS.
-
resultStatistic
public final ReplicationTaskAssessmentRunResultStatistic resultStatistic()
Returns the value of the ResultStatistic property for this object.- Returns:
- The value of the ResultStatistic property for this object.
-
toBuilder
public PremigrationAssessmentStatus.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<PremigrationAssessmentStatus.Builder,PremigrationAssessmentStatus>
-
builder
public static PremigrationAssessmentStatus.Builder builder()
-
serializableBuilderClass
public static Class<? extends PremigrationAssessmentStatus.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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-