refactor(datastore): extract DatastoreExecutionOptions for query execution options

Author: rahulmane-goog

java-datastore/google-cloud-datastore/src/main/java/com/google/cloud/datastore/Datastore.java

@@ -46,6 +46,24 @@ public interface Datastore extends Service<DatastoreOptions>, DatastoreReaderWri
    */
   Transaction newTransaction();
 
+  /**
+   * Returns a new Datastore transaction with specified {@link DatastoreExecutionOptions}.
+   *
+   * @throws DatastoreException upon failure
+   */
+  @BetaApi
+  Transaction newTransaction(DatastoreExecutionOptions executionOptions);
+
+  /**
+   * Returns a new Datastore transaction with specified {@link TransactionOptions} and {@link
+   * DatastoreExecutionOptions}.
+   *
+   * @throws DatastoreException upon failure
+   */
+  @BetaApi
+  Transaction newTransaction(
+      TransactionOptions options, DatastoreExecutionOptions executionOptions);
+
   /**
    * A callback for running with a transactional {@link
    * com.google.cloud.datastore.DatastoreReaderWriter}. The associated transaction will be committed
@@ -181,6 +199,23 @@ interface TransactionCallable<T> {
    */
   List<Key> allocateId(IncompleteKey... keys);
 
+  /**
+   * Allocate a unique id for the given key with specified {@link DatastoreExecutionOptions}.
+   *
+   * @throws DatastoreException upon failure
+   */
+  @BetaApi
+  Key allocateId(IncompleteKey key, DatastoreExecutionOptions executionOptions);
+
+  /**
+   * Returns a list of keys using the allocated ids with specified {@link
+   * DatastoreExecutionOptions}.
+   *
+   * @throws DatastoreException upon failure
+   */
+  @BetaApi
+  List<Key> allocateId(DatastoreExecutionOptions executionOptions, IncompleteKey... keys);
+
   /**
    * Reserve one or more keys, preventing them from being automatically allocated by Datastore.
    *
@@ -198,6 +233,14 @@ interface TransactionCallable<T> {
    */
   List<Key> reserveIds(Key... keys);
 
+  /**
+   * Reserve one or more keys with specified {@link DatastoreExecutionOptions}.
+   *
+   * @throws DatastoreException upon failure
+   */
+  @BetaApi
+  List<Key> reserveIds(DatastoreExecutionOptions executionOptions, Key... keys);
+
   /**
    * {@inheritDoc}
    *
@@ -311,31 +354,24 @@ interface TransactionCallable<T> {
   @Override
   Entity put(FullEntity<?> entity);
 
+  @Override
+  List<Entity> put(FullEntity<?>... entities);
+
   /**
-   * {@inheritDoc}
-   *
-   * <p>Example of putting multiple entities.
-   *
-   * <pre>{@code
-   * String keyName1 = "my_key_name1";
-   * String keyName2 = "my_key_name2";
-   * Key key1 = datastore.newKeyFactory().setKind("MyKind").newKey(keyName1);
-   * Entity.Builder entityBuilder1 = Entity.newBuilder(key1);
-   * entityBuilder1.set("propertyName", "value1");
-   * Entity entity1 = entityBuilder1.build();
+   * {@inheritDoc} with specified {@link DatastoreExecutionOptions}.
    *
-   * Key key2 = datastore.newKeyFactory().setKind("MyKind").newKey(keyName2);
-   * Entity.Builder entityBuilder2 = Entity.newBuilder(key2);
-   * entityBuilder2.set("propertyName", "value2");
-   * Entity entity2 = entityBuilder2.build();
-   *
-   * datastore.put(entity1, entity2);
-   * }</pre>
+   * @throws DatastoreException upon failure
+   */
+  @BetaApi
+  Entity put(FullEntity<?> entity, DatastoreExecutionOptions executionOptions);
+
+  /**
+   * {@inheritDoc} with specified {@link DatastoreExecutionOptions}.
    *
    * @throws DatastoreException upon failure
    */
-  @Override
-  List<Entity> put(FullEntity<?>... entities);
+  @BetaApi
+  List<Entity> put(DatastoreExecutionOptions executionOptions, FullEntity<?>... entities);
 
   /**
    * {@inheritDoc}
@@ -355,6 +391,14 @@ interface TransactionCallable<T> {
   @Override
   void delete(Key... keys);
 
+  /**
+   * A datastore delete operation with specified {@link DatastoreExecutionOptions}.
+   *
+   * @throws DatastoreException upon failure
+   */
+  @BetaApi
+  void delete(DatastoreExecutionOptions executionOptions, Key... keys);
+
   /**
    * Returns a new KeyFactory for this service
    *
@@ -383,6 +427,15 @@ interface TransactionCallable<T> {
    */
   Entity get(Key key, ReadOption... options);
 
+  /**
+   * Returns an {@link Entity} for the given {@link Key} with specified {@link
+   * DatastoreExecutionOptions}.
+   *
+   * @throws DatastoreException upon failure
+   */
+  @BetaApi
+  Entity get(Key key, DatastoreExecutionOptions executionOptions);
+
   /**
    * Returns an {@link Entity} for each given {@link Key} that exists in the Datastore. The order of
    * the result is unspecified. Results are loaded lazily, so it is possible to get a {@code
@@ -411,6 +464,15 @@ interface TransactionCallable<T> {
    */
   Iterator<Entity> get(Iterable<Key> keys, ReadOption... options);
 
