google-cloud-workflows-v1 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f66bc20bb512ca5e4c6b711a54fae7a6377f44a3daa2eeeedff169a98a4d8bff
-  data.tar.gz: 50f3cf3348839df864ddfc67110eedfbdb942833585462ff7ba27550606b3e34
+  metadata.gz: 0c70c1137560fb087db271c7ce6d52e3353ed18fcbe0a2dbc99e71bb6c55c569
+  data.tar.gz: 041c5358c9b1908c65f1652279742cad48b00fc9cd756f3a7b0bf83034640043
 SHA512:
-  metadata.gz: 8e3dcea39e883f3cbb97ce907c223f7431623f07b6f4e3cd14f2dcb67c7d8c3f4a2136a0587a38935c7b932bf5d623a0d5bd5acb151d211245cd421bce9658e7
-  data.tar.gz: cad3cce620b54cd81fe10666273cfba0932ace9c24bfa5ff7a31dc9953240e39158f955729972a6be87cd97d78d213b8d0557603e96dbdfd6804e3f8d1fad07e
+  metadata.gz: b1577a3bd73ec3669e3efacaa4704d8257651781d4dab1008e4638cd2a7c83aae1c55c4250ac5856a1c06ee2115b92e908f35fbdd864ed748d6c5517047afc61
+  data.tar.gz: 315f76b80c16281fd6e653586d76f5e6e752e1b98e9d40dcdeae8276f6fb5aa45fb1ca13e192cda86d5f8fbcfc1d79c2e7d5b164a8406d5deae52ce36fceb830

data/lib/google/cloud/workflows/v1/bindings_override.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/config"
+
+module Google
+  module Cloud
+    module Workflows
+      ##
+      # @example Loading just the REST part of this package, including all its services, and instantiating a REST client
+      #
+      #     require "google/cloud/workflows/v1/rest"
+      #     client = ::Google::Cloud::Workflows::V1::Workflows::Rest::Client.new
+      #
+      module V1
+        ##
+        # @private
+        # Initialize the mixin bindings configuration
+        #
+        def self.configure
+          @configure ||= begin
+            namespace = ["Google", "Cloud", "Workflows"]
+            parent_config = while namespace.any?
+                              parent_name = namespace.join "::"
+                              parent_const = const_get parent_name
+                              break parent_const.configure if parent_const.respond_to? :configure
+                              namespace.pop
+                            end
+
+            default_config = Configuration.new parent_config
+            default_config.bindings_override["google.cloud.location.Locations.GetLocation"] = [
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/v1/{name}",
+                matches: [
+                  ["name", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
+                ],
+                body: nil
+              )
+            ]
+            default_config.bindings_override["google.cloud.location.Locations.ListLocations"] = [
+
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/v1/{name}/locations",
+                matches: [
+                  ["name", %r{^projects/[^/]+/?$}, false]
+                ],
+                body: nil
+              )
+            ]
+            default_config
+          end
+          yield @configure if block_given?
+          @configure
+        end
+
+        ##
+        # @private
+        # Configuration class for the google.cloud.workflows.v1 package.
+        #
+        # This class contains common configuration for all services
+        # of the google.cloud.workflows.v1 package.
+        #
+        # This configuration is for internal use of the client library classes,
+        # and it is not intended that the end-users will read or change it.
+        #
+        class Configuration
+          extend ::Gapic::Config
+
+          # @private
+          # Overrides for http bindings for the RPC of the mixins for this package.
+          # Services in this package should use these when creating clients for the mixin services.
+          # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
+          config_attr :bindings_override, {}, ::Hash, nil
+
+          # @private
+          def initialize parent_config = nil
+            @parent_config = parent_config unless parent_config.nil?
+
+            yield self if block_given?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/workflows/v1/rest.rb

@@ -17,6 +17,7 @@
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
 require "google/cloud/workflows/v1/workflows/rest"
+require "google/cloud/workflows/v1/bindings_override"
 require "google/cloud/workflows/v1/version"
 
 module Google

data/lib/google/cloud/workflows/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Workflows
       module V1
-        VERSION = "0.4.1"
+        VERSION = "0.5.0"
       end
     end
   end

data/lib/google/cloud/workflows/v1/workflows/client.rb

@@ -18,6 +18,7 @@
 
 require "google/cloud/errors"
 require "google/cloud/workflows/v1/workflows_pb"
+require "google/cloud/location"
 
 module Google
   module Cloud
@@ -141,6 +142,12 @@ module Google
                 config.endpoint = @config.endpoint
               end
 
