All Downloads are FREE. Search and download functionalities are using the official Maven repository.

software.amazon.awssdk.services.wisdom.model.AssistantData Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Wisdom module holds the client classes that are used for communicating with Wisdom.

There is a newer version: 2.29.15
Show newest version
/*
 * 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.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
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.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;

/**
 * 

* The assistant data. *

*/ @Generated("software.amazon.awssdk:codegen") public final class AssistantData implements SdkPojo, Serializable, ToCopyableBuilder { private static final SdkField ASSISTANT_ARN_FIELD = SdkField. builder(MarshallingType.STRING) .memberName("assistantArn").getter(getter(AssistantData::assistantArn)).setter(setter(Builder::assistantArn)) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("assistantArn").build()).build(); private static final SdkField ASSISTANT_ID_FIELD = SdkField. builder(MarshallingType.STRING) .memberName("assistantId").getter(getter(AssistantData::assistantId)).setter(setter(Builder::assistantId)) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("assistantId").build()).build(); private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING) .memberName("description").getter(getter(AssistantData::description)).setter(setter(Builder::description)) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build(); private static final SdkField INTEGRATION_CONFIGURATION_FIELD = SdkField . builder(MarshallingType.SDK_POJO).memberName("integrationConfiguration") .getter(getter(AssistantData::integrationConfiguration)).setter(setter(Builder::integrationConfiguration)) .constructor(AssistantIntegrationConfiguration::builder) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("integrationConfiguration").build()) .build(); private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name") .getter(getter(AssistantData::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(AssistantData::serverSideEncryptionConfiguration)) .setter(setter(Builder::serverSideEncryptionConfiguration)) .constructor(ServerSideEncryptionConfiguration::builder) .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("serverSideEncryptionConfiguration") .build()).build(); private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("status") .getter(getter(AssistantData::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(AssistantData::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(AssistantData::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(ASSISTANT_ARN_FIELD, ASSISTANT_ID_FIELD, DESCRIPTION_FIELD, INTEGRATION_CONFIGURATION_FIELD, NAME_FIELD, SERVER_SIDE_ENCRYPTION_CONFIGURATION_FIELD, STATUS_FIELD, TAGS_FIELD, TYPE_FIELD)); private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer(); private static final long serialVersionUID = 1L; private final String assistantArn; private final String assistantId; private final String description; private final AssistantIntegrationConfiguration integrationConfiguration; private final String name; private final ServerSideEncryptionConfiguration serverSideEncryptionConfiguration; private final String status; private final Map tags; private final String type; private AssistantData(BuilderImpl builder) { this.assistantArn = builder.assistantArn; this.assistantId = builder.assistantId; this.description = builder.description; this.integrationConfiguration = builder.integrationConfiguration; this.name = builder.name; this.serverSideEncryptionConfiguration = builder.serverSideEncryptionConfiguration; this.status = builder.status; this.tags = builder.tags; this.type = builder.type; } /** *

* The Amazon Resource Name (ARN) of the Wisdom assistant. *

* * @return The Amazon Resource Name (ARN) of the Wisdom assistant. */ public final String assistantArn() { return assistantArn; } /** *

* The identifier of the Wisdom assistant. *

* * @return The identifier of the Wisdom assistant. */ public final String assistantId() { return assistantId; } /** *

* The description. *

* * @return The description. */ public final String description() { return description; } /** *

* The configuration information for the Wisdom assistant integration. *

* * @return The configuration information for the Wisdom assistant integration. */ public final AssistantIntegrationConfiguration integrationConfiguration() { return integrationConfiguration; } /** *

* The name. *

* * @return The name. */ public final String name() { return name; } /** *

* The configuration information for the customer managed key used for encryption. *

*

* This KMS 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.

*

* This KMS 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; } /** *

* The status of the assistant. *

*

* If the service returns an enum value that is not available in the current SDK version, {@link #status} will * return {@link AssistantStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from * {@link #statusAsString}. *

* * @return The status of the assistant. * @see AssistantStatus */ public final AssistantStatus status() { return AssistantStatus.fromValue(status); } /** *

* The status of the assistant. *

*

* If the service returns an enum value that is not available in the current SDK version, {@link #status} will * return {@link AssistantStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from * {@link #statusAsString}. *

* * @return The status of the assistant. * @see AssistantStatus */ 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. *

