software.amazon.awssdk.services.connect.model.CreateQueueRequest 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.Collection;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
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 CreateQueueRequest extends ConnectRequest implements
ToCopyableBuilder {
private static final SdkField INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceId").getter(getter(CreateQueueRequest::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(CreateQueueRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(CreateQueueRequest::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField OUTBOUND_CALLER_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("OutboundCallerConfig")
.getter(getter(CreateQueueRequest::outboundCallerConfig)).setter(setter(Builder::outboundCallerConfig))
.constructor(OutboundCallerConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OutboundCallerConfig").build())
.build();
private static final SdkField HOURS_OF_OPERATION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("HoursOfOperationId").getter(getter(CreateQueueRequest::hoursOfOperationId))
.setter(setter(Builder::hoursOfOperationId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HoursOfOperationId").build())
.build();
private static final SdkField MAX_CONTACTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxContacts").getter(getter(CreateQueueRequest::maxContacts)).setter(setter(Builder::maxContacts))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxContacts").build()).build();
private static final SdkField> QUICK_CONNECT_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("QuickConnectIds")
.getter(getter(CreateQueueRequest::quickConnectIds))
.setter(setter(Builder::quickConnectIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("QuickConnectIds").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Tags")
.getter(getter(CreateQueueRequest::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,
DESCRIPTION_FIELD, OUTBOUND_CALLER_CONFIG_FIELD, HOURS_OF_OPERATION_ID_FIELD, MAX_CONTACTS_FIELD,
QUICK_CONNECT_IDS_FIELD, TAGS_FIELD));
private final String instanceId;
private final String name;
private final String description;
private final OutboundCallerConfig outboundCallerConfig;
private final String hoursOfOperationId;
private final Integer maxContacts;
private final List quickConnectIds;
private final Map tags;
private CreateQueueRequest(BuilderImpl builder) {
super(builder);
this.instanceId = builder.instanceId;
this.name = builder.name;
this.description = builder.description;
this.outboundCallerConfig = builder.outboundCallerConfig;
this.hoursOfOperationId = builder.hoursOfOperationId;
this.maxContacts = builder.maxContacts;
this.quickConnectIds = builder.quickConnectIds;
this.tags = builder.tags;
}
/**
*
* The identifier of the Amazon Connect instance. You can find the instance ID in
* the Amazon Resource Name (ARN) of the instance.
*
*
* @return The identifier of the Amazon Connect instance. You can find the instance
* ID in the Amazon Resource Name (ARN) of the instance.
*/
public final String instanceId() {
return instanceId;
}
/**
*
* The name of the queue.
*
*
* @return The name of the queue.
*/
public final String name() {
return name;
}
/**
*
* The description of the queue.
*
*
* @return The description of the queue.
*/
public final String description() {
return description;
}
/**
*
* The outbound caller ID name, number, and outbound whisper flow.
*
*
* @return The outbound caller ID name, number, and outbound whisper flow.
*/
public final OutboundCallerConfig outboundCallerConfig() {
return outboundCallerConfig;
}
/**
*
* The identifier for the hours of operation.
*
*
* @return The identifier for the hours of operation.
*/
public final String hoursOfOperationId() {
return hoursOfOperationId;
}
/**
*
* The maximum number of contacts that can be in the queue before it is considered full.
*
*
* @return The maximum number of contacts that can be in the queue before it is considered full.
*/
public final Integer maxContacts() {
return maxContacts;
}
/**
* For responses, this returns true if the service returned a value for the QuickConnectIds 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 hasQuickConnectIds() {
return quickConnectIds != null && !(quickConnectIds instanceof SdkAutoConstructList);
}
/**
*
* The quick connects available to agents who are working the queue.
*
*
* 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 #hasQuickConnectIds} method.
*
*
* @return The quick connects available to agents who are working the queue.
*/
public final List quickConnectIds() {
return quickConnectIds;
}
/**
* 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(description());
hashCode = 31 * hashCode + Objects.hashCode(outboundCallerConfig());
hashCode = 31 * hashCode + Objects.hashCode(hoursOfOperationId());
hashCode = 31 * hashCode + Objects.hashCode(maxContacts());
hashCode = 31 * hashCode + Objects.hashCode(hasQuickConnectIds() ? quickConnectIds() : null);
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 CreateQueueRequest)) {
return false;
}
CreateQueueRequest other = (CreateQueueRequest) obj;
return Objects.equals(instanceId(), other.instanceId()) && Objects.equals(name(), other.name())
&& Objects.equals(description(), other.description())
&& Objects.equals(outboundCallerConfig(), other.outboundCallerConfig())
&& Objects.equals(hoursOfOperationId(), other.hoursOfOperationId())
&& Objects.equals(maxContacts(), other.maxContacts()) && hasQuickConnectIds() == other.hasQuickConnectIds()
&& Objects.equals(quickConnectIds(), other.quickConnectIds()) && 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("CreateQueueRequest").add("InstanceId", instanceId()).add("Name", name())
.add("Description", description()).add("OutboundCallerConfig", outboundCallerConfig())
.add("HoursOfOperationId", hoursOfOperationId()).add("MaxContacts", maxContacts())
.add("QuickConnectIds", hasQuickConnectIds() ? quickConnectIds() : null).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 "Description":
return Optional.ofNullable(clazz.cast(description()));
case "OutboundCallerConfig":
return Optional.ofNullable(clazz.cast(outboundCallerConfig()));
case "HoursOfOperationId":
return Optional.ofNullable(clazz.cast(hoursOfOperationId()));
case "MaxContacts":
return Optional.ofNullable(clazz.cast(maxContacts()));
case "QuickConnectIds":
return Optional.ofNullable(clazz.cast(quickConnectIds()));
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((CreateQueueRequest) 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. You can find the instance ID
* in the Amazon Resource Name (ARN) of the instance.
*
*
* @param instanceId
* The identifier of the Amazon Connect instance. You can find the instance
* ID in the Amazon Resource Name (ARN) of the instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceId(String instanceId);
/**
*
* The name of the queue.
*
*
* @param name
* The name of the queue.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The description of the queue.
*
*
* @param description
* The description of the queue.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The outbound caller ID name, number, and outbound whisper flow.
*
*
* @param outboundCallerConfig
* The outbound caller ID name, number, and outbound whisper flow.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder outboundCallerConfig(OutboundCallerConfig outboundCallerConfig);
/**
*
* The outbound caller ID name, number, and outbound whisper flow.
*
* This is a convenience method that creates an instance of the {@link OutboundCallerConfig.Builder} avoiding
* the need to create one manually via {@link OutboundCallerConfig#builder()}.
*
*
* When the {@link Consumer} completes, {@link OutboundCallerConfig.Builder#build()} is called immediately and
* its result is passed to {@link #outboundCallerConfig(OutboundCallerConfig)}.
*
* @param outboundCallerConfig
* a consumer that will call methods on {@link OutboundCallerConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #outboundCallerConfig(OutboundCallerConfig)
*/
default Builder outboundCallerConfig(Consumer outboundCallerConfig) {
return outboundCallerConfig(OutboundCallerConfig.builder().applyMutation(outboundCallerConfig).build());
}
/**
*
* The identifier for the hours of operation.
*
*
* @param hoursOfOperationId
* The identifier for the hours of operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder hoursOfOperationId(String hoursOfOperationId);
/**
*
* The maximum number of contacts that can be in the queue before it is considered full.
*
*
* @param maxContacts
* The maximum number of contacts that can be in the queue before it is considered full.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxContacts(Integer maxContacts);
/**
*
* The quick connects available to agents who are working the queue.
*
*
* @param quickConnectIds
* The quick connects available to agents who are working the queue.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder quickConnectIds(Collection quickConnectIds);
/**
*
* The quick connects available to agents who are working the queue.
*
*
* @param quickConnectIds
* The quick connects available to agents who are working the queue.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder quickConnectIds(String... quickConnectIds);
/**
*
* 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 description;
private OutboundCallerConfig outboundCallerConfig;
private String hoursOfOperationId;
private Integer maxContacts;
private List quickConnectIds = DefaultSdkAutoConstructList.getInstance();
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateQueueRequest model) {
super(model);
instanceId(model.instanceId);
name(model.name);
description(model.description);
outboundCallerConfig(model.outboundCallerConfig);
hoursOfOperationId(model.hoursOfOperationId);
maxContacts(model.maxContacts);
quickConnectIds(model.quickConnectIds);
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 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 OutboundCallerConfig.Builder getOutboundCallerConfig() {
return outboundCallerConfig != null ? outboundCallerConfig.toBuilder() : null;
}
public final void setOutboundCallerConfig(OutboundCallerConfig.BuilderImpl outboundCallerConfig) {
this.outboundCallerConfig = outboundCallerConfig != null ? outboundCallerConfig.build() : null;
}
@Override
public final Builder outboundCallerConfig(OutboundCallerConfig outboundCallerConfig) {
this.outboundCallerConfig = outboundCallerConfig;
return this;
}
public final String getHoursOfOperationId() {
return hoursOfOperationId;
}
public final void setHoursOfOperationId(String hoursOfOperationId) {
this.hoursOfOperationId = hoursOfOperationId;
}
@Override
public final Builder hoursOfOperationId(String hoursOfOperationId) {
this.hoursOfOperationId = hoursOfOperationId;
return this;
}
public final Integer getMaxContacts() {
return maxContacts;
}
public final void setMaxContacts(Integer maxContacts) {
this.maxContacts = maxContacts;
}
@Override
public final Builder maxContacts(Integer maxContacts) {
this.maxContacts = maxContacts;
return this;
}
public final Collection getQuickConnectIds() {
if (quickConnectIds instanceof SdkAutoConstructList) {
return null;
}
return quickConnectIds;
}
public final void setQuickConnectIds(Collection quickConnectIds) {
this.quickConnectIds = QuickConnectsListCopier.copy(quickConnectIds);
}
@Override
public final Builder quickConnectIds(Collection quickConnectIds) {
this.quickConnectIds = QuickConnectsListCopier.copy(quickConnectIds);
return this;
}
@Override
@SafeVarargs
public final Builder quickConnectIds(String... quickConnectIds) {
quickConnectIds(Arrays.asList(quickConnectIds));
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 CreateQueueRequest build() {
return new CreateQueueRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}