SimpleField Interface

Package:

com.azure.search.documents.indexes

Maven Artifact:

com.azure:azure-search-documents:11.6.2

Implements

Annotation

public interface SimpleField
implements Annotation

An annotation that directs buildSearchFields(Class<?> model, FieldBuilderOptions options) to turn the field or method into a non-searchable SearchField.

Method Summary

Modifier and Type	Method and Description
abstract boolean	isFacetable() Indicates if the field or method should generate as a facetable SearchField.
abstract boolean	isFilterable() Indicates if the field or method should generate as a filterable SearchField.
abstract boolean	isHidden() Indicates if the field or method should generate as a hidden SearchField.
abstract boolean	isKey() Indicates if the field or method should generate as a key SearchField.
abstract boolean	isSortable() Indicates if the field or method should generate as a sortable SearchField.

Method Details

isFacetable

public abstract boolean isFacetable()

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

Returns:

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

isFilterable

public abstract boolean isFilterable()

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

Returns:

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

isHidden

public abstract boolean isHidden()

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

Returns:

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

isKey

public abstract boolean isKey()

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

Returns:

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

isSortable

public abstract boolean isSortable()

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

Returns:

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