software.amazon.awscdk.services.lex

Interface CfnBot.FulfillmentUpdateResponseSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBot.FulfillmentUpdateResponseSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnBot

@Stability(value=Stable)
public static interface CfnBot.FulfillmentUpdateResponseSpecificationProperty
extends software.amazon.jsii.JsiiSerializable

Provides information for updating the user on the progress of fulfilling an intent.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lex.*;
 FulfillmentUpdateResponseSpecificationProperty fulfillmentUpdateResponseSpecificationProperty = FulfillmentUpdateResponseSpecificationProperty.builder()
         .frequencyInSeconds(123)
         .messageGroups(List.of(MessageGroupProperty.builder()
                 .message(MessageProperty.builder()
                         .customPayload(CustomPayloadProperty.builder()
                                 .value("value")
                                 .build())
                         .imageResponseCard(ImageResponseCardProperty.builder()
                                 .title("title")
                                 // the properties below are optional
                                 .buttons(List.of(ButtonProperty.builder()
                                         .text("text")
                                         .value("value")
                                         .build()))
                                 .imageUrl("imageUrl")
                                 .subtitle("subtitle")
                                 .build())
                         .plainTextMessage(PlainTextMessageProperty.builder()
                                 .value("value")
                                 .build())
                         .ssmlMessage(SSMLMessageProperty.builder()
                                 .value("value")
                                 .build())
                         .build())
                 // the properties below are optional
                 .variations(List.of(MessageProperty.builder()
                         .customPayload(CustomPayloadProperty.builder()
                                 .value("value")
                                 .build())
                         .imageResponseCard(ImageResponseCardProperty.builder()
                                 .title("title")
                                 // the properties below are optional
                                 .buttons(List.of(ButtonProperty.builder()
                                         .text("text")
                                         .value("value")
                                         .build()))
                                 .imageUrl("imageUrl")
                                 .subtitle("subtitle")
                                 .build())
                         .plainTextMessage(PlainTextMessageProperty.builder()
                                 .value("value")
                                 .build())
                         .ssmlMessage(SSMLMessageProperty.builder()
                                 .value("value")
                                 .build())
                         .build()))
                 .build()))
         // the properties below are optional
         .allowInterrupt(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnBot.FulfillmentUpdateResponseSpecificationProperty.Builder A builder for CfnBot.FulfillmentUpdateResponseSpecificationProperty
static class	CfnBot.FulfillmentUpdateResponseSpecificationProperty.Jsii$Proxy An implementation for CfnBot.FulfillmentUpdateResponseSpecificationProperty

Method Summary

Modifier and Type	Method and Description
static CfnBot.FulfillmentUpdateResponseSpecificationProperty.Builder	builder()
default Object	getAllowInterrupt() Determines whether the user can interrupt an update message while it is playing.
Number	getFrequencyInSeconds() The frequency that a message is sent to the user.
Object	getMessageGroups() One to 5 message groups that contain update messages.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFrequencyInSeconds

@Stability(value=Stable)
 @NotNull
Number getFrequencyInSeconds()

The frequency that a message is sent to the user.

When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda function returns before the first period ends, an update message is not played to the user.

getMessageGroups

@Stability(value=Stable)
 @NotNull
Object getMessageGroups()

One to 5 message groups that contain update messages.

Amazon Lex chooses one of the messages to play to the user.

getAllowInterrupt

@Stability(value=Stable)
 @Nullable
default Object getAllowInterrupt()

Determines whether the user can interrupt an update message while it is playing.

builder

@Stability(value=Stable)
static CfnBot.FulfillmentUpdateResponseSpecificationProperty.Builder builder()

Returns:

a CfnBot.FulfillmentUpdateResponseSpecificationProperty.Builder of CfnBot.FulfillmentUpdateResponseSpecificationProperty