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

Class LiteralOptions

java.lang.Object

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

All Implemented Interfaces:

ToCopyableBuilder<LiteralOptions.Builder,LiteralOptions>

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LiteralOptions.Builder

Method Summary

Modifier and Type	Method	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	facetEnabled()	Whether facet information can be returned for the field.
int	hashCode()
Boolean	returnEnabled()	Whether the contents of the field can be returned in the search results.
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()
LiteralOptions.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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

defaultValue

public 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 String sourceField()

Returns:

facetEnabled

public Boolean facetEnabled()

Whether facet information can be returned for the field.

Returns:

Whether facet information can be returned for the field.

searchEnabled

public Boolean searchEnabled()

Whether the contents of the field are searchable.

Returns:

Whether the contents of the field are searchable.

returnEnabled

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

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

Returns:

a builder for type T

builder

public static LiteralOptions.Builder builder()

serializableBuilderClass

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