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

Interface LiteralOptions.Builder

All Superinterfaces:

CopyableBuilder<LiteralOptions.Builder,LiteralOptions>, SdkBuilder<LiteralOptions.Builder,LiteralOptions>

Enclosing class:

LiteralOptions

public static interface LiteralOptions.Builder
extends CopyableBuilder<LiteralOptions.Builder,LiteralOptions>

Method Summary

Modifier and Type	Method	Description
LiteralOptions.Builder	defaultValue(String defaultValue)	A value to use for the field if the field isn't specified for a document.
LiteralOptions.Builder	facetEnabled(Boolean facetEnabled)	Whether facet information can be returned for the field.
LiteralOptions.Builder	returnEnabled(Boolean returnEnabled)	Whether the contents of the field can be returned in the search results.
LiteralOptions.Builder	searchEnabled(Boolean searchEnabled)	Whether the contents of the field are searchable.
LiteralOptions.Builder	sortEnabled(Boolean sortEnabled)	Whether the field can be used to sort the search results.
LiteralOptions.Builder	sourceField(String sourceField)

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

copy

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

apply, build

Method Detail

defaultValue

LiteralOptions.Builder defaultValue(String defaultValue)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceField

LiteralOptions.Builder sourceField(String sourceField)

Parameters:

sourceField -

Returns:

Returns a reference to this object so that method calls can be chained together.

facetEnabled

LiteralOptions.Builder facetEnabled(Boolean facetEnabled)

Whether facet information can be returned for the field.

Parameters:

facetEnabled - Whether facet information can be returned for the field.

Returns:

Returns a reference to this object so that method calls can be chained together.

searchEnabled

LiteralOptions.Builder searchEnabled(Boolean searchEnabled)

Whether the contents of the field are searchable.

Parameters:

searchEnabled - Whether the contents of the field are searchable.

Returns:

Returns a reference to this object so that method calls can be chained together.

returnEnabled

LiteralOptions.Builder returnEnabled(Boolean returnEnabled)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sortEnabled

LiteralOptions.Builder sortEnabled(Boolean sortEnabled)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.