google-apis-workflowexecutions_v1 0.28.0 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1def89fcf7428c543ecf9149b5108dce91d116a594d10d31cf0b259c900a7724
-  data.tar.gz: 7e759e41ed9fd00e6405fd6e4236752a4700bee5a3ef3c18f80dc73fc7544d2c
+  metadata.gz: a1b030991a167f8019983a359d2402e6361a960bb3b9e1b9fcb478049504f0ac
+  data.tar.gz: 8596604a5b04f5a26b4dcd98abf34443f256f828dbbee4d2dfd11a6c8d29f122
 SHA512:
-  metadata.gz: 44f45f6be0c2d75580fdae85b85a36c7216fd7ce252d7732b45a6e8a8804c27772934a7c5cc9b7df7c576f8da1b1cca2c8e5dfcc3468cbaace0f729dda1c170d
-  data.tar.gz: 91954160c3a8851a488c178383d025ce6b1a910b686e08479ee821a1be95242405c4b277d1126b7e36c55c1c3caccb8d77b1c547b954ef555bd4703da1091de3
+  metadata.gz: a7c8bfb64f926f98ccdda6d99d46bc4283623d34b90aeda9f157da6e68e6312b3cb148c07e0d25eb2208317dd4b8d643a92f7abcd2b5f8b3c60976e4236d1958
+  data.tar.gz: 58e4e9287fa073bf802e7bcb1bc801613a4e70251b8951599c865e3b5a9dbb7be90b30578457b1e4df85e8030f4ad20adecedba5e1c1bfbb07a5708938b4550c

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-workflowexecutions_v1
 
+### v0.30.0 (2023-12-10)
+
+* Regenerated from discovery document revision 20231128
+
+### v0.29.0 (2023-10-29)
+
+* Regenerated from discovery document revision 20231017
+
 ### v0.28.0 (2023-10-01)
 
 * Regenerated from discovery document revision 20230912

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

@@ -106,6 +106,25 @@ module Google
         end
       end
       
+      # Exception describes why the step entry failed.
+      class Exception
+        include Google::Apis::Core::Hashable
+      
+        # Error message represented as a JSON string.
+        # Corresponds to the JSON property `payload`
+        # @return [String]
+        attr_accessor :payload
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @payload = args[:payload] if args.key?(:payload)
+        end
+      end
+      
       # A running instance of a [Workflow](/workflows/docs/reference/rest/v1/projects.
       # locations.workflows).
       class Execution
@@ -280,6 +299,80 @@ module Google
         end
       end
       
+      # Response message for ExecutionHistory.ListStepEntries.
+      class ListStepEntriesResponse
+        include Google::Apis::Core::Hashable
+      
+        # A token to retrieve next page of results. Pass this value in the
+        # ListStepEntriesRequest.page_token field in the subsequent call to `
+        # ListStepEntries` method to retrieve the next page of results.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        # The list of entries.
+        # Corresponds to the JSON property `stepEntries`
+        # @return [Array<Google::Apis::WorkflowexecutionsV1::StepEntry>]
+        attr_accessor :step_entries
+      
+        # Indicates the total number of StepEntries that matched the request filter. For
+        # running executions, this number shows the number of StepEntries that are
+        # executed thus far.
+        # Corresponds to the JSON property `totalSize`
+        # @return [Fixnum]
+        attr_accessor :total_size
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+          @step_entries = args[:step_entries] if args.key?(:step_entries)
+          @total_size = args[:total_size] if args.key?(:total_size)
+        end
+      end
+      
+      # NavigationInfo describes what steps if any come before or after this step, or
+      # what steps are parents or children of this step.
+      class NavigationInfo
+        include Google::Apis::Core::Hashable
+      
+        # Step entries that can be reached by "stepping into" e.g. a subworkflow call.
+        # Corresponds to the JSON property `children`
+        # @return [Array<Fixnum>]
+        attr_accessor :children
+      
+        # The index of the next step in the current workflow, if any.
+        # Corresponds to the JSON property `next`
+        # @return [Fixnum]
+        attr_accessor :next
+      
+        # The step entry, if any, that can be reached by "stepping out" of the current
+        # workflow being executed.
+        # Corresponds to the JSON property `parent`
+        # @return [Fixnum]
+        attr_accessor :parent
+      
+        # The index of the previous step in the current workflow, if any.
+        # Corresponds to the JSON property `previous`
+        # @return [Fixnum]
+        attr_accessor :previous
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @children = args[:children] if args.key?(:children)
+          @next = args[:next] if args.key?(:next)
+          @parent = args[:parent] if args.key?(:parent)
+          @previous = args[:previous] if args.key?(:previous)
+        end
+      end
+      
       # Position contains source position information about the stack trace element
       # such as line number, column number and length of the code block in bytes.
       class Position