+  /**
+   * Returns an {@link Entity} for each given {@link Key} with specified {@link
+   * DatastoreExecutionOptions}.
+   *
+   * @throws DatastoreException upon failure
+   */
+  @BetaApi
+  Iterator<Entity> get(DatastoreExecutionOptions executionOptions, Key... keys);
+
   /**
    * Returns a list with a value for each given key (ordered by input). {@code null} values are
    * returned for nonexistent keys. When possible prefer using {@link #get(Key...)} to avoid eagerly
@@ -432,6 +494,13 @@ interface TransactionCallable<T> {
    */
   List<Entity> fetch(Iterable<Key> keys, ReadOption... options);
 
+  /**
+   * Returns a list with a value for each given key with specified {@link
+   * DatastoreExecutionOptions}.
+   */
+  @BetaApi
+  List<Entity> fetch(DatastoreExecutionOptions executionOptions, Key... keys);
+
   /**
    * Submits a {@link Query} and returns its result. {@link ReadOption}s can be specified if
    * desired.
@@ -495,28 +564,10 @@ interface TransactionCallable<T> {
   <T> QueryResults<T> run(Query<T> query, ExplainOptions explainOptions, ReadOption... options);
 
   /**
-   * Submits a {@link Query} with specified {@link com.google.datastore.v1.RequestOptions} and
-   * returns its result.
-   */
-  <T> QueryResults<T> run(Query<T> query, RequestOptions requestOptions);
-
-  /**
-   * Submits a {@link Query} with specified {@link com.google.datastore.v1.RequestOptions} and
-   * returns its result. {@link ReadOption}s can be specified if desired.
-   */
-  <T> QueryResults<T> run(Query<T> query, RequestOptions requestOptions, ReadOption... options);
-
-  /**
-   * Submits a {@link Query} with specified {@link com.google.cloud.datastore.models.ExplainOptions}
-   * and {@link com.google.datastore.v1.RequestOptions} and returns its result. {@link ReadOption}s
-   * can be specified if desired.
+   * Submits a {@link Query} with specified {@link DatastoreExecutionOptions} and returns its result.
    */
   @BetaApi
-  <T> QueryResults<T> run(
-      Query<T> query,
-      ExplainOptions explainOptions,
-      RequestOptions requestOptions,
-      ReadOption... options);
+  <T> QueryResults<T> run(Query<T> query, DatastoreExecutionOptions executionOptions);
 
   /**
    * Submits a {@link AggregationQuery} and returns {@link AggregationResults}. {@link ReadOption}s
@@ -563,20 +614,6 @@ <T> QueryResults<T> run(
    */
   AggregationResults runAggregation(AggregationQuery query, ReadOption... options);
 
-  /**
-   * Submits an {@link AggregationQuery} with specified {@link
-   * com.google.datastore.v1.RequestOptions} and returns {@link AggregationResults}.
-   */
-  AggregationResults runAggregation(AggregationQuery query, RequestOptions requestOptions);
-
-  /**
-   * Submits an {@link AggregationQuery} with specified {@link
-   * com.google.datastore.v1.RequestOptions} and returns {@link AggregationResults}. {@link
-   * ReadOption}s can be specified if desired.
-   */
-  AggregationResults runAggregation(
-      AggregationQuery query, RequestOptions requestOptions, ReadOption... options);
-
   /**
    * Submits a {@link AggregationQuery} with specified {@link
    * com.google.cloud.datastore.models.ExplainOptions} and returns {@link AggregationResults}.
@@ -605,26 +642,12 @@ AggregationResults runAggregation(
       AggregationQuery query, ExplainOptions explainOptions, ReadOption... options);
 
   /**
-   * Submits an {@link AggregationQuery} with specified {@link
-   * com.google.cloud.datastore.models.ExplainOptions} and {@link
-   * com.google.datastore.v1.RequestOptions} and returns {@link AggregationResults}.
+   * Submits an {@link AggregationQuery} with specified {@link DatastoreExecutionOptions} and returns
+   * {@link AggregationResults}.
    */
   @BetaApi
   AggregationResults runAggregation(
-      AggregationQuery query, ExplainOptions explainOptions, RequestOptions requestOptions);
-
-  /**
-   * Submits an {@link AggregationQuery} with specified {@link
-   * com.google.cloud.datastore.models.ExplainOptions} and {@link
-   * com.google.datastore.v1.RequestOptions} and returns {@link AggregationResults}. {@link
-   * ReadOption}s can be specified if desired.
-   */
-  @BetaApi
-  AggregationResults runAggregation(
-      AggregationQuery query,
-      ExplainOptions explainOptions,
-      RequestOptions requestOptions,
-      ReadOption... options);
+      AggregationQuery query, DatastoreExecutionOptions executionOptions);
 
   /**
    * Closes the gRPC channels associated with this instance and frees up their resources. This
@@ -636,16 +659,4 @@ AggregationResults runAggregation(
 
   /** Returns true if this background resource has been shut down. */
   boolean isClosed();
-
-  /**
-   * Returns a new Datastore client with the specified request tags added.
-   *
-   * @param requestTags the request tags to append to existing ones
-   */
-  default Datastore withRequestTags(List<String> requestTags) {
-    ImmutableList.Builder<String> builder = ImmutableList.builder();
-    builder.addAll(getOptions().getRequestTags());
-    builder.addAll(requestTags);
-    return getOptions().toBuilder().setRequestTags(builder.build()).build().getService();
-  }
 }