feat: Move CommonOperationMetadata into a separate proto file for potential reuse.

Google APIs · copybara-github · commit 3e0f7ebfbbd2 · 2021-06-04T12:13:53.000-07:00
PiperOrigin-RevId: 377562108
diff --git a/google/cloud/documentai/v1/BUILD.bazel b/google/cloud/documentai/v1/BUILD.bazel
@@ -25,6 +25,7 @@ proto_library(
         "document_io.proto",
         "document_processor_service.proto",
         "geometry.proto",
+        "operation_metadata.proto",
     ],
     deps = [
         "//google/api:annotations_proto",
diff --git a/google/cloud/documentai/v1/document_processor_service.proto b/google/cloud/documentai/v1/document_processor_service.proto
@@ -22,6 +22,7 @@ import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/cloud/documentai/v1/document.proto";
 import "google/cloud/documentai/v1/document_io.proto";
+import "google/cloud/documentai/v1/operation_metadata.proto";
 import "google/longrunning/operations.proto";
 import "google/protobuf/field_mask.proto";
 import "google/protobuf/timestamp.proto";
@@ -280,39 +281,3 @@ message ReviewDocumentOperationMetadata {
   // The basic metadata of the long running operation.
   CommonOperationMetadata common_metadata = 5;
 }
-
-// The common metadata for long running operations.
-message CommonOperationMetadata {
-  // State of the longrunning operation.
-  enum State {
-    // Unspecified state.
-    STATE_UNSPECIFIED = 0;
-
-    // Operation is still running.
-    RUNNING = 1;
-
-    // Operation is being cancelled.
-    CANCELLING = 2;
-
-    // Operation succeeded.
-    SUCCEEDED = 3;
-
-    // Operation failed.
-    FAILED = 4;
-
-    // Operation is cancelled.
-    CANCELLED = 5;
-  }
-
-  // The state of the operation.
-  State state = 1;
-
-  // A message providing more details about the current state of processing.
-  string state_message = 2;
-
-  // The creation time of the operation.
-  google.protobuf.Timestamp create_time = 3;
-
-  // The last update time of the operation.
-  google.protobuf.Timestamp update_time = 4;
-}
diff --git a/google/cloud/documentai/v1/geometry.proto b/google/cloud/documentai/v1/geometry.proto
@@ -32,7 +32,7 @@ message Vertex {
   // X coordinate.
   int32 x = 1;
 
-  // Y coordinate.
+  // Y coordinate (starts from the top of the image).
   int32 y = 2;
 }
 
@@ -43,7 +43,7 @@ message NormalizedVertex {
   // X coordinate.
   float x = 1;
 
-  // Y coordinate.
+  // Y coordinate (starts from the top of the image).
   float y = 2;
 }
 
diff --git a/google/cloud/documentai/v1/operation_metadata.proto b/google/cloud/documentai/v1/operation_metadata.proto
@@ -0,0 +1,64 @@
+// Copyright 2021 Google LLC
+//
+// 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.
+
+syntax = "proto3";
+
+package google.cloud.documentai.v1;
+
+import "google/protobuf/timestamp.proto";
+import "google/api/annotations.proto";
+
+option csharp_namespace = "Google.Cloud.DocumentAI.V1";
+option go_package = "google.golang.org/genproto/googleapis/cloud/documentai/v1;documentai";
+option java_multiple_files = true;
+option java_outer_classname = "OperationMetadataProto";
+option java_package = "com.google.cloud.documentai.v1";
+option php_namespace = "Google\\Cloud\\DocumentAI\\V1";
+option ruby_package = "Google::Cloud::DocumentAI::V1";
+
+// The common metadata for long running operations.
+message CommonOperationMetadata {
+  // State of the longrunning operation.
+  enum State {
+    // Unspecified state.
+    STATE_UNSPECIFIED = 0;
+
+    // Operation is still running.
+    RUNNING = 1;
+
+    // Operation is being cancelled.
+    CANCELLING = 2;
+
+    // Operation succeeded.
+    SUCCEEDED = 3;
+
+    // Operation failed.
+    FAILED = 4;
+
+    // Operation is cancelled.
+    CANCELLED = 5;
+  }
+
+  // The state of the operation.
+  State state = 1;
+
+  // A message providing more details about the current state of processing.
+  string state_message = 2;
+
+  // The creation time of the operation.
+  google.protobuf.Timestamp create_time = 3;
+
+  // The last update time of the operation.
+  google.protobuf.Timestamp update_time = 4;
+}

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ message Vertex {`
`32`	`32`	`// X coordinate.`
`33`	`33`	`int32 x = 1;`
`34`	`34`
`35`		`- // Y coordinate.`
	`35`	`+ // Y coordinate (starts from the top of the image).`
`36`	`36`	`int32 y = 2;`
`37`	`37`	`}`
`38`	`38`
`@@ -43,7 +43,7 @@ message NormalizedVertex {`
`43`	`43`	`// X coordinate.`
`44`	`44`	`float x = 1;`
`45`	`45`
`46`		`- // Y coordinate.`
	`46`	`+ // Y coordinate (starts from the top of the image).`
`47`	`47`	`float y = 2;`
`48`	`48`	`}`
`49`	`49`