GetByDocumentIdRequest.Builder
public final class GetByDocumentIdRequest.Builder
Builder for GetByDocumentIdRequest objects.
Summary
Public constructors |
|---|
|
Creates a |
Public methods |
|
|---|---|
@NonNull GetByDocumentIdRequest.Builder |
Adds one or more document IDs to the request. |
@NonNull GetByDocumentIdRequest.Builder |
addIds(@NonNull Collection<String> ids)Adds a collection of IDs to the request. |
@NonNull GetByDocumentIdRequest.Builder |
addProjection(Adds property paths for the specified type to be used for projection. |
@NonNull GetByDocumentIdRequest.Builder |
addProjectionPaths(Adds property paths for the specified type to be used for projection. |
@NonNull GetByDocumentIdRequest |
build()Builds a new |
Public constructors
Builder
public Builder(@NonNull String namespace)
Creates a GetByDocumentIdRequest.Builder instance.
Public methods
addIds
public @NonNull GetByDocumentIdRequest.Builder addIds(@NonNull String[] ids)
Adds one or more document IDs to the request.
addIds
public @NonNull GetByDocumentIdRequest.Builder addIds(@NonNull Collection<String> ids)
Adds a collection of IDs to the request.
addProjection
public @NonNull GetByDocumentIdRequest.Builder addProjection(
@NonNull String schemaType,
@NonNull Collection<String> propertyPaths
)
Adds property paths for the specified type to be used for projection. If property paths are added for a type, then only the properties referred to will be retrieved for results of that type. If a property path that is specified isn't present in a result, it will be ignored for that result. Property paths cannot be null.
If no property paths are added for a particular type, then all properties of results of that type will be retrieved.
If property path is added for the PROJECTION_SCHEMA_TYPE_WILDCARD, then those property paths will apply to all results, excepting any types that have their own, specific property paths set.
| See also | |
|---|---|
addProjectionPaths |
addProjectionPaths
public @NonNull GetByDocumentIdRequest.Builder addProjectionPaths(
@NonNull String schemaType,
@NonNull Collection<PropertyPath> propertyPaths
)
Adds property paths for the specified type to be used for projection. If property paths are added for a type, then only the properties referred to will be retrieved for results of that type. If a property path that is specified isn't present in a result, it will be ignored for that result. Property paths cannot be null.
If no property paths are added for a particular type, then all properties of results of that type will be retrieved.
If property path is added for the PROJECTION_SCHEMA_TYPE_WILDCARD, then those property paths will apply to all results, excepting any types that have their own, specific property paths set.
| See also | |
|---|---|
addProjectionPaths |
build
public @NonNull GetByDocumentIdRequest build()
Builds a new GetByDocumentIdRequest.