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

Interface TextOptions.Builder

All Superinterfaces:

CopyableBuilder<TextOptions.Builder,TextOptions>, SdkBuilder<TextOptions.Builder,TextOptions>

Enclosing class:

TextOptions

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

Method Summary

Modifier and Type	Method	Description
TextOptions.Builder	analysisScheme(String analysisScheme)	The name of an analysis scheme for a text field.
TextOptions.Builder	defaultValue(String defaultValue)	A value to use for the field if the field isn't specified for a document.
TextOptions.Builder	highlightEnabled(Boolean highlightEnabled)	Whether highlights can be returned for the field.
TextOptions.Builder	returnEnabled(Boolean returnEnabled)	Whether the contents of the field can be returned in the search results.
TextOptions.Builder	sortEnabled(Boolean sortEnabled)	Whether the field can be used to sort the search results.
TextOptions.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

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

TextOptions.Builder sourceField(String sourceField)

Parameters:

sourceField -

Returns:

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

returnEnabled

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

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

highlightEnabled

TextOptions.Builder highlightEnabled(Boolean highlightEnabled)

Whether highlights can be returned for the field.

Parameters:

highlightEnabled - Whether highlights can be returned for the field.

Returns:

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

analysisScheme

TextOptions.Builder analysisScheme(String analysisScheme)

The name of an analysis scheme for a text field.

Parameters:

analysisScheme - The name of an analysis scheme for a text field.

Returns:

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