Batch (Google Cloud Datastore 1.20.0 API)

public interface Batch

An interface to represent a batch of write operations. Any write operation that is applied on a batch will only be sent to the Datastore upon submit(). A usage example:

 
 Entity entity1 = datastore.get(key1);
 Batch batch = datastore.newBatch();
 Entity entity2 = Entity.newBuilder(key2).set("name", "John").build();
 entity1 = Entity.newBuilder(entity1).clear().setNull("bla").build();
 Entity entity3 = Entity.newBuilder(key3).set("title", "title").build();
 batch.update(entity1);
 batch.add(entity2, entity3);
 batch.submit();

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface Batch.Response

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Batch.Response`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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.
`void`	`delete(Key... keys)` A datastore delete operation.
`Datastore`	`getDatastore()` Returns the batch associated `Datastore`.
`boolean`	`isActive()` Returns `true` if still active (write operations were not sent to the Datastore).
`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.
`Batch.Response`	`submit()` Submit the batch to the Datastore.
`void`	`update(Entity... entities)` A Datastore update operation.

- Method Detail
  - add
```
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<?>).
    If an entity for entity.getKey() does not exists, entity is inserted. Otherwise, submit() will throw a DatastoreException with BaseServiceException.getReason() equal to "ALREADY_EXISTS".
    
    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
```
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<?>).
    If none of entities' keys exist, all entities are inserted. If any of entities' keys already exists, submit() will throw a DatastoreException with BaseServiceException.getReason() equal to "ALREADY_EXISTS". All entities in entities whose key did not exist are inserted.
    
    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)
  - submit
```
Batch.Response submit()
```
    Submit the batch to the Datastore.
    
    Throws:
    
    DatastoreException - if there was any failure or if batch is not longer active
  - getDatastore
```
Datastore getDatastore()
```
    Returns the batch associated Datastore.
  - addWithDeferredIdAllocation
```
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.
    
    Throws:
    
    IllegalArgumentException - if any of the given entities is missing a key
    
    DatastoreException - if a given entity with a complete key was already added to this writer or if not active
  - update
```
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.
    
    Specified by:
    
    update in interface DatastoreWriter
    
    Throws:
    
    DatastoreException - if an entity is marked for deletion in this writer or if not active
  - delete
```
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.
    
    Specified by:
    
    delete in interface DatastoreWriter
    
    Throws:
    
    DatastoreException - if not active
  - putWithDeferredIdAllocation
```
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.
    
    Throws:
    
    IllegalArgumentException - if any of the given entities is missing a key
    
    DatastoreException - if not active
  - put
```
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.
    
    Specified by:
    
    put in interface DatastoreWriter
    
    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
    
    Throws:
    
    DatastoreException - if not active or if id allocation for an entity with an incomplete key failed
  - put
```
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.
    
    Specified by:
    
    put in interface DatastoreWriter
    
    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.
    
    Throws:
    
    DatastoreException - if not active or if id allocation for an entity with an incomplete key failed
  - isActive
```
boolean isActive()
```
    Returns true if still active (write operations were not sent to the Datastore).

Interface Batch

Nested Class Summary

Method Summary

Method Detail

add

add

submit

getDatastore

addWithDeferredIdAllocation

update

delete

putWithDeferredIdAllocation

put

put

isActive