GetByDocumentIdRequest.Builder

Builder(namespace: String)

Creates a GetByDocumentIdRequest.Builder instance.

fun addIds(ids: Array<String!>): GetByDocumentIdRequest.Builder

Adds one or more document IDs to the request.

fun addIds(ids: (Mutable)Collection<String!>): GetByDocumentIdRequest.Builder

Adds a collection of IDs to the request.

fun addProjection(
    schemaType: String,
    propertyPaths: (Mutable)Collection<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 PROJECTION_SCHEMA_TYPE_WILDCARD, then those property paths will apply to all results, excepting any types that have their own, specific property paths set.

fun addProjectionPaths(
    schemaType: String,
    propertyPaths: (Mutable)Collection<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 PROJECTION_SCHEMA_TYPE_WILDCARD, then those property paths will apply to all results, excepting any types that have their own, specific property paths set.

fun build(): GetByDocumentIdRequest

Builds a new GetByDocumentIdRequest.