# Print output for @column tags ?> GetByDocumentIdRequest - Android SDK | Android Developers

Most visited


Recently visited


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:

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<StringList<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 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<StringList<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<StringList<String>> This value cannot be null.

Browse this site in English?

You requested a page in English, but your language preference for this site is English.

Would you like to change your language preference and browse this site in English? If you want to change your language preference later, use the language menu at the bottom of each page.