GetByDocumentIdRequest
class GetByDocumentIdRequest : Parcelable
kotlin.Any | |
↳ | android.app.appsearch.GetByDocumentIdRequest |
Encapsulates a request to retrieve documents by namespace and IDs from the AppSearchSession
database.
Summary
Nested classes | |
---|---|
Builder for |
Constants | |
---|---|
static String |
Schema type to be used in |
Inherited constants | |
---|---|
Public methods | |
---|---|
MutableSet<String!> |
getIds() Returns the set of document IDs attached to the request. |
String |
Returns the namespace attached to the request. |
MutableMap<String!, MutableList<PropertyPath!>!> |
Returns a map from schema type to property paths to be used for projection. |
MutableMap<String!, MutableList<String!>!> |
Returns a map from schema type to property paths to be used for projection. |
Unit |
writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel. |
Properties | |
---|---|
static Parcelable.Creator<GetByDocumentIdRequest!> |
Constants
PROJECTION_SCHEMA_TYPE_WILDCARD
static val PROJECTION_SCHEMA_TYPE_WILDCARD: String
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.
Value: "*"
Public methods
getIds
fun getIds(): MutableSet<String!>
Returns the set of document IDs attached to the request.
Return | |
---|---|
MutableSet<String!> |
This value cannot be null . |
getNamespace
fun getNamespace(): String
Returns the namespace attached to the request.
Return | |
---|---|
String |
This value cannot be null . |
getProjectionPaths
fun getProjectionPaths(): MutableMap<String!, MutableList<PropertyPath!>!>
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.
Return | |
---|---|
MutableMap<String!, MutableList<PropertyPath!>!> |
This value cannot be null . |
getProjections
fun getProjections(): MutableMap<String!, MutableList<String!>!>
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.
Return | |
---|---|
MutableMap<String!, MutableList<String!>!> |
This value cannot be null . |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
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_WRITE_RETURN_VALUE . Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |