GetByDocumentIdRequest
public final class GetByDocumentIdRequest
Encapsulates a request to retrieve documents by namespace and IDs from the AppSearchSession database.
| See also | |
|---|---|
getByDocumentIdAsync |
Summary
Nested types |
|---|
public final class GetByDocumentIdRequest.BuilderBuilder for |
Constants |
|
|---|---|
static final String |
Schema type to be used in |
Public methods |
|
|---|---|
@NonNull Set<String> |
getIds()Returns the set of document IDs attached to the request. |
@NonNull String |
Returns the namespace attached to the request. |
@NonNull Map<String, List<PropertyPath>> |
Returns a map from schema type to property paths to be used for projection. |
@NonNull Map<String, List<String>> |
Returns a map from schema type to property paths to be used for projection. |
Constants
PROJECTION_SCHEMA_TYPE_WILDCARD
public static final String PROJECTION_SCHEMA_TYPE_WILDCARD = "*"
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 methods
getIds
public @NonNull Set<String> getIds()
Returns the set of document IDs attached to the request.
getNamespace
public @NonNull String getNamespace()
Returns the namespace attached to the request.
getProjectionPaths
public @NonNull 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.
getProjections
public @NonNull 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.