executions.rb in google-cloud-workflows-executions-v1-0.4.0

- old
+ new

@@ -33,10 +33,13 @@
           #   @return [::Google::Protobuf::Timestamp]
           #     Output only. Marks the beginning of execution.
           # @!attribute [r] end_time
           #   @return [::Google::Protobuf::Timestamp]
           #     Output only. Marks the end of execution, successful or not.
+          # @!attribute [r] duration
+          #   @return [::Google::Protobuf::Duration]
+          #     Output only. Measures the duration of the execution.
           # @!attribute [r] state
           #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::State]
           #     Output only. Current state of the execution.
           # @!attribute [rw] argument
           #   @return [::String]
@@ -59,10 +62,28 @@
           #   @return [::String]
           #     Output only. Revision of the workflow this execution is using.
           # @!attribute [rw] call_log_level
           #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::CallLogLevel]
           #     The call logging level associated to this execution.
+          # @!attribute [r] status
+          #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::Status]
+          #     Output only. Status tracks the current steps and progress data of this
+          #     execution.
+          # @!attribute [rw] labels
+          #   @return [::Google::Protobuf::Map{::String => ::String}]
+          #     Labels associated with this execution.
+          #     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.
+          #     International characters are allowed.
+          #     By default, labels are inherited from the workflow but are overridden by
+          #     any labels associated with the execution.
+          # @!attribute [r] state_error
+          #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StateError]
+          #     Output only. Error regarding the state of the Execution resource. For
+          #     example, this field will have error details if the execution data is
+          #     unavailable due to revoked KMS key permissions.
           class Execution
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
 
             # A single stack element (frame) where an error occurred.
@@ -120,10 +141,67 @@
             class Error
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
 
+            # Represents the current status of this execution.
+            # @!attribute [rw] current_steps
+            #   @return [::Array<::Google::Cloud::Workflows::Executions::V1::Execution::Status::Step>]
+            #     A list of currently executing or last executed step names for the
+            #     workflow execution currently running. If the workflow has succeeded or
+            #     failed, this is the last attempted or executed step. Presently, if the
+            #     current step is inside a subworkflow, the list only includes that step.
+            #     In the future, the list will contain items for each step in the call
+            #     stack, starting with the outermost step in the `main` subworkflow, and
+            #     ending with the most deeply nested step.
+            class Status
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Represents a step of the workflow this execution is running.
+              # @!attribute [rw] routine
+              #   @return [::String]
+              #     Name of a routine within the workflow.
+              # @!attribute [rw] step
+              #   @return [::String]
+              #     Name of a step within the routine.
+              class Step
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+
+            # Describes an error related to the current state of the Execution resource.
+            # @!attribute [rw] details
+            #   @return [::String]
+            #     Provides specifics about the error.
+            # @!attribute [rw] type
+            #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StateError::Type]
+            #     The type of this state error.
+            class StateError
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Describes the possible 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
+            #   @return [::String]
+            class LabelsEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
             # Describes the current state of the execution. More states might be added
             # in the future.
             module State
               # Invalid state.
               STATE_UNSPECIFIED = 0
@@ -137,24 +215,33 @@
               # The execution failed with an error.
               FAILED = 3
 
               # The execution was stopped intentionally.
               CANCELLED = 4
+
+              # Execution data is unavailable. See the `state_error` field.
+              UNAVAILABLE = 5
+
+              # Request has been placed in the backlog for processing at a later time.
+              QUEUED = 6
             end
 
             # Describes the level of platform logging to apply to calls and call
             # responses during workflow executions.
             module CallLogLevel
-              # No call logging specified.
+              # 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
 
           # Request for the
           # [ListExecutions][]
@@ -164,25 +251,40 @@
           #     Required. Name of the workflow for which the executions should be listed.
           #     Format: projects/\\{project}/locations/\\{location}/workflows/\\{workflow}
           # @!attribute [rw] page_size
           #   @return [::Integer]
           #     Maximum number of executions to return per call.
-          #     Max supported value depends on the selected Execution view: it's 10000 for
+          #     Max supported value depends on the selected Execution view: it's 1000 for
           #     BASIC and 100 for FULL. The default value used if the field is not
           #     specified is 100, regardless of the selected view. Values greater than
           #     the max value will be coerced down to it.
           # @!attribute [rw] page_token
           #   @return [::String]
           #     A page token, received from a previous `ListExecutions` call.
           #     Provide this to retrieve the subsequent page.
           #
           #     When paginating, all other parameters provided to `ListExecutions` must
           #     match the call that provided the page token.
+          #
+          #     Note that pagination is applied to dynamic data. The list of executions
+          #     returned can change between page requests.
           # @!attribute [rw] view
           #   @return [::Google::Cloud::Workflows::Executions::V1::ExecutionView]
-          #     Optional. A view defining which fields should be filled in the returned executions.
-          #     The API will default to the BASIC view.
+          #     Optional. A view defining which fields should be filled in the returned
+          #     executions. The API will default to the BASIC view.
+          # @!attribute [rw] filter
+          #   @return [::String]
+          #     Optional. Filters applied to the [Executions.ListExecutions] results.
+          #     The following fields are supported for filtering:
+          #     executionID, state, startTime, endTime, duration, workflowRevisionID,
+          #     stepName, and label.
+          # @!attribute [rw] order_by
+          #   @return [::String]
+          #     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.
           class ListExecutionsRequest
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
@@ -225,12 +327,12 @@
           #     Required. Name of the execution to be retrieved.
           #     Format:
           #     projects/\\{project}/locations/\\{location}/workflows/\\{workflow}/executions/\\{execution}
           # @!attribute [rw] view
           #   @return [::Google::Cloud::Workflows::Executions::V1::ExecutionView]
-          #     Optional. A view defining which fields should be filled in the returned execution.
-          #     The API will default to the FULL view.
+          #     Optional. A view defining which fields should be filled in the returned
+          #     execution. The API will default to the FULL view.
           class GetExecutionRequest
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
@@ -251,11 +353,11 @@
           module ExecutionView
             # The default / unset value.
             EXECUTION_VIEW_UNSPECIFIED = 0
 
             # Includes only basic metadata about the execution.
-            # Following fields are returned: name, start_time, end_time, state
-            # and workflow_revision_id.
+            # The following fields are returned: name, start_time, end_time, duration,
+            # state, and workflow_revision_id.
             BASIC = 1
 
             # Includes all data.
             FULL = 2
           end