software.amazon.awssdk.services.cloudsearch.model

Class DescribeIndexFieldsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudsearch.model.CloudSearchRequest

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

All Implemented Interfaces:

ToCopyableBuilder<DescribeIndexFieldsRequest.Builder,DescribeIndexFieldsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeIndexFieldsRequest
extends CloudSearchRequest
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 and Description
static interface	DescribeIndexFieldsRequest.Builder

Method Summary

Modifier and Type	Method and 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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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>

Specified by:

toBuilder in class CloudSearchRequest

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value