GetByDocumentIdRequest


public final class GetByDocumentIdRequest
extends Object implements Parcelable

java.lang.Object
   ↳ android.app.appsearch.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 to apply property paths to all results, excepting any types that have had their own, specific property paths set.

Inherited constants

Fields

public static final Creator<GetByDocumentIdRequest> CREATOR

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<PropertyPath>> getProjectionPaths()

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

Map<StringList<String>> getProjections()

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

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

PROJECTION_SCHEMA_TYPE_WILDCARD

Added in API level 31
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: "*"

Fields

CREATOR

Added in API level 35
public static final Creator<GetByDocumentIdRequest> CREATOR

Public methods

getIds

Added in API level 31
public Set<String> getIds ()

Returns the set of document IDs attached to the request.

Returns
Set<String> This value cannot be null.

getNamespace

Added in API level 31
public String getNamespace ()

Returns the namespace attached to the request.

Returns
String This value cannot be null.

getProjectionPaths

Added in API level 34
public Map<StringList<PropertyPath>> getProjectionPaths ()

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

getProjections

Added in API level 31
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.

writeToParcel

Added in API level 35
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES