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

Interface IndexField.Builder

All Superinterfaces:

CopyableBuilder<IndexField.Builder,IndexField>, SdkBuilder<IndexField.Builder,IndexField>

Enclosing class:

IndexField

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

Method Summary

Modifier and Type	Method	Description
IndexField.Builder	dateArrayOptions(DateArrayOptions dateArrayOptions)
IndexField.Builder	dateOptions(DateOptions dateOptions)
IndexField.Builder	doubleArrayOptions(DoubleArrayOptions doubleArrayOptions)
IndexField.Builder	doubleOptions(DoubleOptions doubleOptions)
IndexField.Builder	indexFieldName(String indexFieldName)	A string that represents the name of an index field.
IndexField.Builder	indexFieldType(String indexFieldType)
IndexField.Builder	indexFieldType(IndexFieldType indexFieldType)
IndexField.Builder	intArrayOptions(IntArrayOptions intArrayOptions)
IndexField.Builder	intOptions(IntOptions intOptions)
IndexField.Builder	latLonOptions(LatLonOptions latLonOptions)
IndexField.Builder	literalArrayOptions(LiteralArrayOptions literalArrayOptions)
IndexField.Builder	literalOptions(LiteralOptions literalOptions)
IndexField.Builder	textArrayOptions(TextArrayOptions textArrayOptions)
IndexField.Builder	textOptions(TextOptions textOptions)

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

indexFieldName

IndexField.Builder indexFieldName(String indexFieldName)

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

Parameters:

indexFieldName - A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

Returns:

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

indexFieldType

IndexField.Builder indexFieldType(String indexFieldType)

Parameters:

indexFieldType -

Returns:

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

See Also:

IndexFieldType

indexFieldType

IndexField.Builder indexFieldType(IndexFieldType indexFieldType)

Parameters:

indexFieldType -

Returns:

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

See Also:

IndexFieldType

intOptions

IndexField.Builder intOptions(IntOptions intOptions)

Parameters:

intOptions -

Returns:

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

doubleOptions

IndexField.Builder doubleOptions(DoubleOptions doubleOptions)

Parameters:

doubleOptions -

Returns:

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

literalOptions

IndexField.Builder literalOptions(LiteralOptions literalOptions)

Parameters:

literalOptions -

Returns:

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

textOptions

IndexField.Builder textOptions(TextOptions textOptions)

Parameters:

textOptions -

Returns:

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

dateOptions

IndexField.Builder dateOptions(DateOptions dateOptions)

Parameters:

dateOptions -

Returns:

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

latLonOptions

IndexField.Builder latLonOptions(LatLonOptions latLonOptions)

Parameters:

latLonOptions -

Returns:

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

intArrayOptions

IndexField.Builder intArrayOptions(IntArrayOptions intArrayOptions)

Parameters:

intArrayOptions -

Returns:

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

doubleArrayOptions

IndexField.Builder doubleArrayOptions(DoubleArrayOptions doubleArrayOptions)

Parameters:

doubleArrayOptions -

Returns:

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

literalArrayOptions

IndexField.Builder literalArrayOptions(LiteralArrayOptions literalArrayOptions)

Parameters:

literalArrayOptions -

Returns:

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

textArrayOptions

IndexField.Builder textArrayOptions(TextArrayOptions textArrayOptions)

Parameters:

textArrayOptions -

Returns:

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

dateArrayOptions

IndexField.Builder dateArrayOptions(DateArrayOptions dateArrayOptions)

Parameters:

dateArrayOptions -

Returns:

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