Class CreateDataMigrationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest
software.amazon.awssdk.services.databasemigration.model.CreateDataMigrationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateDataMigrationRequest.Builder,CreateDataMigrationRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDataMigrationRequest extends DatabaseMigrationRequest implements ToCopyableBuilder<CreateDataMigrationRequest.Builder,CreateDataMigrationRequest>

  • Method Details

    • dataMigrationName

      public final String dataMigrationName()

      A user-friendly name for the data migration. Data migration names have the following constraints:

      • Must begin with a letter, and can only contain ASCII letters, digits, and hyphens.

      • Can't end with a hyphen or contain two consecutive hyphens.

      • Length must be from 1 to 255 characters.

      Returns:
      A user-friendly name for the data migration. Data migration names have the following constraints:

      • Must begin with a letter, and can only contain ASCII letters, digits, and hyphens.

      • Can't end with a hyphen or contain two consecutive hyphens.

      • Length must be from 1 to 255 characters.

    • migrationProjectIdentifier

      public final String migrationProjectIdentifier()

      An identifier for the migration project.

      Returns:
      An identifier for the migration project.

    • dataMigrationType

      public final MigrationTypeValue dataMigrationType()

      Specifies if 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 if 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 if 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 if the data migration is full-load only, change data capture (CDC) only, or full-load and CDC.
      See Also:

    • serviceAccessRoleArn

      public final String serviceAccessRoleArn()

      The Amazon Resource Name (ARN) for the service access role that you want to use to create the data migration.

      Returns:
      The Amazon Resource Name (ARN) for the service access role that you want to use to create the data migration.

    • enableCloudwatchLogs

      public final Boolean enableCloudwatchLogs()

      Specifies whether to enable CloudWatch logs for the data migration.

      Returns:
      Specifies whether to enable CloudWatch logs 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 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 source data provider.

    • numberOfJobs

      public final Integer numberOfJobs()

      The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.

      Returns:
      The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      One or more tags to be assigned to 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 hasTags() method.

      Returns:
      One or more tags to be assigned to the data migration.

    • selectionRules

      public final String selectionRules()

      An optional JSON string specifying what tables, views, and schemas to include or exclude from the migration.

      Returns:
      An optional JSON string specifying what tables, views, and schemas to include or exclude from the migration.

    • toBuilder

      public CreateDataMigrationRequest.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<CreateDataMigrationRequest.Builder,CreateDataMigrationRequest>
      Specified by:
      toBuilder in class DatabaseMigrationRequest
      Returns:
      a builder for type T

    • builder

      public static CreateDataMigrationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateDataMigrationRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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