GetByDocumentIdRequest
class GetByDocumentIdRequest
Encapsulates a request to retrieve documents by namespace and IDs from the AppSearchSession database.
| See also | |
|---|---|
getByDocumentIdAsync |
Summary
Nested types |
|---|
|
Builder for |
Constants |
|
|---|---|
const String! |
Schema type to be used in |
Public functions |
|
|---|---|
(Mutable)Set<String!> |
getIds()Returns the set of document IDs attached to the request. |
String |
Returns the namespace attached to the request. |
(Mutable)Map<String!, (Mutable)List<PropertyPath!>!> |
Returns a map from schema type to property paths to be used for projection. |
(Mutable)Map<String!, (Mutable)List<String!>!> |
Returns a map from schema type to property paths to be used for projection. |
Constants
PROJECTION_SCHEMA_TYPE_WILDCARD
const val PROJECTION_SCHEMA_TYPE_WILDCARD = "*": String!
Schema type to be used in addProjection to apply property paths to all results, excepting any types that have had their own, specific property paths set.
Public functions
getIds
fun getIds(): (Mutable)Set<String!>
Returns the set of document IDs attached to the request.
getNamespace
fun getNamespace(): String
Returns the namespace attached to the request.
getProjectionPaths
fun getProjectionPaths(): (Mutable)Map<String!, (Mutable)List<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.
getProjections
fun getProjections(): (Mutable)Map<String!, (Mutable)List<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.