GetByDocumentIdRequest

public final class GetByDocumentIdRequest
extends Object

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


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

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(String, Collection) 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

Constants

PROJECTION_SCHEMA_TYPE_WILDCARD

public static final String PROJECTION_SCHEMA_TYPE_WILDCARD

Schema type to be used in GetByDocumentIdRequest.Builder.addProjection(String, Collection) 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>

getNamespace

public String getNamespace ()

Returns the namespace attached to the request.

Returns
String

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>>