Package software.amazon.awssdk.services.lexmodelbuilding.model

Class GetIntentResponse

    • Method Detail

      • name

        public final String name()

        The name of the intent.

        Returns:
        The name of the intent.

      • description

        public final String description()

        A description of the intent.

        Returns:
        A description of the intent.

      • hasSlots

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

      • slots

        public final List<Slot> slots()

        An array of intent slots configured for 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 hasSlots() method.

        Returns:
        An array of intent slots configured for the 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<String> sampleUtterances()

        An array of sample utterances configured for 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:
        An array of sample utterances configured for the intent.

      • confirmationPrompt

        public final Prompt confirmationPrompt()

        If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see PutIntent.

        Returns:
        If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see PutIntent.

      • rejectionStatement

        public final Statement rejectionStatement()

        If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

        Returns:
        If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

      • followUpPrompt

        public final FollowUpPrompt followUpPrompt()

        If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see PutIntent.

        Returns:
        If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see PutIntent.

      • conclusionStatement

        public final Statement conclusionStatement()

        After the Lambda function specified in the fulfillmentActivity element fulfills the intent, Amazon Lex conveys this statement to the user.

        Returns:
        After the Lambda function specified in the fulfillmentActivity element fulfills the intent, Amazon Lex conveys this statement to the user.

      • dialogCodeHook

        public final CodeHook dialogCodeHook()

        If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see PutIntent.

        Returns:
        If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see PutIntent.

      • fulfillmentActivity

        public final FulfillmentActivity fulfillmentActivity()

        Describes how the intent is fulfilled. For more information, see PutIntent.

        Returns:
        Describes how the intent is fulfilled. For more information, see PutIntent.

      • parentIntentSignature

        public final String parentIntentSignature()

        A unique identifier for a built-in intent.

        Returns:
        A unique identifier for a built-in intent.

      • lastUpdatedDate

        public final Instant lastUpdatedDate()

        The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same.

        Returns:
        The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same.

      • createdDate

        public final Instant createdDate()

        The date that the intent was created.

        Returns:
        The date that the intent was created.

      • version

        public final String version()

        The version of the intent.

        Returns:
        The version of the intent.

      • checksum

        public final String checksum()

        Checksum of the intent.

        Returns:
        Checksum of the intent.

      • kendraConfiguration

        public final KendraConfiguration kendraConfiguration()

        Configuration information, if any, to connect to an Amazon Kendra index with the AMAZON.KendraSearchIntent intent.

        Returns:
        Configuration information, if any, to connect to an Amazon Kendra index with the AMAZON.KendraSearchIntent intent.

      • 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()

        An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

        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:
        An array of InputContext objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

      • 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()

        An array of OutputContext objects that lists the contexts that the intent 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:
        An array of OutputContext objects that lists the contexts that the intent activates when the intent is fulfilled.

      • 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