K - Key typeT - The concrete field args typeB - The concrete builder typepublic abstract static class FieldArgs.Builder<K,T extends FieldArgs<K>,B extends FieldArgs.Builder<K,T,B>> extends Object
| Modifier | Constructor and Description |
|---|---|
protected |
Builder(T instance)
Constructor for subclasses.
|
| Modifier and Type | Method and Description |
|---|---|
B |
as(K as)
Defines the attribute associated to the identifier.
|
T |
build()
Build the field arguments.
|
B |
indexEmpty()
For TEXT and TAG attributes, introduced in v2.10, allows you to index and search for empty strings.
|
B |
indexMissing()
For all field types, introduced in v2.10, allows you to search for missing values, that is, documents that do not
contain a specific field.
|
B |
name(K name)
The name of the field in a hash the index is going to be based on.
|
B |
noIndex()
Attributes can have the NOINDEX option, which means they will not be indexed.
|
protected B |
self()
Returns this builder instance for method chaining.
|
B |
sortable()
NUMERIC, TAG, TEXT, or GEO attributes can have an optional SORTABLE argument.
|
B |
unNormalizedForm()
By default, for hashes (not with JSON) SORTABLE applies normalization to the indexed value (characters set to
lowercase, removal of diacritics).
|
protected Builder(T instance)
instance - the field args instance to buildprotected B self()
public B name(K name)
name - the name of the fieldFieldArgs.Builder for the purpose of method chainingpublic B as(K as)
as - the field name to be used in queriesFieldArgs.Builder for the purpose of method chainingpublic B sortable()
FieldArgs.Builder for the purpose of method chainingpublic B unNormalizedForm()
FieldArgs.Builder for the purpose of method chainingpublic B noIndex()
sortable(), to create attributes whose update using PARTIAL will not cause full reindexing of the
document. If an attribute has NOINDEX and doesn't have SORTABLE, it will just be ignored by the index.FieldArgs.Builder for the purpose of method chainingpublic B indexEmpty()
FieldArgs.Builder for the purpose of method chainingpublic B indexMissing()
FieldArgs.Builder for the purpose of method chainingpublic T build()
Copyright © 2025 lettuce.io. All rights reserved.