@@ -502,6 +595,124 @@ module Google
         end
       end
       
+      # An StepEntry contains debugging information for a step transition in a
+      # workflow execution.
+      class StepEntry
+        include Google::Apis::Core::Hashable
+      
+        # Output only. The creation time of the step entry.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # Output only. The numeric ID of this step entry, used for navigation.
+        # Corresponds to the JSON property `entryId`
+        # @return [Fixnum]
+        attr_accessor :entry_id
+      
+        # Exception describes why the step entry failed.
+        # Corresponds to the JSON property `exception`
+        # @return [Google::Apis::WorkflowexecutionsV1::Exception]
+        attr_accessor :exception
+      
+        # Output only. The full resource name of the step entry. Each step entry has a
+        # unique entry ID, which is a monotonically increasing counter. Step entry names
+        # have the format: `projects/`project`/locations/`location`/workflows/`workflow`/
+        # executions/`execution`/stepEntries/`step_entry``.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # NavigationInfo describes what steps if any come before or after this step, or
+        # what steps are parents or children of this step.
+        # Corresponds to the JSON property `navigationInfo`
+        # @return [Google::Apis::WorkflowexecutionsV1::NavigationInfo]
+        attr_accessor :navigation_info
+      
+        # Output only. The name of the routine this step entry belongs to. A routine
+        # name is the subworkflow name defined in the YAML source code. The top level
+        # routine name is `main`.
+        # Corresponds to the JSON property `routine`
+        # @return [String]
+        attr_accessor :routine
+      
+        # Output only. The state of the step entry.
+        # Corresponds to the JSON property `state`
+        # @return [String]
+        attr_accessor :state
+      
+        # Output only. The name of the step this step entry belongs to.
+        # Corresponds to the JSON property `step`
+        # @return [String]
+        attr_accessor :step
+      
+        # StepEntryMetadata contains metadata information about this step.
+        # Corresponds to the JSON property `stepEntryMetadata`
+        # @return [Google::Apis::WorkflowexecutionsV1::StepEntryMetadata]
+        attr_accessor :step_entry_metadata
+      
+        # Output only. The type of the step this step entry belongs to.
+        # Corresponds to the JSON property `stepType`
+        # @return [String]
+        attr_accessor :step_type
+      
+        # Output only. The most recently updated time of the step entry.
+        # Corresponds to the JSON property `updateTime`
+        # @return [String]
+        attr_accessor :update_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @entry_id = args[:entry_id] if args.key?(:entry_id)
+          @exception = args[:exception] if args.key?(:exception)
+          @name = args[:name] if args.key?(:name)
+          @navigation_info = args[:navigation_info] if args.key?(:navigation_info)
+          @routine = args[:routine] if args.key?(:routine)
+          @state = args[:state] if args.key?(:state)
+          @step = args[:step] if args.key?(:step)
+          @step_entry_metadata = args[:step_entry_metadata] if args.key?(:step_entry_metadata)
+          @step_type = args[:step_type] if args.key?(:step_type)
+          @update_time = args[:update_time] if args.key?(:update_time)
+        end
+      end
+      
+      # StepEntryMetadata contains metadata information about this step.
+      class StepEntryMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Progress number represents the current state of the current progress. eg: A
+        # step entry represents the 4th iteration in a progress of PROGRESS_TYPE_FOR.
+        # Corresponds to the JSON property `progressNumber`
+        # @return [Fixnum]
+        attr_accessor :progress_number
+      
+        # Progress type of this step entry.
+        # Corresponds to the JSON property `progressType`
+        # @return [String]
+        attr_accessor :progress_type
+      
+        # Child thread id that this step entry belongs to.
+        # Corresponds to the JSON property `threadId`
+        # @return [String]
+        attr_accessor :thread_id
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @progress_number = args[:progress_number] if args.key?(:progress_number)
+          @progress_type = args[:progress_type] if args.key?(:progress_type)
+          @thread_id = args[:thread_id] if args.key?(:thread_id)
+        end
+      end
+      
       # Request for the TriggerPubsubExecution method.
       class TriggerPubsubExecutionRequest
         include Google::Apis::Core::Hashable

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.28.0"
+      GEM_VERSION = "0.30.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 = "20230912"
+      REVISION = "20231128"
     end
   end
 end

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

