GetByDocumentIdRequest.Builder

public static final classGetByDocumentIdRequest.BuilderextendsObject

Builder forGetByDocumentIdRequest objects.

Public Constructor Summary

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(StringschemaType, Collection<String> propertyPaths) Adds property paths for the specified type to be used for projection.
GetByDocumentIdRequest.Builder	addProjectionPaths(StringschemaType, Collection<PropertyPath> propertyPaths) Adds property paths for the specified type to be used for projection.
GetByDocumentIdRequest	build() Builds a new`GetByDocumentIdRequest`.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Objectarg0)
void	finalize()
finalClass<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Constructors

publicBuilder(Stringnamespace)

Creates aGetByDocumentIdRequest.Builderinstance.

Public Methods

publicGetByDocumentIdRequest.Builder addIds(String...ids)

Adds one or more document IDs to the request.

publicGetByDocumentIdRequest.Builder addIds(Collection<String> ids)

Adds a collection of IDs to the request.

publicGetByDocumentIdRequest.Builder addProjection(StringschemaType,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 theGetByDocumentIdRequest.PROJECTION_SCHEMA_TYPE_WILDCARD,then those property paths will apply to all results, excepting any types that have their own, specific property paths set.

publicGetByDocumentIdRequest.Builder addProjectionPaths(String schemaType,Collection<PropertyPath> propertyPaths)