Added in API level 31

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

AppSearchSchema

---

Kotlin |Java

public final class AppSearchSchema
extends Object implements Parcelable

java.lang.Object
↳	android.app.appsearch.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:

• AppSearchSession.setSchema(SetSchemaRequest, Executor, Executor, Consumer)

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.EmbeddingPropertyConfig Configuration for a property of type EmbeddingVector in a Document.
class	AppSearchSchema.LongPropertyConfig 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.

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields
public static final Creator<AppSearchSchema>	CREATOR

Public methods
boolean	equals(Object other) Indicates whether some other object is "equal to" this one.
String	getDescription() Returns a natural language description of this schema type.
List<String>	getParentTypes() Returns the list of parent types of this schema for polymorphism.
List<AppSearchSchema.PropertyConfig>	getProperties() Returns the list of PropertyConfigs that are part of this schema.
String	getSchemaType() Returns the name of this schema type, such as Email.
int	hashCode() Returns a hash code value for the object.
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 35
Also in T Extensions 13

public static final Creator<AppSearchSchema> CREATOR

Public methods

equals

Added in API level 31

public boolean equals (Object other)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other	Object: This value may be null.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

getDescription

Added in Android Baklava

public String getDescription ()

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 Builder.setDescription is uncalled, then this method will return an empty string.

Returns
String	This value cannot be null.

getParentTypes

Added in API level 35
Also in T Extensions 13

public List<String> getParentTypes ()

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

Returns
List<String>	This value cannot be null.

getProperties

Added in API level 31

public List<AppSearchSchema.PropertyConfig> getProperties ()

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

This method creates a new list when called.

Returns
List<AppSearchSchema.PropertyConfig>	This value cannot be null.

getSchemaType

Added in API level 31

public String getSchemaType ()

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

Returns
String	This value cannot be null.

hashCode

Added in API level 31

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int	a hash code value for this object.

toString

Added in API level 31

public String toString ()

Returns a string representation of the object.

Returns
String	This value cannot be null.

writeToParcel

Added in API level 35

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest	Parcel: This value cannot be null.
flags	int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES