Class DescribeMetadataModelChildrenRequest

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

  • Method Details

    • selectionRules

      public final String selectionRules()

      The JSON string that specifies which metadata model's children to retrieve. Only one selection rule with "rule-action": "explicit" can be provided. For more information, see Selection Rules in the DMS User Guide.

      Returns:
      The JSON string that specifies which metadata model's children to retrieve. Only one selection rule with "rule-action": "explicit" can be provided. For more information, see Selection Rules in the DMS User Guide.

    • migrationProjectIdentifier

      public final String migrationProjectIdentifier()

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

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

    • origin

      public final OriginTypeValue origin()

      Specifies whether to retrieve metadata from the source or target tree. Valid values: SOURCE | TARGET

      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 whether to retrieve metadata from the source or target tree. Valid values: SOURCE | TARGET
      See Also:

    • originAsString

      public final String originAsString()

      Specifies whether to retrieve metadata from the source or target tree. Valid values: SOURCE | TARGET

      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 whether to retrieve metadata from the source or target tree. Valid values: SOURCE | TARGET
      See Also:

    • marker

      public final String marker()

      Specifies the unique pagination token that indicates where the next page should start. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      Returns:
      Specifies the unique pagination token that indicates where the next page should start. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • maxRecords

      public final Integer maxRecords()

      The maximum number of metadata model children to include in the response. If more items exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

      Returns:
      The maximum number of metadata model children to include in the response. If more items exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    • toBuilder

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

    • builder

      public static DescribeMetadataModelChildrenRequest.Builder builder()

    • serializableBuilderClass

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