Class GetMigrationResponse

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

  • Method Details

    • migrationId

      public final String migrationId()

      The unique identifier of the migration. This is the same as the identifier used when calling the GetMigration operation.

      Returns:
      The unique identifier of the migration. This is the same as the identifier used when calling the GetMigration operation.

    • v1BotName

      public final String v1BotName()

      The name of the Amazon Lex V1 bot migrated to Amazon Lex V2.

      Returns:
      The name of the Amazon Lex V1 bot migrated to Amazon Lex V2.

    • v1BotVersion

      public final String v1BotVersion()

      The version of the Amazon Lex V1 bot migrated to Amazon Lex V2.

      Returns:
      The version of the Amazon Lex V1 bot migrated to Amazon Lex V2.

    • v1BotLocale

      public final Locale v1BotLocale()

      The locale of the Amazon Lex V1 bot migrated to Amazon Lex V2.

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

      Returns:
      The locale of the Amazon Lex V1 bot migrated to Amazon Lex V2.
      See Also:

    • v1BotLocaleAsString

      public final String v1BotLocaleAsString()

      The locale of the Amazon Lex V1 bot migrated to Amazon Lex V2.

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

      Returns:
      The locale of the Amazon Lex V1 bot migrated to Amazon Lex V2.
      See Also:

    • v2BotId

      public final String v2BotId()

      The unique identifier of the Amazon Lex V2 bot that the Amazon Lex V1 is being migrated to.

      Returns:
      The unique identifier of the Amazon Lex V2 bot that the Amazon Lex V1 is being migrated to.

    • v2BotRole

      public final String v2BotRole()

      The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.

      Returns:
      The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.

    • migrationStatus

      public final MigrationStatus migrationStatus()

      Indicates the status of the migration. When the status is COMPLETE the migration is finished and the bot is available in Amazon Lex V2. There may be alerts and warnings that need to be resolved to complete the migration.

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

      Returns:
      Indicates the status of the migration. When the status is COMPLETE the migration is finished and the bot is available in Amazon Lex V2. There may be alerts and warnings that need to be resolved to complete the migration.
      See Also:

    • migrationStatusAsString

      public final String migrationStatusAsString()

      Indicates the status of the migration. When the status is COMPLETE the migration is finished and the bot is available in Amazon Lex V2. There may be alerts and warnings that need to be resolved to complete the migration.

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

      Returns:
      Indicates the status of the migration. When the status is COMPLETE the migration is finished and the bot is available in Amazon Lex V2. There may be alerts and warnings that need to be resolved to complete the migration.
      See Also:

    • migrationStrategy

      public final MigrationStrategy migrationStrategy()

      The strategy used to conduct the migration.

      • CREATE_NEW - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.

      • UPDATE_EXISTING - Overwrites the existing Amazon Lex V2 bot metadata and the locale being migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the locale doesn't exist, a new locale is created in the Amazon Lex V2 bot.

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

      Returns:
      The strategy used to conduct the migration.

      • CREATE_NEW - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.

      • UPDATE_EXISTING - Overwrites the existing Amazon Lex V2 bot metadata and the locale being migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the locale doesn't exist, a new locale is created in the Amazon Lex V2 bot.

      See Also:

    • migrationStrategyAsString

      public final String migrationStrategyAsString()

      The strategy used to conduct the migration.

      • CREATE_NEW - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.

      • UPDATE_EXISTING - Overwrites the existing Amazon Lex V2 bot metadata and the locale being migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the locale doesn't exist, a new locale is created in the Amazon Lex V2 bot.

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

      Returns:
      The strategy used to conduct the migration.

      • CREATE_NEW - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.

      • UPDATE_EXISTING - Overwrites the existing Amazon Lex V2 bot metadata and the locale being migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the locale doesn't exist, a new locale is created in the Amazon Lex V2 bot.

      See Also:

    • migrationTimestamp

      public final Instant migrationTimestamp()

      The date and time that the migration started.

      Returns:
      The date and time that the migration started.

    • hasAlerts

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

    • alerts

      public final List<MigrationAlert> alerts()

      A list of alerts and warnings that indicate issues with the migration for the Amazon Lex V1 bot to Amazon Lex V2. You receive a warning when an Amazon Lex V1 feature has a different implementation if Amazon Lex V2.

      For more information, see Migrating a bot in the Amazon Lex V2 developer guide.

      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 hasAlerts() method.

      Returns:
      A list of alerts and warnings that indicate issues with the migration for the Amazon Lex V1 bot to Amazon Lex V2. You receive a warning when an Amazon Lex V1 feature has a different implementation if Amazon Lex V2.

      For more information, see Migrating a bot in the Amazon Lex V2 developer guide.

    • toBuilder

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

    • builder

      public static GetMigrationResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.