@@ -40,6 +40,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Exception
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Execution
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -64,6 +70,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ListStepEntriesResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class NavigationInfo
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Position
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -106,6 +124,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class StepEntry
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class StepEntryMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class TriggerPubsubExecutionRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -138,6 +168,13 @@ module Google
         end
       end
       
+      class Exception
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :payload, as: 'payload'
+        end
+      end
+      
       class Execution
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -185,6 +222,26 @@ module Google
         end
       end
       
+      class ListStepEntriesResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :next_page_token, as: 'nextPageToken'
+          collection :step_entries, as: 'stepEntries', class: Google::Apis::WorkflowexecutionsV1::StepEntry, decorator: Google::Apis::WorkflowexecutionsV1::StepEntry::Representation
+      
+          property :total_size, as: 'totalSize'
+        end
+      end
+      
+      class NavigationInfo
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :children, as: 'children'
+          property :next, :numeric_string => true, as: 'next'
+          property :parent, :numeric_string => true, as: 'parent'
+          property :previous, :numeric_string => true, as: 'previous'
+        end
+      end
+      
       class Position
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -247,6 +304,35 @@ module Google
         end
       end
       
+      class StepEntry
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :create_time, as: 'createTime'
+          property :entry_id, :numeric_string => true, as: 'entryId'
+          property :exception, as: 'exception', class: Google::Apis::WorkflowexecutionsV1::Exception, decorator: Google::Apis::WorkflowexecutionsV1::Exception::Representation
+      
+          property :name, as: 'name'
+          property :navigation_info, as: 'navigationInfo', class: Google::Apis::WorkflowexecutionsV1::NavigationInfo, decorator: Google::Apis::WorkflowexecutionsV1::NavigationInfo::Representation
+      
+          property :routine, as: 'routine'
+          property :state, as: 'state'
+          property :step, as: 'step'
+          property :step_entry_metadata, as: 'stepEntryMetadata', class: Google::Apis::WorkflowexecutionsV1::StepEntryMetadata, decorator: Google::Apis::WorkflowexecutionsV1::StepEntryMetadata::Representation
+      
+          property :step_type, as: 'stepType'
+          property :update_time, as: 'updateTime'
+        end
+      end
+      
+      class StepEntryMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :progress_number, :numeric_string => true, as: 'progressNumber'
+          property :progress_type, as: 'progressType'
+          property :thread_id, as: 'threadId'
+        end
+      end
+      
       class TriggerPubsubExecutionRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -118,7 +118,8 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Creates a new execution using the latest revision of the given workflow.
+        # Creates a new execution using the latest revision of the given workflow. For
+        # more information, see Execute a workflow.
         # @param [String] parent
         #   Required. Name of the workflow for which an execution should be created.
         #   Format: projects/`project`/locations/`location`/workflows/`workflow` The
@@ -228,14 +229,18 @@ module Google
         #   Required. Name of the workflow for which the executions should be listed.
         #   Format: projects/`project`/locations/`location`/workflows/`workflow`
         # @param [String] filter
-        #   Optional. Filters applied to the [Executions.ListExecutions] results. The
-        #   following fields are supported for filtering: executionID, state, startTime,
-        #   endTime, duration, workflowRevisionID, stepName, and label.
+        #   Optional. Filters applied to the `[Executions.ListExecutions]` results. The
+        #   following fields are supported for filtering: `executionId`, `state`, `
+        #   startTime`, `endTime`, `duration`, `workflowRevisionId`, `stepName`, and `
+        #   label`. For details, see AIP-160. For example, if you are using the Google
+        #   APIs Explorer: `state="SUCCEEDED"` or `startTime>"2023-08-01" AND state="
+        #   FAILED"`
         # @param [String] order_by
