AppSearchSchema

Kotlin |Java

class AppSearchSchema : Parcelable

kotlin.Any
↳	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).

Summary

Nested classes
	`BlobHandlePropertyConfig` Configuration for a property of type `AppSearchBlobHandle` in a Document.
	`BooleanPropertyConfig` Configuration for a property containing a boolean.
	`Builder` Builder for `objects`.
	`BytesPropertyConfig` Configuration for a property containing a byte array.
	`DocumentPropertyConfig` Configuration for a property containing another Document.
	`DoublePropertyConfig` Configuration for a property containing a double-precision decimal number.
	`EmbeddingPropertyConfig` Configuration for a property of type `EmbeddingVector` in a Document.
	`LongPropertyConfig` Configuration for a property containing a 64-bit integer.
abstract	`PropertyConfig` Common configuration for a single property (field) in a Document.
	`StringPropertyConfig` Configuration for a property of type String in a Document.

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()`
Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
String	`getDescription()` Returns a natural language description of this schema type.
MutableList<String!>	`getParentTypes()` Returns the list of parent types of this schema for polymorphism.
MutableList<AppSearchSchema.PropertyConfig!>	`getProperties()` Returns the list of `PropertyConfig`s 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.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<AppSearchSchema!>	`CREATOR`

Public methods

describeContents

Added in API level 35

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 31

fun equals(other: Any?): Boolean

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
`obj`	the reference object with which to compare.
`other`	Any?: This value may be `null`.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getDescription

Added in API level 36.1
Also in T Extensions 18

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

Return
`String`	This value cannot be `null`.

getParentTypes

Added in API level 35
Also in T Extensions 13

fun getParentTypes(): MutableList<String!>

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

Return
`MutableList<String!>`	This value cannot be `null`.

getProperties

Added in API level 31

fun getProperties(): MutableList<AppSearchSchema.PropertyConfig!>

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

This method creates a new list when called.

Return
`MutableList<AppSearchSchema.PropertyConfig!>`	This value cannot be `null`.

getSchemaType

Added in API level 31

fun getSchemaType(): String

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

Return
`String`	This value cannot be `null`.

hashCode

Added in API level 31

fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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.

Return
`Int`	a hash code value for this object.

toString

Added in API level 31

fun toString(): String

Returns a string representation of the object.

Return
`String`	This value cannot be `null`.

writeToParcel

Added in API level 35

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `PARCELABLE_WRITE_RETURN_VALUE`

Properties

CREATOR

Added in API level 35
Also in T Extensions 13

static val CREATOR: Parcelable.Creator<AppSearchSchema!>