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

Class DescribeIndexFieldsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.cloudsearch.model.DescribeIndexFieldsRequest

All Implemented Interfaces:

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

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

Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields 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	DescribeIndexFieldsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DescribeIndexFieldsRequest.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)
List<String>	fieldNames()	A list of the index fields you want to describe.
int	hashCode()
static Class<? extends DescribeIndexFieldsRequest.Builder>	serializableBuilderClass()
DescribeIndexFieldsRequest.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.

fieldNames

public List<String> fieldNames()

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

Returns:

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

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 DescribeIndexFieldsRequest.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<DescribeIndexFieldsRequest.Builder,DescribeIndexFieldsRequest>

Returns:

a builder for type T

builder

public static DescribeIndexFieldsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeIndexFieldsRequest.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