+              @location_client = Google::Cloud::Location::Locations::Client.new do |config|
+                config.credentials = credentials
+                config.quota_project = @quota_project_id
+                config.endpoint = @config.endpoint
+              end
+
               @workflows_stub = ::Gapic::ServiceStub.new(
                 ::Google::Cloud::Workflows::V1::Workflows::Stub,
                 credentials:  credentials,
@@ -157,10 +164,17 @@ module Google
             #
             attr_reader :operations_client
 
+            ##
+            # Get the associated client for mix-in of the Locations.
+            #
+            # @return [Google::Cloud::Location::Locations::Client]
+            #
+            attr_reader :location_client
+
             # Service calls
 
             ##
-            # Lists Workflows in a given project and location.
+            # Lists workflows in a given project and location.
             # The default order is not specified.
             #
             # @overload list_workflows(request, options = nil)
@@ -182,10 +196,10 @@ module Google
             #     Required. Project and location from which the workflows should be listed.
             #     Format: projects/\\{project}/locations/\\{location}
             #   @param page_size [::Integer]
-            #     Maximum number of workflows to return per call. The service may return
-            #     fewer than this value. If the value is not specified, a default value of
-            #     500 will be used. The maximum permitted value is 1000 and values greater
-            #     than 1000 will be coerced down to 1000.
+            #     Maximum number of workflows to return per call. The service might return
+            #     fewer than this value even if not at the end of the collection. If a value
+            #     is not specified, a default value of 500 is used. The maximum permitted
+            #     value is 1000 and values greater than 1000 are coerced down to 1000.
             #   @param page_token [::String]
             #     A page token, received from a previous `ListWorkflows` call.
             #     Provide this to retrieve the subsequent page.
@@ -195,10 +209,10 @@ module Google
             #   @param filter [::String]
             #     Filter to restrict results to specific workflows.
             #   @param order_by [::String]
-            #     Comma-separated list of fields that that specify the order of the results.
+            #     Comma-separated list of fields that specify the order of the results.
             #     Default sorting order for a field is ascending. To specify descending order
-            #     for a field, append a " desc" suffix.
-            #     If not specified, the results will be returned in an unspecified order.
+            #     for a field, append a "desc" suffix.
+            #     If not specified, the results are returned in an unspecified order.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Workflows::V1::Workflow>]
@@ -270,7 +284,7 @@ module Google
             end
 
             ##
-            # Gets details of a single Workflow.
+            # Gets details of a single workflow.
             #
             # @overload get_workflow(request, options = nil)
             #   Pass arguments to `get_workflow` via a request object, either of type
@@ -282,14 +296,20 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload get_workflow(name: nil)
+            # @overload get_workflow(name: nil, revision_id: nil)
             #   Pass arguments to `get_workflow` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. Name of the workflow which information should be retrieved.
+            #     Required. Name of the workflow for which information should be retrieved.
             #     Format: projects/\\{project}/locations/\\{location}/workflows/\\{workflow}
+            #   @param revision_id [::String]
+            #     Optional. The revision of the workflow to retrieve. If the revision_id is
+            #     empty, the latest revision is retrieved.
+            #     The format is "000001-a4d", where the first six characters define
+            #     the zero-padded decimal revision number. They are followed by a hyphen and
+            #     three hexadecimal characters.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Workflows::V1::Workflow]
@@ -358,7 +378,7 @@ module Google
             ##
             # Creates a new workflow. If a workflow with the specified name already
             # exists in the specified project and location, the long running operation
-            # will return [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.
+            # returns a [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.
             #
             # @overload create_workflow(request, options = nil)
             #   Pass arguments to `create_workflow` via a request object, either of type
@@ -561,8 +581,8 @@ module Google
             ##
             # Updates an existing workflow.
             # Running this method has no impact on already running executions of the
-            # workflow. A new revision of the workflow may be created as a result of a
-            # successful update operation. In that case, such revision will be used
+            # workflow. A new revision of the workflow might be created as a result of a
+            # successful update operation. In that case, the new revision is used
             # in new workflow executions.
             #
             # @overload update_workflow(request, options = nil)

data/lib/google/cloud/workflows/v1/workflows/paths.rb

@@ -24,6 +24,27 @@ module Google
         module Workflows
           # Path helper methods for the Workflows API.
           module Paths
+            ##
+            # Create a fully-qualified CryptoKey resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param key_ring [String]
+            # @param crypto_key [String]
+            #
+            # @return [::String]
+            def crypto_key_path project:, location:, key_ring:, crypto_key:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+              raise ::ArgumentError, "key_ring cannot contain /" if key_ring.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/keyRings/#{key_ring}/cryptoKeys/#{crypto_key}"
+            end
+
             ##
             # Create a fully-qualified Location resource string.
             #

data/lib/google/cloud/workflows/v1/workflows/rest/client.rb

@@ -19,6 +19,7 @@
 require "google/cloud/errors"
 require "google/cloud/workflows/v1/workflows_pb"
 require "google/cloud/workflows/v1/workflows/rest/service_stub"
+require "google/cloud/location/rest"
 
 module Google
   module Cloud
@@ -138,6 +139,13 @@ module Google
                   config.endpoint = @config.endpoint
                 end
 
+                @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
+                  config.credentials = credentials
+                  config.quota_project = @quota_project_id
+                  config.endpoint = @config.endpoint
+                  config.bindings_override = @config.bindings_override
+                end
+
                 @workflows_stub = ::Google::Cloud::Workflows::V1::Workflows::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
               end
 
@@ -148,10 +156,17 @@ module Google
               #
               attr_reader :operations_client
 
+              ##
+              # Get the associated client for mix-in of the Locations.
+              #
+              # @return [Google::Cloud::Location::Locations::Rest::Client]
+              #
+              attr_reader :location_client
+
               # Service calls
 
               ##
-              # Lists Workflows in a given project and location.
+              # Lists workflows in a given project and location.
               # The default order is not specified.
               #
               # @overload list_workflows(request, options = nil)
@@ -173,10 +188,10 @@ module Google
               #     Required. Project and location from which the workflows should be listed.
               #     Format: projects/\\{project}/locations/\\{location}
               #   @param page_size [::Integer]
-              #     Maximum number of workflows to return per call. The service may return
-              #     fewer than this value. If the value is not specified, a default value of
-              #     500 will be used. The maximum permitted value is 1000 and values greater
-              #     than 1000 will be coerced down to 1000.
+              #     Maximum number of workflows to return per call. The service might return
+              #     fewer than this value even if not at the end of the collection. If a value
+              #     is not specified, a default value of 500 is used. The maximum permitted
+              #     value is 1000 and values greater than 1000 are coerced down to 1000.
               #   @param page_token [::String]
               #     A page token, received from a previous `ListWorkflows` call.
               #     Provide this to retrieve the subsequent page.
@@ -186,10 +201,10 @@ module Google
               #   @param filter [::String]
               #     Filter to restrict results to specific workflows.
               #   @param order_by [::String]
-              #     Comma-separated list of fields that that specify the order of the results.
+              #     Comma-separated list of fields that specify the order of the results.
               #     Default sorting order for a field is ascending. To specify descending order
-              #     for a field, append a " desc" suffix.
-              #     If not specified, the results will be returned in an unspecified order.
+              #     for a field, append a "desc" suffix.
+              #     If not specified, the results are returned in an unspecified order.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::Workflows::V1::ListWorkflowsResponse]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -233,7 +248,7 @@ module Google
               end
 
               ##
-              # Gets details of a single Workflow.
+              # Gets details of a single workflow.
               #
               # @overload get_workflow(request, options = nil)
               #   Pass arguments to `get_workflow` via a request object, either of type
@@ -245,14 +260,20 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload get_workflow(name: nil)
+              # @overload get_workflow(name: nil, revision_id: nil)
               #   Pass arguments to `get_workflow` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param name [::String]
-              #     Required. Name of the workflow which information should be retrieved.
+              #     Required. Name of the workflow for which information should be retrieved.
               #     Format: projects/\\{project}/locations/\\{location}/workflows/\\{workflow}
+              #   @param revision_id [::String]
+              #     Optional. The revision of the workflow to retrieve. If the revision_id is
+              #     empty, the latest revision is retrieved.
+              #     The format is "000001-a4d", where the first six characters define
+              #     the zero-padded decimal revision number. They are followed by a hyphen and
+              #     three hexadecimal characters.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::Workflows::V1::Workflow]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -298,7 +319,7 @@ module Google
               ##
               # Creates a new workflow. If a workflow with the specified name already
               # exists in the specified project and location, the long running operation
-              # will return [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.
+              # returns a [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.
               #
               # @overload create_workflow(request, options = nil)
               #   Pass arguments to `create_workflow` via a request object, either of type
@@ -441,8 +462,8 @@ module Google
               ##
               # Updates an existing workflow.
               # Running this method has no impact on already running executions of the
-              # workflow. A new revision of the workflow may be created as a result of a
-              # successful update operation. In that case, such revision will be used
+              # workflow. A new revision of the workflow might be created as a result of a
+              # successful update operation. In that case, the new revision is used
               # in new workflow executions.
               #
               # @overload update_workflow(request, options = nil)
@@ -596,6 +617,13 @@ module Google
                 config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
                 config_attr :quota_project, nil, ::String, nil
 
+                # @private
+                # Overrides for http bindings for the RPCs of this service
+                # are only used when this service is used as mixin, and only
+                # by the host service.
+                # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
+                config_attr :bindings_override, {}, ::Hash, nil
+
                 # @private
                 def initialize parent_config = nil
                   @parent_config = parent_config unless parent_config.nil?

data/lib/google/cloud/workflows/v1/workflows/rest.rb

@@ -21,6 +21,7 @@ require "gapic/config"
 require "gapic/config/method"
 
 require "google/cloud/workflows/v1/version"
+require "google/cloud/workflows/v1/bindings_override"
 
 require "google/cloud/workflows/v1/workflows/credentials"
 require "google/cloud/workflows/v1/workflows/paths"

data/lib/google/cloud/workflows/v1/workflows_pb.rb

@@ -9,11 +9,12 @@ require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/longrunning/operations_pb'
+require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
 
 
-descriptor_data = "\n)google/cloud/workflows/v1/workflows.proto\x12\x19google.cloud.workflows.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a#google/longrunning/operations.proto\x1a google/protobuf/field_mask.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xf6\x04\n\x08Workflow\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x02 \x01(\t\x12=\n\x05state\x18\x03 \x01(\x0e\x32).google.cloud.workflows.v1.Workflow.StateB\x03\xe0\x41\x03\x12\x18\n\x0brevision_id\x18\x04 \x01(\tB\x03\xe0\x41\x03\x12\x34\n\x0b\x63reate_time\x18\x05 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x34\n\x0bupdate_time\x18\x06 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12=\n\x14revision_create_time\x18\x07 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12?\n\x06labels\x18\x08 \x03(\x0b\x32/.google.cloud.workflows.v1.Workflow.LabelsEntry\x12\x17\n\x0fservice_account\x18\t \x01(\t\x12\x19\n\x0fsource_contents\x18\n \x01(\tH\x00\x1a-\n\x0bLabelsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"*\n\x05State\x12\x15\n\x11STATE_UNSPECIFIED\x10\x00\x12\n\n\x06\x41\x43TIVE\x10\x01:d\xea\x41\x61\n!workflows.googleapis.com/Workflow\x12<projects/{project}/locations/{location}/workflows/{workflow}B\r\n\x0bsource_code\"\x9a\x01\n\x14ListWorkflowsRequest\x12\x39\n\x06parent\x18\x01 \x01(\tB)\xe0\x41\x02\xfa\x41#\n!locations.googleapis.com/Location\x12\x11\n\tpage_size\x18\x02 \x01(\x05\x12\x12\n\npage_token\x18\x03 \x01(\t\x12\x0e\n\x06\x66ilter\x18\x04 \x01(\t\x12\x10\n\x08order_by\x18\x05 \x01(\t\"}\n\x15ListWorkflowsResponse\x12\x36\n\tworkflows\x18\x01 \x03(\x0b\x32#.google.cloud.workflows.v1.Workflow\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\x12\x13\n\x0bunreachable\x18\x03 \x03(\t\"M\n\x12GetWorkflowRequest\x12\x37\n\x04name\x18\x01 \x01(\tB)\xe0\x41\x02\xfa\x41#\n!workflows.googleapis.com/Workflow\"\xa8\x01\n\x15\x43reateWorkflowRequest\x12\x39\n\x06parent\x18\x01 \x01(\tB)\xe0\x41\x02\xfa\x41#\n!locations.googleapis.com/Location\x12:\n\x08workflow\x18\x02 \x01(\x0b\x32#.google.cloud.workflows.v1.WorkflowB\x03\xe0\x41\x02\x12\x18\n\x0bworkflow_id\x18\x03 \x01(\tB\x03\xe0\x41\x02\"P\n\x15\x44\x65leteWorkflowRequest\x12\x37\n\x04name\x18\x01 \x01(\tB)\xe0\x41\x02\xfa\x41#\n!workflows.googleapis.com/Workflow\"\x84\x01\n\x15UpdateWorkflowRequest\x12:\n\x08workflow\x18\x01 \x01(\x0b\x32#.google.cloud.workflows.v1.WorkflowB\x03\xe0\x41\x02\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask\"\xa5\x01\n\x11OperationMetadata\x12/\n\x0b\x63reate_time\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12,\n\x08\x65nd_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x0e\n\x06target\x18\x03 \x01(\t\x12\x0c\n\x04verb\x18\x04 \x01(\t\x12\x13\n\x0b\x61pi_version\x18\x05 \x01(\t2\xc7\x08\n\tWorkflows\x12\xb2\x01\n\rListWorkflows\x12/.google.cloud.workflows.v1.ListWorkflowsRequest\x1a\x30.google.cloud.workflows.v1.ListWorkflowsResponse\">\x82\xd3\xe4\x93\x02/\x12-/v1/{parent=projects/*/locations/*}/workflows\xda\x41\x06parent\x12\x9f\x01\n\x0bGetWorkflow\x12-.google.cloud.workflows.v1.GetWorkflowRequest\x1a#.google.cloud.workflows.v1.Workflow\"<\x82\xd3\xe4\x93\x02/\x12-/v1/{name=projects/*/locations/*/workflows/*}\xda\x41\x04name\x12\xe0\x01\n\x0e\x43reateWorkflow\x12\x30.google.cloud.workflows.v1.CreateWorkflowRequest\x1a\x1d.google.longrunning.Operation\"}\x82\xd3\xe4\x93\x02\x39\"-/v1/{parent=projects/*/locations/*}/workflows:\x08workflow\xda\x41\x1bparent,workflow,workflow_id\xca\x41\x1d\n\x08Workflow\x12\x11OperationMetadata\x12\xcc\x01\n\x0e\x44\x65leteWorkflow\x12\x30.google.cloud.workflows.v1.DeleteWorkflowRequest\x1a\x1d.google.longrunning.Operation\"i\x82\xd3\xe4\x93\x02/*-/v1/{name=projects/*/locations/*/workflows/*}\xda\x41\x04name\xca\x41*\n\x15google.protobuf.Empty\x12\x11OperationMetadata\x12\xe2\x01\n\x0eUpdateWorkflow\x12\x30.google.cloud.workflows.v1.UpdateWorkflowRequest\x1a\x1d.google.longrunning.Operation\"\x7f\x82\xd3\xe4\x93\x02\x42\x32\x36/v1/{workflow.name=projects/*/locations/*/workflows/*}:\x08workflow\xda\x41\x14workflow,update_mask\xca\x41\x1d\n\x08Workflow\x12\x11OperationMetadata\x1aL\xca\x41\x18workflows.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformBn\n\x1d\x63om.google.cloud.workflows.v1B\x0eWorkflowsProtoP\x01Z;cloud.google.com/go/workflows/apiv1/workflowspb;workflowspbb\x06proto3"
+descriptor_data = "\n)google/cloud/workflows/v1/workflows.proto\x12\x19google.cloud.workflows.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a#google/longrunning/operations.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xe0\t\n\x08Workflow\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x02 \x01(\t\x12=\n\x05state\x18\x03 \x01(\x0e\x32).google.cloud.workflows.v1.Workflow.StateB\x03\xe0\x41\x03\x12\x18\n\x0brevision_id\x18\x04 \x01(\tB\x03\xe0\x41\x03\x12\x34\n\x0b\x63reate_time\x18\x05 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x34\n\x0bupdate_time\x18\x06 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12=\n\x14revision_create_time\x18\x07 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12?\n\x06labels\x18\x08 \x03(\x0b\x32/.google.cloud.workflows.v1.Workflow.LabelsEntry\x12\x17\n\x0fservice_account\x18\t \x01(\t\x12\x19\n\x0fsource_contents\x18\n \x01(\tH\x00\x12\x42\n\x0f\x63rypto_key_name\x18\x0b \x01(\tB)\xe0\x41\x01\xfa\x41#\n!cloudkms.googleapis.com/CryptoKey\x12H\n\x0bstate_error\x18\x0c \x01(\x0b\x32..google.cloud.workflows.v1.Workflow.StateErrorB\x03\xe0\x41\x03\x12M\n\x0e\x63\x61ll_log_level\x18\r \x01(\x0e\x32\x30.google.cloud.workflows.v1.Workflow.CallLogLevelB\x03\xe0\x41\x01\x12P\n\ruser_env_vars\x18\x0e \x03(\x0b\x32\x34.google.cloud.workflows.v1.Workflow.UserEnvVarsEntryB\x03\xe0\x41\x01\x1a\x8d\x01\n\nStateError\x12\x0f\n\x07\x64\x65tails\x18\x01 \x01(\t\x12\x41\n\x04type\x18\x02 \x01(\x0e\x32\x33.google.cloud.workflows.v1.Workflow.StateError.Type\"+\n\x04Type\x12\x14\n\x10TYPE_UNSPECIFIED\x10\x00\x12\r\n\tKMS_ERROR\x10\x01\x1a-\n\x0bLabelsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\x1a\x32\n\x10UserEnvVarsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\";\n\x05State\x12\x15\n\x11STATE_UNSPECIFIED\x10\x00\x12\n\n\x06\x41\x43TIVE\x10\x01\x12\x0f\n\x0bUNAVAILABLE\x10\x02\"d\n\x0c\x43\x61llLogLevel\x12\x1e\n\x1a\x43\x41LL_LOG_LEVEL_UNSPECIFIED\x10\x00\x12\x11\n\rLOG_ALL_CALLS\x10\x01\x12\x13\n\x0fLOG_ERRORS_ONLY\x10\x02\x12\x0c\n\x08LOG_NONE\x10\x03:d\xea\x41\x61\n!workflows.googleapis.com/Workflow\x12<projects/{project}/locations/{location}/workflows/{workflow}B\r\n\x0bsource_code\"\x9a\x01\n\x14ListWorkflowsRequest\x12\x39\n\x06parent\x18\x01 \x01(\tB)\xe0\x41\x02\xfa\x41#\n!locations.googleapis.com/Location\x12\x11\n\tpage_size\x18\x02 \x01(\x05\x12\x12\n\npage_token\x18\x03 \x01(\t\x12\x0e\n\x06\x66ilter\x18\x04 \x01(\t\x12\x10\n\x08order_by\x18\x05 \x01(\t\"}\n\x15ListWorkflowsResponse\x12\x36\n\tworkflows\x18\x01 \x03(\x0b\x32#.google.cloud.workflows.v1.Workflow\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\x12\x13\n\x0bunreachable\x18\x03 \x03(\t\"g\n\x12GetWorkflowRequest\x12\x37\n\x04name\x18\x01 \x01(\tB)\xe0\x41\x02\xfa\x41#\n!workflows.googleapis.com/Workflow\x12\x18\n\x0brevision_id\x18\x02 \x01(\tB\x03\xe0\x41\x01\"\xa8\x01\n\x15\x43reateWorkflowRequest\x12\x39\n\x06parent\x18\x01 \x01(\tB)\xe0\x41\x02\xfa\x41#\n!locations.googleapis.com/Location\x12:\n\x08workflow\x18\x02 \x01(\x0b\x32#.google.cloud.workflows.v1.WorkflowB\x03\xe0\x41\x02\x12\x18\n\x0bworkflow_id\x18\x03 \x01(\tB\x03\xe0\x41\x02\"P\n\x15\x44\x65leteWorkflowRequest\x12\x37\n\x04name\x18\x01 \x01(\tB)\xe0\x41\x02\xfa\x41#\n!workflows.googleapis.com/Workflow\"\x84\x01\n\x15UpdateWorkflowRequest\x12:\n\x08workflow\x18\x01 \x01(\x0b\x32#.google.cloud.workflows.v1.WorkflowB\x03\xe0\x41\x02\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask\"\xa5\x01\n\x11OperationMetadata\x12/\n\x0b\x63reate_time\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12,\n\x08\x65nd_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x0e\n\x06target\x18\x03 \x01(\t\x12\x0c\n\x04verb\x18\x04 \x01(\t\x12\x13\n\x0b\x61pi_version\x18\x05 \x01(\t2\xc7\x08\n\tWorkflows\x12\xb2\x01\n\rListWorkflows\x12/.google.cloud.workflows.v1.ListWorkflowsRequest\x1a\x30.google.cloud.workflows.v1.ListWorkflowsResponse\">\x82\xd3\xe4\x93\x02/\x12-/v1/{parent=projects/*/locations/*}/workflows\xda\x41\x06parent\x12\x9f\x01\n\x0bGetWorkflow\x12-.google.cloud.workflows.v1.GetWorkflowRequest\x1a#.google.cloud.workflows.v1.Workflow\"<\x82\xd3\xe4\x93\x02/\x12-/v1/{name=projects/*/locations/*/workflows/*}\xda\x41\x04name\x12\xe0\x01\n\x0e\x43reateWorkflow\x12\x30.google.cloud.workflows.v1.CreateWorkflowRequest\x1a\x1d.google.longrunning.Operation\"}\x82\xd3\xe4\x93\x02\x39\"-/v1/{parent=projects/*/locations/*}/workflows:\x08workflow\xda\x41\x1bparent,workflow,workflow_id\xca\x41\x1d\n\x08Workflow\x12\x11OperationMetadata\x12\xcc\x01\n\x0e\x44\x65leteWorkflow\x12\x30.google.cloud.workflows.v1.DeleteWorkflowRequest\x1a\x1d.google.longrunning.Operation\"i\x82\xd3\xe4\x93\x02/*-/v1/{name=projects/*/locations/*/workflows/*}\xda\x41\x04name\xca\x41*\n\x15google.protobuf.Empty\x12\x11OperationMetadata\x12\xe2\x01\n\x0eUpdateWorkflow\x12\x30.google.cloud.workflows.v1.UpdateWorkflowRequest\x1a\x1d.google.longrunning.Operation\"\x7f\x82\xd3\xe4\x93\x02\x42\x32\x36/v1/{workflow.name=projects/*/locations/*/workflows/*}:\x08workflow\xda\x41\x14workflow,update_mask\xca\x41\x1d\n\x08Workflow\x12\x11OperationMetadata\x1aL\xca\x41\x18workflows.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\xe7\x01\n\x1d\x63om.google.cloud.workflows.v1B\x0eWorkflowsProtoP\x01Z;cloud.google.com/go/workflows/apiv1/workflowspb;workflowspb\xea\x41v\n!cloudkms.googleapis.com/CryptoKey\x12Qprojects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}b\x06proto3"
 
 pool = Google::Protobuf::DescriptorPool.generated_pool
 
@@ -46,7 +47,10 @@ module Google
     module Workflows
       module V1
         Workflow = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.v1.Workflow").msgclass
+        Workflow::StateError = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.v1.Workflow.StateError").msgclass
+        Workflow::StateError::Type = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.v1.Workflow.StateError.Type").enummodule
         Workflow::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.v1.Workflow.State").enummodule
+        Workflow::CallLogLevel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.v1.Workflow.CallLogLevel").enummodule
         ListWorkflowsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.v1.ListWorkflowsRequest").msgclass
         ListWorkflowsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.v1.ListWorkflowsResponse").msgclass
         GetWorkflowRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.workflows.v1.GetWorkflowRequest").msgclass

data/lib/google/cloud/workflows/v1/workflows_services_pb.rb

@@ -35,14 +35,14 @@ module Google
             self.unmarshal_class_method = :decode
             self.service_name = 'google.cloud.workflows.v1.Workflows'
 
-            # Lists Workflows in a given project and location.
+            # Lists workflows in a given project and location.
             # The default order is not specified.
             rpc :ListWorkflows, ::Google::Cloud::Workflows::V1::ListWorkflowsRequest, ::Google::Cloud::Workflows::V1::ListWorkflowsResponse
-            # Gets details of a single Workflow.
+            # Gets details of a single workflow.
             rpc :GetWorkflow, ::Google::Cloud::Workflows::V1::GetWorkflowRequest, ::Google::Cloud::Workflows::V1::Workflow
             # Creates a new workflow. If a workflow with the specified name already
             # exists in the specified project and location, the long running operation
-            # will return [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.
+            # returns a [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.
             rpc :CreateWorkflow, ::Google::Cloud::Workflows::V1::CreateWorkflowRequest, ::Google::Longrunning::Operation
             # Deletes a workflow with the specified name.
             # This method also cancels and deletes all running executions of the
@@ -50,8 +50,8 @@ module Google
             rpc :DeleteWorkflow, ::Google::Cloud::Workflows::V1::DeleteWorkflowRequest, ::Google::Longrunning::Operation
             # Updates an existing workflow.
             # Running this method has no impact on already running executions of the
-            # workflow. A new revision of the workflow may be created as a result of a
-            # successful update operation. In that case, such revision will be used
+            # workflow. A new revision of the workflow might be created as a result of a
+            # successful update operation. In that case, the new revision is used
             # in new workflow executions.
             rpc :UpdateWorkflow, ::Google::Cloud::Workflows::V1::UpdateWorkflowRequest, ::Google::Longrunning::Operation
           end

data/proto_docs/google/cloud/workflows/v1/workflows.rb

@@ -40,27 +40,28 @@ module Google
         #     following properties of a workflow:
         #
         #     - {::Google::Cloud::Workflows::V1::Workflow#service_account Service account}
-        #     - {::Google::Cloud::Workflows::V1::Workflow#source_contents Workflow code to be executed}
+        #     - [Workflow code to be
+        #     executed][google.cloud.workflows.v1.Workflow.source_contents]
         #
-        #     The format is "000001-a4d", where the first 6 characters define
+        #     The format is "000001-a4d", where the first six characters define
         #     the zero-padded revision ordinal number. They are followed by a hyphen and
-        #     3 hexadecimal random characters.
+        #     three hexadecimal random characters.
         # @!attribute [r] create_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. The timestamp of when the workflow was created.
+        #     Output only. The timestamp for when the workflow was created.
         # @!attribute [r] update_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. The last update timestamp of the workflow.
+        #     Output only. The timestamp for when the workflow was last updated.
         # @!attribute [r] revision_create_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. The timestamp that the latest revision of the workflow
-        #     was created.
+        #     Output only. The timestamp for the latest revision of the workflow's
+        #     creation.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     Labels associated with this workflow.
         #     Labels can contain at most 64 entries. Keys and values can be no longer
         #     than 63 characters and can only contain lowercase letters, numeric
-        #     characters, underscores and dashes. Label keys must start with a letter.
+        #     characters, underscores, and dashes. Label keys must start with a letter.
         #     International characters are allowed.
         # @!attribute [rw] service_account
         #   @return [::String]
@@ -79,10 +80,61 @@ module Google
         # @!attribute [rw] source_contents
         #   @return [::String]
         #     Workflow code to be executed. The size limit is 128KB.
+        # @!attribute [rw] crypto_key_name
+        #   @return [::String]
+        #     Optional. The resource name of a KMS crypto key used to encrypt or decrypt
+        #     the data associated with the workflow.
+        #
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
+        #
+        #     Using `-` as a wildcard for the `{project}` or not providing one at all
+        #     will infer the project from the account.
+        #
+        #     If not provided, data associated with the workflow will not be
+        #     CMEK-encrypted.
+        # @!attribute [r] state_error
+        #   @return [::Google::Cloud::Workflows::V1::Workflow::StateError]
+        #     Output only. Error regarding the state of the workflow. For example, this
+        #     field will have error details if the execution data is unavailable due to
+        #     revoked KMS key permissions.
+        # @!attribute [rw] call_log_level
+        #   @return [::Google::Cloud::Workflows::V1::Workflow::CallLogLevel]
+        #     Optional. Describes the level of platform logging to apply to calls and
+        #     call responses during executions of this workflow. If both the workflow and
+        #     the execution specify a logging level, the execution level takes
+        #     precedence.
+        # @!attribute [rw] user_env_vars
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     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".
         class Workflow
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
+          # Describes an error related to the current state of the workflow.
+          # @!attribute [rw] details
+          #   @return [::String]
+          #     Provides specifics about the error.
+          # @!attribute [rw] type
+          #   @return [::Google::Cloud::Workflows::V1::Workflow::StateError::Type]
+          #     The type of this state error.
+          class StateError
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Describes the possibled types of a state error.
+            module Type
+              # No type specified.
+              TYPE_UNSPECIFIED = 0
+
+              # Caused by an issue with KMS.
+              KMS_ERROR = 1
+            end
+          end
+
           # @!attribute [rw] key
           #   @return [::String]
           # @!attribute [rw] value
@@ -92,14 +144,42 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
-          # Describes the current state of workflow deployment. More states may be
-          # added in the future.
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class UserEnvVarsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Describes the current state of workflow deployment.
           module State
             # Invalid state.
             STATE_UNSPECIFIED = 0
 
             # The workflow has been deployed successfully and is serving.
             ACTIVE = 1
+
+            # Workflow data is unavailable. See the `state_error` field.
+            UNAVAILABLE = 2
+          end
+
+          # Describes the level of platform logging to apply to calls and call
+          # responses during workflow executions.
+          module CallLogLevel
+            # No call logging level specified.
+            CALL_LOG_LEVEL_UNSPECIFIED = 0
+
+            # Log all call steps within workflows, all call returns, and all exceptions
+            # raised.
+            LOG_ALL_CALLS = 1
+
+            # Log only exceptions that are raised from call steps within workflows.
+            LOG_ERRORS_ONLY = 2
+
+            # Explicitly log nothing.
+            LOG_NONE = 3
           end
         end
 
@@ -112,10 +192,10 @@ module Google
         #     Format: projects/\\{project}/locations/\\{location}
         # @!attribute [rw] page_size
         #   @return [::Integer]
-        #     Maximum number of workflows to return per call. The service may return
-        #     fewer than this value. If the value is not specified, a default value of
-        #     500 will be used. The maximum permitted value is 1000 and values greater
-        #     than 1000 will be coerced down to 1000.
+        #     Maximum number of workflows to return per call. The service might return
+        #     fewer than this value even if not at the end of the collection. If a value
+        #     is not specified, a default value of 500 is used. The maximum permitted
+        #     value is 1000 and values greater than 1000 are coerced down to 1000.
         # @!attribute [rw] page_token
         #   @return [::String]
         #     A page token, received from a previous `ListWorkflows` call.
@@ -128,10 +208,10 @@ module Google
         #     Filter to restrict results to specific workflows.
         # @!attribute [rw] order_by
         #   @return [::String]
-        #     Comma-separated list of fields that that specify the order of the results.
+        #     Comma-separated list of fields that specify the order of the results.
         #     Default sorting order for a field is ascending. To specify descending order
-        #     for a field, append a " desc" suffix.
-        #     If not specified, the results will be returned in an unspecified order.
+        #     for a field, append a "desc" suffix.
+        #     If not specified, the results are returned in an unspecified order.
         class ListWorkflowsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -142,7 +222,7 @@ module Google
         # method.
         # @!attribute [rw] workflows
         #   @return [::Array<::Google::Cloud::Workflows::V1::Workflow>]
-        #     The workflows which match the request.
+        #     The workflows that match the request.
         # @!attribute [rw] next_page_token
         #   @return [::String]
         #     A token, which can be sent as `page_token` to retrieve the next page.
@@ -159,8 +239,15 @@ module Google
         # {::Google::Cloud::Workflows::V1::Workflows::Client#get_workflow GetWorkflow} method.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. Name of the workflow which information should be retrieved.
+        #     Required. Name of the workflow for which information should be retrieved.
         #     Format: projects/\\{project}/locations/\\{location}/workflows/\\{workflow}
+        # @!attribute [rw] revision_id
+        #   @return [::String]
+        #     Optional. The revision of the workflow to retrieve. If the revision_id is
+        #     empty, the latest revision is retrieved.
+        #     The format is "000001-a4d", where the first six characters define
+        #     the zero-padded decimal revision number. They are followed by a hyphen and
+        #     three hexadecimal characters.
         class GetWorkflowRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-workflows-v1
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-06 00:00:00.000000000 Z
+date: 2023-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -44,6 +44,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-location
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
@@ -174,6 +194,7 @@ files:
 - README.md
 - lib/google-cloud-workflows-v1.rb
 - lib/google/cloud/workflows/v1.rb
+- lib/google/cloud/workflows/v1/bindings_override.rb
 - lib/google/cloud/workflows/v1/rest.rb
 - lib/google/cloud/workflows/v1/version.rb
 - lib/google/cloud/workflows/v1/workflows.rb