Class GetMigrationsRequest

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

  • Method Details

    • sortByAttribute

      public final MigrationSortAttribute sortByAttribute()

      The field to sort the list of migrations by. You can sort by the Amazon Lex V1 bot name or the date and time that the migration was started.

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

      Returns:
      The field to sort the list of migrations by. You can sort by the Amazon Lex V1 bot name or the date and time that the migration was started.
      See Also:

    • sortByAttributeAsString

      public final String sortByAttributeAsString()

      The field to sort the list of migrations by. You can sort by the Amazon Lex V1 bot name or the date and time that the migration was started.

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

      Returns:
      The field to sort the list of migrations by. You can sort by the Amazon Lex V1 bot name or the date and time that the migration was started.
      See Also:

    • sortByOrder

      public final SortOrder sortByOrder()

      The order so sort the list.

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

      Returns:
      The order so sort the list.
      See Also:

    • sortByOrderAsString

      public final String sortByOrderAsString()

      The order so sort the list.

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

      Returns:
      The order so sort the list.
      See Also:

    • v1BotNameContains

      public final String v1BotNameContains()

      Filters the list to contain only bots whose name contains the specified string. The string is matched anywhere in bot name.

      Returns:
      Filters the list to contain only bots whose name contains the specified string. The string is matched anywhere in bot name.

    • migrationStatusEquals

      public final MigrationStatus migrationStatusEquals()

      Filters the list to contain only migrations in the specified state.

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

      Returns:
      Filters the list to contain only migrations in the specified state.
      See Also:

    • migrationStatusEqualsAsString

      public final String migrationStatusEqualsAsString()

      Filters the list to contain only migrations in the specified state.

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

      Returns:
      Filters the list to contain only migrations in the specified state.
      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of migrations to return in the response. The default is 10.

      Returns:
      The maximum number of migrations to return in the response. The default is 10.

    • nextToken

      public final String nextToken()

      A pagination token that fetches the next page of migrations. If the response to this operation is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of migrations, specify the pagination token in the request.

      Returns:
      A pagination token that fetches the next page of migrations. If the response to this operation is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of migrations, specify the pagination token in the request.

    • toBuilder

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

    • builder

      public static GetMigrationsRequest.Builder builder()

    • serializableBuilderClass

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