google-apis-workflowexecutions_v1 0.25.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d79f44fefc117ab0411e25a926c77b89db273192e8ebe274adeee3d59ea8f62e
-  data.tar.gz: bdefd0742be3bb5280d52d042c79fd6a2964fb887efdbed36f961ea55963e79c
+  metadata.gz: 1d140cc0f9a69f2a9730b20d55c27e70c90468e11fb689304e25f925b52dfcb7
+  data.tar.gz: 0cbdd954311552e80743983a63baa6b9340fea5090a3b9262f9d1c3803b48302
 SHA512:
-  metadata.gz: dd661a06f574aa5160a991a9f48eb3e976d2f7d006c490f1996254c72b80dc3327211aa9841009a452934b7dcc2e72d4653de2a9a041a295667b3fb13be32773
-  data.tar.gz: 5eda431713ea0d929acc3a67b3bc03bc0855f6f985034519dde2d2bcbc540ef1f5f28c2ab81f4803ee1ef3119bb82201d00d9415b509f638cddf2a802c21a2a1
+  metadata.gz: eb6074a4ab7db975e80ee8bdd091db0dcea456490001f56813c7f58b37e8a9c412aaa36582cbd031576e127af9c22074a24bba2a1d86638d0e540e86b4003635
+  data.tar.gz: d63d50ba4d1ac0ff75540e23eadf2bd8cb0660865ced528e44d58790fac5e9a1e317811a81e20530558a0f592e4e9920212b814e764c3dee9d179af28f6b1963

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-workflowexecutions_v1
 
+### v0.27.0 (2023-09-10)
+
+* Regenerated from discovery document revision 20230829
+
+### v0.26.0 (2023-07-16)
+
+* Regenerated from discovery document revision 20230710
+
 ### v0.25.0 (2023-06-18)
 
 * Regenerated from discovery document revision 20230607

data/lib/google/apis/workflowexecutions_v1/classes.rb

@@ -22,6 +22,46 @@ module Google
   module Apis
     module WorkflowexecutionsV1
       
+      # An instance of a Callback created by an execution.
+      class Callback
+        include Google::Apis::Core::Hashable
+      
+        # Output only. The payloads received by the callback that have not been
+        # processed by a waiting execution step.
+        # Corresponds to the JSON property `availablePayloads`
+        # @return [Array<String>]
+        attr_accessor :available_payloads
+      
+        # Output only. The method accepted by the callback. E.g. GET, POST, PUT.
+        # Corresponds to the JSON property `method`
+        # @return [String]
+        attr_accessor :method_prop
+      
+        # Output only. The resource name of the callback. Format: projects/`project`/
+        # locations/`location`/workflows/`workflow`/executions/`execution`/callback/`
+        # callback`
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Output only. Number of execution steps waiting on this callback.
+        # Corresponds to the JSON property `waiters`
+        # @return [Fixnum]
+        attr_accessor :waiters
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @available_payloads = args[:available_payloads] if args.key?(:available_payloads)
+          @method_prop = args[:method_prop] if args.key?(:method_prop)
+          @name = args[:name] if args.key?(:name)
+          @waiters = args[:waiters] if args.key?(:waiters)
+        end
+      end
+      
       # Request for the CancelExecution method.
       class CancelExecutionRequest
         include Google::Apis::Core::Hashable
@@ -168,6 +208,52 @@ module Google
         end
       end
       
+      # Response for the ExportData method.
+      class ExportDataResponse
+        include Google::Apis::Core::Hashable
+      
+        # The JSON string with customer data and metadata of an execution of the given
+        # name
+        # Corresponds to the JSON property `data`
+        # @return [String]
+        attr_accessor :data
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @data = args[:data] if args.key?(:data)
+        end
+      end
+      
+      # RPC response object for the ListCallbacks method.
+      class ListCallbacksResponse
+        include Google::Apis::Core::Hashable
+      
+        # The callbacks which match the request.
+        # Corresponds to the JSON property `callbacks`
+        # @return [Array<Google::Apis::WorkflowexecutionsV1::Callback>]
+        attr_accessor :callbacks
+      
+        # A token, which can be sent as `page_token` to retrieve the next page. If this
+        # field is omitted, there are no subsequent pages.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @callbacks = args[:callbacks] if args.key?(:callbacks)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+        end
+      end
+      
       # Response for the ListExecutions method.
       class ListExecutionsResponse
         include Google::Apis::Core::Hashable
@@ -237,30 +323,31 @@ module Google
       class PubsubMessage
         include Google::Apis::Core::Hashable
       
-        # Attributes for this message. If this field is empty, the message must contain
-        # non-empty data. This can be used to filter messages on the subscription.
+        # Optional. Attributes for this message. If this field is empty, the message
+        # must contain non-empty data. This can be used to filter messages on the
+        # subscription.
         # Corresponds to the JSON property `attributes`
         # @return [Hash<String,String>]
         attr_accessor :attributes
       
-        # The message data field. If this field is empty, the message must contain at
-        # least one attribute.
+        # Optional. The message data field. If this field is empty, the message must
+        # contain at least one attribute.
         # Corresponds to the JSON property `data`
         # NOTE: Values are automatically base64 encoded/decoded in the client library.
         # @return [String]
         attr_accessor :data
       
