Added in API level 31

Summary: Ctors | Methods | Inherited Methods

GenericDocument.Builder

---

Kotlin |Java

public static class GenericDocument.Builder
extends Object

java.lang.Object
↳	android.app.appsearch.GenericDocument.Builder<BuilderType extends android.app.appsearch.GenericDocument.Builder<BuilderType>>

---

The builder class for GenericDocument.

Summary

Public constructors
Builder(GenericDocument document) Creates a new GenericDocument.Builder from the given GenericDocument.
Builder(String namespace, String id, String schemaType) Creates a new GenericDocument.Builder.

Public methods
GenericDocument	build() Builds the GenericDocument object.
BuilderType	clearProperty(String name) Clears the value for the property with the given name.
BuilderType	setCreationTimestampMillis(long creationTimestampMillis) Sets the creation timestamp of the GenericDocument, in milliseconds.
BuilderType	setId(String id) Sets the ID of this document, changing the value provided in the constructor.
BuilderType	setNamespace(String namespace) Sets the app-defined namespace this document resides in, changing the value provided in the constructor.
BuilderType	setPropertyBoolean(String name, boolean... values) Sets one or multiple boolean values for a property, replacing its previous values.
BuilderType	setPropertyBytes(String name, byte... values) Sets one or multiple byte[] for a property, replacing its previous values.
BuilderType	setPropertyDocument(String name, GenericDocument... values) Sets one or multiple GenericDocument values for a property, replacing its previous values.
BuilderType	setPropertyDouble(String name, double... values) Sets one or multiple double values for a property, replacing its previous values.
BuilderType	setPropertyEmbedding(String name, EmbeddingVector... values) Sets one or multiple EmbeddingVector values for a property, replacing its previous values.
BuilderType	setPropertyLong(String name, long... values) Sets one or multiple long values for a property, replacing its previous values.
BuilderType	setPropertyString(String name, String... values) Sets one or multiple String values for a property, replacing its previous values.
BuilderType	setSchemaType(String schemaType) Sets the schema type of this document, changing the value provided in the constructor.
BuilderType	setScore(int score) Sets the score of the GenericDocument.
BuilderType	setTtlMillis(long ttlMillis) Sets the TTL (time-to-live) of the GenericDocument, in milliseconds.

Inherited methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Builder

Added in API level 35
Also in T Extensions 13

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.

Parameters
document	GenericDocument: This value cannot be null.

Builder

Added in API level 31
Also in T Extensions 13

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.

Parameters
namespace	String: the namespace to set for the GenericDocument. This value cannot be null.
id	String: the unique identifier for the GenericDocument in its namespace. This value cannot be null.
schemaType	String: the AppSearchSchema type of the GenericDocument. The provided schemaType must be defined using AppSearchSession.setSchema prior to inserting a document of this schemaType into the AppSearch index using AppSearchSession.put. Otherwise, the document will be rejected by AppSearchSession.put with result code AppSearchResult.RESULT_NOT_FOUND. This value cannot be null.

Builder

Added in API level 35

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.

Parameters
document	GenericDocument: This value cannot be null.

Public methods

build

Added in API level 31

public GenericDocument build ()

Builds the GenericDocument object.

Returns
GenericDocument	This value cannot be null.

clearProperty

Added in API level 35
Also in T Extensions 13

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.

Parameters
name	String: The name of the property to clear. This value cannot be null.

Returns
BuilderType	This value cannot be null.

setCreationTimestampMillis

Added in API level 31

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.

Parameters
creationTimestampMillis	long: a creation timestamp in milliseconds. Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.

Returns
BuilderType	This value cannot be null.

setId

Added in API level 35
Also in T Extensions 13

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.

Parameters
id	String: This value cannot be null.

Returns
BuilderType	This value cannot be null.

setNamespace

Added in API level 35
Also in T Extensions 13

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.

Parameters
namespace	String: This value cannot be null.

Returns
BuilderType	This value cannot be null.

setPropertyBoolean

Added in API level 31

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

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

Parameters
name	String: the name associated with the values. Must match the name for this property as given in AppSearchSchema.PropertyConfig.getName. This value cannot be null.
values	boolean: the boolean values of the property. This value cannot be null.

Returns
BuilderType	This value cannot be null.

Throws
IllegalArgumentException	if the name is empty or null.

setPropertyBytes

Added in API level 31

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

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

Parameters
name	String: the name associated with the values. Must match the name for this property as given in AppSearchSchema.PropertyConfig.getName. This value cannot be null.
values	byte: the byte[] of the property. This value cannot be null.

Returns
BuilderType	This value cannot be null.

Throws
IllegalArgumentException	if no values are provided, or if a passed in byte[] is null, or if name is empty.

setPropertyDocument

Added in API level 31

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

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

Parameters
name	String: the name associated with the values. Must match the name for this property as given in AppSearchSchema.PropertyConfig.getName. This value cannot be null.
values	GenericDocument: the GenericDocument values of the property. This value cannot be null.

Returns
BuilderType	This value cannot be null.

Throws
IllegalArgumentException	if no values are provided, or if a passed in GenericDocument is null, or if name is empty.

setPropertyDouble

Added in API level 31

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

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

Parameters
name	String: the name associated with the values. Must match the name for this property as given in AppSearchSchema.PropertyConfig.getName. This value cannot be null.
values	double: the double values of the property. This value cannot be null.

Returns
BuilderType	This value cannot be null.

Throws
IllegalArgumentException	if the name is empty or null.

setPropertyEmbedding

Added in Android Baklava

public BuilderType setPropertyEmbedding (String name, 
                EmbeddingVector... values)

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

Parameters
name	String: the name associated with the values. Must match the name for this property as given in AppSearchSchema.PropertyConfig.getName. This value cannot be null.
values	EmbeddingVector: the EmbeddingVector values of the property. This value cannot be null.

Returns
BuilderType	This value cannot be null.

Throws
IllegalArgumentException	if the name is empty or null.

setPropertyLong

Added in API level 31

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

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

Parameters
name	String: the name associated with the values. Must match the name for this property as given in AppSearchSchema.PropertyConfig.getName. This value cannot be null.
values	long: the long values of the property. This value cannot be null.

Returns
BuilderType	This value cannot be null.

Throws
IllegalArgumentException	if the name is empty or null.

setPropertyString

Added in API level 31

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

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

Parameters
name	String: the name associated with the values. Must match the name for this property as given in AppSearchSchema.PropertyConfig.getName. This value cannot be null.
values	String: the String values of the property. This value cannot be null.

Returns
BuilderType	This value cannot be null.

Throws
IllegalArgumentException	if no values are provided, or if a passed in String is null or "".

setSchemaType

Added in API level 35
Also in T Extensions 13

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.

Parameters
schemaType	String: This value cannot be null.

Returns
BuilderType	This value cannot be null.

setScore

Added in API level 31

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.

Parameters
score	int: any non-negative int representing the document's score. Value is between 0 and Integer.MAX_VALUE inclusive

Returns
BuilderType	This value cannot be null.

Throws
IllegalArgumentException	if the score is negative.

setTtlMillis

Added in API level 31

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.

Parameters
ttlMillis	long: a non-negative duration in milliseconds.

Returns
BuilderType	This value cannot be null.

Throws
IllegalArgumentException	if ttlMillis is negative.