Document.BooleanProperty
@Documented
@Retention(value = RetentionPolicy.CLASS)
@Target(value = [ElementType.FIELD, ElementType.METHOD])
annotation Document.BooleanProperty
Configures a boolean member field of a class as a property known to AppSearch.
Summary
Public functions |
|
|---|---|
abstract String! |
name()The name of this property. |
abstract Boolean |
required()Configures whether this property must be specified for the document to be valid. |
Public functions
name
Added in 1.1.0-alpha04
abstract fun name(): String!
The name of this property. This string is used to query against this property.
If not specified, the name of the field in the code will be used instead.
required
Added in 1.1.0-alpha04
abstract fun required(): Boolean
Configures whether this property must be specified for the document to be valid.
This attribute does not apply to properties of a repeated type (e.g. a list).
Please make sure you understand the consequences of required fields on schema migration before setting this attribute to true.