*

* 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 + Objects.hashCode(assistantArn()); hashCode = 31 * hashCode + Objects.hashCode(assistantId()); hashCode = 31 * hashCode + Objects.hashCode(description()); hashCode = 31 * hashCode + Objects.hashCode(integrationConfiguration()); hashCode = 31 * hashCode + Objects.hashCode(name()); hashCode = 31 * hashCode + Objects.hashCode(serverSideEncryptionConfiguration()); hashCode = 31 * hashCode + Objects.hashCode(statusAsString()); hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null); hashCode = 31 * hashCode + Objects.hashCode(typeAsString()); return hashCode; } @Override public final boolean equals(Object obj) { return equalsBySdkFields(obj); } @Override public final boolean equalsBySdkFields(Object obj) { if (this == obj) { return true; } if (obj == null) { return false; } if (!(obj instanceof AssistantData)) { return false; } AssistantData other = (AssistantData) obj; return Objects.equals(assistantArn(), other.assistantArn()) && Objects.equals(assistantId(), other.assistantId()) && Objects.equals(description(), other.description()) && Objects.equals(integrationConfiguration(), other.integrationConfiguration()) && Objects.equals(name(), other.name()) && Objects.equals(serverSideEncryptionConfiguration(), other.serverSideEncryptionConfiguration()) && Objects.equals(statusAsString(), other.statusAsString()) && 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("AssistantData").add("AssistantArn", assistantArn()).add("AssistantId", assistantId()) .add("Description", description()).add("IntegrationConfiguration", integrationConfiguration()) .add("Name", name()).add("ServerSideEncryptionConfiguration", serverSideEncryptionConfiguration()) .add("Status", statusAsString()).add("Tags", hasTags() ? tags() : null).add("Type", typeAsString()).build(); } public final Optional getValueForField(String fieldName, Class clazz) { switch (fieldName) { case "assistantArn": return Optional.ofNullable(clazz.cast(assistantArn())); case "assistantId": return Optional.ofNullable(clazz.cast(assistantId())); case "description": return Optional.ofNullable(clazz.cast(description())); case "integrationConfiguration": return Optional.ofNullable(clazz.cast(integrationConfiguration())); case "name": return Optional.ofNullable(clazz.cast(name())); case "serverSideEncryptionConfiguration": return Optional.ofNullable(clazz.cast(serverSideEncryptionConfiguration())); case "status": return Optional.ofNullable(clazz.cast(statusAsString())); 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; } @Override public final Map> sdkFieldNameToField() { return SDK_NAME_TO_FIELD; } private static Map> memberNameToFieldInitializer() { Map> map = new HashMap<>(); map.put("assistantArn", ASSISTANT_ARN_FIELD); map.put("assistantId", ASSISTANT_ID_FIELD); map.put("description", DESCRIPTION_FIELD); map.put("integrationConfiguration", INTEGRATION_CONFIGURATION_FIELD); map.put("name", NAME_FIELD); map.put("serverSideEncryptionConfiguration", SERVER_SIDE_ENCRYPTION_CONFIGURATION_FIELD); map.put("status", STATUS_FIELD); map.put("tags", TAGS_FIELD); map.put("type", TYPE_FIELD); return Collections.unmodifiableMap(map); } private static Function getter(Function g) { return obj -> g.apply((AssistantData) obj); } private static BiConsumer setter(BiConsumer s) { return (obj, val) -> s.accept((Builder) obj, val); } public interface Builder extends SdkPojo, CopyableBuilder { /** *

* The Amazon Resource Name (ARN) of the Wisdom assistant. *

* * @param assistantArn * The Amazon Resource Name (ARN) of the Wisdom assistant. * @return Returns a reference to this object so that method calls can be chained together. */ Builder assistantArn(String assistantArn); /** *

* The identifier of the Wisdom assistant. *

* * @param assistantId * The identifier of the Wisdom assistant. * @return Returns a reference to this object so that method calls can be chained together. */ Builder assistantId(String assistantId); /** *

* The description. *

* * @param description * The description. * @return Returns a reference to this object so that method calls can be chained together. */ Builder description(String description); /** *

* The configuration information for the Wisdom assistant integration. *

* * @param integrationConfiguration * The configuration information for the Wisdom assistant integration. * @return Returns a reference to this object so that method calls can be chained together. */ Builder integrationConfiguration(AssistantIntegrationConfiguration integrationConfiguration); /** *

* The configuration information for the Wisdom assistant integration. *

* This is a convenience method that creates an instance of the * {@link AssistantIntegrationConfiguration.Builder} avoiding the need to create one manually via * {@link AssistantIntegrationConfiguration#builder()}. * *

* When the {@link Consumer} completes, {@link AssistantIntegrationConfiguration.Builder#build()} is called * immediately and its result is passed to {@link #integrationConfiguration(AssistantIntegrationConfiguration)}. * * @param integrationConfiguration * a consumer that will call methods on {@link AssistantIntegrationConfiguration.Builder} * @return Returns a reference to this object so that method calls can be chained together. * @see #integrationConfiguration(AssistantIntegrationConfiguration) */ default Builder integrationConfiguration(Consumer integrationConfiguration) { return integrationConfiguration(AssistantIntegrationConfiguration.builder().applyMutation(integrationConfiguration) .build()); } /** *

* The name. *

* * @param name * The name. * @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. *

*

* This KMS 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.

*

* This KMS 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. *

*

* This KMS 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 status of the assistant. *

* * @param status * The status of the assistant. * @see AssistantStatus * @return Returns a reference to this object so that method calls can be chained together. * @see AssistantStatus */ Builder status(String status); /** *

* The status of the assistant. *

* * @param status * The status of the assistant. * @see AssistantStatus * @return Returns a reference to this object so that method calls can be chained together. * @see AssistantStatus */ Builder status(AssistantStatus status); /** *

* 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); } static final class BuilderImpl implements Builder { private String assistantArn; private String assistantId; private String description; private AssistantIntegrationConfiguration integrationConfiguration; private String name; private ServerSideEncryptionConfiguration serverSideEncryptionConfiguration; private String status; private Map tags = DefaultSdkAutoConstructMap.getInstance(); private String type; private BuilderImpl() { } private BuilderImpl(AssistantData model) { assistantArn(model.assistantArn); assistantId(model.assistantId); description(model.description); integrationConfiguration(model.integrationConfiguration); name(model.name); serverSideEncryptionConfiguration(model.serverSideEncryptionConfiguration); status(model.status); tags(model.tags); type(model.type); } public final String getAssistantArn() { return assistantArn; } public final void setAssistantArn(String assistantArn) { this.assistantArn = assistantArn; } @Override public final Builder assistantArn(String assistantArn) { this.assistantArn = assistantArn; return this; } public final String getAssistantId() { return assistantId; } public final void setAssistantId(String assistantId) { this.assistantId = assistantId; } @Override public final Builder assistantId(String assistantId) { this.assistantId = assistantId; 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 AssistantIntegrationConfiguration.Builder getIntegrationConfiguration() { return integrationConfiguration != null ? integrationConfiguration.toBuilder() : null; } public final void setIntegrationConfiguration(AssistantIntegrationConfiguration.BuilderImpl integrationConfiguration) { this.integrationConfiguration = integrationConfiguration != null ? integrationConfiguration.build() : null; } @Override public final Builder integrationConfiguration(AssistantIntegrationConfiguration integrationConfiguration) { this.integrationConfiguration = integrationConfiguration; 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 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(AssistantStatus 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 = 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 AssistantData build() { return new AssistantData(this); } @Override public List> sdkFields() { return SDK_FIELDS; } @Override public Map> sdkFieldNameToField() { return SDK_NAME_TO_FIELD; } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy