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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDataMigration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DataMigration.Builderbuilder()StringdataMigrationArn()The Amazon Resource Name (ARN) that identifies this replication.List<String>dataMigrationCidrBlocks()The CIDR blocks of the endpoints for the data migration.InstantdataMigrationCreateTime()The UTC time when DMS created the data migration.InstantdataMigrationEndTime()The UTC time when data migration ended.StringdataMigrationName()The user-friendly name for the data migration.DataMigrationSettingsdataMigrationSettings()Specifies CloudWatch settings and selection rules for the data migration.InstantdataMigrationStartTime()The UTC time when DMS started the data migration.DataMigrationStatisticsdataMigrationStatistics()Provides information about the data migration's run, including start and stop time, latency, and data migration progress.StringdataMigrationStatus()The current status of the data migration.MigrationTypeValuedataMigrationType()Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.StringdataMigrationTypeAsString()Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasDataMigrationCidrBlocks()For responses, this returns true if the service returned a value for the DataMigrationCidrBlocks property.inthashCode()booleanhasPublicIpAddresses()For responses, this returns true if the service returned a value for the PublicIpAddresses property.booleanhasSourceDataSettings()For responses, this returns true if the service returned a value for the SourceDataSettings property.booleanhasTargetDataSettings()For responses, this returns true if the service returned a value for the TargetDataSettings property.StringlastFailureMessage()Information about the data migration's most recent error or failure.StringmigrationProjectArn()The Amazon Resource Name (ARN) of the data migration's associated migration project.List<String>publicIpAddresses()The IP addresses of the endpoints for the data migration.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends DataMigration.Builder>serializableBuilderClass()StringserviceAccessRoleArn()The IAM role that the data migration uses to access Amazon Web Services resources.List<SourceDataSetting>sourceDataSettings()Specifies information about the data migration's source data provider.StringstopReason()The reason the data migration last stopped.List<TargetDataSetting>targetDataSettings()Specifies information about the data migration's target data provider.DataMigration.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
-
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,
dataMigrationTypewill returnMigrationTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdataMigrationTypeAsString().- Returns:
- Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.
- See Also:
MigrationTypeValue
-
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,
dataMigrationTypewill returnMigrationTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdataMigrationTypeAsString().- Returns:
- Specifies whether the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.
- See Also:
MigrationTypeValue
-
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 theisEmpty()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.
-
hasTargetDataSettings
public final boolean hasTargetDataSettings()
For responses, this returns true if the service returned a value for the TargetDataSettings property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
targetDataSettings
public final List<TargetDataSetting> targetDataSettings()
Specifies information about the data migration's target 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
hasTargetDataSettings()method.- Returns:
- Specifies information about the data migration's target 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 theisEmpty()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.
-
hasDataMigrationCidrBlocks
public final boolean hasDataMigrationCidrBlocks()
For responses, this returns true if the service returned a value for the DataMigrationCidrBlocks property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
dataMigrationCidrBlocks
public final List<String> dataMigrationCidrBlocks()
The CIDR blocks 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
hasDataMigrationCidrBlocks()method.- Returns:
- The CIDR blocks 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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DataMigration.Builder,DataMigration>
-
builder
public static DataMigration.Builder builder()
-
serializableBuilderClass
public static Class<? extends DataMigration.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
-
-