Most visited

Recently visited

Results for

Summary: Nested Classes | Constants | Methods | Inherited Methods

GetByDocumentIdRequest

public final class GetByDocumentIdRequest
extends Object

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

Encapsulates a request to retrieve documents by namespace and IDs from the AppSearchSession database.

See also:

AppSearchSession.getByDocumentId(GetByDocumentIdRequest, Executor, BatchResultCallback)

Summary

Nested classes
`class`	`GetByDocumentIdRequest.Builder` Builder for `GetByDocumentIdRequest` objects.

Constants
`String`	`PROJECTION_SCHEMA_TYPE_WILDCARD` Schema type to be used in `GetByDocumentIdRequest.Builder#addProjection` to apply property paths to all results, excepting any types that have had their own, specific property paths set.

Public methods
`Set<String>`	`getIds()` Returns the set of document IDs attached to the request.
`String`	`getNamespace()` Returns the namespace attached to the request.
`Map<String, List<String>>`	`getProjections()` Returns a map from schema type to property paths to be used for projection.

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 timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Constants

PROJECTION_SCHEMA_TYPE_WILDCARD

public static final String PROJECTION_SCHEMA_TYPE_WILDCARD

Schema type to be used in GetByDocumentIdRequest.Builder#addProjection to apply property paths to all results, excepting any types that have had their own, specific property paths set.

Constant Value: "*"

Public methods

getIds

public Set<String> getIds ()

Returns the set of document IDs attached to the request.

Returns
`Set<String>`	This value cannot be `null`.

getNamespace

public String getNamespace ()

Returns the namespace attached to the request.

Returns
`String`	This value cannot be `null`.

getProjections

public Map<String, List<String>> getProjections ()

Returns a map from schema type to property paths to be used for projection.

If the map is empty, then all properties will be retrieved for all results.

Calling this function repeatedly is inefficient. Prefer to retain the Map returned by this function, rather than calling it multiple times.

Returns
`Map<String, List<String>>`	This value cannot be `null`.

Interfaces

Classes

Most visited

Recently visited

Results for

GetByDocumentIdRequest

Summary

Nested classes

Constants

Public methods

Inherited methods

Constants

PROJECTION_SCHEMA_TYPE_WILDCARD

Public methods

getIds

getNamespace

getProjections