feat: add ROOT_FOLDER field to Document Warehouse API v1

Google APIs · copybara-github · commit c7c2ce2311e9 · 2023-09-18T13:15:04.000-07:00
feat: add `cloud_function`fields to support new ingestion option in Document Warehouse API v1

PiperOrigin-RevId: 566393178
diff --git a/google/cloud/contentwarehouse/v1/filters.proto b/google/cloud/contentwarehouse/v1/filters.proto
@@ -262,6 +262,9 @@ message FileTypeFilter {
 
     // Returns only non-folder documents.
     DOCUMENT = 3;
+
+    // Returns only root folders
+    ROOT_FOLDER = 4;
   }
 
   // The type of files to return.
diff --git a/google/cloud/contentwarehouse/v1/pipelines.proto b/google/cloud/contentwarehouse/v1/pipelines.proto
@@ -29,6 +29,10 @@ option java_outer_classname = "PipelinesProto";
 option java_package = "com.google.cloud.contentwarehouse.v1";
 option php_namespace = "Google\\Cloud\\ContentWarehouse\\V1";
 option ruby_package = "Google::Cloud::ContentWarehouse::V1";
+option (google.api.resource_definition) = {
+  type: "cloudfunctions.googleapis.com/CloudFunction"
+  pattern: "projects/{project}/locations/{location}/functions/{function}"
+};
 
 // Response message of RunPipeline method.
 message RunPipelineResponse {}
@@ -146,6 +150,33 @@ message IngestPipelineConfig {
   // linked during ingestion process. Format is
   // `projects/{project}/locations/{location}/documents/{folder_id}`
   string folder = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // The Cloud Function resource name. The Cloud Function needs to live inside
+  // consumer project and is accessible to Document AI Warehouse P4SA.
+  // Only Cloud Functions V2 is supported. Cloud function execution should
+  // complete within 5 minutes or this file ingestion may fail due to timeout.
+  // Format: `https://{region}-{project_id}.cloudfunctions.net/{cloud_function}`
+  // The following keys are available the request json payload.
+  // * display_name
+  // * properties
+  // * plain_text
+  // * reference_id
+  // * document_schema_name
+  // * raw_document_path
+  // * raw_document_file_type
+  //
+  // The following keys from the cloud function json response payload will be
+  // ingested to the Document AI Warehouse as part of Document proto content
+  // and/or related information. The original values will be overridden if any
+  // key is present in the response.
+  // * display_name
+  // * properties
+  // * plain_text
+  // * document_acl_policy
+  // * folder
+  string cloud_function = 4 [(google.api.resource_reference) = {
+    type: "cloudfunctions.googleapis.com/CloudFunction"
+  }];
 }
 
 // The configuration of the Cloud Storage Ingestion pipeline.

Original file line number	Diff line number	Diff line change
`@@ -262,6 +262,9 @@ message FileTypeFilter {`
`262`	`262`
`263`	`263`	`// Returns only non-folder documents.`
`264`	`264`	`DOCUMENT = 3;`
	`265`	`+`
	`266`	`+ // Returns only root folders`
	`267`	`+ ROOT_FOLDER = 4;`
`265`	`268`	`}`
`266`	`269`
`267`	`270`	`// The type of files to return.`