Interface DocumentMetadataConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

DocumentMetadataConfiguration

@Mutable
@NotThreadSafe
public static interface DocumentMetadataConfiguration.Builder
extends SdkPojo, CopyableBuilder<DocumentMetadataConfiguration.Builder,DocumentMetadataConfiguration>

Method Summary

Modifier and Type	Method	Description
DocumentMetadataConfiguration.Builder	name(String name)	The name of the index field.
default DocumentMetadataConfiguration.Builder	relevance(Consumer<Relevance.Builder> relevance)	Provides tuning parameters to determine how the field affects the search results.
DocumentMetadataConfiguration.Builder	relevance(Relevance relevance)	Provides tuning parameters to determine how the field affects the search results.
default DocumentMetadataConfiguration.Builder	search(Consumer<Search.Builder> search)	Provides information about how the field is used during a search.
DocumentMetadataConfiguration.Builder	search(Search search)	Provides information about how the field is used during a search.
DocumentMetadataConfiguration.Builder	type(String type)	The data type of the index field.
DocumentMetadataConfiguration.Builder	type(DocumentAttributeValueType type)	The data type of the index field.

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, sdkFieldNameToField, sdkFields

Method Details

name

DocumentMetadataConfiguration.Builder name(String name)

The name of the index field.

Parameters:

name - The name of the index field.

Returns:

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

type

DocumentMetadataConfiguration.Builder type(String type)

The data type of the index field.

Parameters:

type - The data type of the index field.

Returns:

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

See Also:

• DocumentAttributeValueType
• DocumentAttributeValueType

type

DocumentMetadataConfiguration.Builder type(DocumentAttributeValueType type)

The data type of the index field.

Parameters:

type - The data type of the index field.

Returns:

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

See Also:

• DocumentAttributeValueType
• DocumentAttributeValueType

relevance

DocumentMetadataConfiguration.Builder relevance(Relevance relevance)

Provides tuning parameters to determine how the field affects the search results.

Parameters:

relevance - Provides tuning parameters to determine how the field affects the search results.

Returns:

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

relevance

default DocumentMetadataConfiguration.Builder relevance(Consumer<Relevance.Builder> relevance)

Provides tuning parameters to determine how the field affects the search results.

This is a convenience method that creates an instance of the Relevance.Builder avoiding the need to create one manually via Relevance.builder().

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

Parameters:

relevance - a consumer that will call methods on Relevance.Builder

Returns:

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

See Also:

• relevance(Relevance)

search

DocumentMetadataConfiguration.Builder search(Search search)

Provides information about how the field is used during a search.

Parameters:

search - Provides information about how the field is used during a search.

Returns:

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

search

default DocumentMetadataConfiguration.Builder search(Consumer<Search.Builder> search)

Provides information about how the field is used during a search.

This is a convenience method that creates an instance of the Search.Builder avoiding the need to create one manually via Search.builder().

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

Parameters:

search - a consumer that will call methods on Search.Builder

Returns:

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

See Also:

• search(Search)