-        #   Optional. The ordering applied to the [Executions.ListExecutions] results. By
-        #   default the ordering is based on descending start time. The following fields
-        #   are supported for order by: executionID, startTime, endTime, duration, state,
-        #   and workflowRevisionID.
+        #   Optional. Comma-separated list of fields that specify the ordering applied to
+        #   the `[Executions.ListExecutions]` results. By default the ordering is based on
+        #   descending `startTime`. The following fields are supported for ordering: `
+        #   executionId`, `state`, `startTime`, `endTime`, `duration`, and `
+        #   workflowRevisionId`. For details, see AIP-132.
         # @param [Fixnum] page_size
         #   Maximum number of executions to return per call. Max supported value depends
         #   on the selected Execution view: it's 1000 for BASIC and 100 for FULL. The
@@ -324,6 +329,99 @@ module Google
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
+        
+        # Gets a step entry.
+        # @param [String] name
+        #   Required. The name of the step entry to retrieve. Format: projects/`project`/
+        #   locations/`location`/workflows/`workflow`/executions/`execution`/stepEntries/`
+        #   step_entry`
+        # @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::StepEntry] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::WorkflowexecutionsV1::StepEntry]
+        #
+        # @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 get_project_location_workflow_execution_step_entry(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+name}', options)
+          command.response_representation = Google::Apis::WorkflowexecutionsV1::StepEntry::Representation
+          command.response_class = Google::Apis::WorkflowexecutionsV1::StepEntry
+          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
+        
+        # Lists step entries for the corresponding workflow execution. Returned entries
+        # are ordered by their create_time.
+        # @param [String] parent
+        #   Required. Name of the workflow execution to list entries for. Format: projects/
+        #   `project`/locations/`location`/workflows/`workflow`/executions/`execution`/
+        #   stepEntries/
+        # @param [String] filter
+        #   Optional. Filters applied to the `[StepEntries.ListStepEntries]` results. The
+        #   following fields are supported for filtering: `entryId`, `createTime`, `
+        #   updateTime`, `routine`, `step`, `stepType`, `state`. For details, see AIP-160.
+        #   For example, if you are using the Google APIs Explorer: `state="SUCCEEDED"` or
+        #   `createTime>"2023-08-01" AND state="FAILED"`
+        # @param [String] order_by
+        #   Optional. Comma-separated list of fields that specify the ordering applied to
+        #   the `[StepEntries.ListStepEntries]` results. By default the ordering is based
+        #   on ascending `entryId`. The following fields are supported for ordering: `
+        #   entryId`, `createTime`, `updateTime`, `routine`, `step`, `stepType`, `state`.
+        #   For details, see AIP-132.
+        # @param [Fixnum] page_size
+        #   Optional. Number of step entries to return per call. The default max is 1000.
+        # @param [String] page_token
+        #   Optional. A page token, received from a previous `ListStepEntries` call.
+        #   Provide this to retrieve the subsequent page. When paginating, all other
+        #   parameters provided to `ListStepEntries` must match the call that provided the
+        #   page token.
+        # @param [Fixnum] skip
+        #   Optional. The number of step entries to skip. It can be used with or without a
+        #   pageToken. If used with a pageToken, then it indicates the number of step
+        #   entries to skip starting from the requested page.
+        # @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::ListStepEntriesResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::WorkflowexecutionsV1::ListStepEntriesResponse]
+        #
+        # @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_step_entries(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, skip: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+parent}/stepEntries', options)
+          command.response_representation = Google::Apis::WorkflowexecutionsV1::ListStepEntriesResponse::Representation
+          command.response_class = Google::Apis::WorkflowexecutionsV1::ListStepEntriesResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['filter'] = filter unless filter.nil?
+          command.query['orderBy'] = order_by unless order_by.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['skip'] = skip unless skip.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.28.0
+  version: 0.30.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-01 00:00:00.000000000 Z
+date: 2023-12-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.28.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-workflowexecutions_v1/v0.30.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-workflowexecutions_v1
 post_install_message: 
 rdoc_options: []