docs: clarifications for DatastoreFirestoreMigraitonMetadata

Google APIs · copybara-github · commit 454ad5ec4399 · 2022-05-31T23:10:26.000-07:00
feat: new enum value `OPTIMISTIC_WITH_ENTITY_GROUPS` for `ConcurrencyMode`

PiperOrigin-RevId: 452220654
diff --git a/google/datastore/admin/v1/datastore_admin.proto b/google/datastore/admin/v1/datastore_admin.proto
@@ -1,4 +1,4 @@
-// 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.
@@ -481,7 +481,7 @@ message IndexOperationMetadata {
 // design pattern.
 //
 // This singleton resource can be accessed at:
-// `projects/{project_id}/datastore-firestore-migration`
+// "projects/{project_id}/operations/datastore-firestore-migration"
 message DatastoreFirestoreMigrationMetadata {
   // The current state of migration from Cloud Datastore to Cloud Firestore in
   // Datastore mode.
diff --git a/google/datastore/admin/v1/datastore_v1.yaml b/google/datastore/admin/v1/datastore_v1.yaml
@@ -5,6 +5,7 @@ title: Cloud Datastore API
 
 apis:
 - name: google.datastore.admin.v1.DatastoreAdmin
+- name: google.longrunning.Operations
 
 types:
 - name: google.datastore.admin.v1.DatastoreFirestoreMigrationMetadata
diff --git a/google/datastore/admin/v1/index.proto b/google/datastore/admin/v1/index.proto
@@ -1,4 +1,4 @@
-// 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.
@@ -17,7 +17,6 @@ syntax = "proto3";
 package google.datastore.admin.v1;
 
 import "google/api/field_behavior.proto";
-import "google/api/annotations.proto";
 
 option csharp_namespace = "Google.Cloud.Datastore.Admin.V1";
 option go_package = "google.golang.org/genproto/googleapis/datastore/admin/v1;admin";
@@ -29,15 +28,6 @@ option ruby_package = "Google::Cloud::Datastore::Admin::V1";
 
 // Datastore composite index definition.
 message Index {
-  // A property of an index.
-  message IndexedProperty {
-    // Required. The property name to index.
-    string name = 1 [(google.api.field_behavior) = REQUIRED];
-
-    // Required. The indexed property's direction.  Must not be DIRECTION_UNSPECIFIED.
-    Direction direction = 2 [(google.api.field_behavior) = REQUIRED];
-  }
-
   // For an ordered index, specifies whether each of the entity's ancestors
   // will be included.
   enum AncestorMode {
@@ -65,6 +55,15 @@ message Index {
     DESCENDING = 2;
   }
 
+  // A property of an index.
+  message IndexedProperty {
+    // Required. The property name to index.
+    string name = 1 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. The indexed property's direction.  Must not be DIRECTION_UNSPECIFIED.
+    Direction direction = 2 [(google.api.field_behavior) = REQUIRED];
+  }
+
   // The possible set of states of an index.
   enum State {
     // The state is unspecified.
diff --git a/google/datastore/admin/v1/migration.proto b/google/datastore/admin/v1/migration.proto
@@ -1,4 +1,4 @@
-// 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.
@@ -16,8 +16,6 @@ syntax = "proto3";
 
 package google.datastore.admin.v1;
 
-import "google/api/annotations.proto";
-
 option csharp_namespace = "Google.Cloud.Datastore.Admin.V1";
 option go_package = "google.golang.org/genproto/googleapis/datastore/admin/v1;admin";
 option java_multiple_files = true;
@@ -38,6 +36,21 @@ message MigrationStateEvent {
 // Datastore to Cloud Firestore in Datastore
 // mode](https://cloud.google.com/datastore/docs/upgrade-to-firestore).
 message MigrationProgressEvent {
+  // Concurrency modes for transactions in Cloud Firestore.
+  enum ConcurrencyMode {
+    // Unspecified.
+    CONCURRENCY_MODE_UNSPECIFIED = 0;
+
+    // Pessimistic concurrency.
+    PESSIMISTIC = 1;
+
+    // Optimistic concurrency.
+    OPTIMISTIC = 2;
+
+    // Optimistic concurrency with entity groups.
+    OPTIMISTIC_WITH_ENTITY_GROUPS = 3;
+  }
+
   // Details for the `PREPARE` step.
   message PrepareStepDetails {
     // The concurrency mode this database will use when it reaches the
@@ -51,18 +64,6 @@ message MigrationProgressEvent {
     ConcurrencyMode concurrency_mode = 1;
   }
 
-  // Concurrency modes for transactions in Cloud Firestore.
-  enum ConcurrencyMode {
-    // Unspecified.
-    CONCURRENCY_MODE_UNSPECIFIED = 0;
-
-    // Pessimistic concurrency.
-    PESSIMISTIC = 1;
-
-    // Optimistic concurrency.
-    OPTIMISTIC = 2;
-  }
-
   // The step that is starting.
   //
   // An event with step set to `START` indicates that the migration
