AppSearchSchema
Stay organized with collections
Save and categorize content based on your preferences.
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).
Nested Class Summary
class
Configuration for a property containing a
boolean.
class
Configuration for a property containing a byte
array.
class
Configuration for a property containing another
Document.
class
Configuration for a property containing a
double-precision decimal number.
class
Configuration for a property containing a 64-bit
integer.
class
Common configuration for a single property
(field) in a Document.
class
Configuration for a property of type String in a
Document.
Inherited Constant Summary
From interface android.os.Parcelable
| int |
CONTENTS_FILE_DESCRIPTOR |
|
| int |
PARCELABLE_WRITE_RETURN_VALUE |
|
Inherited Method Summary
From class java.lang.Object
From interface android.os.Parcelable
| abstract int |
describeContents
()
|
| abstract void |
writeToParcel
( Parcel
arg0,
int arg1)
|
Public Methods
public boolean
equals
( Object
other)
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 AppSearchSchema.Builder.setDescription(String)
is uncalled, then this method
will return an empty string.
public List
< String
>
getParentTypes
()
Returns the list of parent types of this schema for polymorphism.
public String
getSchemaType
()
Returns the name of this schema type, such as Email.
public void
writeToParcel
( Parcel
dest, int
flags)
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-31 UTC."],[[["\u003cp\u003e\u003ccode\u003eAppSearchSchema\u003c/code\u003e defines the structure and properties for a specific type of document in AppSearch, like an email or music recording.\u003c/p\u003e\n"],["\u003cp\u003eIt includes information like type, properties, and configuration details such as tokenization type.\u003c/p\u003e\n"],["\u003cp\u003eSchemas support polymorphism through parent types and contain a list of \u003ccode\u003ePropertyConfig\u003c/code\u003e objects defining individual properties within the document.\u003c/p\u003e\n"],["\u003cp\u003eYou can access schema details such as schema type, description, properties, and parent types using methods like \u003ccode\u003egetSchemaType()\u003c/code\u003e, \u003ccode\u003egetDescription()\u003c/code\u003e, \u003ccode\u003egetProperties()\u003c/code\u003e, and \u003ccode\u003egetParentTypes()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eAppSearchSchema\u003c/code\u003e is parcelable, meaning it can be passed between components or processes.\u003c/p\u003e\n"]]],[],null,[]]
