software.amazon.awssdk.services.wisdom.model.CreateAssistantRequest Maven / Gradle / Ivy
Show all versions of wisdom 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.wisdom.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.DefaultValueTrait;
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 CreateAssistantRequest extends WisdomRequest implements
ToCopyableBuilder {
private static final SdkField CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("clientToken")
.getter(getter(CreateAssistantRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("clientToken").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(CreateAssistantRequest::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(CreateAssistantRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField SERVER_SIDE_ENCRYPTION_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("serverSideEncryptionConfiguration")
.getter(getter(CreateAssistantRequest::serverSideEncryptionConfiguration))
.setter(setter(Builder::serverSideEncryptionConfiguration))
.constructor(ServerSideEncryptionConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("serverSideEncryptionConfiguration")
.build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("tags")
.getter(getter(CreateAssistantRequest::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 SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("type")
.getter(getter(CreateAssistantRequest::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("type").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CLIENT_TOKEN_FIELD,
DESCRIPTION_FIELD, NAME_FIELD, SERVER_SIDE_ENCRYPTION_CONFIGURATION_FIELD, TAGS_FIELD, TYPE_FIELD));
private final String clientToken;
private final String description;
private final String name;
private final ServerSideEncryptionConfiguration serverSideEncryptionConfiguration;
private final Map tags;
private final String type;
private CreateAssistantRequest(BuilderImpl builder) {
super(builder);
this.clientToken = builder.clientToken;
this.description = builder.description;
this.name = builder.name;
this.serverSideEncryptionConfiguration = builder.serverSideEncryptionConfiguration;
this.tags = builder.tags;
this.type = builder.type;
}
/**
*
* 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;
}
/**
*
* The description of the assistant.
*
*
* @return The description of the assistant.
*/
public final String description() {
return description;
}
/**
*
* The name of the assistant.
*
*
* @return The name of the assistant.
*/
public final String name() {
return name;
}
/**
*
* The configuration information for the customer managed key used for encryption.
*
*
* The customer managed key must have a policy that allows kms:CreateGrant,
* kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity
* using the key to invoke Wisdom. To use Wisdom with chat, the key policy must also allow kms:Decrypt,
* kms:GenerateDataKey*, and kms:DescribeKey permissions to the
* connect.amazonaws.com service principal.
*
*
* For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for
* your instance.
*
*
* @return The configuration information for the customer managed key used for encryption.
*
* The customer managed key must have a policy that allows kms:CreateGrant,
* kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM
* identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy must also allow
* kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions
* to the connect.amazonaws.com service principal.
*
*
* For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect
* Wisdom for your instance.
*/
public final ServerSideEncryptionConfiguration serverSideEncryptionConfiguration() {
return serverSideEncryptionConfiguration;
}
/**
* 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.
*
*
* 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.
*/
public final Map tags() {
return tags;
}
/**
*
* The type of assistant.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link AssistantType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of assistant.
* @see AssistantType
*/
public final AssistantType type() {
return AssistantType.fromValue(type);
}
/**
*
* The type of assistant.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link AssistantType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of assistant.
* @see AssistantType
*/
public final String typeAsString() {
return type;
}
@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(clientToken());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(serverSideEncryptionConfiguration());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(typeAsString());
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 CreateAssistantRequest)) {
return false;
}
CreateAssistantRequest other = (CreateAssistantRequest) obj;
return Objects.equals(clientToken(), other.clientToken()) && Objects.equals(description(), other.description())
&& Objects.equals(name(), other.name())
&& Objects.equals(serverSideEncryptionConfiguration(), other.serverSideEncryptionConfiguration())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags())
&& Objects.equals(typeAsString(), other.typeAsString());
}
/**
* 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("CreateAssistantRequest").add("ClientToken", clientToken()).add("Description", description())
.add("Name", name()).add("ServerSideEncryptionConfiguration", serverSideEncryptionConfiguration())
.add("Tags", hasTags() ? tags() : null).add("Type", typeAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "clientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
case "description":
return Optional.ofNullable(clazz.cast(description()));
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "serverSideEncryptionConfiguration":
return Optional.ofNullable(clazz.cast(serverSideEncryptionConfiguration()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
case "type":
return Optional.ofNullable(clazz.cast(typeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateAssistantRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends WisdomRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* 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);
/**
*
* The description of the assistant.
*
*
* @param description
* The description of the assistant.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The name of the assistant.
*
*
* @param name
* The name of the assistant.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The configuration information for the customer managed key used for encryption.
*
*
* The customer managed key must have a policy that allows kms:CreateGrant,
* kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM
* identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy must also allow
* kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to
* the connect.amazonaws.com service principal.
*
*
* For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom
* for your instance.
*
*
* @param serverSideEncryptionConfiguration
* The configuration information for the customer managed key used for encryption.
*
* The customer managed key must have a policy that allows kms:CreateGrant,
* kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM
* identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy must also allow
* kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey
* permissions to the connect.amazonaws.com service principal.
*
*
* For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect
* Wisdom for your instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration);
/**
*
* The configuration information for the customer managed key used for encryption.
*
*
* The customer managed key must have a policy that allows kms:CreateGrant,
* kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM
* identity using the key to invoke Wisdom. To use Wisdom with chat, the key policy must also allow
* kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to
* the connect.amazonaws.com service principal.
*
*
* For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom
* for your instance.
*
* This is a convenience method that creates an instance of the
* {@link ServerSideEncryptionConfiguration.Builder} avoiding the need to create one manually via
* {@link ServerSideEncryptionConfiguration#builder()}.
*
*
* When the {@link Consumer} completes, {@link ServerSideEncryptionConfiguration.Builder#build()} is called
* immediately and its result is passed to
* {@link #serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration)}.
*
* @param serverSideEncryptionConfiguration
* a consumer that will call methods on {@link ServerSideEncryptionConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration)
*/
default Builder serverSideEncryptionConfiguration(
Consumer serverSideEncryptionConfiguration) {
return serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration.builder()
.applyMutation(serverSideEncryptionConfiguration).build());
}
/**
*
* The tags used to organize, track, or control access for this resource.
*
*
* @param tags
* The tags used to organize, track, or control access for this resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Map tags);
/**
*
* The type of assistant.
*
*
* @param type
* The type of assistant.
* @see AssistantType
* @return Returns a reference to this object so that method calls can be chained together.
* @see AssistantType
*/
Builder type(String type);
/**
*
* The type of assistant.
*
*
* @param type
* The type of assistant.
* @see AssistantType
* @return Returns a reference to this object so that method calls can be chained together.
* @see AssistantType
*/
Builder type(AssistantType type);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends WisdomRequest.BuilderImpl implements Builder {
private String clientToken;
private String description;
private String name;
private ServerSideEncryptionConfiguration serverSideEncryptionConfiguration;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private String type;
private BuilderImpl() {
}
private BuilderImpl(CreateAssistantRequest model) {
super(model);
clientToken(model.clientToken);
description(model.description);
name(model.name);
serverSideEncryptionConfiguration(model.serverSideEncryptionConfiguration);
tags(model.tags);
type(model.type);
}
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;
}
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 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 ServerSideEncryptionConfiguration.Builder getServerSideEncryptionConfiguration() {
return serverSideEncryptionConfiguration != null ? serverSideEncryptionConfiguration.toBuilder() : null;
}
public final void setServerSideEncryptionConfiguration(
ServerSideEncryptionConfiguration.BuilderImpl serverSideEncryptionConfiguration) {
this.serverSideEncryptionConfiguration = serverSideEncryptionConfiguration != null ? serverSideEncryptionConfiguration
.build() : null;
}
@Override
public final Builder serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration) {
this.serverSideEncryptionConfiguration = serverSideEncryptionConfiguration;
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagsCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = TagsCopier.copy(tags);
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(AssistantType type) {
this.type(type == null ? null : type.toString());
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 CreateAssistantRequest build() {
return new CreateAssistantRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}