feat: add ListWorkflowRevisions method

Google APIs · copybara-github · commit d7db9c6f0c5a · 2025-03-17T11:54:06.000-07:00
feat: add ExecutionHistoryLevel to Workflow
feat: add crypto key config to Workflow
feat: add tags to Workflow
feat: add ExecutionHistoryLevel enum
docs: update Workflow some standard field docs

PiperOrigin-RevId: 737698339
diff --git a/google/cloud/workflows/v1/workflows.proto b/google/cloud/workflows/v1/workflows.proto
@@ -33,6 +33,10 @@ option (google.api.resource_definition) = {
   type: "cloudkms.googleapis.com/CryptoKey"
   pattern: "projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}"
 };
+option (google.api.resource_definition) = {
+  type: "cloudkms.googleapis.com/CryptoKeyVersion"
+  pattern: "projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}"
+};
 
 // Workflows is used to deploy and execute workflow programs.
 // Workflows makes sure the program executes reliably, despite hardware and
@@ -107,6 +111,14 @@ service Workflows {
       metadata_type: "OperationMetadata"
     };
   }
+
+  // Lists revisions for a given workflow.
+  rpc ListWorkflowRevisions(ListWorkflowRevisionsRequest)
+      returns (ListWorkflowRevisionsResponse) {
+    option (google.api.http) = {
+      get: "/v1/{name=projects/*/locations/*/workflows/*}:listRevisions"
+    };
+  }
 }
 
 // Workflow program to be executed by Workflows.
@@ -164,11 +176,13 @@ message Workflow {
   }
 
   // The resource name of the workflow.
-  // Format: projects/{project}/locations/{location}/workflows/{workflow}
+  // Format: projects/{project}/locations/{location}/workflows/{workflow}.
+  // This is a workflow-wide field and is not tied to a specific revision.
   string name = 1;
 
   // Description of the workflow provided by the user.
-  // Must be at most 1000 unicode characters long.
+  // Must be at most 1000 Unicode characters long.
+  // This is a workflow-wide field and is not tied to a specific revision.
   string description = 2;
 
   // Output only. State of the workflow deployment.
