Class MigrationSummary

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

A summary of a migration.

See Also:

  • Method Details

    • migrationId

      public final String migrationId()

      The ID of the migration.

      Returns:
      The ID of the migration.

    • tableBucketARN

      public final String tableBucketARN()

      The Amazon Resource Name (ARN) of the table bucket that contains the destination table.

      Returns:
      The Amazon Resource Name (ARN) of the table bucket that contains the destination table.

    • namespace

      public final String namespace()

      The namespace of the destination table.

      Returns:
      The namespace of the destination table.

    • tableARN

      public final String tableARN()

      The Amazon Resource Name (ARN) of the destination table, once the migration creates it.

      Returns:
      The Amazon Resource Name (ARN) of the destination table, once the migration creates it.

    • name

      public final String name()

      The name of the destination table.

      Returns:
      The name of the destination table.

    • type

      public final MigrationType type()

      The type of the migration. Valid values:

      • start - A migration that StartTableMigration started.

      • sync - A migration that SyncTableMigration started.

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

      Returns:
      The type of the migration. Valid values:

      • start - A migration that StartTableMigration started.

      • sync - A migration that SyncTableMigration started.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the migration. Valid values:

      • start - A migration that StartTableMigration started.

      • sync - A migration that SyncTableMigration started.

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

      Returns:
      The type of the migration. Valid values:

      • start - A migration that StartTableMigration started.

      • sync - A migration that SyncTableMigration started.

      See Also:

    • state

      public final MigrationState state()

      The state of the migration. Valid values:

      • new - S3 Tables accepted the request.

      • planning - The migration is checking the source table, its objects and the destination for compatibility, and writing the compatibility reports.

      • pendingReview - Planning finished, and the migration waits for you to continue or cancel it with UpdateTableMigration.

      • queued - The migration is waiting to start migrating data.

      • migrating - The migration is running the plan from the planning state: it copies data and commits it to the destination table. A migration reaches this state only if hasValidPlan is true.

      • succeeded - Every planned object migrated.

      • failed - The migration failed. Check failureReason for the cause.

      • cancelling - You cancelled the migration, and it is finishing the work in progress.

      • cancelled - The migration is cancelled.

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

      Returns:
      The state of the migration. Valid values:

      • new - S3 Tables accepted the request.

      • planning - The migration is checking the source table, its objects and the destination for compatibility, and writing the compatibility reports.

      • pendingReview - Planning finished, and the migration waits for you to continue or cancel it with UpdateTableMigration.

      • queued - The migration is waiting to start migrating data.

      • migrating - The migration is running the plan from the planning state: it copies data and commits it to the destination table. A migration reaches this state only if hasValidPlan is true.

      • succeeded - Every planned object migrated.

      • failed - The migration failed. Check failureReason for the cause.

      • cancelling - You cancelled the migration, and it is finishing the work in progress.

      • cancelled - The migration is cancelled.

      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the migration. Valid values:

      • new - S3 Tables accepted the request.

      • planning - The migration is checking the source table, its objects and the destination for compatibility, and writing the compatibility reports.

      • pendingReview - Planning finished, and the migration waits for you to continue or cancel it with UpdateTableMigration.

      • queued - The migration is waiting to start migrating data.

      • migrating - The migration is running the plan from the planning state: it copies data and commits it to the destination table. A migration reaches this state only if hasValidPlan is true.

      • succeeded - Every planned object migrated.

      • failed - The migration failed. Check failureReason for the cause.

      • cancelling - You cancelled the migration, and it is finishing the work in progress.

      • cancelled - The migration is cancelled.

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

      Returns:
      The state of the migration. Valid values:

      • new - S3 Tables accepted the request.

      • planning - The migration is checking the source table, its objects and the destination for compatibility, and writing the compatibility reports.

      • pendingReview - Planning finished, and the migration waits for you to continue or cancel it with UpdateTableMigration.

      • queued - The migration is waiting to start migrating data.

      • migrating - The migration is running the plan from the planning state: it copies data and commits it to the destination table. A migration reaches this state only if hasValidPlan is true.

      • succeeded - Every planned object migrated.

      • failed - The migration failed. Check failureReason for the cause.

      • cancelling - You cancelled the migration, and it is finishing the work in progress.

      • cancelled - The migration is cancelled.

      See Also:

    • hasValidPlan

      public final Boolean hasValidPlan()

      A Boolean value that specifies whether planning produced a plan that the migration can run. If planning hasn't finished, this value isn't returned.

      Returns:
      A Boolean value that specifies whether planning produced a plan that the migration can run. If planning hasn't finished, this value isn't returned.

    • createdAt

      public final Instant createdAt()

      The date and time that the migration was created.

      Returns:
      The date and time that the migration was created.

    • stateUpdatedAt

      public final Instant stateUpdatedAt()

      The date and time that the migration's state last changed.

      Returns:
      The date and time that the migration's state last changed.

    • toBuilder

      public MigrationSummary.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<MigrationSummary.Builder,MigrationSummary>
      Returns:
      a builder for type T

    • builder

      public static MigrationSummary.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.