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 |
Constants | |
---|---|
String |
PROJECTION_SCHEMA_TYPE_WILDCARD
Schema type to be used in |
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<String, List<PropertyPath>>
|
getProjectionPaths()
Returns a map from schema type to property paths to be used for projection. |
Map<String, List<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
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
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 . |
getProjectionPaths
public Map<String, List<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<String, List<PropertyPath>> |
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 . |
writeToParcel
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 |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-06-18 UTC.