software.amazon.awssdk.services.kendra.model

Interface DocumentAttributeValueCountPair.Builder

All Superinterfaces:

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

Enclosing class:

DocumentAttributeValueCountPair

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

Method Summary

Modifier and Type	Method and Description
DocumentAttributeValueCountPair.Builder	count(Integer count) The number of documents in the response that have the attribute/field value for the key.
default DocumentAttributeValueCountPair.Builder	documentAttributeValue(Consumer<DocumentAttributeValue.Builder> documentAttributeValue) The value of the attribute/field.
DocumentAttributeValueCountPair.Builder	documentAttributeValue(DocumentAttributeValue documentAttributeValue) The value of the attribute/field.
DocumentAttributeValueCountPair.Builder	facetResults(Collection<FacetResult> facetResults) Contains the results of a document attribute/field that is a nested facet.
DocumentAttributeValueCountPair.Builder	facetResults(Consumer<FacetResult.Builder>... facetResults) Contains the results of a document attribute/field that is a nested facet.
DocumentAttributeValueCountPair.Builder	facetResults(FacetResult... facetResults) Contains the results of a document attribute/field that is a nested facet.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

documentAttributeValue

DocumentAttributeValueCountPair.Builder documentAttributeValue(DocumentAttributeValue documentAttributeValue)

The value of the attribute/field. For example, "HR".

Parameters:

documentAttributeValue - The value of the attribute/field. For example, "HR".

Returns:

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

documentAttributeValue

default DocumentAttributeValueCountPair.Builder documentAttributeValue(Consumer<DocumentAttributeValue.Builder> documentAttributeValue)

The value of the attribute/field. For example, "HR".

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

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

Parameters:

documentAttributeValue - a consumer that will call methods on DocumentAttributeValue.Builder

Returns:

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

See Also:

documentAttributeValue(DocumentAttributeValue)

count

DocumentAttributeValueCountPair.Builder count(Integer count)

The number of documents in the response that have the attribute/field value for the key.

Parameters:

count - The number of documents in the response that have the attribute/field value for the key.

Returns:

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

facetResults

DocumentAttributeValueCountPair.Builder facetResults(Collection<FacetResult> facetResults)

Contains the results of a document attribute/field that is a nested facet. A FacetResult contains the counts for each facet nested within a facet.

For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.

Parameters:

facetResults - Contains the results of a document attribute/field that is a nested facet. A FacetResult contains the counts for each facet nested within a facet.

For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.

Returns:

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

facetResults

DocumentAttributeValueCountPair.Builder facetResults(FacetResult... facetResults)

Contains the results of a document attribute/field that is a nested facet. A FacetResult contains the counts for each facet nested within a facet.

For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.

Parameters:

facetResults - Contains the results of a document attribute/field that is a nested facet. A FacetResult contains the counts for each facet nested within a facet.

For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.

Returns:

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

facetResults

DocumentAttributeValueCountPair.Builder facetResults(Consumer<FacetResult.Builder>... facetResults)

Contains the results of a document attribute/field that is a nested facet. A FacetResult contains the counts for each facet nested within a facet.

For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #facetResults(List).

Parameters:

facetResults - a consumer that will call methods on FacetResult.Builder

Returns:

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

See Also:

#facetResults(java.util.Collection)