Class DescribeBotResourceGenerationResponse

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

  • Method Details

    • botId

      public final String botId()

      The unique identifier of the bot for which the generation request was made.

      Returns:
      The unique identifier of the bot for which the generation request was made.

    • botVersion

      public final String botVersion()

      The version of the bot for which the generation request was made.

      Returns:
      The version of the bot for which the generation request was made.

    • localeId

      public final String localeId()

      The locale of the bot for which the generation request was made.

      Returns:
      The locale of the bot for which the generation request was made.

    • generationId

      public final String generationId()

      The generation ID for which to return the generation details.

      Returns:
      The generation ID for which to return the generation details.

    • hasFailureReasons

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

    • failureReasons

      public final List<String> failureReasons()

      A list of reasons why the generation of bot resources through natural language description failed.

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

      Returns:
      A list of reasons why the generation of bot resources through natural language description failed.

    • generationStatus

      public final GenerationStatus generationStatus()

      The status of the generation request.

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

      Returns:
      The status of the generation request.
      See Also:

    • generationStatusAsString

      public final String generationStatusAsString()

      The status of the generation request.

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

      Returns:
      The status of the generation request.
      See Also:

    • generationInputPrompt

      public final String generationInputPrompt()

      The prompt used in the generation request.

      Returns:
      The prompt used in the generation request.

    • generatedBotLocaleUrl

      public final String generatedBotLocaleUrl()

      The Amazon S3 location of the generated bot locale configuration.

      Returns:
      The Amazon S3 location of the generated bot locale configuration.

    • creationDateTime

      public final Instant creationDateTime()

      The date and time at which the item was generated.

      Returns:
      The date and time at which the item was generated.

    • modelArn

      public final String modelArn()

      The ARN of the model used to generate the bot resources.

      Returns:
      The ARN of the model used to generate the bot resources.

    • lastUpdatedDateTime

      public final Instant lastUpdatedDateTime()

      The date and time at which the generated item was updated.

      Returns:
      The date and time at which the generated item was updated.

    • toBuilder

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

    • builder

      public static DescribeBotResourceGenerationResponse.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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