Builder
class Builder
| kotlin.Any | |
| ↳ | android.app.appsearch.GetByDocumentIdRequest.Builder |
Builder for GetByDocumentIdRequest objects.
Summary
| Public constructors | |
|---|---|
|
Creates a |
|
| Public methods | |
|---|---|
| GetByDocumentIdRequest.Builder |
Adds one or more document IDs to the request. |
| GetByDocumentIdRequest.Builder |
addIds(ids: MutableCollection<String!>)Adds a collection of IDs to the request. |
| GetByDocumentIdRequest.Builder |
addProjection(schemaType: String, propertyPaths: MutableCollection<String!>)Adds property paths for the specified type to be used for projection. |
| GetByDocumentIdRequest.Builder |
addProjectionPaths(schemaType: String, propertyPaths: MutableCollection<PropertyPath!>)Adds property paths for the specified type to be used for projection. |
| GetByDocumentIdRequest |
build()Builds a new |
Public constructors
Builder
Builder(namespace: String)
Creates a GetByDocumentIdRequest.Builder instance.
| Parameters | |
|---|---|
namespace |
String: This value cannot be null. |
Public methods
addIds
fun addIds(vararg ids: String!): GetByDocumentIdRequest.Builder
Adds one or more document IDs to the request.
| Parameters | |
|---|---|
ids |
String!: This value cannot be null. |
| Return | |
|---|---|
GetByDocumentIdRequest.Builder |
This value cannot be null. |
addIds
fun addIds(ids: MutableCollection<String!>): GetByDocumentIdRequest.Builder
Adds a collection of IDs to the request.
| Parameters | |
|---|---|
ids |
MutableCollection<String!>: This value cannot be null. |
| Return | |
|---|---|
GetByDocumentIdRequest.Builder |
This value cannot be null. |
addProjection
fun addProjection(
schemaType: String,
propertyPaths: MutableCollection<String!>
): GetByDocumentIdRequest.Builder
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 android.app.appsearch.GetByDocumentIdRequest#PROJECTION_SCHEMA_TYPE_WILDCARD, then those property paths will apply to all results, excepting any types that have their own, specific property paths set.
| Parameters | |
|---|---|
schemaType |
String: This value cannot be null. |
propertyPaths |
MutableCollection<String!>: This value cannot be null. |
addProjectionPaths
fun addProjectionPaths(
schemaType: String,
propertyPaths: MutableCollection<PropertyPath!>
): GetByDocumentIdRequest.Builder
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 android.app.appsearch.GetByDocumentIdRequest#PROJECTION_SCHEMA_TYPE_WILDCARD, then those property paths will apply to all results, excepting any types that have their own, specific property paths set.
| Parameters | |
|---|---|
schemaType |
String: This value cannot be null. |
propertyPaths |
MutableCollection<PropertyPath!>: This value cannot be null. |
build
fun build(): GetByDocumentIdRequest
Builds a new GetByDocumentIdRequest.
| Return | |
|---|---|
GetByDocumentIdRequest |
This value cannot be null. |