GenericDocument

Creates a newGenericDocument from an existing instance.

This method should be only used by constructor of a subclass.

Returns the creation timestamp of theGenericDocument, in milliseconds.

The value is in theSystem.currentTimeMillis() time base.

Returns the unique identifier of theGenericDocument.

The maximum number of indexed properties a document can have.

Indexed properties are properties which are strings where the AppSearchSchema.StringPropertyConfig.getInde xing Type()value is anything other than AppSearchSchema.StringPropertyConfig.INDEXING_TYPE_NONE,as well as long properties where the AppSearchSchema.LongPropertyConfig.getInde xing Type()value is AppSearchSchema.LongPropertyConfig.INDEXING_TYPE_RANGE.

Returns the namespace of theGenericDocument.

Retrieves the property value with the given path asObject.

A path can be a simple property name, such as those returned by getPropertyNames().It may also be a dot-delimited path through the nested document hierarchy, with nestedGenericDocument properties accessed via'.'and repeated properties optionally indexed into via[n].

For example, given the followingGenericDocument:

(Message) {
from: "sender@example"
to: [{
name: "Albert Einstein"
email: "einstein@example"
}, {
name: "Marie Curie"
email: "curie@example"
}]
tags: [ "important", "inbox" ]
subject: "Hello"
}

Here are some example paths and their results:

• "from"returns"sender@example"as aStringarray with one element
• "to"returns the two nested documents containing contact information as aGenericDocument array with two elements
• "to[1]"returns the second nested document containing Marie Curie's contact information as aGenericDocument array with one element
• "to[1].email"returns"curie@example"
• "to[100].email"returnsnullas this particular document does not have that many elements in its"to"array.
• "to.email"aggregates emails across all nested documents that have them, returning[ "einstein@example", "curie@example" ]as a Stringarray with two elements.

If you know the expected type of the property you are retrieving, it is recommended to use one of the typed versions of this method instead, such as getPropertyString(String)or getPropertyStringArray(String).

If the property was assigned as an empty array using one of the Builder#setPropertyfunctions, this method will return an empty array. If no such property exists at all, this method returnsnull.

Note: If the property is an emptyGenericDocument[] orbyte[][],this method will return anullvalue in versions of Android prior toAndroid T.Starting in Android T it will return an empty array if the property has been set as an empty array, matching the behavior of other property types.

Retrieves abooleanproperty by path.

See getProperty(String)for a detailed description of the path syntax.

Retrieves a repeatedbooleanproperty by path.

See getProperty(String)for a detailed description of the path syntax.

If the property has not been set via GenericDocument.Builder.setPropertyBoolean(String, boolean...),this method returnsnull.

If it has been set via GenericDocument.Builder.setPropertyBoolean(String, boolean...)to an empty boolean[],this method returns an emptyboolean[].

Retrieves abyte[]property by path.

See getProperty(String)for a detailed description of the path syntax.

Retrieves abyte[][]property by path.

See getProperty(String)for a detailed description of the path syntax.

If the property has not been set via GenericDocument.Builder.setPropertyBytes(String, byte[]...),this method returnsnull.

If it has been set via GenericDocument.Builder.setPropertyBytes(String, byte[]...)to an empty byte[][],this method returns an emptybyte[][]starting in Android Tandnullin earlier versions of Android.

Retrieves aGenericDocument property by path.

See getProperty(String)for a detailed description of the path syntax.

Retrieves a repeatedGenericDocument property by path.

See getProperty(String)for a detailed description of the path syntax.

If the property has not been set via GenericDocument.Builder.setPropertyDocument(String, GenericDocument...), this method returnsnull.

If it has been set via GenericDocument.Builder.setPropertyDocument(String, GenericDocument...)to an emptyGenericDocument[],this method returns an empty GenericDocument[]starting inAndroid Tandnullin earlier versions of Android.

Retrieves adoubleproperty by path.

See getProperty(String)for a detailed description of the path syntax.

Retrieves a repeateddoubleproperty by path.

See getProperty(String)for a detailed description of the path syntax.

If the property has not been set via GenericDocument.Builder.setPropertyDouble(String, double...),this method returnsnull.

If it has been set via GenericDocument.Builder.setPropertyDouble(String, double...)to an empty double[],this method returns an emptydouble[].

Retrieves alongproperty by path.

See getProperty(String)for a detailed description of the path syntax.

Retrieves a repeatedlong[]property by path.

See getProperty(String)for a detailed description of the path syntax.

If the property has not been set via GenericDocument.Builder.setPropertyLong(String, long...),this method returnsnull.

If it has been set via GenericDocument.Builder.setPropertyLong(String, long...)to an empty long[],this method returns an emptylong[].

Returns the names of all properties defined in this document.

Retrieves aStringproperty by path.

See getProperty(String)for a detailed description of the path syntax.

Retrieves a repeatedStringproperty by path.

See getProperty(String)for a detailed description of the path syntax.

If the property has not been set via GenericDocument.Builder.setPropertyString(String, String...),this method returnsnull.

If it has been set via GenericDocument.Builder.setPropertyString(String, String...)to an empty String[],this method returns an emptyString[].

Returns theAppSearchSchema type of theGenericDocument.

Returns the score of theGenericDocument.

The score is a query-independent measure of the document's quality, relative to otherGenericDocument objects of the sameAppSearchSchema type.

Results may be sorted by score using SearchSpec.Builder.setRankingStrategy(int).Documents with higher scores are considered better than documents with lower scores.

Any non-negative integer can be used a score.

Returns the TTL (time-to-live) of theGenericDocument, in milliseconds.

The TTL is measured against getCreationTimestampMillis().At the timestamp of creationTimestampMillis + ttlMillis,measured in theSystem.currentTimeMillis() time base, the document will be auto-deleted.

The default value is 0, which means the document is permanent and won't be auto-deleted until the app is uninstalled or AppSearchClient.remove(RemoveByDocumentIdRequest, String)is called.