SearchSuggestionSpec.Builder
class SearchSuggestionSpec.Builder
Builder for objects.
Summary
Public constructors |
|---|
|
Creates an |
Public constructors
Builder
Builder(maximumResultCount: @IntRange(from = 1) Int)
Creates an SearchSuggestionSpec.Builder object.
Public functions
addFilterDocumentClasses
fun addFilterDocumentClasses(documentClasses: Array<Class<Any!>!>): SearchSuggestionSpec.Builder
Adds a schema filter to SearchSuggestionSpec Entry. Only search for suggestions that has documents under the specified schema.
If unset, the query will search over all schema.
Merged list available from getFilterSchemas.
addFilterDocumentClasses
fun addFilterDocumentClasses(
documentClasses: (Mutable)Collection<Class<Any!>!>
): SearchSuggestionSpec.Builder
Adds the Schema names of given document classes to the Schema type filter of SearchSuggestionSpec Entry. Only search for suggestions that has documents under the specified schema.
If unset, the query will search over all schema.
Merged list available from getFilterSchemas.
| Parameters | |
|---|---|
documentClasses: (Mutable)Collection<Class<Any!>!> |
classes annotated with |
addFilterDocumentIds
fun addFilterDocumentIds(namespace: String, documentIds: Array<String!>): SearchSuggestionSpec.Builder
Adds a document ID filter to SearchSuggestionSpec Entry. Only search for suggestions in the given specified documents.
If unset, the query will search over all documents.
addFilterDocumentIds
fun addFilterDocumentIds(
namespace: String,
documentIds: (Mutable)Collection<String!>
): SearchSuggestionSpec.Builder
Adds a document ID filter to SearchSuggestionSpec Entry. Only search for suggestions in the given specified documents.
If unset, the query will search over all documents.
addFilterNamespaces
fun addFilterNamespaces(namespaces: Array<String!>): SearchSuggestionSpec.Builder
Adds a namespace filter to SearchSuggestionSpec Entry. Only search for suggestions that has documents under the specified namespaces.
If unset, the query will search over all namespaces.
addFilterNamespaces
fun addFilterNamespaces(namespaces: (Mutable)Collection<String!>): SearchSuggestionSpec.Builder
Adds a namespace filter to SearchSuggestionSpec Entry. Only search for suggestions that has documents under the specified namespaces.
If unset, the query will search over all namespaces.
addFilterSchemas
fun addFilterSchemas(schemaTypes: Array<String!>): SearchSuggestionSpec.Builder
Adds a schema filter to SearchSuggestionSpec Entry. Only search for suggestions that has documents under the specified schema.
If unset, the query will search over all schema.
addFilterSchemas
fun addFilterSchemas(schemaTypes: (Mutable)Collection<String!>): SearchSuggestionSpec.Builder
Adds a schema filter to SearchSuggestionSpec Entry. Only search for suggestions that has documents under the specified schema.
If unset, the query will search over all schema.
build
fun build(): SearchSuggestionSpec
Constructs a new SearchSpec from the contents of this builder.
setRankingStrategy
fun setRankingStrategy(rankingStrategy: Int): SearchSuggestionSpec.Builder
Sets ranking strategy for suggestion results.
The default value SUGGESTION_RANKING_STRATEGY_DOCUMENT_COUNT will be used if this method is never called.