GenericDocument

See also:

• AppSearchSession.put(PutDocumentsRequest)
• AppSearchSession.getByDocumentId(GetByDocumentIdRequest)
• AppSearchSession.search(String, SearchSpec)

GenericDocument

protected GenericDocument (GenericDocument document)

Creates a new GenericDocument from an existing instance.

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

equals

public boolean equals (Object other)

fromDocumentClass

public static GenericDocument fromDocumentClass (Object document)

Converts an instance of a class annotated with \@Document into an instance of GenericDocument.

getCreationTimestampMillis

public long getCreationTimestampMillis ()

Returns the creation timestamp of the GenericDocument, in milliseconds.

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

getId

public String getId ()

Returns the unique identifier of the GenericDocument.

getMaxIndexedProperties

public static int getMaxIndexedProperties ()

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.

getNamespace

public String getNamespace ()

Returns the namespace of the GenericDocument.

getProperty

public Object getProperty (String path)

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: "[email protected]"
         to: [{
             name: "Albert Einstein"
             email: "[email protected]"
           }, {
             name: "Marie Curie"
             email: "[email protected]"
           }]
         tags: ["important", "inbox"]
         subject: "Hello"
     }
 

Here are some example paths and their results:

• "from" returns "[email protected]" 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 "[email protected]"
• "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 ["[email protected]", "[email protected]"] 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).

getPropertyBoolean

public boolean getPropertyBoolean (String path)

Retrieves a boolean property by path.

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

getPropertyBooleanArray

public boolean[] getPropertyBooleanArray (String path)

Retrieves a repeated boolean property by path.

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

getPropertyBytes

public byte[] getPropertyBytes (String path)

Retrieves a byte[] property by path.

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

getPropertyBytesArray

public byte[][] getPropertyBytesArray (String path)

Retrieves a byte[][] property by path.

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

getPropertyDocument

public GenericDocument getPropertyDocument (String path)

Retrieves a GenericDocument property by path.

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

getPropertyDocumentArray

public GenericDocument[] getPropertyDocumentArray (String path)

Retrieves a repeated GenericDocument property by path.

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

getPropertyDouble

public double getPropertyDouble (String path)

Retrieves a double property by path.

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

getPropertyDoubleArray

public double[] getPropertyDoubleArray (String path)

Retrieves a repeated double property by path.

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

getPropertyLong

public long getPropertyLong (String path)

Retrieves a long property by path.

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

getPropertyLongArray

public long[] getPropertyLongArray (String path)

Retrieves a repeated long[] property by path.

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

getPropertyNames

public Set<String> getPropertyNames ()

Returns the names of all properties defined in this document.

getPropertyString

public String getPropertyString (String path)

Retrieves a String property by path.

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

getPropertyStringArray

public String[] getPropertyStringArray (String path)

Retrieves a repeated String property by path.

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

getSchemaType

public String getSchemaType ()

Returns the AppSearchSchema type of the GenericDocument.

getScore

public int getScore ()

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.

getTtlMillis

public long getTtlMillis ()

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 AppSearchSession.remove(RemoveByDocumentIdRequest) is called.

hashCode

public int hashCode ()

toBuilder

public Builder<Builder<?>> toBuilder ()

Copies the contents of this GenericDocument into a new GenericDocument.Builder.

The returned builder is a deep copy whose data is separate from this document.

toDocumentClass

public T toDocumentClass (Class<T> documentClass)

Converts this GenericDocument into an instance of the provided document class.

It is the developer's responsibility to ensure the right kind of document class is being supplied here, either by structuring the application code to ensure the document type is known, or by checking the return value of getSchemaType().

Document properties are identified by String names. Any that are found are assigned into fields of the given document class. As such, the most likely outcome of supplying the wrong document class would be an empty or partially populated result.

toString

public String toString ()