GenericDocument

Returns the creation timestamp of the GenericDocument , in milliseconds.

The value is in the System.currentTimeMillis() time base.

Returns the unique identifier of the GenericDocument .

The maximum number of indexed properties a document can have.

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

Returns the namespace of the GenericDocument .

Retrieves the property value with the given path as Object .

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 nested GenericDocument properties accessed via '.' and repeated properties optionally indexed into via [n] .

For example, given the following GenericDocument :

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

Here are some example paths and their results:

• "from" returns "sender@example.com" as a String array with one element
• "to" returns the two nested documents containing contact information as a GenericDocument array with two elements
• "to[1]" returns the second nested document containing Marie Curie's contact information as a GenericDocument array with one element
• "to[1].email" returns "curie@example.com"
• "to[100].email" returns null as 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.com", "curie@example.com"] as a String array 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#setProperty functions, this method will return an empty array. If no such property exists at all, this method returns null .

Note: If the property is an empty GenericDocument [] or byte[][] , this method will return a null value in versions of Android prior to Android 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 a boolean property by path.

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

Retrieves a repeated boolean property 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 returns null .

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

Retrieves a byte[] property by path.

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

Retrieves a byte[][] 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 returns null .

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

Retrieves a GenericDocument property by path.

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

Retrieves a repeated GenericDocument 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 returns null .

If it has been set via GenericDocument.Builder.setPropertyDocument(String, GenericDocument...) to an empty GenericDocument[] , this method returns an empty GenericDocument[] starting in Android T and null in earlier versions of Android.

Retrieves a double property by path.

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

Retrieves a repeated double property 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 returns null .

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

Retrieves a long property by path.

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

Retrieves a repeated long[] 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 returns null .

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

Returns the names of all properties defined in this document.

Retrieves a String property by path.

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

Retrieves a repeated String property 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 returns null .

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

Returns the AppSearchSchema type of the GenericDocument .

Returns the score of the GenericDocument .

The score is a query-independent measure of the document's quality, relative to other GenericDocument objects of the same AppSearchSchema 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 the GenericDocument , in milliseconds.

The TTL is measured against getCreationTimestampMillis() . At the timestamp of creationTimestampMillis + ttlMillis , measured in the System.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.