Class DataMigration

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

This object provides information about a DMS data migration.

See Also:

  • Method Details

    • dataMigrationName

      public final String dataMigrationName()

      The user-friendly name for the data migration.

      Returns:
      The user-friendly name for the data migration.

    • dataMigrationArn

      public final String dataMigrationArn()

      The Amazon Resource Name (ARN) that identifies this replication.

      Returns:
      The Amazon Resource Name (ARN) that identifies this replication.

    • dataMigrationCreateTime

      public final Instant dataMigrationCreateTime()

      The UTC time when DMS created the data migration.

      Returns:
      The UTC time when DMS created the data migration.

    • dataMigrationStartTime

      public final Instant dataMigrationStartTime()

      The UTC time when DMS started the data migration.

      Returns:
      The UTC time when DMS started the data migration.

    • dataMigrationEndTime

      public final Instant dataMigrationEndTime()

      The UTC time when data migration ended.

      Returns:
      The UTC time when data migration ended.

    • serviceAccessRoleArn

      public final String serviceAccessRoleArn()

      The IAM role that the data migration uses to access Amazon Web Services resources.

      Returns:
      The IAM role that the data migration uses to access Amazon Web Services resources.

    • migrationProjectArn

      public final String migrationProjectArn()

      The Amazon Resource Name (ARN) of the data migration's associated migration project.

      Returns:
      The Amazon Resource Name (ARN) of the data migration's associated migration project.

    • dataMigrationType

      public final MigrationTypeValue dataMigrationType()

      Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.

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

      Returns:
      Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.
      See Also:

    • dataMigrationTypeAsString

      public final String dataMigrationTypeAsString()

      Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.

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

      Returns:
      Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.
      See Also:

    • dataMigrationSettings

      public final DataMigrationSettings dataMigrationSettings()

      Specifies CloudWatch settings and selection rules for the data migration.

      Returns:
      Specifies CloudWatch settings and selection rules for the data migration.

    • hasSourceDataSettings

      public final boolean hasSourceDataSettings()
      For responses, this returns true if the service returned a value for the SourceDataSettings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • sourceDataSettings

      public final List<SourceDataSetting> sourceDataSettings()

      Specifies information about the data migration's source data provider.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSourceDataSettings() method.

      Returns:
      Specifies information about the data migration's source data provider.

    • dataMigrationStatistics

      public final DataMigrationStatistics dataMigrationStatistics()

      Provides information about the data migration's run, including start and stop time, latency, and data migration progress.

      Returns:
      Provides information about the data migration's run, including start and stop time, latency, and data migration progress.

    • dataMigrationStatus

      public final String dataMigrationStatus()

      The current status of the data migration.

      Returns:
      The current status of the data migration.

    • hasPublicIpAddresses

      public final boolean hasPublicIpAddresses()
      For responses, this returns true if the service returned a value for the PublicIpAddresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • publicIpAddresses

      public final List<String> publicIpAddresses()

      The IP addresses of the endpoints for the data migration.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPublicIpAddresses() method.

      Returns:
      The IP addresses of the endpoints for the data migration.

    • lastFailureMessage

      public final String lastFailureMessage()

      Information about the data migration's most recent error or failure.

      Returns:
      Information about the data migration's most recent error or failure.

    • stopReason

      public final String stopReason()

      The reason the data migration last stopped.

      Returns:
      The reason the data migration last stopped.

    • toBuilder

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

    • builder

      public static DataMigration.Builder builder()

    • serializableBuilderClass

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