Document.BlobHandleProperty
@Documented
@Retention(value = RetentionPolicy.CLASS)
@Target(value = [ElementType.FIELD, ElementType.METHOD])
@ExperimentalAppSearchApi
public annotation Document.BlobHandleProperty
Configures an androidx.appsearch.app.AppSearchBlobHandle field of a class as a property known to AppSearch.
Summary
Public methods |
|
|---|---|
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 methods
name
Added in 1.1.0
public abstract String name()
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
public abstract boolean required()
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.