software.amazon.awssdk.services.cloudsearch.model

Class LiteralOptions

java.lang.Object

software.amazon.awssdk.services.cloudsearch.model.LiteralOptions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<LiteralOptions.Builder,LiteralOptions>

@Generated(value="software.amazon.awssdk:codegen")
public final class LiteralOptions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LiteralOptions.Builder,LiteralOptions>

Options for literal field. Present if IndexFieldType specifies the field is of type literal . All options are enabled by default.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LiteralOptions.Builder

Method Summary

Modifier and Type	Method and Description
static LiteralOptions.Builder	builder()
String	defaultValue() A value to use for the field if the field isn't specified for a document.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	facetEnabled() Whether facet information can be returned for the field.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	returnEnabled() Whether the contents of the field can be returned in the search results.
List<SdkField<?>>	sdkFields()
Boolean	searchEnabled() Whether the contents of the field are searchable.
static Class<? extends LiteralOptions.Builder>	serializableBuilderClass()
Boolean	sortEnabled() Whether the field can be used to sort the search results.
String	sourceField() Returns the value of the SourceField property for this object.
LiteralOptions.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

defaultValue

public final String defaultValue()

A value to use for the field if the field isn't specified for a document.

Returns:

A value to use for the field if the field isn't specified for a document.

sourceField

public final String sourceField()

Returns the value of the SourceField property for this object.

Returns:

The value of the SourceField property for this object.

facetEnabled

public final Boolean facetEnabled()

Whether facet information can be returned for the field.

Returns:

Whether facet information can be returned for the field.

searchEnabled

public final Boolean searchEnabled()

Whether the contents of the field are searchable.

Returns:

Whether the contents of the field are searchable.

returnEnabled

public final Boolean returnEnabled()

Whether the contents of the field can be returned in the search results.

Returns:

Whether the contents of the field can be returned in the search results.

sortEnabled

public final Boolean sortEnabled()

Whether the field can be used to sort the search results.

Returns:

Whether the field can be used to sort the search results.

toBuilder

public LiteralOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LiteralOptions.Builder,LiteralOptions>

builder

public static LiteralOptions.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo