software.amazon.awssdk.services.connect.model.CreateEvaluationFormRequest 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.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.DefaultValueTrait;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
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 CreateEvaluationFormRequest extends ConnectRequest implements
ToCopyableBuilder {
private static final SdkField INSTANCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceId").getter(getter(CreateEvaluationFormRequest::instanceId)).setter(setter(Builder::instanceId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("InstanceId").build()).build();
private static final SdkField TITLE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Title")
.getter(getter(CreateEvaluationFormRequest::title)).setter(setter(Builder::title))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Title").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(CreateEvaluationFormRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField> ITEMS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Items")
.getter(getter(CreateEvaluationFormRequest::items))
.setter(setter(Builder::items))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Items").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(EvaluationFormItem::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField SCORING_STRATEGY_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ScoringStrategy")
.getter(getter(CreateEvaluationFormRequest::scoringStrategy)).setter(setter(Builder::scoringStrategy))
.constructor(EvaluationFormScoringStrategy::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ScoringStrategy").build()).build();
private static final SdkField CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ClientToken")
.getter(getter(CreateEvaluationFormRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClientToken").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INSTANCE_ID_FIELD,
TITLE_FIELD, DESCRIPTION_FIELD, ITEMS_FIELD, SCORING_STRATEGY_FIELD, CLIENT_TOKEN_FIELD));
private final String instanceId;
private final String title;
private final String description;
private final List items;
private final EvaluationFormScoringStrategy scoringStrategy;
private final String clientToken;
private CreateEvaluationFormRequest(BuilderImpl builder) {
super(builder);
this.instanceId = builder.instanceId;
this.title = builder.title;
this.description = builder.description;
this.items = builder.items;
this.scoringStrategy = builder.scoringStrategy;
this.clientToken = builder.clientToken;
}
/**
*
* 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;
}
/**
*
* A title of the evaluation form.
*
*
* @return A title of the evaluation form.
*/
public final String title() {
return title;
}
/**
*
* The description of the evaluation form.
*
*
* @return The description of the evaluation form.
*/
public final String description() {
return description;
}
/**
* For responses, this returns true if the service returned a value for the Items 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 hasItems() {
return items != null && !(items instanceof SdkAutoConstructList);
}
/**
*
* Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each.
* Questions must be contained in a section.
*
*
* 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 #hasItems} method.
*
*
* @return Items that are part of the evaluation form. The total number of sections and questions must not exceed
* 100 each. Questions must be contained in a section.
*/
public final List items() {
return items;
}
/**
*
* A scoring strategy of the evaluation form.
*
*
* @return A scoring strategy of the evaluation form.
*/
public final EvaluationFormScoringStrategy scoringStrategy() {
return scoringStrategy;
}
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided,
* the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with
* idempotent APIs.
*
*
* @return A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
* provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see
* Making
* retries safe with idempotent APIs.
*/
public final String clientToken() {
return clientToken;
}
@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(title());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(hasItems() ? items() : null);
hashCode = 31 * hashCode + Objects.hashCode(scoringStrategy());
hashCode = 31 * hashCode + Objects.hashCode(clientToken());
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 CreateEvaluationFormRequest)) {
return false;
}
CreateEvaluationFormRequest other = (CreateEvaluationFormRequest) obj;
return Objects.equals(instanceId(), other.instanceId()) && Objects.equals(title(), other.title())
&& Objects.equals(description(), other.description()) && hasItems() == other.hasItems()
&& Objects.equals(items(), other.items()) && Objects.equals(scoringStrategy(), other.scoringStrategy())
&& Objects.equals(clientToken(), other.clientToken());
}
/**
* 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("CreateEvaluationFormRequest").add("InstanceId", instanceId()).add("Title", title())
.add("Description", description()).add("Items", hasItems() ? items() : null)
.add("ScoringStrategy", scoringStrategy()).add("ClientToken", clientToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "InstanceId":
return Optional.ofNullable(clazz.cast(instanceId()));
case "Title":
return Optional.ofNullable(clazz.cast(title()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "Items":
return Optional.ofNullable(clazz.cast(items()));
case "ScoringStrategy":
return Optional.ofNullable(clazz.cast(scoringStrategy()));
case "ClientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateEvaluationFormRequest) 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);
/**
*
* A title of the evaluation form.
*
*
* @param title
* A title of the evaluation form.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder title(String title);
/**
*
* The description of the evaluation form.
*
*
* @param description
* The description of the evaluation form.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* Items that are part of the evaluation form. The total number of sections and questions must not exceed 100
* each. Questions must be contained in a section.
*
*
* @param items
* Items that are part of the evaluation form. The total number of sections and questions must not exceed
* 100 each. Questions must be contained in a section.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder items(Collection items);
/**
*
* Items that are part of the evaluation form. The total number of sections and questions must not exceed 100
* each. Questions must be contained in a section.
*
*
* @param items
* Items that are part of the evaluation form. The total number of sections and questions must not exceed
* 100 each. Questions must be contained in a section.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder items(EvaluationFormItem... items);
/**
*
* Items that are part of the evaluation form. The total number of sections and questions must not exceed 100
* each. Questions must be contained in a section.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.connect.model.EvaluationFormItem.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.connect.model.EvaluationFormItem#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.connect.model.EvaluationFormItem.Builder#build()} is called
* immediately and its result is passed to {@link #items(List)}.
*
* @param items
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.connect.model.EvaluationFormItem.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #items(java.util.Collection)
*/
Builder items(Consumer... items);
/**
*
* A scoring strategy of the evaluation form.
*
*
* @param scoringStrategy
* A scoring strategy of the evaluation form.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder scoringStrategy(EvaluationFormScoringStrategy scoringStrategy);
/**
*
* A scoring strategy of the evaluation form.
*
* This is a convenience method that creates an instance of the {@link EvaluationFormScoringStrategy.Builder}
* avoiding the need to create one manually via {@link EvaluationFormScoringStrategy#builder()}.
*
*
* When the {@link Consumer} completes, {@link EvaluationFormScoringStrategy.Builder#build()} is called
* immediately and its result is passed to {@link #scoringStrategy(EvaluationFormScoringStrategy)}.
*
* @param scoringStrategy
* a consumer that will call methods on {@link EvaluationFormScoringStrategy.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #scoringStrategy(EvaluationFormScoringStrategy)
*/
default Builder scoringStrategy(Consumer scoringStrategy) {
return scoringStrategy(EvaluationFormScoringStrategy.builder().applyMutation(scoringStrategy).build());
}
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
* provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe
* with idempotent APIs.
*
*
* @param clientToken
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
* provided, the Amazon Web Services SDK populates this field. For more information about idempotency,
* see Making
* retries safe with idempotent APIs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientToken(String clientToken);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ConnectRequest.BuilderImpl implements Builder {
private String instanceId;
private String title;
private String description;
private List items = DefaultSdkAutoConstructList.getInstance();
private EvaluationFormScoringStrategy scoringStrategy;
private String clientToken;
private BuilderImpl() {
}
private BuilderImpl(CreateEvaluationFormRequest model) {
super(model);
instanceId(model.instanceId);
title(model.title);
description(model.description);
items(model.items);
scoringStrategy(model.scoringStrategy);
clientToken(model.clientToken);
}
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 getTitle() {
return title;
}
public final void setTitle(String title) {
this.title = title;
}
@Override
public final Builder title(String title) {
this.title = title;
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 List getItems() {
List result = EvaluationFormItemsListCopier.copyToBuilder(this.items);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setItems(Collection items) {
this.items = EvaluationFormItemsListCopier.copyFromBuilder(items);
}
@Override
public final Builder items(Collection items) {
this.items = EvaluationFormItemsListCopier.copy(items);
return this;
}
@Override
@SafeVarargs
public final Builder items(EvaluationFormItem... items) {
items(Arrays.asList(items));
return this;
}
@Override
@SafeVarargs
public final Builder items(Consumer... items) {
items(Stream.of(items).map(c -> EvaluationFormItem.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final EvaluationFormScoringStrategy.Builder getScoringStrategy() {
return scoringStrategy != null ? scoringStrategy.toBuilder() : null;
}
public final void setScoringStrategy(EvaluationFormScoringStrategy.BuilderImpl scoringStrategy) {
this.scoringStrategy = scoringStrategy != null ? scoringStrategy.build() : null;
}
@Override
public final Builder scoringStrategy(EvaluationFormScoringStrategy scoringStrategy) {
this.scoringStrategy = scoringStrategy;
return this;
}
public final String getClientToken() {
return clientToken;
}
public final void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
@Override
public final Builder clientToken(String clientToken) {
this.clientToken = clientToken;
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 CreateEvaluationFormRequest build() {
return new CreateEvaluationFormRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}