PutDocumentsRequest


public final class PutDocumentsRequest
extends Object

java.lang.Object
   ↳ android.app.appsearch.PutDocumentsRequest


Encapsulates a request to index documents into an AppSearchSession database.

Summary

Nested classes

class PutDocumentsRequest.Builder

Builder for PutDocumentsRequest objects. 

Public methods

List<GenericDocument> getGenericDocuments()

Returns a list of GenericDocument objects that are part of this request.

List<GenericDocument> getTakenActionGenericDocuments()

Returns a list of GenericDocument objects containing taken action metrics that are part of this request.

Inherited methods

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 methods

getGenericDocuments

Added in API level 31
public List<GenericDocument> getGenericDocuments ()

Returns a list of GenericDocument objects that are part of this request.

Returns
List<GenericDocument> This value cannot be null.

getTakenActionGenericDocuments

Added in API level 35
Also in T Extensions 13
public List<GenericDocument> getTakenActionGenericDocuments ()

Returns a list of GenericDocument objects containing taken action metrics that are part of this request.

See Builder.addTakenActionGenericDocuments(GenericDocument...).

Returns
List<GenericDocument> This value cannot be null.