GenericDocument.Builder

Builder

public Builder (String namespace, 
                String id, 
                String schemaType)

Creates a new GenericDocument.Builder.

Document IDs are unique within a namespace.

The number of namespaces per app should be kept small for efficiency reasons.

Builder

public Builder (GenericDocument document)

Creates a new GenericDocument.Builder from the given GenericDocument.

The GenericDocument is deep copied, that is, it changes to a new GenericDocument returned by this function and will NOT affect the original GenericDocument.

build

public GenericDocument build ()

Builds the GenericDocument object.

clearProperty

public BuilderType clearProperty (String name)

Clears the value for the property with the given name.

Note that this method does not support property paths.

You should check for the existence of the property in GenericDocument.getPropertyNames() if you need to make sure the property being cleared actually exists.

If the string passed is an invalid or nonexistent property, no error message or behavior will be observed.

setCreationTimestampMillis

public BuilderType setCreationTimestampMillis (long creationTimestampMillis)

Sets the creation timestamp of the GenericDocument, in milliseconds.

This should be set using a value obtained from the System#currentTimeMillis time base.

If this method is not called, this will be set to the time the object is built.

setId

public BuilderType setId (String id)

Sets the ID of this document, changing the value provided in the constructor. No special values are reserved or understood by the infrastructure.

Document IDs are unique within the combination of package, database, and namespace.

Setting a document with a duplicate id will overwrite the original document with the new document, enforcing uniqueness within the above constraint.

setNamespace

public BuilderType setNamespace (String namespace)

Sets the app-defined namespace this document resides in, changing the value provided in the constructor. No special values are reserved or understood by the infrastructure.

Document IDs are unique within a namespace.

The number of namespaces per app should be kept small for efficiency reasons.

setPropertyBoolean

public BuilderType setPropertyBoolean (String name, 
                boolean... values)

Sets one or multiple boolean values for a property, replacing its previous values.

setPropertyBytes

public BuilderType setPropertyBytes (String name, 
                byte... values)

Sets one or multiple byte[] for a property, replacing its previous values.

setPropertyDocument

public BuilderType setPropertyDocument (String name, 
                GenericDocument... values)

Sets one or multiple GenericDocument values for a property, replacing its previous values.

setPropertyDouble

public BuilderType setPropertyDouble (String name, 
                double... values)

Sets one or multiple double values for a property, replacing its previous values.

setPropertyLong

public BuilderType setPropertyLong (String name, 
                long... values)

Sets one or multiple long values for a property, replacing its previous values.

setPropertyString

public BuilderType setPropertyString (String name, 
                String... values)

Sets one or multiple String values for a property, replacing its previous values.

setSchemaType

public BuilderType setSchemaType (String schemaType)

Sets the schema type of this document, changing the value provided in the constructor.

To successfully index a document, the schema type must match the name of an AppSearchSchema object previously provided to AppSearchSession#setSchema.

setScore

public BuilderType setScore (int score)

Sets 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. Documents with higher scores are considered better than documents with lower scores.

Any non-negative integer can be used a score. By default, scores are set to 0.

setTtlMillis

public BuilderType setTtlMillis (long ttlMillis)

Sets the TTL (time-to-live) of the GenericDocument, in milliseconds.

The TTL is measured against GenericDocument.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 is called.