software.amazon.awssdk.services.connect.model.CreateRoutingProfileRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of connect Show documentation
Show all versions of connect Show documentation
The AWS Java SDK for Connect module holds the client classes that are used for
communicating with Connect.
/*
* 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.beans.Transient;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
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 CreateRoutingProfileRequest extends ConnectRequest implements
ToCopyableBuilder {
private static final SdkField INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceId").getter(getter(CreateRoutingProfileRequest::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(CreateRoutingProfileRequest::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(CreateRoutingProfileRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField DEFAULT_OUTBOUND_QUEUE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DefaultOutboundQueueId").getter(getter(CreateRoutingProfileRequest::defaultOutboundQueueId))
.setter(setter(Builder::defaultOutboundQueueId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DefaultOutboundQueueId").build())
.build();
private static final SdkField> QUEUE_CONFIGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("QueueConfigs")
.getter(getter(CreateRoutingProfileRequest::queueConfigs))
.setter(setter(Builder::queueConfigs))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("QueueConfigs").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(RoutingProfileQueueConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> MEDIA_CONCURRENCIES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("MediaConcurrencies")
.getter(getter(CreateRoutingProfileRequest::mediaConcurrencies))
.setter(setter(Builder::mediaConcurrencies))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MediaConcurrencies").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(MediaConcurrency::builder)
.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(CreateRoutingProfileRequest::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, DEFAULT_OUTBOUND_QUEUE_ID_FIELD, QUEUE_CONFIGS_FIELD, MEDIA_CONCURRENCIES_FIELD, TAGS_FIELD));
private final String instanceId;
private final String name;
private final String description;
private final String defaultOutboundQueueId;
private final List queueConfigs;
private final List mediaConcurrencies;
private final Map tags;
private CreateRoutingProfileRequest(BuilderImpl builder) {
super(builder);
this.instanceId = builder.instanceId;
this.name = builder.name;
this.description = builder.description;
this.defaultOutboundQueueId = builder.defaultOutboundQueueId;
this.queueConfigs = builder.queueConfigs;
this.mediaConcurrencies = builder.mediaConcurrencies;
this.tags = builder.tags;
}
/**
*
* The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
*
*
* @return The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
*/
public final String instanceId() {
return instanceId;
}
/**
*
* The name of the routing profile. Must not be more than 127 characters.
*
*
* @return The name of the routing profile. Must not be more than 127 characters.
*/
public final String name() {
return name;
}
/**
*
* Description of the routing profile. Must not be more than 250 characters.
*
*
* @return Description of the routing profile. Must not be more than 250 characters.
*/
public final String description() {
return description;
}
/**
*
* The default outbound queue for the routing profile.
*
*
* @return The default outbound queue for the routing profile.
*/
public final String defaultOutboundQueueId() {
return defaultOutboundQueueId;
}
/**
* For responses, this returns true if the service returned a value for the QueueConfigs 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 hasQueueConfigs() {
return queueConfigs != null && !(queueConfigs instanceof SdkAutoConstructList);
}
/**
*
* The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound
* calls.
*
*
* 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 #hasQueueConfigs} method.
*
*
* @return The inbound queues associated with the routing profile. If no queue is added, the agent can make only
* outbound calls.
*/
public final List queueConfigs() {
return queueConfigs;
}
/**
* For responses, this returns true if the service returned a value for the MediaConcurrencies 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 hasMediaConcurrencies() {
return mediaConcurrencies != null && !(mediaConcurrencies instanceof SdkAutoConstructList);
}
/**
*
* The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.
*
*
* 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 #hasMediaConcurrencies} method.
*
*
* @return The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.
*/
public final List mediaConcurrencies() {
return mediaConcurrencies;
}
/**
* 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);
}
/**
*
* One or more tags.
*
*
* 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 One or more tags.
*/
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(defaultOutboundQueueId());
hashCode = 31 * hashCode + Objects.hashCode(hasQueueConfigs() ? queueConfigs() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasMediaConcurrencies() ? mediaConcurrencies() : 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 CreateRoutingProfileRequest)) {
return false;
}
CreateRoutingProfileRequest other = (CreateRoutingProfileRequest) obj;
return Objects.equals(instanceId(), other.instanceId()) && Objects.equals(name(), other.name())
&& Objects.equals(description(), other.description())
&& Objects.equals(defaultOutboundQueueId(), other.defaultOutboundQueueId())
&& hasQueueConfigs() == other.hasQueueConfigs() && Objects.equals(queueConfigs(), other.queueConfigs())
&& hasMediaConcurrencies() == other.hasMediaConcurrencies()
&& Objects.equals(mediaConcurrencies(), other.mediaConcurrencies()) && 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("CreateRoutingProfileRequest").add("InstanceId", instanceId()).add("Name", name())
.add("Description", description()).add("DefaultOutboundQueueId", defaultOutboundQueueId())
.add("QueueConfigs", hasQueueConfigs() ? queueConfigs() : null)
.add("MediaConcurrencies", hasMediaConcurrencies() ? mediaConcurrencies() : 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 "DefaultOutboundQueueId":
return Optional.ofNullable(clazz.cast(defaultOutboundQueueId()));
case "QueueConfigs":
return Optional.ofNullable(clazz.cast(queueConfigs()));
case "MediaConcurrencies":
return Optional.ofNullable(clazz.cast(mediaConcurrencies()));
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((CreateRoutingProfileRequest) 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 instanceId in the ARN of the instance.
*
*
* @param instanceId
* The identifier of the Amazon Connect instance. You can find the instanceId in the 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 routing profile. Must not be more than 127 characters.
*
*
* @param name
* The name of the routing profile. Must not be more than 127 characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* Description of the routing profile. Must not be more than 250 characters.
*
*
* @param description
* Description of the routing profile. Must not be more than 250 characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The default outbound queue for the routing profile.
*
*
* @param defaultOutboundQueueId
* The default outbound queue for the routing profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder defaultOutboundQueueId(String defaultOutboundQueueId);
/**
*
* The inbound queues associated with the routing profile. If no queue is added, the agent can make only
* outbound calls.
*
*
* @param queueConfigs
* The inbound queues associated with the routing profile. If no queue is added, the agent can make only
* outbound calls.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder queueConfigs(Collection queueConfigs);
/**
*
* The inbound queues associated with the routing profile. If no queue is added, the agent can make only
* outbound calls.
*
*
* @param queueConfigs
* The inbound queues associated with the routing profile. If no queue is added, the agent can make only
* outbound calls.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder queueConfigs(RoutingProfileQueueConfig... queueConfigs);
/**
*
* The inbound queues associated with the routing profile. If no queue is added, the agent can make only
* outbound calls.
*
* This is a convenience that creates an instance of the {@link List.Builder}
* avoiding the need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called
* immediately and its result is passed to {@link #queueConfigs(List)}.
*
* @param queueConfigs
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #queueConfigs(List)
*/
Builder queueConfigs(Consumer... queueConfigs);
/**
*
* The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.
*
*
* @param mediaConcurrencies
* The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder mediaConcurrencies(Collection mediaConcurrencies);
/**
*
* The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.
*
*
* @param mediaConcurrencies
* The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder mediaConcurrencies(MediaConcurrency... mediaConcurrencies);
/**
*
* The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the
* need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and
* its result is passed to {@link #mediaConcurrencies(List)}.
*
* @param mediaConcurrencies
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #mediaConcurrencies(List)
*/
Builder mediaConcurrencies(Consumer... mediaConcurrencies);
/**
*
* One or more tags.
*
*
* @param tags
* One or more tags.
* @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 String defaultOutboundQueueId;
private List queueConfigs = DefaultSdkAutoConstructList.getInstance();
private List mediaConcurrencies = DefaultSdkAutoConstructList.getInstance();
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateRoutingProfileRequest model) {
super(model);
instanceId(model.instanceId);
name(model.name);
description(model.description);
defaultOutboundQueueId(model.defaultOutboundQueueId);
queueConfigs(model.queueConfigs);
mediaConcurrencies(model.mediaConcurrencies);
tags(model.tags);
}
public final String getInstanceId() {
return instanceId;
}
public final void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
@Override
@Transient
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
@Transient
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
@Transient
public final Builder description(String description) {
this.description = description;
return this;
}
public final String getDefaultOutboundQueueId() {
return defaultOutboundQueueId;
}
public final void setDefaultOutboundQueueId(String defaultOutboundQueueId) {
this.defaultOutboundQueueId = defaultOutboundQueueId;
}
@Override
@Transient
public final Builder defaultOutboundQueueId(String defaultOutboundQueueId) {
this.defaultOutboundQueueId = defaultOutboundQueueId;
return this;
}
public final List getQueueConfigs() {
List result = RoutingProfileQueueConfigListCopier.copyToBuilder(this.queueConfigs);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setQueueConfigs(Collection queueConfigs) {
this.queueConfigs = RoutingProfileQueueConfigListCopier.copyFromBuilder(queueConfigs);
}
@Override
@Transient
public final Builder queueConfigs(Collection queueConfigs) {
this.queueConfigs = RoutingProfileQueueConfigListCopier.copy(queueConfigs);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder queueConfigs(RoutingProfileQueueConfig... queueConfigs) {
queueConfigs(Arrays.asList(queueConfigs));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder queueConfigs(Consumer... queueConfigs) {
queueConfigs(Stream.of(queueConfigs).map(c -> RoutingProfileQueueConfig.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getMediaConcurrencies() {
List result = MediaConcurrenciesCopier.copyToBuilder(this.mediaConcurrencies);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setMediaConcurrencies(Collection mediaConcurrencies) {
this.mediaConcurrencies = MediaConcurrenciesCopier.copyFromBuilder(mediaConcurrencies);
}
@Override
@Transient
public final Builder mediaConcurrencies(Collection mediaConcurrencies) {
this.mediaConcurrencies = MediaConcurrenciesCopier.copy(mediaConcurrencies);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder mediaConcurrencies(MediaConcurrency... mediaConcurrencies) {
mediaConcurrencies(Arrays.asList(mediaConcurrencies));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder mediaConcurrencies(Consumer... mediaConcurrencies) {
mediaConcurrencies(Stream.of(mediaConcurrencies).map(c -> MediaConcurrency.builder().applyMutation(c).build())
.collect(Collectors.toList()));
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
@Transient
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 CreateRoutingProfileRequest build() {
return new CreateRoutingProfileRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy