software.amazon.awssdk.services.cloudsearch.model

Class DefineIndexFieldRequest

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.DefineIndexFieldRequest

All Implemented Interfaces:

ToCopyableBuilder<DefineIndexFieldRequest.Builder,DefineIndexFieldRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DefineIndexFieldRequest
extends CloudSearchRequest
implements ToCopyableBuilder<DefineIndexFieldRequest.Builder,DefineIndexFieldRequest>

Container for the parameters to the DefineIndexField operation. Specifies the name of the domain you want to update and the index field configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DefineIndexFieldRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DefineIndexFieldRequest.Builder	builder()
String	domainName() Returns the value of the DomainName property for this object.
boolean	equals(Object obj)
<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()
IndexField	indexField() The index field and field options you want to configure.
static Class<? extends DefineIndexFieldRequest.Builder>	serializableBuilderClass()
DefineIndexFieldRequest.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()

Returns the value of the DomainName property for this object.

Returns:

The value of the DomainName property for this object.

indexField

public IndexField indexField()

The index field and field options you want to configure.

Returns:

The index field and field options you want to configure.

toBuilder

public DefineIndexFieldRequest.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<DefineIndexFieldRequest.Builder,DefineIndexFieldRequest>

Specified by:

toBuilder in class CloudSearchRequest

Returns:

a builder for type T

builder

public static DefineIndexFieldRequest.Builder builder()

serializableBuilderClass

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