Class BaseKey.Builder<B> (2.24.1)

public abstract static class BaseKey.Builder<B>

Base class for key builders.

Inheritance

java.lang.Object > BaseKey.Builder<B>

Type Parameter

Name Description
B

Methods

addAncestor(PathElement ancestor)

public B addAncestor(PathElement ancestor)

Adds an ancestor for this key.

Parameter
Name Description
ancestor PathElement
Returns
Type Description
B

addAncestors(PathElement ancestor, PathElement[] other)

public B addAncestors(PathElement ancestor, PathElement[] other)

Adds the provided ancestors to the key.

Parameters
Name Description
ancestor PathElement
other PathElement[]
Returns
Type Description
B

addAncestors(Iterable<PathElement> ancestors)

public B addAncestors(Iterable<PathElement> ancestors)

Adds the provided ancestors to the key.

Parameter
Name Description
ancestors Iterable<PathElement>
Returns
Type Description
B

build()

protected abstract BaseKey build()
Returns
Type Description
BaseKey

setDatabaseId(String databaseId)

public B setDatabaseId(String databaseId)

Sets the database id of the key.

Parameter
Name Description
databaseId String
Returns
Type Description
B

setKind(String kind)

public B setKind(String kind)

Sets the kind of the key.

Parameter
Name Description
kind String
Returns
Type Description
B

setNamespace(String namespace)

public B setNamespace(String namespace)

Sets the namespace of the key.

Parameter
Name Description
namespace String
Returns
Type Description
B

setProjectId(String projectId)

public B setProjectId(String projectId)

Sets the project ID of the key.

Parameter
Name Description
projectId String
Returns
Type Description
B