@@ -188,10 +202,12 @@ message Workflow {
   string revision_id = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Output only. The timestamp for when the workflow was created.
+  // This is a workflow-wide field and is not tied to a specific revision.
   google.protobuf.Timestamp create_time = 5
       [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Output only. The timestamp for when the workflow was last updated.
+  // This is a workflow-wide field and is not tied to a specific revision.
   google.protobuf.Timestamp update_time = 6
       [(google.api.field_behavior) = OUTPUT_ONLY];
 
@@ -205,6 +221,7 @@ message Workflow {
   // than 63 characters and can only contain lowercase letters, numeric
   // characters, underscores, and dashes. Label keys must start with a letter.
   // International characters are allowed.
+  // This is a workflow-wide field and is not tied to a specific revision.
   map<string, string> labels = 8;
 
   // The service account associated with the latest workflow version.
@@ -260,10 +277,51 @@ message Workflow {
 
   // Optional. User-defined environment variables associated with this workflow
   // revision. This map has a maximum length of 20. Each string can take up to
-  // 40KiB. Keys cannot be empty strings and cannot start with “GOOGLE” or
-  // “WORKFLOWS".
+  // 4KiB. Keys cannot be empty strings and cannot start with "GOOGLE" or
+  // "WORKFLOWS".
   map<string, string> user_env_vars = 14
       [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Describes the execution history level to apply to this workflow.
+  ExecutionHistoryLevel execution_history_level = 15
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. A list of all KMS crypto keys used to encrypt or decrypt the
+  // data associated with the workflow.
+  repeated string all_kms_keys = 16 [
+    (google.api.field_behavior) = OUTPUT_ONLY,
+    (google.api.resource_reference) = {
+      type: "cloudkms.googleapis.com/CryptoKey"
+    }
+  ];
+
+  // Output only. A list of all KMS crypto key versions used to encrypt or
+  // decrypt the data associated with the workflow.
+  repeated string all_kms_keys_versions = 17 [
+    (google.api.field_behavior) = OUTPUT_ONLY,
+    (google.api.resource_reference) = {
+      type: "cloudkms.googleapis.com/CryptoKeyVersion"
+    }
+  ];
+
+  // Output only. The resource name of a KMS crypto key version used to encrypt
+  // or decrypt the data associated with the workflow.
+  //
+  // Format:
+  // projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}
+  string crypto_key_version = 18 [
+    (google.api.field_behavior) = OUTPUT_ONLY,
+    (google.api.resource_reference) = {
+      type: "cloudkms.googleapis.com/CryptoKeyVersion"
+    }
+  ];
+
+  // Optional. Input only. Immutable. Tags associated with this workflow.
+  map<string, string> tags = 19 [
+    (google.api.field_behavior) = INPUT_ONLY,
+    (google.api.field_behavior) = IMMUTABLE,
+    (google.api.field_behavior) = OPTIONAL
+  ];
 }
 
 // Request for the
@@ -293,6 +351,16 @@ message ListWorkflowsRequest {
   string page_token = 3;
 
   // Filter to restrict results to specific workflows.
+  // For details, see <a href="https://google.aip.dev/160"
+  // class="external">AIP-160</a>.
+  //
+  // For example, if you are using the Google APIs Explorer:
+  //
+  // `state="SUCCEEDED"`
+  //
+  // or
+  //
+  // `createTime>"2023-08-01" AND state="FAILED"`
   string filter = 4;
 
   // Comma-separated list of fields that specify the order of the results.
@@ -407,3 +475,50 @@ message OperationMetadata {
   // API version used to start the operation.
   string api_version = 5;
 }
+
+// Request for the
+// [ListWorkflowRevisions][google.cloud.workflows.v1.Workflows.ListWorkflowRevisions]
+// method.
+message ListWorkflowRevisionsRequest {
+  // Required. Workflow for which the revisions should be listed.
+  // Format: projects/{project}/locations/{location}/workflows/{workflow}
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "workflows.googleapis.com/Workflow"
+    }
+  ];
+
+  // The maximum number of revisions to return per page. If a value is not
+  // specified, a default value of 20 is used. The maximum permitted value is
+  // 100. Values greater than 100 are coerced down to 100.
+  int32 page_size = 2;
+
+  // The page token, received from a previous ListWorkflowRevisions call.
+  // Provide this to retrieve the subsequent page.
+  string page_token = 3;
+}
+
+// Response for the
+// [ListWorkflowRevisions][google.cloud.workflows.v1.Workflows.ListWorkflowRevisions]
+// method.
+message ListWorkflowRevisionsResponse {
+  // The revisions of the workflow, ordered in reverse chronological order.
+  repeated Workflow workflows = 1;
+
+  // A token, which can be sent as `page_token` to retrieve the next page.
+  // If this field is omitted, there are no subsequent pages.
+  string next_page_token = 2;
+}
+
+// Define possible options for enabling the execution history level.
+enum ExecutionHistoryLevel {
+  // The default/unset value.
+  EXECUTION_HISTORY_LEVEL_UNSPECIFIED = 0;
+
+  // Enable execution history basic feature.
+  EXECUTION_HISTORY_BASIC = 1;
+
+  // Enable execution history detailed feature.
+  EXECUTION_HISTORY_DETAILED = 2;
+}
diff --git a/google/cloud/workflows/v1/workflows_grpc_service_config.json b/google/cloud/workflows/v1/workflows_grpc_service_config.json
@@ -1,6 +1,7 @@
 {
   "methodConfig": [{
     "name": [
+        { "service": "google.cloud.workflows.v1", "method": "ListWorkflowRevisions"},
         { "service": "google.cloud.workflows.v1", "method": "ListWorkflows"},
         { "service": "google.cloud.workflows.v1", "method": "GetWorkflow"}
     ],
diff --git a/google/cloud/workflows/v1/workflows_v1.yaml b/google/cloud/workflows/v1/workflows_v1.yaml
@@ -22,19 +22,6 @@ documentation:
   - selector: google.cloud.location.Locations.ListLocations
     description: Lists information about the supported locations for this service.
 
-backend:
-  rules:
-  - selector: google.cloud.location.Locations.GetLocation
-    deadline: 60.0
-  - selector: google.cloud.location.Locations.ListLocations
-    deadline: 60.0
-  - selector: 'google.cloud.workflows.v1.Workflows.*'
-    deadline: 60.0
-  - selector: 'google.longrunning.Operations.*'
-    deadline: 60.0
-  - selector: google.longrunning.Operations.GetOperation
-    deadline: 5.0
-
 http:
   rules:
   - selector: google.cloud.location.Locations.GetLocation

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"methodConfig": [{`
`3`	`3`	`"name": [`
	`4`	`+ { "service": "google.cloud.workflows.v1", "method": "ListWorkflowRevisions"},`
`4`	`5`	`{ "service": "google.cloud.workflows.v1", "method": "ListWorkflows"},`
`5`	`6`	`{ "service": "google.cloud.workflows.v1", "method": "GetWorkflow"}`
`6`	`7`	`],`