docs: clarifications for DatastoreFirestoreMigraitonMetadata (#759)

* docs: clarifications for `DatastoreFirestoreMigraitonMetadata`
feat: new enum value `OPTIMISTIC_WITH_ENTITY_GROUPS` for `ConcurrencyMode`

PiperOrigin-RevId: 452220654

Source-Link: googleapis/googleapis@454ad5e

Source-Link: https://github.com/googleapis/googleapis-gen/commit/45e72318c728b40c2131df1b5650965b68eb3bed
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNDVlNzIzMThjNzI4YjQwYzIxMzFkZjFiNTY1MDk2NWI2OGViM2JlZCJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Author: gcf-owl-bot[bot]

README.md

@@ -56,13 +56,13 @@ implementation 'com.google.cloud:google-cloud-datastore'
 If you are using Gradle without BOM, add this to your dependencies
 
 ```Groovy
-implementation 'com.google.cloud:google-cloud-datastore:2.5.1'
+implementation 'com.google.cloud:google-cloud-datastore:2.6.0'
 ```
 
 If you are using SBT, add this to your dependencies
 
 ```Scala
-libraryDependencies += "com.google.cloud" % "google-cloud-datastore" % "2.5.1"
+libraryDependencies += "com.google.cloud" % "google-cloud-datastore" % "2.6.0"
 ```
 
 ## Authentication

google-cloud-datastore/src/main/java/com/google/cloud/datastore/admin/v1/DatastoreAdminClient.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 Google LLC
+ * Copyright 2022 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,7 +18,6 @@
 
 import com.google.api.core.ApiFuture;
 import com.google.api.core.ApiFutures;
-import com.google.api.core.BetaApi;
 import com.google.api.gax.core.BackgroundResource;
 import com.google.api.gax.longrunning.OperationFuture;
 import com.google.api.gax.paging.AbstractFixedSizeCollection;
@@ -113,6 +112,8 @@
  * calls that map to API methods. Sample code to get started:
  *
  * <pre>{@code
+ * // This snippet has been automatically generated for illustrative purposes only.
+ * // It may require modifications to work in your environment.
  * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
  *   GetIndexRequest request =
  *       GetIndexRequest.newBuilder()
@@ -152,6 +153,8 @@
  * <p>To customize credentials:
  *
  * <pre>{@code
+ * // This snippet has been automatically generated for illustrative purposes only.
+ * // It may require modifications to work in your environment.
  * DatastoreAdminSettings datastoreAdminSettings =
  *     DatastoreAdminSettings.newBuilder()
  *         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
@@ -162,6 +165,8 @@
  * <p>To customize the endpoint:
  *
  * <pre>{@code
+ * // This snippet has been automatically generated for illustrative purposes only.
+ * // It may require modifications to work in your environment.
  * DatastoreAdminSettings datastoreAdminSettings =
  *     DatastoreAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
  * DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create(datastoreAdminSettings);
@@ -193,7 +198,6 @@ public static final DatastoreAdminClient create(DatastoreAdminSettings settings)
    * Constructs an instance of DatastoreAdminClient, using the given stub for making calls. This is
    * for advanced usage - prefer using create(DatastoreAdminSettings).
    */
-  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
   public static final DatastoreAdminClient create(DatastoreAdminStub stub) {
     return new DatastoreAdminClient(stub);
   }
@@ -209,7 +213,6 @@ protected DatastoreAdminClient(DatastoreAdminSettings settings) throws IOExcepti
     this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
   }
 
-  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
   protected DatastoreAdminClient(DatastoreAdminStub stub) {
     this.settings = null;
     this.stub = stub;
@@ -220,7 +223,6 @@ public final DatastoreAdminSettings getSettings() {
     return settings;
   }
 
-  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
   public DatastoreAdminStub getStub() {
     return stub;
   }
@@ -245,6 +247,8 @@ public final OperationsClient getOperationsClient() {
    * <p>Sample code:
    *
    * <pre>{@code
+   * // This snippet has been automatically generated for illustrative purposes only.
+   * // It may require modifications to work in your environment.
    * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
    *   String projectId = "projectId-894832108";
    *   Map<String, String> labels = new HashMap<>();
@@ -303,6 +307,8 @@ public final OperationFuture<ExportEntitiesResponse, ExportEntitiesMetadata> exp
    * <p>Sample code:
    *
    * <pre>{@code
+   * // This snippet has been automatically generated for illustrative purposes only.
+   * // It may require modifications to work in your environment.
    * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
    *   ExportEntitiesRequest request =
    *       ExportEntitiesRequest.newBuilder()
@@ -335,6 +341,8 @@ public final OperationFuture<ExportEntitiesResponse, ExportEntitiesMetadata> exp
    * <p>Sample code:
    *
    * <pre>{@code
+   * // This snippet has been automatically generated for illustrative purposes only.
+   * // It may require modifications to work in your environment.
    * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
    *   ExportEntitiesRequest request =
    *       ExportEntitiesRequest.newBuilder()
@@ -368,6 +376,8 @@ public final OperationFuture<ExportEntitiesResponse, ExportEntitiesMetadata> exp
    * <p>Sample code:
    *
    * <pre>{@code
+   * // This snippet has been automatically generated for illustrative purposes only.
+   * // It may require modifications to work in your environment.
    * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
    *   ExportEntitiesRequest request =
    *       ExportEntitiesRequest.newBuilder()
@@ -397,6 +407,8 @@ public final UnaryCallable<ExportEntitiesRequest, Operation> exportEntitiesCalla
    * <p>Sample code:
    *
    * <pre>{@code
+   * // This snippet has been automatically generated for illustrative purposes only.
+   * // It may require modifications to work in your environment.
    * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
    *   String projectId = "projectId-894832108";
    *   Map<String, String> labels = new HashMap<>();
@@ -446,6 +458,8 @@ public final OperationFuture<Empty, ImportEntitiesMetadata> importEntitiesAsync(
    * <p>Sample code:
    *
    * <pre>{@code
+   * // This snippet has been automatically generated for illustrative purposes only.
+   * // It may require modifications to work in your environment.
    * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
    *   ImportEntitiesRequest request =
    *       ImportEntitiesRequest.newBuilder()
@@ -476,6 +490,8 @@ public final OperationFuture<Empty, ImportEntitiesMetadata> importEntitiesAsync(
    * <p>Sample code:
    *
    * <pre>{@code
+   * // This snippet has been automatically generated for illustrative purposes only.
+   * // It may require modifications to work in your environment.
    * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
    *   ImportEntitiesRequest request =
    *       ImportEntitiesRequest.newBuilder()
@@ -506,6 +522,8 @@ public final OperationFuture<Empty, ImportEntitiesMetadata> importEntitiesAsync(
    * <p>Sample code:
    *
    * <pre>{@code
+   * // This snippet has been automatically generated for illustrative purposes only.
+   * // It may require modifications to work in your environment.
    * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
    *   ImportEntitiesRequest request =
    *       ImportEntitiesRequest.newBuilder()
@@ -542,6 +560,8 @@ public final UnaryCallable<ImportEntitiesRequest, Operation> importEntitiesCalla
    * <p>Sample code:
    *
    * <pre>{@code
+   * // This snippet has been automatically generated for illustrative purposes only.
+   * // It may require modifications to work in your environment.
    * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
    *   CreateIndexRequest request =
    *       CreateIndexRequest.newBuilder()
@@ -577,6 +597,8 @@ public final OperationFuture<Index, IndexOperationMetadata> createIndexAsync(
    * <p>Sample code:
    *
    * <pre>{@code
+   * // This snippet has been automatically generated for illustrative purposes only.
+   * // It may require modifications to work in your environment.
    * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
    *   CreateIndexRequest request =
    *       CreateIndexRequest.newBuilder()
@@ -612,6 +634,8 @@ public final OperationFuture<Index, IndexOperationMetadata> createIndexAsync(
    * <p>Sample code:
    *
    * <pre>{@code
+   * // This snippet has been automatically generated for illustrative purposes only.
+   * // It may require modifications to work in your environment.
    * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
    *   CreateIndexRequest request =
    *       CreateIndexRequest.newBuilder()
@@ -643,6 +667,8 @@ public final UnaryCallable<CreateIndexRequest, Operation> createIndexCallable()
    * <p>Sample code:
    *
    * <pre>{@code
+   * // This snippet has been automatically generated for illustrative purposes only.
+   * // It may require modifications to work in your environment.
    * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
    *   DeleteIndexRequest request =
    *       DeleteIndexRequest.newBuilder()
@@ -676,6 +702,8 @@ public final OperationFuture<Index, IndexOperationMetadata> deleteIndexAsync(
    * <p>Sample code:
    *
    * <pre>{@code
+   * // This snippet has been automatically generated for illustrative purposes only.
+   * // It may require modifications to work in your environment.
    * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
    *   DeleteIndexRequest request =
    *       DeleteIndexRequest.newBuilder()
@@ -709,6 +737,8 @@ public final OperationFuture<Index, IndexOperationMetadata> deleteIndexAsync(
    * <p>Sample code:
    *
    * <pre>{@code
+   * // This snippet has been automatically generated for illustrative purposes only.
+   * // It may require modifications to work in your environment.
    * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
    *   DeleteIndexRequest request =
    *       DeleteIndexRequest.newBuilder()
@@ -732,6 +762,8 @@ public final UnaryCallable<DeleteIndexRequest, Operation> deleteIndexCallable()
    * <p>Sample code:
    *
    * <pre>{@code
+   * // This snippet has been automatically generated for illustrative purposes only.
+   * // It may require modifications to work in your environment.
    * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
    *   GetIndexRequest request =
    *       GetIndexRequest.newBuilder()
@@ -756,6 +788,8 @@ public final Index getIndex(GetIndexRequest request) {
    * <p>Sample code:
    *
    * <pre>{@code
+   * // This snippet has been automatically generated for illustrative purposes only.
+   * // It may require modifications to work in your environment.
    * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
    *   GetIndexRequest request =
    *       GetIndexRequest.newBuilder()
@@ -780,6 +814,8 @@ public final UnaryCallable<GetIndexRequest, Index> getIndexCallable() {
    * <p>Sample code:
    *
    * <pre>{@code
+   * // This snippet has been automatically generated for illustrative purposes only.
+   * // It may require modifications to work in your environment.
    * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
    *   ListIndexesRequest request =
    *       ListIndexesRequest.newBuilder()
@@ -809,6 +845,8 @@ public final ListIndexesPagedResponse listIndexes(ListIndexesRequest request) {
    * <p>Sample code:
    *
    * <pre>{@code
+   * // This snippet has been automatically generated for illustrative purposes only.
+   * // It may require modifications to work in your environment.
    * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
    *   ListIndexesRequest request =
    *       ListIndexesRequest.newBuilder()
@@ -838,6 +876,8 @@ public final ListIndexesPagedResponse listIndexes(ListIndexesRequest request) {
    * <p>Sample code:
    *
    * <pre>{@code
+   * // This snippet has been automatically generated for illustrative purposes only.
+   * // It may require modifications to work in your environment.
    * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
    *   ListIndexesRequest request =
    *       ListIndexesRequest.newBuilder()

google-cloud-datastore/src/main/java/com/google/cloud/datastore/admin/v1/DatastoreAdminSettings.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 Google LLC
+ * Copyright 2022 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -67,6 +67,8 @@
  * <p>For example, to set the total timeout of getIndex to 30 seconds:
  *
  * <pre>{@code
+ * // This snippet has been automatically generated for illustrative purposes only.
+ * // It may require modifications to work in your environment.
  * DatastoreAdminSettings.Builder datastoreAdminSettingsBuilder =
  *     DatastoreAdminSettings.newBuilder();
  * datastoreAdminSettingsBuilder

google-cloud-datastore/src/main/java/com/google/cloud/datastore/admin/v1/package-info.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 Google LLC
+ * Copyright 2022 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -79,6 +79,8 @@
  * <p>Sample for DatastoreAdminClient:
  *
  * <pre>{@code
+ * // This snippet has been automatically generated for illustrative purposes only.
+ * // It may require modifications to work in your environment.
  * try (DatastoreAdminClient datastoreAdminClient = DatastoreAdminClient.create()) {
  *   GetIndexRequest request =
  *       GetIndexRequest.newBuilder()

google-cloud-datastore/src/main/java/com/google/cloud/datastore/admin/v1/stub/DatastoreAdminStub.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 Google LLC
+ * Copyright 2022 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

google-cloud-datastore/src/main/java/com/google/cloud/datastore/admin/v1/stub/DatastoreAdminStubSettings.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 Google LLC
+ * Copyright 2022 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -85,6 +85,8 @@
  * <p>For example, to set the total timeout of getIndex to 30 seconds:
  *
  * <pre>{@code
+ * // This snippet has been automatically generated for illustrative purposes only.
+ * // It may require modifications to work in your environment.
  * DatastoreAdminStubSettings.Builder datastoreAdminSettingsBuilder =
  *     DatastoreAdminStubSettings.newBuilder();
  * datastoreAdminSettingsBuilder
@@ -234,7 +236,6 @@ public UnaryCallSettings<GetIndexRequest, Index> getIndexSettings() {
     return listIndexesSettings;
   }
 
-  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
   public DatastoreAdminStub createStub() throws IOException {
     if (getTransportChannelProvider()
         .getTransportName()

google-cloud-datastore/src/main/java/com/google/cloud/datastore/admin/v1/stub/GrpcDatastoreAdminCallableFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 Google LLC
+ * Copyright 2022 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

google-cloud-datastore/src/main/java/com/google/cloud/datastore/admin/v1/stub/GrpcDatastoreAdminStub.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 Google LLC
+ * Copyright 2022 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

google-cloud-datastore/src/test/java/com/google/cloud/datastore/admin/v1/DatastoreAdminClientTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 Google LLC
+ * Copyright 2022 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

google-cloud-datastore/src/test/java/com/google/cloud/datastore/admin/v1/MockDatastoreAdmin.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 Google LLC
+ * Copyright 2022 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.