software.amazon.awssdk.services.wisdom.model.SearchQuickResponsesRequest 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.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 SearchQuickResponsesRequest extends WisdomRequest implements
ToCopyableBuilder {
private static final SdkField> ATTRIBUTES_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("attributes")
.getter(getter(SearchQuickResponsesRequest::attributes))
.setter(setter(Builder::attributes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("attributes").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 KNOWLEDGE_BASE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("knowledgeBaseId").getter(getter(SearchQuickResponsesRequest::knowledgeBaseId))
.setter(setter(Builder::knowledgeBaseId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("knowledgeBaseId").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("maxResults").getter(getter(SearchQuickResponsesRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("maxResults").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("nextToken").getter(getter(SearchQuickResponsesRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("nextToken").build()).build();
private static final SdkField SEARCH_EXPRESSION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("searchExpression")
.getter(getter(SearchQuickResponsesRequest::searchExpression)).setter(setter(Builder::searchExpression))
.constructor(QuickResponseSearchExpression::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("searchExpression").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ATTRIBUTES_FIELD,
KNOWLEDGE_BASE_ID_FIELD, MAX_RESULTS_FIELD, NEXT_TOKEN_FIELD, SEARCH_EXPRESSION_FIELD));
private final Map attributes;
private final String knowledgeBaseId;
private final Integer maxResults;
private final String nextToken;
private final QuickResponseSearchExpression searchExpression;
private SearchQuickResponsesRequest(BuilderImpl builder) {
super(builder);
this.attributes = builder.attributes;
this.knowledgeBaseId = builder.knowledgeBaseId;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
this.searchExpression = builder.searchExpression;
}
/**
* For responses, this returns true if the service returned a value for the Attributes 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 hasAttributes() {
return attributes != null && !(attributes instanceof SdkAutoConstructMap);
}
/**
*
* The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
*
*
* 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 #hasAttributes} method.
*
*
* @return The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
*/
public final Map attributes() {
return attributes;
}
/**
*
* The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID
* or the ARN. URLs cannot contain the ARN.
*
*
* @return The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either
* the ID or the ARN. URLs cannot contain the ARN.
*/
public final String knowledgeBaseId() {
return knowledgeBaseId;
}
/**
*
* The maximum number of results to return per page.
*
*
* @return The maximum number of results to return per page.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* The token for the next set of results. Use the value returned in the previous response in the next request to
* retrieve the next set of results.
*
*
* @return The token for the next set of results. Use the value returned in the previous response in the next
* request to retrieve the next set of results.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The search expression for querying the quick response.
*
*
* @return The search expression for querying the quick response.
*/
public final QuickResponseSearchExpression searchExpression() {
return searchExpression;
}
@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(hasAttributes() ? attributes() : null);
hashCode = 31 * hashCode + Objects.hashCode(knowledgeBaseId());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(searchExpression());
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 SearchQuickResponsesRequest)) {
return false;
}
SearchQuickResponsesRequest other = (SearchQuickResponsesRequest) obj;
return hasAttributes() == other.hasAttributes() && Objects.equals(attributes(), other.attributes())
&& Objects.equals(knowledgeBaseId(), other.knowledgeBaseId()) && Objects.equals(maxResults(), other.maxResults())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(searchExpression(), other.searchExpression());
}
/**
* 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("SearchQuickResponsesRequest")
.add("Attributes", attributes() == null ? null : "*** Sensitive Data Redacted ***")
.add("KnowledgeBaseId", knowledgeBaseId()).add("MaxResults", maxResults()).add("NextToken", nextToken())
.add("SearchExpression", searchExpression()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "attributes":
return Optional.ofNullable(clazz.cast(attributes()));
case "knowledgeBaseId":
return Optional.ofNullable(clazz.cast(knowledgeBaseId()));
case "maxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "nextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "searchExpression":
return Optional.ofNullable(clazz.cast(searchExpression()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SearchQuickResponsesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends WisdomRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
*
*
* @param attributes
* The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributes(Map attributes);
/**
*
* The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the
* ID or the ARN. URLs cannot contain the ARN.
*
*
* @param knowledgeBaseId
* The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be
* either the ID or the ARN. URLs cannot contain the ARN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder knowledgeBaseId(String knowledgeBaseId);
/**
*
* The maximum number of results to return per page.
*
*
* @param maxResults
* The maximum number of results to return per page.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* The token for the next set of results. Use the value returned in the previous response in the next request to
* retrieve the next set of results.
*
*
* @param nextToken
* The token for the next set of results. Use the value returned in the previous response in the next
* request to retrieve the next set of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The search expression for querying the quick response.
*
*
* @param searchExpression
* The search expression for querying the quick response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder searchExpression(QuickResponseSearchExpression searchExpression);
/**
*
* The search expression for querying the quick response.
*
* This is a convenience method that creates an instance of the {@link QuickResponseSearchExpression.Builder}
* avoiding the need to create one manually via {@link QuickResponseSearchExpression#builder()}.
*
*
* When the {@link Consumer} completes, {@link QuickResponseSearchExpression.Builder#build()} is called
* immediately and its result is passed to {@link #searchExpression(QuickResponseSearchExpression)}.
*
* @param searchExpression
* a consumer that will call methods on {@link QuickResponseSearchExpression.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #searchExpression(QuickResponseSearchExpression)
*/
default Builder searchExpression(Consumer searchExpression) {
return searchExpression(QuickResponseSearchExpression.builder().applyMutation(searchExpression).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends WisdomRequest.BuilderImpl implements Builder {
private Map attributes = DefaultSdkAutoConstructMap.getInstance();
private String knowledgeBaseId;
private Integer maxResults;
private String nextToken;
private QuickResponseSearchExpression searchExpression;
private BuilderImpl() {
}
private BuilderImpl(SearchQuickResponsesRequest model) {
super(model);
attributes(model.attributes);
knowledgeBaseId(model.knowledgeBaseId);
maxResults(model.maxResults);
nextToken(model.nextToken);
searchExpression(model.searchExpression);
}
public final Map getAttributes() {
if (attributes instanceof SdkAutoConstructMap) {
return null;
}
return attributes;
}
public final void setAttributes(Map attributes) {
this.attributes = ContactAttributesCopier.copy(attributes);
}
@Override
public final Builder attributes(Map attributes) {
this.attributes = ContactAttributesCopier.copy(attributes);
return this;
}
public final String getKnowledgeBaseId() {
return knowledgeBaseId;
}
public final void setKnowledgeBaseId(String knowledgeBaseId) {
this.knowledgeBaseId = knowledgeBaseId;
}
@Override
public final Builder knowledgeBaseId(String knowledgeBaseId) {
this.knowledgeBaseId = knowledgeBaseId;
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final QuickResponseSearchExpression.Builder getSearchExpression() {
return searchExpression != null ? searchExpression.toBuilder() : null;
}
public final void setSearchExpression(QuickResponseSearchExpression.BuilderImpl searchExpression) {
this.searchExpression = searchExpression != null ? searchExpression.build() : null;
}
@Override
public final Builder searchExpression(QuickResponseSearchExpression searchExpression) {
this.searchExpression = searchExpression;
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 SearchQuickResponsesRequest build() {
return new SearchQuickResponsesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}