Class FulfillmentActivity

java.lang.Object
software.amazon.awssdk.services.lexmodelbuilding.model.FulfillmentActivity
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FulfillmentActivity.Builder,FulfillmentActivity>
@Generated("software.amazon.awssdk:codegen") public final class FulfillmentActivity extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FulfillmentActivity.Builder,FulfillmentActivity>

Describes how the intent is fulfilled after the user provides all of the information required for the intent. You can provide a Lambda function to process the intent, or you can return the intent information to the client application. We recommend that you use a Lambda function so that the relevant logic lives in the Cloud and limit the client-side code primarily to presentation. If you need to update the logic, you only update the Lambda function; you don't need to upgrade your client application.

Consider the following examples:

  • In a pizza ordering application, after the user provides all of the information for placing an order, you use a Lambda function to place an order with a pizzeria.

  • In a gaming application, when a user says "pick up a rock," this information must go back to the client application so that it can perform the operation and update the graphics. In this case, you want Amazon Lex to return the intent data to the client.

See Also:

  • Method Details

    • type

      public final FulfillmentActivityType type()

      How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.

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

      Returns:
      How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.
      See Also:

    • typeAsString

      public final String typeAsString()

      How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.

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

      Returns:
      How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.
      See Also:

    • codeHook

      public final CodeHook codeHook()

      A description of the Lambda function that is run to fulfill the intent.

      Returns:
      A description of the Lambda function that is run to fulfill the intent.

    • toBuilder

      public FulfillmentActivity.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<FulfillmentActivity.Builder,FulfillmentActivity>
      Returns:
      a builder for type T

    • builder

      public static FulfillmentActivity.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

    • 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.