Interface MigrationSummary.Builder

  • Method Details

    • migrationId

      MigrationSummary.Builder migrationId(String migrationId)

      The ID of the migration.

      Parameters:
      migrationId - The ID of the migration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tableBucketARN

      MigrationSummary.Builder tableBucketARN(String tableBucketARN)

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

      Parameters:
      tableBucketARN - The Amazon Resource Name (ARN) of the table bucket that contains the destination table.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • namespace

      MigrationSummary.Builder namespace(String namespace)

      The namespace of the destination table.

      Parameters:
      namespace - The namespace of the destination table.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tableARN

      MigrationSummary.Builder tableARN(String tableARN)

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

      Parameters:
      tableARN - The Amazon Resource Name (ARN) of the destination table, once the migration creates it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • name

      The name of the destination table.

      Parameters:
      name - The name of the destination table.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • type

      The type of the migration. Valid values:

      • start - A migration that StartTableMigration started.

      • sync - A migration that SyncTableMigration started.

      Parameters:
      type - The type of the migration. Valid values:

      • start - A migration that StartTableMigration started.

      • sync - A migration that SyncTableMigration started.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • type

      The type of the migration. Valid values:

      • start - A migration that StartTableMigration started.

      • sync - A migration that SyncTableMigration started.

      Parameters:
      type - The type of the migration. Valid values:

      • start - A migration that StartTableMigration started.

      • sync - A migration that SyncTableMigration started.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • hasValidPlan

      MigrationSummary.Builder hasValidPlan(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • createdAt

      MigrationSummary.Builder createdAt(Instant createdAt)

      The date and time that the migration was created.

      Parameters:
      createdAt - The date and time that the migration was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • stateUpdatedAt

      MigrationSummary.Builder stateUpdatedAt(Instant stateUpdatedAt)

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

      Parameters:
      stateUpdatedAt - The date and time that the migration's state last changed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.