Class ListTableMigrationsRequest

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

  • Method Details

    • tableBucketARN

      public final String tableBucketARN()

      The Amazon Resource Name (ARN) of the table bucket to list migrations for.

      Returns:
      The Amazon Resource Name (ARN) of the table bucket to list migrations for.

    • namespace

      public final String namespace()

      The namespace to list migrations for. Requires tableBucketARN.

      Returns:
      The namespace to list migrations for. Requires tableBucketARN.

    • name

      public final String name()

      The name of the table to list migrations for. Requires tableBucketARN and namespace.

      Returns:
      The name of the table to list migrations for. Requires tableBucketARN and namespace.

    • tableARN

      public final String tableARN()

      The Amazon Resource Name (ARN) of the table to list migrations for. The list includes the migrations into this table. To also list migrations into an earlier table of the same name, specify tableBucketARN, namespace and name instead. Specify either tableARN or tableBucketARN, not both.

      Returns:
      The Amazon Resource Name (ARN) of the table to list migrations for. The list includes the migrations into this table. To also list migrations into an earlier table of the same name, specify tableBucketARN, namespace and name instead. Specify either tableARN or tableBucketARN, not both.

    • state

      public final MigrationState state()

      The state to filter the list by. For the valid values, see the state member of GetTableMigration.

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

      Returns:
      The state to filter the list by. For the valid values, see the state member of GetTableMigration.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state to filter the list by. For the valid values, see the state member of GetTableMigration.

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

      Returns:
      The state to filter the list by. For the valid values, see the state member of GetTableMigration.
      See Also:

    • hasValidPlan

      public final Boolean hasValidPlan()

      The hasValidPlan value to filter the list by. Migrations that are still planning aren't listed, whichever value you specify.

      Returns:
      The hasValidPlan value to filter the list by. Migrations that are still planning aren't listed, whichever value you specify.

    • maxResults

      public final Integer maxResults()

      The maximum number of migrations to return, from 1 to 1,000. If you don't specify a value, the default is 100.

      Returns:
      The maximum number of migrations to return, from 1 to 1,000. If you don't specify a value, the default is 100.

    • nextToken

      public final String nextToken()

      The nextToken from a previous response, to get the next page of results.

      Returns:
      The nextToken from a previous response, to get the next page of results.

    • toBuilder

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

    • builder

      public static ListTableMigrationsRequest.Builder builder()

    • serializableBuilderClass

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