Added in API level 31

Builder


class Builder
kotlin.Any
   ↳ android.app.appsearch.GetByDocumentIdRequest.Builder

Builder for GetByDocumentIdRequest objects.

Summary

Public constructors
Builder(namespace: String)

Creates a GetByDocumentIdRequest.Builder instance.

Public methods
GetByDocumentIdRequest.Builder
addIds(vararg ids: String!)

Adds one or more document IDs to the request.

GetByDocumentIdRequest.Builder

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

Builds a new GetByDocumentIdRequest.

Public constructors

Builder

Added in API level 31
Builder(namespace: String)

Creates a GetByDocumentIdRequest.Builder instance.

Parameters
namespace String: This value cannot be null.

Public methods

addIds

Added in API level 31
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

Added in API level 31
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

Added in API level 31
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

Added in API level 34
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

Added in API level 31
fun build(): GetByDocumentIdRequest

Builds a new GetByDocumentIdRequest.

Return
GetByDocumentIdRequest This value cannot be null.