Package com.azure.search.documents.indexes

Annotation Type SearchableField

@Target({FIELD,METHOD})
@Retention(RUNTIME)
public @interface SearchableField

An annotation that directs SearchIndexAsyncClient.buildSearchFields(Class, FieldBuilderOptions) to turn the field or method into a searchable field.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	analyzerName	A LexicalAnalyzerName to associate as the search and index analyzer for the field.
String	indexAnalyzerName	A LexicalAnalyzerName to associate as the index analyzer for the field.
boolean	isFacetable	Indicates if the field or method should generate as a facetable field.
boolean	isFilterable	Indicates if the field or method should generate as a filterable field.
boolean	isHidden	Indicates if the field or method should generate as a hidden field.
boolean	isKey	Indicates if the field or method should generate as a key field.
boolean	isSortable	Indicates if the field or method should generate as a sortable field.
String	searchAnalyzerName	A LexicalAnalyzerName to associate as the search analyzer for the field.
String[]	synonymMapNames	A list of SynonymMap names to be associated with the field.

Element Detail

isKey

boolean isKey

Indicates if the field or method should generate as a key field.

Returns:

A flag indicating if the field or method should generate as a key field.

Default:

false

isHidden

boolean isHidden

Indicates if the field or method should generate as a hidden field.

Returns:

A flag indicating if the field or method should generate as a hidden field.

Default:

false

isFacetable

boolean isFacetable

Indicates if the field or method should generate as a facetable field.

Returns:

A flag indicating if the field or method should generate as a facetable field.

Default:

false

isSortable

boolean isSortable

Indicates if the field or method should generate as a sortable field.

Returns:

A flag indicating if the field or method should generate as a sortable field.

Default:

false

isFilterable

boolean isFilterable

Indicates if the field or method should generate as a filterable field.

Returns:

A flag indicating if the field or method should generate as a filterable field.

Default:

false

analyzerName

String analyzerName

A LexicalAnalyzerName to associate as the search and index analyzer for the field.

Returns:

The LexicalAnalyzerName that will be associated as the search and index analyzer for the field.

Default:

""

searchAnalyzerName

String searchAnalyzerName

A LexicalAnalyzerName to associate as the search analyzer for the field.

Returns:

The LexicalAnalyzerName that will be associated as the search analyzer for the field.

Default:

""

indexAnalyzerName

String indexAnalyzerName

A LexicalAnalyzerName to associate as the index analyzer for the field.

Returns:

The LexicalAnalyzerName that will be associated as the index analyzer for the field.

Default:

""

synonymMapNames

String[] synonymMapNames

A list of SynonymMap names to be associated with the field.

Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map. The synonym map attribute may be changed on existing fields.

Currently, only one synonym map per field is supported.

Returns:

The SynonymMap names that will be associated with the field.

Default:

{}