com.google.gcloud.datastore.DatastoreBatchWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gcloud-java-datastore Show documentation
Java idiomatic client for Google Cloud Datastore.
The newest version!
/*
 * Copyright 2015 Google Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.gcloud.datastore;

import java.util.List;

/**
 * An interface to represent a batch of write operations.
 * All write operation for a batch writer will be applied to the Datastore in one RPC call.
 */
interface DatastoreBatchWriter extends DatastoreWriter {

  /**
   * Datastore add operation.
   * This method will also allocate id for any entity with an incomplete key.
   * As oppose to {@link #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
   * @throws DatastoreException if a given entity with a
   *     complete key was already added to this writer or if not active
   */
  void addWithDeferredIdAllocation(FullEntity... entity);

  /**
   * {@inheritDoc}
   * For entities with complete keys that were marked for deletion in this writer the operation
   * will be changed to {@link #put}.
   * @throws DatastoreException if a given entity with the
   *     same complete key was already added to this writer, if writer is not active or
   *     if id allocation for an entity with an incomplete key failed.
   */
  @Override
  List add(FullEntity... entity);

  /**
   * {@inheritDoc}
   * This operation will be converted to {@link #put} operation for entities that were already
   *     added or put in this writer
   * @throws DatastoreException if an entity is marked for
   *     deletion in this writer or if not active
   */
  @Override
  void update(Entity... entity);

  /**
   * {@inheritDoc}
   * This operation will also remove from this batch any prior writes for entities with the same
   *     keys
   * @throws DatastoreException if not active
   */
  @Override
  void delete(Key... key);

  /**
   * {@inheritDoc}
   * This operation will also remove from this writer any prior writes for the same entities.
   * @throws DatastoreException if not active
   */
  @Override
  void put(Entity... entity);

  /**
   * Returns {@code true} if still active (write operations were not sent to the Datastore).
   */
  boolean active();
}