Encapsulates a request to retrieve documents by namespace and IDs from the AppSearchClient
database.
Nested Class Summary
| class | GetByDocumentIdRequest.Builder | Builder for GetByDocumentIdRequest
objects. |
|
Constant Summary
| String | PROJECTION_SCHEMA_TYPE_WILDCARD | Schema type to be used in
GetByDocumentIdRequest.Builder.addProjection(String, Collection) to apply
property paths to all results, excepting any types that have had their own, specific
property paths set. |
Inherited Constant Summary
Field Summary
| public static final Creator<GetByDocumentIdRequest> | CREATOR |
Public Method Summary
| 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)
|
Inherited Method Summary
Constants
public static final String PROJECTION_SCHEMA_TYPE_WILDCARD
Schema type to be used in
GetByDocumentIdRequest.Builder.addProjection(String, Collection) to apply
property paths to all results, excepting any types that have had their own, specific
property paths set.
Fields
public static final Creator<GetByDocumentIdRequest> CREATOR
Public Methods
public String getNamespace ()
Returns the namespace attached to the request.
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.
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.