software.amazon.awssdk.services.lexruntimev2.model.TextResponseEvent Maven / Gradle / Ivy
Show all versions of lexruntimev2 Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.lexruntimev2.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The event sent from Amazon Lex V2 to your application with text to present to the user.
*
*/
@Generated("software.amazon.awssdk:codegen")
public class TextResponseEvent implements SdkPojo, Serializable, ToCopyableBuilder,
StartConversationResponseEventStream {
private static final SdkField> MESSAGES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("messages")
.getter(getter(TextResponseEvent::messages))
.setter(setter(Builder::messages))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("messages").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Message::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField EVENT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("eventId").getter(getter(TextResponseEvent::eventId)).setter(setter(Builder::eventId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("eventId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays
.asList(MESSAGES_FIELD, EVENT_ID_FIELD));
private static final long serialVersionUID = 1L;
private final List messages;
private final String eventId;
protected TextResponseEvent(BuilderImpl builder) {
this.messages = builder.messages;
this.eventId = builder.eventId;
}
/**
* For responses, this returns true if the service returned a value for the Messages property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasMessages() {
return messages != null && !(messages instanceof SdkAutoConstructList);
}
/**
*
* A list of messages to send to the user. Messages are ordered based on the order that you returned the messages
* from your Lambda function or the order that the messages are defined in the bot.
*
*
* 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 {@link #hasMessages} method.
*
*
* @return A list of messages to send to the user. Messages are ordered based on the order that you returned the
* messages from your Lambda function or the order that the messages are defined in the bot.
*/
public final List messages() {
return messages;
}
/**
*
* A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form RESPONSE-N,
* where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current
* session.
*
*
* @return A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form
* RESPONSE-N, where N is a number starting with one and incremented for each event sent by
* Amazon Lex V2 in the current session.
*/
public final String eventId() {
return eventId;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(hasMessages() ? messages() : null);
hashCode = 31 * hashCode + Objects.hashCode(eventId());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof TextResponseEvent)) {
return false;
}
TextResponseEvent other = (TextResponseEvent) obj;
return hasMessages() == other.hasMessages() && Objects.equals(messages(), other.messages())
&& Objects.equals(eventId(), other.eventId());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("TextResponseEvent").add("Messages", hasMessages() ? messages() : null).add("EventId", eventId())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "messages":
return Optional.ofNullable(clazz.cast(messages()));
case "eventId":
return Optional.ofNullable(clazz.cast(eventId()));
default:
return Optional.empty();
}
}
@Override
public final TextResponseEvent copy(Consumer modifier) {
return ToCopyableBuilder.super.copy(modifier);
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((TextResponseEvent) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
/**
* Calls the appropriate visit method depending on the subtype of {@link TextResponseEvent}.
*
* @param visitor
* Visitor to invoke.
*/
@Override
public void accept(StartConversationResponseHandler.Visitor visitor) {
throw new UnsupportedOperationException();
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A list of messages to send to the user. Messages are ordered based on the order that you returned the
* messages from your Lambda function or the order that the messages are defined in the bot.
*
*
* @param messages
* A list of messages to send to the user. Messages are ordered based on the order that you returned the
* messages from your Lambda function or the order that the messages are defined in the bot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder messages(Collection messages);
/**
*
* A list of messages to send to the user. Messages are ordered based on the order that you returned the
* messages from your Lambda function or the order that the messages are defined in the bot.
*
*
* @param messages
* A list of messages to send to the user. Messages are ordered based on the order that you returned the
* messages from your Lambda function or the order that the messages are defined in the bot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder messages(Message... messages);
/**
*
* A list of messages to send to the user. Messages are ordered based on the order that you returned the
* messages from your Lambda function or the order that the messages are defined in the bot.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.lexruntimev2.model.Message.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.lexruntimev2.model.Message#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.lexruntimev2.model.Message.Builder#build()} is called immediately and
* its result is passed to {@link #messages(List)}.
*
* @param messages
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.lexruntimev2.model.Message.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #messages(java.util.Collection)
*/
Builder messages(Consumer... messages);
/**
*
* A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form RESPONSE-N
* , where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current
* session.
*
*
* @param eventId
* A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form
* RESPONSE-N, where N is a number starting with one and incremented for each event sent by
* Amazon Lex V2 in the current session.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder eventId(String eventId);
}
protected static class BuilderImpl implements Builder {
private List messages = DefaultSdkAutoConstructList.getInstance();
private String eventId;
protected BuilderImpl() {
}
protected BuilderImpl(TextResponseEvent model) {
messages(model.messages);
eventId(model.eventId);
}
public final List getMessages() {
List result = MessagesCopier.copyToBuilder(this.messages);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setMessages(Collection messages) {
this.messages = MessagesCopier.copyFromBuilder(messages);
}
@Override
public final Builder messages(Collection messages) {
this.messages = MessagesCopier.copy(messages);
return this;
}
@Override
@SafeVarargs
public final Builder messages(Message... messages) {
messages(Arrays.asList(messages));
return this;
}
@Override
@SafeVarargs
public final Builder messages(Consumer... messages) {
messages(Stream.of(messages).map(c -> Message.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getEventId() {
return eventId;
}
public final void setEventId(String eventId) {
this.eventId = eventId;
}
@Override
public final Builder eventId(String eventId) {
this.eventId = eventId;
return this;
}
@Override
public TextResponseEvent build() {
return new TextResponseEvent(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}