software.amazon.awssdk.services.connect.model.ContactFlow Maven / Gradle / Ivy
Show all versions of connect 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.connect.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
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.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains information about a flow.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ContactFlow implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Arn")
.getter(getter(ContactFlow::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Arn").build()).build();
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Id")
.getter(getter(ContactFlow::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Id").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(ContactFlow::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Type")
.getter(getter(ContactFlow::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Type").build()).build();
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("State")
.getter(getter(ContactFlow::stateAsString)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("State").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(ContactFlow::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(ContactFlow::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField CONTENT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Content")
.getter(getter(ContactFlow::content)).setter(setter(Builder::content))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Content").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Tags")
.getter(getter(ContactFlow::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ARN_FIELD, ID_FIELD,
NAME_FIELD, TYPE_FIELD, STATE_FIELD, STATUS_FIELD, DESCRIPTION_FIELD, CONTENT_FIELD, TAGS_FIELD));
private static final long serialVersionUID = 1L;
private final String arn;
private final String id;
private final String name;
private final String type;
private final String state;
private final String status;
private final String description;
private final String content;
private final Map tags;
private ContactFlow(BuilderImpl builder) {
this.arn = builder.arn;
this.id = builder.id;
this.name = builder.name;
this.type = builder.type;
this.state = builder.state;
this.status = builder.status;
this.description = builder.description;
this.content = builder.content;
this.tags = builder.tags;
}
/**
*
* The Amazon Resource Name (ARN) of the flow.
*
*
* @return The Amazon Resource Name (ARN) of the flow.
*/
public final String arn() {
return arn;
}
/**
*
* The identifier of the flow.
*
*
* @return The identifier of the flow.
*/
public final String id() {
return id;
}
/**
*
* The name of the flow.
*
*
* @return The name of the flow.
*/
public final String name() {
return name;
}
/**
*
* The type of the flow. For descriptions of the available types, see Choose a
* flow type in the Amazon Connect Administrator Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link ContactFlowType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
* @see ContactFlowType
*/
public final ContactFlowType type() {
return ContactFlowType.fromValue(type);
}
/**
*
* The type of the flow. For descriptions of the available types, see Choose a
* flow type in the Amazon Connect Administrator Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link ContactFlowType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
* @see ContactFlowType
*/
public final String typeAsString() {
return type;
}
/**
*
* The type of flow.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link ContactFlowState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The type of flow.
* @see ContactFlowState
*/
public final ContactFlowState state() {
return ContactFlowState.fromValue(state);
}
/**
*
* The type of flow.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link ContactFlowState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The type of flow.
* @see ContactFlowState
*/
public final String stateAsString() {
return state;
}
/**
*
* The status of the contact flow.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link ContactFlowStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The status of the contact flow.
* @see ContactFlowStatus
*/
public final ContactFlowStatus status() {
return ContactFlowStatus.fromValue(status);
}
/**
*
* The status of the contact flow.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link ContactFlowStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The status of the contact flow.
* @see ContactFlowStatus
*/
public final String statusAsString() {
return status;
}
/**
*
* The description of the flow.
*
*
* @return The description of the flow.
*/
public final String description() {
return description;
}
/**
*
* The JSON string that represents the content of the flow. For an example, see Example flow in Amazon
* Connect Flow language.
*
*
* Length Constraints: Minimum length of 1. Maximum length of 256000.
*
*
* @return The JSON string that represents the content of the flow. For an example, see Example flow in
* Amazon Connect Flow language.
*
* Length Constraints: Minimum length of 1. Maximum length of 256000.
*/
public final String content() {
return content;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1",
* "key2":"value2"} }.
*
*
* 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 #hasTags} method.
*
*
* @return The tags used to organize, track, or control access for this resource. For example, { "Tags":
* {"key1":"value1", "key2":"value2"} }.
*/
public final Map tags() {
return tags;
}
@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(arn());
hashCode = 31 * hashCode + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(typeAsString());
hashCode = 31 * hashCode + Objects.hashCode(stateAsString());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(content());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
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 ContactFlow)) {
return false;
}
ContactFlow other = (ContactFlow) obj;
return Objects.equals(arn(), other.arn()) && Objects.equals(id(), other.id()) && Objects.equals(name(), other.name())
&& Objects.equals(typeAsString(), other.typeAsString()) && Objects.equals(stateAsString(), other.stateAsString())
&& Objects.equals(statusAsString(), other.statusAsString()) && Objects.equals(description(), other.description())
&& Objects.equals(content(), other.content()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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("ContactFlow").add("Arn", arn()).add("Id", id()).add("Name", name()).add("Type", typeAsString())
.add("State", stateAsString()).add("Status", statusAsString()).add("Description", description())
.add("Content", content()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "Id":
return Optional.ofNullable(clazz.cast(id()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Type":
return Optional.ofNullable(clazz.cast(typeAsString()));
case "State":
return Optional.ofNullable(clazz.cast(stateAsString()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "Content":
return Optional.ofNullable(clazz.cast(content()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ContactFlow) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the flow.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the flow.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* The identifier of the flow.
*
*
* @param id
* The identifier of the flow.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* The name of the flow.
*
*
* @param name
* The name of the flow.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
*
*
* @param type
* The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
* @see ContactFlowType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ContactFlowType
*/
Builder type(String type);
/**
*
* The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
*
*
* @param type
* The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
* @see ContactFlowType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ContactFlowType
*/
Builder type(ContactFlowType type);
/**
*
* The type of flow.
*
*
* @param state
* The type of flow.
* @see ContactFlowState
* @return Returns a reference to this object so that method calls can be chained together.
* @see ContactFlowState
*/
Builder state(String state);
/**
*
* The type of flow.
*
*
* @param state
* The type of flow.
* @see ContactFlowState
* @return Returns a reference to this object so that method calls can be chained together.
* @see ContactFlowState
*/
Builder state(ContactFlowState state);
/**
*
* The status of the contact flow.
*
*
* @param status
* The status of the contact flow.
* @see ContactFlowStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ContactFlowStatus
*/
Builder status(String status);
/**
*
* The status of the contact flow.
*
*
* @param status
* The status of the contact flow.
* @see ContactFlowStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ContactFlowStatus
*/
Builder status(ContactFlowStatus status);
/**
*
* The description of the flow.
*
*
* @param description
* The description of the flow.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The JSON string that represents the content of the flow. For an example, see Example flow in
* Amazon Connect Flow language.
*
*
* Length Constraints: Minimum length of 1. Maximum length of 256000.
*
*
* @param content
* The JSON string that represents the content of the flow. For an example, see Example flow
* in Amazon Connect Flow language.
*
* Length Constraints: Minimum length of 1. Maximum length of 256000.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder content(String content);
/**
*
* The tags used to organize, track, or control access for this resource. For example, { "Tags":
* {"key1":"value1", "key2":"value2"} }.
*
*
* @param tags
* The tags used to organize, track, or control access for this resource. For example, { "Tags":
* {"key1":"value1", "key2":"value2"} }.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
}
static final class BuilderImpl implements Builder {
private String arn;
private String id;
private String name;
private String type;
private String state;
private String status;
private String description;
private String content;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ContactFlow model) {
arn(model.arn);
id(model.id);
name(model.name);
type(model.type);
state(model.state);
status(model.status);
description(model.description);
content(model.content);
tags(model.tags);
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final String getId() {
return id;
}
public final void setId(String id) {
this.id = id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
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(ContactFlowType type) {
this.type(type == null ? null : type.toString());
return this;
}
public final String getState() {
return state;
}
public final void setState(String state) {
this.state = state;
}
@Override
public final Builder state(String state) {
this.state = state;
return this;
}
@Override
public final Builder state(ContactFlowState state) {
this.state(state == null ? null : state.toString());
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(ContactFlowStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
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;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagMapCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = TagMapCopier.copy(tags);
return this;
}
@Override
public ContactFlow build() {
return new ContactFlow(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}