AppSearchSchema

public final 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.

public final class AppSearchSchema.Builder

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.

Configuration for a property containing a 64-bit integer.

Builder for LongPropertyConfig.

public abstract class AppSearchSchema.PropertyConfig

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

Configuration for a property of type String in a Document.

Builder for StringPropertyConfig.

Public methods

boolean
@NonNull List<String>

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

@NonNull List<AppSearchSchema.PropertyConfig>

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

@NonNull String

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

int
@NonNull String

Public methods

equals

public boolean equals(@Nullable Object other)

getParentTypes

Added in 1.1.0-alpha04
public @NonNull List<StringgetParentTypes()

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

TODO(b/291122592): Unhide in Mainline when API updates via Mainline are possible. -->

getProperties

Added in 1.1.0-alpha04
public @NonNull List<AppSearchSchema.PropertyConfiggetProperties()

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-alpha04
public @NonNull String getSchemaType()

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

hashCode

public int hashCode()

toString

public @NonNull String toString()