com.google.cloud.datastore

Class BaseDatastoreBatchWriter

java.lang.Object

com.google.cloud.datastore.BaseDatastoreBatchWriter

public abstract class BaseDatastoreBatchWriter
extends Object

Base class for DatastoreBatchWriter.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseDatastoreBatchWriter(String name)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	active() Deprecated.
List<Entity>	add(FullEntity<?>... entities) Datastore add operation: inserts the provided entities.
Entity	add(FullEntity<?> entity) Datastore add operation: inserts the provided entity.
void	addWithDeferredIdAllocation(FullEntity<?>... entities) Datastore add operation.
protected abstract Datastore	datastore() Deprecated.
protected void	deactivate()
void	delete(Key... keys) A datastore delete operation.
protected abstract Datastore	getDatastore()
protected String	getName()
boolean	isActive() Returns true if still active (write operations were not sent to the Datastore).
protected DatastoreException	newInvalidRequest(String msg, Object... params)
List<Entity>	put(FullEntity<?>... entities) A Datastore put (a.k.a upsert) operation: creates an entity if it does not exist, updates it otherwise.
Entity	put(FullEntity<?> entity) A Datastore put (a.k.a upsert) operation: inserts an entity if it does not exist, updates it otherwise.
void	putWithDeferredIdAllocation(FullEntity<?>... entities) Datastore put operation.
protected Map<Key,FullEntity<Key>>	toAdd()
protected List<FullEntity<IncompleteKey>>	toAddAutoId()
protected Set<Key>	toDelete()
protected List<com.google.datastore.v1.Mutation>	toMutationPbList()
protected Map<Key,FullEntity<Key>>	toPut()
protected Map<Key,FullEntity<Key>>	toUpdate()
void	update(Entity... entities) A Datastore update operation.
protected void	validateActive()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseDatastoreBatchWriter

protected BaseDatastoreBatchWriter(String name)

Method Detail

addWithDeferredIdAllocation

public final void addWithDeferredIdAllocation(FullEntity<?>... entities)

Datastore add operation. This method will also allocate id for any entity with an incomplete key. As opposed to add(FullEntity) and add(FullEntity...), this method will defer any necessary id allocation to submit time.

add

public final Entity add(FullEntity<?> entity)

Datastore add operation: inserts the provided entity. This method will automatically allocate an id if necessary. If entity has a complete key and was already marked for deletion in this writer, the operation will be changed to put(com.google.cloud.datastore.FullEntity<?>).

Parameters:

entity - the entity to add

Returns:

an Entity with the same properties and a key that is either newly allocated or the same one if key is already complete

add

public final List<Entity> add(FullEntity<?>... entities)

Datastore add operation: inserts the provided entities. This method will automatically allocate id for any entity with an incomplete key. For entities with complete keys that were marked for deletion in this writer the operation will be changed to put(com.google.cloud.datastore.FullEntity<?>).

Returns:

a list of Entity ordered by input with the same properties and a key that is either newly allocated or the same one if was already complete

See Also:

DatastoreWriter.add(FullEntity)

update

@SafeVarargs
public final void update(Entity... entities)

A Datastore update operation. The operation will fail if an entity with the same key does not already exist. This operation will be converted to put(com.google.cloud.datastore.FullEntity<?>) operation for entities that were already added or put in this writer.

put

public final Entity put(FullEntity<?> entity)

A Datastore put (a.k.a upsert) operation: inserts an entity if it does not exist, updates it otherwise. This method will automatically allocate an id if necessary. This operation will also remove from this writer any prior writes for the same entity.

Parameters:

entity - the entity to put

Returns:

an Entity with the same properties and a key that is either newly allocated or the same one if key is already complete

putWithDeferredIdAllocation

public final void putWithDeferredIdAllocation(FullEntity<?>... entities)

Datastore put operation. This method will also allocate id for any entity with an incomplete key. As opposed to put(FullEntity) and put(FullEntity...), this method will defer any necessary id allocation to submit time.

put

public final List<Entity> put(FullEntity<?>... entities)

A Datastore put (a.k.a upsert) operation: creates an entity if it does not exist, updates it otherwise. This method will automatically allocate id for any entity with an incomplete key. This operation will also remove from this writer any prior writes for the same entities.

Returns:

a list of updated or inserted Entity, ordered by input. Returned keys are either newly allocated or the same one if was already complete.

delete

public final void delete(Key... keys)

A datastore delete operation. It is OK to request the deletion of a non-existing key. This operation will also remove from this batch any prior writes for entities with the same keys.

active

@Deprecated
public boolean active()

Deprecated.

Returns true if still active (write operations were not sent to the Datastore).

isActive

public boolean isActive()

Returns true if still active (write operations were not sent to the Datastore).

getName

protected String getName()

toAdd

protected Map<Key,FullEntity<Key>> toAdd()

toAddAutoId

protected List<FullEntity<IncompleteKey>> toAddAutoId()

toUpdate

protected Map<Key,FullEntity<Key>> toUpdate()

toPut

protected Map<Key,FullEntity<Key>> toPut()

toDelete

protected Set<Key> toDelete()

deactivate

protected void deactivate()

validateActive

protected void validateActive()

newInvalidRequest

protected DatastoreException newInvalidRequest(String msg,
                                   Object... params)

toMutationPbList

protected List<com.google.datastore.v1.Mutation> toMutationPbList()

datastore

@Deprecated
protected abstract Datastore datastore()

Deprecated.

getDatastore

protected abstract Datastore getDatastore()