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

Interface IndexField.Builder

All Superinterfaces:

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

Enclosing class:

IndexField

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

Method Summary

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

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

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)

Sets the value of the IndexFieldType property for this object.

Parameters:

indexFieldType - The new value for the IndexFieldType property for this object.

Returns:

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

See Also:

• IndexFieldType
• IndexFieldType

indexFieldType

IndexField.Builder indexFieldType(IndexFieldType indexFieldType)

Sets the value of the IndexFieldType property for this object.

Parameters:

indexFieldType - The new value for the IndexFieldType property for this object.

Returns:

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

See Also:

• IndexFieldType
• IndexFieldType

intOptions

IndexField.Builder intOptions(IntOptions intOptions)

Sets the value of the IntOptions property for this object.

Parameters:

intOptions - The new value for the IntOptions property for this object.

Returns:

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

intOptions

default IndexField.Builder intOptions(Consumer<IntOptions.Builder> intOptions)

Sets the value of the IntOptions property for this object. This is a convenience method that creates an instance of the IntOptions.Builder avoiding the need to create one manually via IntOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to intOptions(IntOptions).

Parameters:

intOptions - a consumer that will call methods on IntOptions.Builder

Returns:

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

See Also:

• intOptions(IntOptions)

doubleOptions

IndexField.Builder doubleOptions(DoubleOptions doubleOptions)

Sets the value of the DoubleOptions property for this object.

Parameters:

doubleOptions - The new value for the DoubleOptions property for this object.

Returns:

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

doubleOptions

default IndexField.Builder doubleOptions(Consumer<DoubleOptions.Builder> doubleOptions)

Sets the value of the DoubleOptions property for this object. This is a convenience method that creates an instance of the DoubleOptions.Builder avoiding the need to create one manually via DoubleOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to doubleOptions(DoubleOptions).

Parameters:

doubleOptions - a consumer that will call methods on DoubleOptions.Builder

Returns:

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

See Also:

• doubleOptions(DoubleOptions)

literalOptions

IndexField.Builder literalOptions(LiteralOptions literalOptions)

Sets the value of the LiteralOptions property for this object.

Parameters:

literalOptions - The new value for the LiteralOptions property for this object.

Returns:

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

literalOptions

default IndexField.Builder literalOptions(Consumer<LiteralOptions.Builder> literalOptions)

Sets the value of the LiteralOptions property for this object. This is a convenience method that creates an instance of the LiteralOptions.Builder avoiding the need to create one manually via LiteralOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to literalOptions(LiteralOptions).

Parameters:

literalOptions - a consumer that will call methods on LiteralOptions.Builder

Returns:

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

See Also:

• literalOptions(LiteralOptions)

textOptions

IndexField.Builder textOptions(TextOptions textOptions)

Sets the value of the TextOptions property for this object.

Parameters:

textOptions - The new value for the TextOptions property for this object.

Returns:

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

textOptions

default IndexField.Builder textOptions(Consumer<TextOptions.Builder> textOptions)

Sets the value of the TextOptions property for this object. This is a convenience method that creates an instance of the TextOptions.Builder avoiding the need to create one manually via TextOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to textOptions(TextOptions).

Parameters:

textOptions - a consumer that will call methods on TextOptions.Builder

Returns:

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

See Also:

• textOptions(TextOptions)

dateOptions

IndexField.Builder dateOptions(DateOptions dateOptions)

Sets the value of the DateOptions property for this object.

Parameters:

dateOptions - The new value for the DateOptions property for this object.

Returns:

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

dateOptions

default IndexField.Builder dateOptions(Consumer<DateOptions.Builder> dateOptions)

Sets the value of the DateOptions property for this object. This is a convenience method that creates an instance of the DateOptions.Builder avoiding the need to create one manually via DateOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dateOptions(DateOptions).

Parameters:

dateOptions - a consumer that will call methods on DateOptions.Builder

Returns:

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

See Also:

• dateOptions(DateOptions)

latLonOptions

IndexField.Builder latLonOptions(LatLonOptions latLonOptions)

Sets the value of the LatLonOptions property for this object.

Parameters:

latLonOptions - The new value for the LatLonOptions property for this object.

Returns:

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

latLonOptions

default IndexField.Builder latLonOptions(Consumer<LatLonOptions.Builder> latLonOptions)

