Package 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:

SdkPojo, ToCopyableBuilder<DescribeIndexFieldsRequest.Builder,DescribeIndexFieldsRequest>

@Generated("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	Description
static interface	DescribeIndexFieldsRequest.Builder

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)
boolean	equalsBySdkFields(Object obj)
List<String>	fieldNames()	A list of the index fields you want to describe.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFieldNames()	For responses, this returns true if the service returned a value for the FieldNames property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeIndexFieldsRequest.Builder>	serializableBuilderClass()
DescribeIndexFieldsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

domainName

public final String domainName()

The name of the domain you want to describe.

Returns:

The name of the domain you want to describe.

hasFieldNames

public final boolean hasFieldNames()

For responses, this returns true if the service returned a value for the FieldNames property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

fieldNames

public final 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.

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 hasFieldNames() method.

Returns:

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

deployed

public final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeIndexFieldsRequest.Builder,DescribeIndexFieldsRequest>

Specified by:

toBuilder in class CloudSearchRequest

builder

public static DescribeIndexFieldsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo