Package software.amazon.awssdk.services.lexmodelsv2.model

Class UpdateIntentRequest

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

  • Method Details

    • intentId

      public final String intentId()

      The unique identifier of the intent to update.

      Returns:
      The unique identifier of the intent to update.

    • intentName

      public final String intentName()

      The new name for the intent.

      Returns:
      The new name for the intent.

    • description

      public final String description()

      The new description of the intent.

      Returns:
      The new description of the intent.

    • parentIntentSignature

      public final String parentIntentSignature()

      The signature of the new built-in intent to use as the parent of this intent.

      Returns:
      The signature of the new built-in intent to use as the parent of this intent.

    • hasSampleUtterances

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

    • sampleUtterances

      public final List<SampleUtterance> sampleUtterances()

      New utterances used to invoke the intent.

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

      Returns:
      New utterances used to invoke the intent.

    • dialogCodeHook

      public final DialogCodeHookSettings dialogCodeHook()

      The new Lambda function to use between each turn of the conversation with the bot.

      Returns:
      The new Lambda function to use between each turn of the conversation with the bot.

    • fulfillmentCodeHook

      public final FulfillmentCodeHookSettings fulfillmentCodeHook()

      The new Lambda function to call when all of the intents required slots are provided and the intent is ready for fulfillment.

      Returns:
      The new Lambda function to call when all of the intents required slots are provided and the intent is ready for fulfillment.

    • hasSlotPriorities

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

    • slotPriorities

      public final List<SlotPriority> slotPriorities()

      A new list of slots and their priorities that are contained by the intent.

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

      Returns:
      A new list of slots and their priorities that are contained by the intent.

    • intentConfirmationSetting

      public final IntentConfirmationSetting intentConfirmationSetting()

      New prompts that Amazon Lex sends to the user to confirm the completion of an intent.

      Returns:
      New prompts that Amazon Lex sends to the user to confirm the completion of an intent.

    • intentClosingSetting

      public final IntentClosingSetting intentClosingSetting()

      The new response that Amazon Lex sends the user when the intent is closed.

      Returns:
      The new response that Amazon Lex sends the user when the intent is closed.

    • hasInputContexts

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

    • inputContexts

      public final List<InputContext> inputContexts()

      A new list of contexts that must be active in order for Amazon Lex to consider the intent.

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

      Returns:
      A new list of contexts that must be active in order for Amazon Lex to consider the intent.

    • hasOutputContexts

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

    • outputContexts

      public final List<OutputContext> outputContexts()

      A new list of contexts that Amazon Lex activates when the intent is fulfilled.

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

      Returns:
      A new list of contexts that Amazon Lex activates when the intent is fulfilled.

    • kendraConfiguration

      public final KendraConfiguration kendraConfiguration()

      New configuration settings for connecting to an Amazon Kendra index.

      Returns:
      New configuration settings for connecting to an Amazon Kendra index.

    • botId

      public final String botId()

      The identifier of the bot that contains the intent.

      Returns:
      The identifier of the bot that contains the intent.

    • botVersion

      public final String botVersion()

      The version of the bot that contains the intent. Must be DRAFT.

      Returns:
      The version of the bot that contains the intent. Must be DRAFT.

    • localeId

      public final String localeId()

      The identifier of the language and locale where this intent is used. The string must match one of the supported locales. For more information, see Supported languages.

      Returns:
      The identifier of the language and locale where this intent is used. The string must match one of the supported locales. For more information, see Supported languages.

    • initialResponseSetting

      public final InitialResponseSetting initialResponseSetting()

      Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.

      Returns:
      Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.

    • qnAIntentConfiguration

      public final QnAIntentConfiguration qnAIntentConfiguration()

      Specifies the configuration of the built-in Amazon.QnAIntent. The AMAZON.QnAIntent intent is called when Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the kendraConfiguration field.

      Returns:
      Specifies the configuration of the built-in Amazon.QnAIntent. The AMAZON.QnAIntent intent is called when Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify the kendraConfiguration field.

    • toBuilder

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

    • builder

      public static UpdateIntentRequest.Builder builder()

    • serializableBuilderClass

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