Sets the value of the LatLonOptions property for this object. This is a convenience method that creates an instance of the LatLonOptions.Builder avoiding the need to create one manually via LatLonOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to latLonOptions(LatLonOptions).

Parameters:

latLonOptions - a consumer that will call methods on LatLonOptions.Builder

Returns:

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

See Also:

• latLonOptions(LatLonOptions)

intArrayOptions

IndexField.Builder intArrayOptions(IntArrayOptions intArrayOptions)

Sets the value of the IntArrayOptions property for this object.

Parameters:

intArrayOptions - The new value for the IntArrayOptions property for this object.

Returns:

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

intArrayOptions

default IndexField.Builder intArrayOptions(Consumer<IntArrayOptions.Builder> intArrayOptions)

Sets the value of the IntArrayOptions property for this object. This is a convenience method that creates an instance of the IntArrayOptions.Builder avoiding the need to create one manually via IntArrayOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to intArrayOptions(IntArrayOptions).

Parameters:

intArrayOptions - a consumer that will call methods on IntArrayOptions.Builder

Returns:

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

See Also:

• intArrayOptions(IntArrayOptions)

doubleArrayOptions

IndexField.Builder doubleArrayOptions(DoubleArrayOptions doubleArrayOptions)

Sets the value of the DoubleArrayOptions property for this object.

Parameters:

doubleArrayOptions - The new value for the DoubleArrayOptions property for this object.

Returns:

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

doubleArrayOptions

default IndexField.Builder doubleArrayOptions(Consumer<DoubleArrayOptions.Builder> doubleArrayOptions)

Sets the value of the DoubleArrayOptions property for this object. This is a convenience method that creates an instance of the DoubleArrayOptions.Builder avoiding the need to create one manually via DoubleArrayOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to doubleArrayOptions(DoubleArrayOptions).

Parameters:

doubleArrayOptions - a consumer that will call methods on DoubleArrayOptions.Builder

Returns:

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

See Also:

• doubleArrayOptions(DoubleArrayOptions)

literalArrayOptions

IndexField.Builder literalArrayOptions(LiteralArrayOptions literalArrayOptions)

Sets the value of the LiteralArrayOptions property for this object.

Parameters:

literalArrayOptions - The new value for the LiteralArrayOptions property for this object.

Returns:

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

literalArrayOptions

default IndexField.Builder literalArrayOptions(Consumer<LiteralArrayOptions.Builder> literalArrayOptions)

Sets the value of the LiteralArrayOptions property for this object. This is a convenience method that creates an instance of the LiteralArrayOptions.Builder avoiding the need to create one manually via LiteralArrayOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to literalArrayOptions(LiteralArrayOptions).

Parameters:

literalArrayOptions - a consumer that will call methods on LiteralArrayOptions.Builder

Returns:

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

See Also:

• literalArrayOptions(LiteralArrayOptions)

textArrayOptions

IndexField.Builder textArrayOptions(TextArrayOptions textArrayOptions)

Sets the value of the TextArrayOptions property for this object.

Parameters:

textArrayOptions - The new value for the TextArrayOptions property for this object.

Returns:

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

textArrayOptions

default IndexField.Builder textArrayOptions(Consumer<TextArrayOptions.Builder> textArrayOptions)

Sets the value of the TextArrayOptions property for this object. This is a convenience method that creates an instance of the TextArrayOptions.Builder avoiding the need to create one manually via TextArrayOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to textArrayOptions(TextArrayOptions).

Parameters:

textArrayOptions - a consumer that will call methods on TextArrayOptions.Builder

Returns:

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

See Also:

• textArrayOptions(TextArrayOptions)

dateArrayOptions

IndexField.Builder dateArrayOptions(DateArrayOptions dateArrayOptions)

Sets the value of the DateArrayOptions property for this object.

Parameters:

dateArrayOptions - The new value for the DateArrayOptions property for this object.

Returns:

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

dateArrayOptions

default IndexField.Builder dateArrayOptions(Consumer<DateArrayOptions.Builder> dateArrayOptions)

Sets the value of the DateArrayOptions property for this object. This is a convenience method that creates an instance of the DateArrayOptions.Builder avoiding the need to create one manually via DateArrayOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dateArrayOptions(DateArrayOptions).

Parameters:

dateArrayOptions - a consumer that will call methods on DateArrayOptions.Builder

Returns:

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

See Also:

• dateArrayOptions(DateArrayOptions)