-        # ID of this message, assigned by the server when the message is published.
-        # Guaranteed to be unique within the topic. This value may be read by a
-        # subscriber that receives a `PubsubMessage` via a `Pull` call or a push
+        # Optional. ID of this message, assigned by the server when the message is
+        # published. Guaranteed to be unique within the topic. This value may be read by
+        # a subscriber that receives a `PubsubMessage` via a `Pull` call or a push
         # delivery. It must not be populated by the publisher in a `Publish` call.
         # Corresponds to the JSON property `messageId`
         # @return [String]
         attr_accessor :message_id
       
-        # If non-empty, identifies related messages for which publish order should be
-        # respected. If a `Subscription` has `enable_message_ordering` set to `true`,
-        # messages published with the same non-empty `ordering_key` value will be
+        # Optional. If non-empty, identifies related messages for which publish order
+        # should be respected. If a `Subscription` has `enable_message_ordering` set to `
+        # true`, messages published with the same non-empty `ordering_key` value will be
         # delivered to subscribers in the order in which they are received by the Pub/
         # Sub system. All `PubsubMessage`s published in a given `PublishRequest` must
         # specify the same `ordering_key` value. For more information, see [ordering
@@ -269,9 +356,9 @@ module Google
         # @return [String]
         attr_accessor :ordering_key
       
-        # The time at which the message was published, populated by the server when it
-        # receives the `Publish` call. It must not be populated by the publisher in a `
-        # Publish` call.
+        # Optional. The time at which the message was published, populated by the server
+        # when it receives the `Publish` call. It must not be populated by the publisher
+        # in a `Publish` call.
         # Corresponds to the JSON property `publishTime`
         # @return [String]
         attr_accessor :publish_time

data/lib/google/apis/workflowexecutions_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module WorkflowexecutionsV1
       # Version of the google-apis-workflowexecutions_v1 gem
-      GEM_VERSION = "0.25.0"
+      GEM_VERSION = "0.27.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230607"
+      REVISION = "20230829"
     end
   end
 end

data/lib/google/apis/workflowexecutions_v1/representations.rb

@@ -22,6 +22,12 @@ module Google
   module Apis
     module WorkflowexecutionsV1
       
+      class Callback
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class CancelExecutionRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -40,6 +46,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ExportDataResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ListCallbacksResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ListExecutionsResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -94,6 +112,16 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Callback
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :available_payloads, as: 'availablePayloads'
+          property :method_prop, as: 'method'
+          property :name, as: 'name'
+          property :waiters, :numeric_string => true, as: 'waiters'
+        end
+      end
+      
       class CancelExecutionRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -132,6 +160,22 @@ module Google
         end
       end
       
+      class ExportDataResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :data, as: 'data'
+        end
+      end
+      
+      class ListCallbacksResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :callbacks, as: 'callbacks', class: Google::Apis::WorkflowexecutionsV1::Callback, decorator: Google::Apis::WorkflowexecutionsV1::Callback::Representation
+      
+          property :next_page_token, as: 'nextPageToken'
+        end
+      end
+      
       class ListExecutionsResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/workflowexecutions_v1/service.rb

@@ -153,6 +153,38 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Returns all metadata stored about an execution, excluding most data that is
+        # already accessible via other API methods.
+        # @param [String] name
+        #   Required. Name of the execution to be data exported. Format: projects/`project`
+        #   /locations/`location`/workflows/`workflow`/executions/`execution`
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::WorkflowexecutionsV1::ExportDataResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::WorkflowexecutionsV1::ExportDataResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def export_project_location_workflow_execution_data(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+name}:exportData', options)
+          command.response_representation = Google::Apis::WorkflowexecutionsV1::ExportDataResponse::Representation
+          command.response_class = Google::Apis::WorkflowexecutionsV1::ExportDataResponse
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Returns an execution of the given name.
         # @param [String] name
         #   Required. Name of the execution to be retrieved. Format: projects/`project`/
@@ -248,6 +280,49 @@ module Google
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
+        
+        # Returns a list of active callbacks which belong to the execution with the
+        # given name. The returned callbacks are ordered by callback ID. first).
+        # @param [String] parent
+        #   Required. Name of the execution for which the callbacks should be listed.
+        #   Format: projects/`project`/locations/`location`/workflows/`workflow`/
+        #   executions/`execution`
+        # @param [Fixnum] page_size
+        #   Maximum number of callbacks to return per call. The default value is 100 and
+        #   is also the maximum value.
+        # @param [String] page_token
+        #   A page token, received from a previous `ListCallbacks` call. Provide this to
+        #   retrieve the subsequent page. Note that pagination is applied to dynamic data.
+        #   The list of callbacks returned can change between page requests if callbacks
+        #   are created or deleted.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::WorkflowexecutionsV1::ListCallbacksResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::WorkflowexecutionsV1::ListCallbacksResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_project_location_workflow_execution_callbacks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+parent}/callbacks', options)
+          command.response_representation = Google::Apis::WorkflowexecutionsV1::ListCallbacksResponse::Representation
+          command.response_class = Google::Apis::WorkflowexecutionsV1::ListCallbacksResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
 
         protected
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-workflowexecutions_v1
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.27.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-18 00:00:00.000000000 Z
+date: 2023-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-workflowexecutions_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-workflowexecutions_v1/v0.25.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-workflowexecutions_v1/v0.27.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-workflowexecutions_v1
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Workflow Executions API V1