AppSearchSchema

public final class AppSearchSchema
extends Object

java.lang.Object
   ↳ androidx.appsearch.app.AppSearchSchema


The AppSearch Schema for a particular type of document.

For example, an e-mail message or a music recording could be a schema type.

The schema consists of type information, properties, and config (like tokenization type).

Summary

Nested classes

class AppSearchSchema.BooleanPropertyConfig

Configuration for a property containing a boolean. 

class AppSearchSchema.Builder

Builder for objects

class AppSearchSchema.BytesPropertyConfig

Configuration for a property containing a byte array. 

class AppSearchSchema.DocumentPropertyConfig

Configuration for a property containing another Document. 

class AppSearchSchema.DoublePropertyConfig

Configuration for a property containing a double-precision decimal number. 

class AppSearchSchema.Int64PropertyConfig

Configuration for a property containing a 64-bit integer. 

class AppSearchSchema.PropertyConfig

Common configuration for a single property (field) in a Document. 

class AppSearchSchema.StringPropertyConfig

Configuration for a property of type String in a Document. 

Public methods

boolean equals(Object other)
List<AppSearchSchema.PropertyConfig> getProperties()

Returns the list of AppSearchSchema.PropertyConfigs that are part of this schema.

String getSchemaType()

Returns the name of this schema type, e.g.

int hashCode()
String toString()

Inherited methods

Public methods

equals

public boolean equals (Object other)

Parameters
other Object

Returns
boolean

getProperties

public List<AppSearchSchema.PropertyConfig> getProperties ()

Returns the list of AppSearchSchema.PropertyConfigs that are part of this schema.

This method creates a new list when called.

Returns
List<AppSearchSchema.PropertyConfig>

getSchemaType

public String getSchemaType ()

Returns the name of this schema type, e.g. Email.

Returns
String

hashCode

public int hashCode ()

Returns
int

toString

public String toString ()

Returns
String