Interface Facet.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Facet.Builder,
,Facet> SdkBuilder<Facet.Builder,
,Facet> SdkPojo
- Enclosing class:
Facet
-
Method Summary
Modifier and TypeMethodDescriptiondocumentAttributeKey
(String documentAttributeKey) The unique key for the document attribute.facets
(Collection<Facet> facets) An array of document attributes that are nested facets within a facet.facets
(Consumer<Facet.Builder>... facets) An array of document attributes that are nested facets within a facet.An array of document attributes that are nested facets within a facet.maxResults
(Integer maxResults) Maximum number of facet values per facet.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
-
documentAttributeKey
The unique key for the document attribute.
- Parameters:
documentAttributeKey
- The unique key for the document attribute.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
facets
An array of document attributes that are nested facets 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. This helps your users further narrow their search.
You can only have one nested facet within a facet. If you want to increase this limit, contact Support.
- Parameters:
facets
- An array of document attributes that are nested facets 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. This helps your users further narrow their search.
You can only have one nested facet within a facet. If you want to increase this limit, contact Support.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
facets
An array of document attributes that are nested facets 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. This helps your users further narrow their search.
You can only have one nested facet within a facet. If you want to increase this limit, contact Support.
- Parameters:
facets
- An array of document attributes that are nested facets 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. This helps your users further narrow their search.
You can only have one nested facet within a facet. If you want to increase this limit, contact Support.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
facets
An array of document attributes that are nested facets 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. This helps your users further narrow their search.
You can only have one nested facet within a facet. If you want to increase this limit, contact Support.
This is a convenience method that creates an instance of theFacet.Builder
avoiding the need to create one manually viaFacet.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofacets(List<Facet>)
.- Parameters:
facets
- a consumer that will call methods onFacet.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
maxResults
Maximum number of facet values per facet. The default is 10. You can use this to limit the number of facet values to less than 10. If you want to increase the default, contact Support.
- Parameters:
maxResults
- Maximum number of facet values per facet. The default is 10. You can use this to limit the number of facet values to less than 10. If you want to increase the default, contact Support.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-