Class MigrationSummary

java.lang.Object
software.amazon.awssdk.services.opensearch.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 job, including its status and progress.

See Also:

  • Method Details

    • migrationId

      public final String migrationId()

      The unique identifier of the migration job.

      Returns:
      The unique identifier of the migration job.

    • status

      public final String status()

      The current status of the migration job.

      Returns:
      The current status of the migration job.

    • applicationId

      public final String applicationId()

      The unique identifier of the OpenSearch application associated with the migration.

      Returns:
      The unique identifier of the OpenSearch application associated with the migration.

    • source

      public final MigrationSource source()

      The source configuration for the migration.

      Returns:
      The source configuration for the migration.

    • exportedCount

      public final Integer exportedCount()

      The number of saved objects exported from the source data source.

      Returns:
      The number of saved objects exported from the source data source.

    • importedCount

      public final Integer importedCount()

      The number of saved objects successfully imported into the target workspace.

      Returns:
      The number of saved objects successfully imported into the target workspace.

    • error

      public final MigrationError error()

      Error details if the migration failed or completed with errors.

      Returns:
      Error details if the migration failed or completed with errors.

    • createdAt

      public final Instant createdAt()

      The date and time when the migration job was created.

      Returns:
      The date and time when the migration job was created.

    • updatedAt

      public final Instant updatedAt()

      The date and time when the migration job was last updated.

      Returns:
      The date and time when the migration job was last updated.

    • 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.