Package software.amazon.awssdk.services.cloudsearch.model

Class DescribeSuggestersRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.cloudsearch.model.DescribeSuggestersRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeSuggestersRequest.Builder,DescribeSuggestersRequest>

@Generated("software.amazon.awssdk:codegen")
public class DescribeSuggestersRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DescribeSuggestersRequest.Builder,DescribeSuggestersRequest>

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeSuggestersRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DescribeSuggestersRequest.Builder	builder()
Boolean	deployed()	Whether to display the deployed configuration (true) or include any pending changes ( false).
String	domainName()	The name of the domain you want to describe.
boolean	equals(Object obj)
int	hashCode()
static Class<? extends DescribeSuggestersRequest.Builder>	serializableBuilderClass()
List<String>	suggesterNames()	The suggesters you want to describe.
DescribeSuggestersRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

domainName

public String domainName()

The name of the domain you want to describe.

Returns:

The name of the domain you want to describe.

suggesterNames

public List<String> suggesterNames()

The suggesters you want to describe.

Returns:

The suggesters you want to describe.

deployed

public Boolean deployed()

Whether to display the deployed configuration (true) or include any pending changes ( false). Defaults to false.

Returns:

Whether to display the deployed configuration (true) or include any pending changes ( false). Defaults to false.

toBuilder

public DescribeSuggestersRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeSuggestersRequest.Builder,DescribeSuggestersRequest>

Returns:

a builder for type T

builder

public static DescribeSuggestersRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeSuggestersRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object