software.amazon.awssdk.services.kendra.model.ListFeaturedResultsSetsRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kendra Show documentation
Show all versions of kendra Show documentation
The AWS Java SDK for Kendra module holds the client classes that are used for
communicating with Kendra.
/*
* 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.kendra.model;
import java.util.Arrays;
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 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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListFeaturedResultsSetsRequest extends KendraRequest implements
ToCopyableBuilder {
private static final SdkField INDEX_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("IndexId").getter(getter(ListFeaturedResultsSetsRequest::indexId)).setter(setter(Builder::indexId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IndexId").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(ListFeaturedResultsSetsRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(ListFeaturedResultsSetsRequest::maxResults))
.setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INDEX_ID_FIELD,
NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD));
private final String indexId;
private final String nextToken;
private final Integer maxResults;
private ListFeaturedResultsSetsRequest(BuilderImpl builder) {
super(builder);
this.indexId = builder.indexId;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
}
/**
*
* The identifier of the index used for featuring results.
*
*
* @return The identifier of the index used for featuring results.
*/
public final String indexId() {
return indexId;
}
/**
*
* If the response is truncated, Amazon Kendra returns a pagination token in the response. You can use this
* pagination token to retrieve the next set of featured results sets.
*
*
* @return If the response is truncated, Amazon Kendra returns a pagination token in the response. You can use this
* pagination token to retrieve the next set of featured results sets.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The maximum number of featured results sets to return.
*
*
* @return The maximum number of featured results sets to return.
*/
public final Integer maxResults() {
return maxResults;
}
@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(indexId());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
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 ListFeaturedResultsSetsRequest)) {
return false;
}
ListFeaturedResultsSetsRequest other = (ListFeaturedResultsSetsRequest) obj;
return Objects.equals(indexId(), other.indexId()) && Objects.equals(nextToken(), other.nextToken())
&& Objects.equals(maxResults(), other.maxResults());
}
/**
* 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("ListFeaturedResultsSetsRequest").add("IndexId", indexId()).add("NextToken", nextToken())
.add("MaxResults", maxResults()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "IndexId":
return Optional.ofNullable(clazz.cast(indexId()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListFeaturedResultsSetsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends KendraRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The identifier of the index used for featuring results.
*
*
* @param indexId
* The identifier of the index used for featuring results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder indexId(String indexId);
/**
*
* If the response is truncated, Amazon Kendra returns a pagination token in the response. You can use this
* pagination token to retrieve the next set of featured results sets.
*
*
* @param nextToken
* If the response is truncated, Amazon Kendra returns a pagination token in the response. You can use
* this pagination token to retrieve the next set of featured results sets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The maximum number of featured results sets to return.
*
*
* @param maxResults
* The maximum number of featured results sets to return.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends KendraRequest.BuilderImpl implements Builder {
private String indexId;
private String nextToken;
private Integer maxResults;
private BuilderImpl() {
}
private BuilderImpl(ListFeaturedResultsSetsRequest model) {
super(model);
indexId(model.indexId);
nextToken(model.nextToken);
maxResults(model.maxResults);
}
public final String getIndexId() {
return indexId;
}
public final void setIndexId(String indexId) {
this.indexId = indexId;
}
@Override
public final Builder indexId(String indexId) {
this.indexId = indexId;
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 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;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ListFeaturedResultsSetsRequest build() {
return new ListFeaturedResultsSetsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}