AppSearchSchema


class 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).

See also
setSchemaAsync

Summary

Nested types

Configuration for a property containing a boolean.

Builder for BooleanPropertyConfig.

Builder for objects.

Configuration for a property containing a byte array.

Builder for BytesPropertyConfig.

Configuration for a property containing another Document.

Builder for DocumentPropertyConfig.

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

Builder for DoublePropertyConfig.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SCHEMA_EMBEDDING_PROPERTY_CONFIG)
class AppSearchSchema.EmbeddingPropertyConfig : AppSearchSchema.PropertyConfig

Configuration for a property of type EmbeddingVector in a Document.

Builder for EmbeddingPropertyConfig.

Configuration for a property containing a 64-bit integer.

Builder for LongPropertyConfig.

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

Configuration for a property of type String in a Document.

Builder for StringPropertyConfig.

Public functions

Boolean
equals(other: Any?)
String

Returns a natural language description of this schema type.

(Mutable)List<String!>

Returns the list of parent types of this schema for polymorphism.

(Mutable)List<AppSearchSchema.PropertyConfig!>

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

String

Returns the name of this schema type, such as Email.

Int
String

Public functions

equals

fun equals(other: Any?): Boolean

getDescription

Added in 1.1.0-alpha06
fun getDescription(): String

Returns a natural language description of this schema type.

Ex. The description for an Email type could be "A type of electronic message".

This information is purely to help apps consuming this type to understand its semantic meaning. This field has no effect in AppSearch - it is just stored with the AppSearchSchema. If setDescription is uncalled, then this method will return an empty string.

getParentTypes

Added in 1.1.0-alpha06
fun getParentTypes(): (Mutable)List<String!>

Returns the list of parent types of this schema for polymorphism.

getProperties

Added in 1.1.0-alpha06
fun getProperties(): (Mutable)List<AppSearchSchema.PropertyConfig!>

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

This method creates a new list when called.

getSchemaType

Added in 1.1.0-alpha06
fun getSchemaType(): String

Returns the name of this schema type, such as Email.

hashCode

fun hashCode(): Int

toString

fun toString(): String