Class StartMetadataModelExportAsScriptRequest

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.StartMetadataModelExportAsScriptRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartMetadataModelExportAsScriptRequest.Builder,StartMetadataModelExportAsScriptRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartMetadataModelExportAsScriptRequest extends DatabaseMigrationRequest implements ToCopyableBuilder<StartMetadataModelExportAsScriptRequest.Builder,StartMetadataModelExportAsScriptRequest>

  • Method Details

    • migrationProjectIdentifier

      public final String migrationProjectIdentifier()

      The migration project name or Amazon Resource Name (ARN).

      Returns:
      The migration project name or Amazon Resource Name (ARN).

    • selectionRules

      public final String selectionRules()

      A JSON string that identifies the metadata models to export as a SQL script. For the selection rule format and examples, see Selection rules in DMS Schema Conversion.

      Usage:

      • Accepts source or target selection rules depending on the Origin parameter. The server-name in the object locator must match the corresponding data provider.

      • Supports explicit, include, and exclude rule actions.

      Returns:
      A JSON string that identifies the metadata models to export as a SQL script. For the selection rule format and examples, see Selection rules in DMS Schema Conversion.

      Usage:

      • Accepts source or target selection rules depending on the Origin parameter. The server-name in the object locator must match the corresponding data provider.

      • Supports explicit, include, and exclude rule actions.

    • origin

      public final OriginTypeValue origin()

      Specifies the metadata tree to export from.

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

      Returns:
      Specifies the metadata tree to export from.
      See Also:

    • originAsString

      public final String originAsString()

      Specifies the metadata tree to export from.

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

      Returns:
      Specifies the metadata tree to export from.
      See Also:

    • fileName

      public final String fileName()

      The name for the exported file. When you omit this parameter, the service generates a name from the data provider engine name and an export timestamp.

      Returns:
      The name for the exported file. When you omit this parameter, the service generates a name from the data provider engine name and an export timestamp.

    • toBuilder

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

    • builder

      public static StartMetadataModelExportAsScriptRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.