software.amazon.awssdk.services.connect.model.CreateContactFlowRequest 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.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.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateContactFlowRequest extends ConnectRequest implements
ToCopyableBuilder {
private static final SdkField INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceId").getter(getter(CreateContactFlowRequest::instanceId)).setter(setter(Builder::instanceId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("InstanceId").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(CreateContactFlowRequest::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(CreateContactFlowRequest::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Type").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(CreateContactFlowRequest::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(CreateContactFlowRequest::content)).setter(setter(Builder::content))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Content").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(CreateContactFlowRequest::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Tags")
.getter(getter(CreateContactFlowRequest::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(INSTANCE_ID_FIELD, NAME_FIELD,
TYPE_FIELD, DESCRIPTION_FIELD, CONTENT_FIELD, STATUS_FIELD, TAGS_FIELD));
private final String instanceId;
private final String name;
private final String type;
private final String description;
private final String content;
private final String status;
private final Map tags;
private CreateContactFlowRequest(BuilderImpl builder) {
super(builder);
this.instanceId = builder.instanceId;
this.name = builder.name;
this.type = builder.type;
this.description = builder.description;
this.content = builder.content;
this.status = builder.status;
this.tags = builder.tags;
}
/**
*
* The identifier of the Amazon Connect instance.
*
*
* @return The identifier of the Amazon Connect instance.
*/
public final String instanceId() {
return instanceId;
}
/**
*
* 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 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;
}
/**
*
* Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED
* status will initiate validation on the content. the SAVED status does not initiate validation of the
* content. SAVED | PUBLISHED.
*
*
* 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 Indicates the flow status as either SAVED or PUBLISHED. The
* PUBLISHED status will initiate validation on the content. the SAVED status does
* not initiate validation of the content. SAVED | PUBLISHED.
* @see ContactFlowStatus
*/
public final ContactFlowStatus status() {
return ContactFlowStatus.fromValue(status);
}
/**
*
* Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED
* status will initiate validation on the content. the SAVED status does not initiate validation of the
* content. SAVED | PUBLISHED.
*
*
* 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 Indicates the flow status as either SAVED or PUBLISHED. The
* PUBLISHED status will initiate validation on the content. the SAVED status does
* not initiate validation of the content. SAVED | PUBLISHED.
* @see ContactFlowStatus
*/
public final String statusAsString() {
return status;
}
/**
* 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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(instanceId());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(typeAsString());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(content());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateContactFlowRequest)) {
return false;
}
CreateContactFlowRequest other = (CreateContactFlowRequest) obj;
return Objects.equals(instanceId(), other.instanceId()) && Objects.equals(name(), other.name())
&& Objects.equals(typeAsString(), other.typeAsString()) && Objects.equals(description(), other.description())
&& Objects.equals(content(), other.content()) && Objects.equals(statusAsString(), other.statusAsString())
&& 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("CreateContactFlowRequest").add("InstanceId", instanceId()).add("Name", name())
.add("Type", typeAsString()).add("Description", description()).add("Content", content())
.add("Status", statusAsString()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "InstanceId":
return Optional.ofNullable(clazz.cast(instanceId()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Type":
return Optional.ofNullable(clazz.cast(typeAsString()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "Content":
return Optional.ofNullable(clazz.cast(content()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
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((CreateContactFlowRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The identifier of the Amazon Connect instance.
*
*
* @param instanceId
* The identifier of the Amazon Connect instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceId(String instanceId);
/**
*
* 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 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);
/**
*
* Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED
* status will initiate validation on the content. the SAVED status does not initiate validation of
* the content. SAVED | PUBLISHED.
*
*
* @param status
* Indicates the flow status as either SAVED or PUBLISHED. The
* PUBLISHED status will initiate validation on the content. the SAVED status
* does not initiate validation of the content. SAVED | PUBLISHED.
* @see ContactFlowStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ContactFlowStatus
*/
Builder status(String status);
/**
*
* Indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED
* status will initiate validation on the content. the SAVED status does not initiate validation of
* the content. SAVED | PUBLISHED.
*
*
* @param status
* Indicates the flow status as either SAVED or PUBLISHED. The
* PUBLISHED status will initiate validation on the content. the SAVED status
* does not initiate validation of the content. SAVED | PUBLISHED.
* @see ContactFlowStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ContactFlowStatus
*/
Builder status(ContactFlowStatus status);
/**
*
* 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);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ConnectRequest.BuilderImpl implements Builder {
private String instanceId;
private String name;
private String type;
private String description;
private String content;
private String status;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateContactFlowRequest model) {
super(model);
instanceId(model.instanceId);
name(model.name);
type(model.type);
description(model.description);
content(model.content);
status(model.status);
tags(model.tags);
}
public final String getInstanceId() {
return instanceId;
}
public final void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
@Override
public final Builder instanceId(String instanceId) {
this.instanceId = instanceId;
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 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 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 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 Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateContactFlowRequest build() {
return new CreateContactFlowRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}