GetByDocumentIdRequest.Builder

  • GetByDocumentIdRequest.Builder is used to create GetByDocumentIdRequest objects.

  • It provides methods to add document IDs and specify property paths for projection.

  • The build method finalizes and creates the GetByDocumentIdRequest object.
public static final class GetByDocumentIdRequest.Builder extends Object

Builder for GetByDocumentIdRequest objects.

Public Constructor Summary

Builder(String namespace)
Creates a GetByDocumentIdRequest.Builder instance.

Public Method Summary

GetByDocumentIdRequest.Builder
addIds(String... ids)
Adds one or more document IDs to the request.
GetByDocumentIdRequest.Builder
addIds(Collection<String> ids)
Adds a collection of IDs to the request.
GetByDocumentIdRequest.Builder
addProjection(String schemaType, Collection<String> propertyPaths)
Adds property paths for the specified type to be used for projection.
GetByDocumentIdRequest.Builder
addProjectionPaths(String schemaType, Collection<PropertyPath> propertyPaths)
Adds property paths for the specified type to be used for projection.
GetByDocumentIdRequest
build()
Builds a new GetByDocumentIdRequest.

Inherited Method Summary

Public Constructors

public Builder (String namespace)

Creates a GetByDocumentIdRequest.Builder instance.

Public Methods

public GetByDocumentIdRequest.Builder addIds (String... ids)

Adds one or more document IDs to the request.

public GetByDocumentIdRequest.Builder addIds (Collection<String> ids)

Adds a collection of IDs to the request.

public GetByDocumentIdRequest.Builder addProjection (String schemaType, 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 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.

See Also

public GetByDocumentIdRequest.Builder addProjectionPaths (String schemaType, 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 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.

See Also

public GetByDocumentIdRequest build ()

Builds a new GetByDocumentIdRequest.