software.amazon.awssdk.services.cloudsearch.model.DescribeSuggestersRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cloudsearch Show documentation
Show all versions of cloudsearch Show documentation
The AWS Java SDK for Amazon CloudSearch module holds the client classes that are used for communicating
with Amazon CloudSearch Service
/*
* 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.cloudsearch.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 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.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;
/**
*
* Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain
* you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want
* to describe. To show the active configuration and exclude any pending changes, set the Deployed option
* to true.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeSuggestersRequest extends CloudSearchRequest implements
ToCopyableBuilder {
private static final SdkField DOMAIN_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DomainName").getter(getter(DescribeSuggestersRequest::domainName)).setter(setter(Builder::domainName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DomainName").build()).build();
private static final SdkField> SUGGESTER_NAMES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SuggesterNames")
.getter(getter(DescribeSuggestersRequest::suggesterNames))
.setter(setter(Builder::suggesterNames))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SuggesterNames").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField DEPLOYED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("Deployed").getter(getter(DescribeSuggestersRequest::deployed)).setter(setter(Builder::deployed))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Deployed").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DOMAIN_NAME_FIELD,
SUGGESTER_NAMES_FIELD, DEPLOYED_FIELD));
private final String domainName;
private final List suggesterNames;
private final Boolean deployed;
private DescribeSuggestersRequest(BuilderImpl builder) {
super(builder);
this.domainName = builder.domainName;
this.suggesterNames = builder.suggesterNames;
this.deployed = builder.deployed;
}
/**
*
* The name of the domain you want to describe.
*
*
* @return The name of the domain you want to describe.
*/
public final String domainName() {
return domainName;
}
/**
* For responses, this returns true if the service returned a value for the SuggesterNames 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 hasSuggesterNames() {
return suggesterNames != null && !(suggesterNames instanceof SdkAutoConstructList);
}
/**
*
* The suggesters you want to describe.
*
*
* 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 #hasSuggesterNames} method.
*
*
* @return The suggesters you want to describe.
*/
public final List suggesterNames() {
return suggesterNames;
}
/**
*
* Whether to display the deployed configuration (true) or include any pending changes (
* false). Defaults to false.
*
*
* @return Whether to display the deployed configuration (true) or include any pending changes (
* false). Defaults to false.
*/
public final Boolean deployed() {
return deployed;
}
@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(domainName());
hashCode = 31 * hashCode + Objects.hashCode(hasSuggesterNames() ? suggesterNames() : null);
hashCode = 31 * hashCode + Objects.hashCode(deployed());
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 DescribeSuggestersRequest)) {
return false;
}
DescribeSuggestersRequest other = (DescribeSuggestersRequest) obj;
return Objects.equals(domainName(), other.domainName()) && hasSuggesterNames() == other.hasSuggesterNames()
&& Objects.equals(suggesterNames(), other.suggesterNames()) && Objects.equals(deployed(), other.deployed());
}
/**
* 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("DescribeSuggestersRequest").add("DomainName", domainName())
.add("SuggesterNames", hasSuggesterNames() ? suggesterNames() : null).add("Deployed", deployed()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DomainName":
return Optional.ofNullable(clazz.cast(domainName()));
case "SuggesterNames":
return Optional.ofNullable(clazz.cast(suggesterNames()));
case "Deployed":
return Optional.ofNullable(clazz.cast(deployed()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeSuggestersRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CloudSearchRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the domain you want to describe.
*
*
* @param domainName
* The name of the domain you want to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder domainName(String domainName);
/**
*
* The suggesters you want to describe.
*
*
* @param suggesterNames
* The suggesters you want to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder suggesterNames(Collection suggesterNames);
/**
*
* The suggesters you want to describe.
*
*
* @param suggesterNames
* The suggesters you want to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder suggesterNames(String... suggesterNames);
/**
*
* Whether to display the deployed configuration (true) or include any pending changes (
* false). Defaults to false.
*
*
* @param deployed
* Whether to display the deployed configuration (true) or include any pending changes (
* false). Defaults to false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deployed(Boolean deployed);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CloudSearchRequest.BuilderImpl implements Builder {
private String domainName;
private List suggesterNames = DefaultSdkAutoConstructList.getInstance();
private Boolean deployed;
private BuilderImpl() {
}
private BuilderImpl(DescribeSuggestersRequest model) {
super(model);
domainName(model.domainName);
suggesterNames(model.suggesterNames);
deployed(model.deployed);
}
public final String getDomainName() {
return domainName;
}
public final void setDomainName(String domainName) {
this.domainName = domainName;
}
@Override
public final Builder domainName(String domainName) {
this.domainName = domainName;
return this;
}
public final Collection getSuggesterNames() {
if (suggesterNames instanceof SdkAutoConstructList) {
return null;
}
return suggesterNames;
}
public final void setSuggesterNames(Collection suggesterNames) {
this.suggesterNames = StandardNameListCopier.copy(suggesterNames);
}
@Override
public final Builder suggesterNames(Collection suggesterNames) {
this.suggesterNames = StandardNameListCopier.copy(suggesterNames);
return this;
}
@Override
@SafeVarargs
public final Builder suggesterNames(String... suggesterNames) {
suggesterNames(Arrays.asList(suggesterNames));
return this;
}
public final Boolean getDeployed() {
return deployed;
}
public final void setDeployed(Boolean deployed) {
this.deployed = deployed;
}
@Override
public final Builder deployed(Boolean deployed) {
this.deployed = deployed;
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 DescribeSuggestersRequest build() {
return new DescribeSuggestersRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy