software.amazon.awssdk.services.connect.model.ChatEvent Maven / Gradle / Ivy
/*
* 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.connect.model;
import java.io.Serializable;
import java.util.Arrays;
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.Function;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Chat integration event containing payload to perform different chat actions such as:
*
*
* -
*
* Sending a chat message
*
*
* -
*
* Sending a chat event, such as typing
*
*
* -
*
* Disconnecting from a chat
*
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ChatEvent implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Type")
.getter(getter(ChatEvent::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Type").build()).build();
private static final SdkField CONTENT_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ContentType").getter(getter(ChatEvent::contentType)).setter(setter(Builder::contentType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ContentType").build()).build();
private static final SdkField CONTENT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Content")
.getter(getter(ChatEvent::content)).setter(setter(Builder::content))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Content").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TYPE_FIELD,
CONTENT_TYPE_FIELD, CONTENT_FIELD));
private static final long serialVersionUID = 1L;
private final String type;
private final String contentType;
private final String content;
private ChatEvent(BuilderImpl builder) {
this.type = builder.type;
this.contentType = builder.contentType;
this.content = builder.content;
}
/**
*
* Type of chat integration event.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link ChatEventType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return Type of chat integration event.
* @see ChatEventType
*/
public final ChatEventType type() {
return ChatEventType.fromValue(type);
}
/**
*
* Type of chat integration event.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link ChatEventType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return Type of chat integration event.
* @see ChatEventType
*/
public final String typeAsString() {
return type;
}
/**
*
* Type of content. This is required when Type is MESSAGE or EVENT.
*
*
* -
*
* For allowed message content types, see the ContentType parameter in the SendMessage
* topic in the Amazon Connect Participant Service API Reference.
*
*
* -
*
* For allowed event content types, see the ContentType parameter in the SendEvent topic
* in the Amazon Connect Participant Service API Reference.
*
*
*
*
* @return Type of content. This is required when Type is MESSAGE or EVENT.
*
*
* -
*
* For allowed message content types, see the ContentType parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference.
*
*
* -
*
* For allowed event content types, see the ContentType parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference.
*
*
*/
public final String contentType() {
return contentType;
}
/**
*
* Content of the message or event. This is required when Type is MESSAGE and for certain
* ContentTypes when Type is EVENT.
*
*
* -
*
* For allowed message content, see the Content parameter in the SendMessage
* topic in the Amazon Connect Participant Service API Reference.
*
*
* -
*
* For allowed event content, see the Content parameter in the SendEvent topic
* in the Amazon Connect Participant Service API Reference.
*
*
*
*
* @return Content of the message or event. This is required when Type is MESSAGE and for
* certain ContentTypes when Type is EVENT.
*
* -
*
* For allowed message content, see the Content parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference.
*
*
* -
*
* For allowed event content, see the Content parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference.
*
*
*/
public final String content() {
return content;
}
@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(typeAsString());
hashCode = 31 * hashCode + Objects.hashCode(contentType());
hashCode = 31 * hashCode + Objects.hashCode(content());
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 ChatEvent)) {
return false;
}
ChatEvent other = (ChatEvent) obj;
return Objects.equals(typeAsString(), other.typeAsString()) && Objects.equals(contentType(), other.contentType())
&& Objects.equals(content(), other.content());
}
/**
* 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("ChatEvent").add("Type", typeAsString()).add("ContentType", contentType())
.add("Content", content()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Type":
return Optional.ofNullable(clazz.cast(typeAsString()));
case "ContentType":
return Optional.ofNullable(clazz.cast(contentType()));
case "Content":
return Optional.ofNullable(clazz.cast(content()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ChatEvent) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Type of chat integration event.
*
*
* @param type
* Type of chat integration event.
* @see ChatEventType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChatEventType
*/
Builder type(String type);
/**
*
* Type of chat integration event.
*
*
* @param type
* Type of chat integration event.
* @see ChatEventType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChatEventType
*/
Builder type(ChatEventType type);
/**
*
* Type of content. This is required when Type is MESSAGE or EVENT.
*
*
* -
*
* For allowed message content types, see the ContentType parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference.
*
*
* -
*
* For allowed event content types, see the ContentType parameter in the SendEvent
* topic in the Amazon Connect Participant Service API Reference.
*
*
*
*
* @param contentType
* Type of content. This is required when Type is MESSAGE or EVENT
* .
*
* -
*
* For allowed message content types, see the ContentType parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference.
*
*
* -
*
* For allowed event content types, see the ContentType parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder contentType(String contentType);
/**
*
* Content of the message or event. This is required when Type is MESSAGE and for
* certain ContentTypes when Type is EVENT.
*
*
* -
*
* For allowed message content, see the Content parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference.
*
*
* -
*
* For allowed event content, see the Content parameter in the SendEvent
* topic in the Amazon Connect Participant Service API Reference.
*
*
*
*
* @param content
* Content of the message or event. This is required when Type is MESSAGE and
* for certain ContentTypes when Type is EVENT.
*
* -
*
* For allowed message content, see the Content parameter in the SendMessage topic in the Amazon Connect Participant Service API Reference.
*
*
* -
*
* For allowed event content, see the Content parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder content(String content);
}
static final class BuilderImpl implements Builder {
private String type;
private String contentType;
private String content;
private BuilderImpl() {
}
private BuilderImpl(ChatEvent model) {
type(model.type);
contentType(model.contentType);
content(model.content);
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
public final Builder type(String type) {
this.type = type;
return this;
}
@Override
public final Builder type(ChatEventType type) {
this.type(type == null ? null : type.toString());
return this;
}
public final String getContentType() {
return contentType;
}
public final void setContentType(String contentType) {
this.contentType = contentType;
}
@Override
public final Builder contentType(String contentType) {
this.contentType = contentType;
return this;
}
public final String getContent() {
return content;
}
public final void setContent(String content) {
this.content = content;
}
@Override
public final Builder content(String content) {
this.content = content;
return this;
}
@Override
public ChatEvent build() {
return new ChatEvent(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}