Class: Google::Cloud::Workflows::Executions::V1::Execution

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/workflows/executions/v1/executions.rb

Overview

A running instance of a Workflow.

Defined Under Namespace

Modules: CallLogLevel, State Classes: Error, LabelsEntry, StackTrace, StackTraceElement, StateError, Status

Instance Attribute Summary collapse

Instance Attribute Details

#argument ⇒ ::String

Returns Input parameters of the execution represented as a JSON string. The size limit is 32KB.

Note: If you are using the REST API directly to run your workflow, you must escape any JSON string value of argument. Example: '{"argument":"{\"firstName\":\"FIRST\",\"lastName\":\"LAST\"}"}'.

Returns:

  • (::String) —

    Input parameters of the execution represented as a JSON string. The size limit is 32KB.

    Note: If you are using the REST API directly to run your workflow, you must escape any JSON string value of argument. Example: '{"argument":"{\"firstName\":\"FIRST\",\"lastName\":\"LAST\"}"}'



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'proto_docs/google/cloud/workflows/executions/v1/executions.rb', line 85

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A single stack element (frame) where an error occurred.
  # @!attribute [rw] step
  #   @return [::String]
  #     The step the error occurred at.
  # @!attribute [rw] routine
  #   @return [::String]
  #     The routine where the error occurred.
  # @!attribute [rw] position
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement::Position]
  #     The source position information of the stack trace element.
  class StackTraceElement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Position contains source position information about the stack trace
    # element such as line number, column number and length of the code block
    # in bytes.
    # @!attribute [rw] line
    #   @return [::Integer]
    #     The source code line number the current instruction was generated from.
    # @!attribute [rw] column
    #   @return [::Integer]
    #     The source code column position (of the line) the current instruction
    #     was generated from.
    # @!attribute [rw] length
    #   @return [::Integer]
    #     The number of bytes of source code making up this stack trace element.
    class Position
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A collection of stack elements (frames) where an error occurred.
  # @!attribute [rw] elements
  #   @return [::Array<::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement>]
  #     An array of stack elements.
  class StackTrace
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error message and data returned represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human-readable stack trace string.
  # @!attribute [rw] stack_trace
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTrace]
  #     Stack trace with detailed information of where error was generated.
  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

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # 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 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

#call_log_level ⇒ ::Google::Cloud::Workflows::Executions::V1::Execution::CallLogLevel

Returns The call logging level associated to this execution.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'proto_docs/google/cloud/workflows/executions/v1/executions.rb', line 85

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A single stack element (frame) where an error occurred.
  # @!attribute [rw] step
  #   @return [::String]
  #     The step the error occurred at.
  # @!attribute [rw] routine
  #   @return [::String]
  #     The routine where the error occurred.
  # @!attribute [rw] position
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement::Position]
  #     The source position information of the stack trace element.
  class StackTraceElement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Position contains source position information about the stack trace
    # element such as line number, column number and length of the code block
    # in bytes.
    # @!attribute [rw] line
    #   @return [::Integer]
    #     The source code line number the current instruction was generated from.
    # @!attribute [rw] column
    #   @return [::Integer]
    #     The source code column position (of the line) the current instruction
    #     was generated from.
    # @!attribute [rw] length
    #   @return [::Integer]
    #     The number of bytes of source code making up this stack trace element.
    class Position
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A collection of stack elements (frames) where an error occurred.
  # @!attribute [rw] elements
  #   @return [::Array<::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement>]
  #     An array of stack elements.
  class StackTrace
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error message and data returned represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human-readable stack trace string.
  # @!attribute [rw] stack_trace
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTrace]
  #     Stack trace with detailed information of where error was generated.
  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

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # 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 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

#duration ⇒ ::Google::Protobuf::Duration (readonly)

Returns Output only. Measures the duration of the execution.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'proto_docs/google/cloud/workflows/executions/v1/executions.rb', line 85

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A single stack element (frame) where an error occurred.
  # @!attribute [rw] step
  #   @return [::String]
  #     The step the error occurred at.
  # @!attribute [rw] routine
  #   @return [::String]
  #     The routine where the error occurred.
  # @!attribute [rw] position
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement::Position]
  #     The source position information of the stack trace element.
  class StackTraceElement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Position contains source position information about the stack trace
    # element such as line number, column number and length of the code block
    # in bytes.
    # @!attribute [rw] line
    #   @return [::Integer]
    #     The source code line number the current instruction was generated from.
    # @!attribute [rw] column
    #   @return [::Integer]
    #     The source code column position (of the line) the current instruction
    #     was generated from.
    # @!attribute [rw] length
    #   @return [::Integer]
    #     The number of bytes of source code making up this stack trace element.
    class Position
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A collection of stack elements (frames) where an error occurred.
  # @!attribute [rw] elements
  #   @return [::Array<::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement>]
  #     An array of stack elements.
  class StackTrace
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error message and data returned represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human-readable stack trace string.
  # @!attribute [rw] stack_trace
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTrace]
  #     Stack trace with detailed information of where error was generated.
  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

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # 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 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

#end_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Marks the end of execution, successful or not.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'proto_docs/google/cloud/workflows/executions/v1/executions.rb', line 85

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A single stack element (frame) where an error occurred.
  # @!attribute [rw] step
  #   @return [::String]
  #     The step the error occurred at.
  # @!attribute [rw] routine
  #   @return [::String]
  #     The routine where the error occurred.
  # @!attribute [rw] position
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement::Position]
  #     The source position information of the stack trace element.
  class StackTraceElement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Position contains source position information about the stack trace
    # element such as line number, column number and length of the code block
    # in bytes.
    # @!attribute [rw] line
    #   @return [::Integer]
    #     The source code line number the current instruction was generated from.
    # @!attribute [rw] column
    #   @return [::Integer]
    #     The source code column position (of the line) the current instruction
    #     was generated from.
    # @!attribute [rw] length
    #   @return [::Integer]
    #     The number of bytes of source code making up this stack trace element.
    class Position
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A collection of stack elements (frames) where an error occurred.
  # @!attribute [rw] elements
  #   @return [::Array<::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement>]
  #     An array of stack elements.
  class StackTrace
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error message and data returned represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human-readable stack trace string.
  # @!attribute [rw] stack_trace
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTrace]
  #     Stack trace with detailed information of where error was generated.
  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

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # 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 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

#error ⇒ ::Google::Cloud::Workflows::Executions::V1::Execution::Error (readonly)

Returns Output only. The error which caused the execution to finish prematurely. The value is only present if the execution's state is FAILED or CANCELLED.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'proto_docs/google/cloud/workflows/executions/v1/executions.rb', line 85

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A single stack element (frame) where an error occurred.
  # @!attribute [rw] step
  #   @return [::String]
  #     The step the error occurred at.
  # @!attribute [rw] routine
  #   @return [::String]
  #     The routine where the error occurred.
  # @!attribute [rw] position
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement::Position]
  #     The source position information of the stack trace element.
  class StackTraceElement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Position contains source position information about the stack trace
    # element such as line number, column number and length of the code block
    # in bytes.
    # @!attribute [rw] line
    #   @return [::Integer]
    #     The source code line number the current instruction was generated from.
    # @!attribute [rw] column
    #   @return [::Integer]
    #     The source code column position (of the line) the current instruction
    #     was generated from.
    # @!attribute [rw] length
    #   @return [::Integer]
    #     The number of bytes of source code making up this stack trace element.
    class Position
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A collection of stack elements (frames) where an error occurred.
  # @!attribute [rw] elements
  #   @return [::Array<::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement>]
  #     An array of stack elements.
  class StackTrace
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error message and data returned represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human-readable stack trace string.
  # @!attribute [rw] stack_trace
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTrace]
  #     Stack trace with detailed information of where error was generated.
  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

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # 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 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

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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.

Returns:

  • (::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.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'proto_docs/google/cloud/workflows/executions/v1/executions.rb', line 85

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A single stack element (frame) where an error occurred.
  # @!attribute [rw] step
  #   @return [::String]
  #     The step the error occurred at.
  # @!attribute [rw] routine
  #   @return [::String]
  #     The routine where the error occurred.
  # @!attribute [rw] position
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement::Position]
  #     The source position information of the stack trace element.
  class StackTraceElement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Position contains source position information about the stack trace
    # element such as line number, column number and length of the code block
    # in bytes.
    # @!attribute [rw] line
    #   @return [::Integer]
    #     The source code line number the current instruction was generated from.
    # @!attribute [rw] column
    #   @return [::Integer]
    #     The source code column position (of the line) the current instruction
    #     was generated from.
    # @!attribute [rw] length
    #   @return [::Integer]
    #     The number of bytes of source code making up this stack trace element.
    class Position
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A collection of stack elements (frames) where an error occurred.
  # @!attribute [rw] elements
  #   @return [::Array<::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement>]
  #     An array of stack elements.
  class StackTrace
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error message and data returned represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human-readable stack trace string.
  # @!attribute [rw] stack_trace
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTrace]
  #     Stack trace with detailed information of where error was generated.
  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

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # 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 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

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}.

Returns:

  • (::String) —

    Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'proto_docs/google/cloud/workflows/executions/v1/executions.rb', line 85

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A single stack element (frame) where an error occurred.
  # @!attribute [rw] step
  #   @return [::String]
  #     The step the error occurred at.
  # @!attribute [rw] routine
  #   @return [::String]
  #     The routine where the error occurred.
  # @!attribute [rw] position
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement::Position]
  #     The source position information of the stack trace element.
  class StackTraceElement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Position contains source position information about the stack trace
    # element such as line number, column number and length of the code block
    # in bytes.
    # @!attribute [rw] line
    #   @return [::Integer]
    #     The source code line number the current instruction was generated from.
    # @!attribute [rw] column
    #   @return [::Integer]
    #     The source code column position (of the line) the current instruction
    #     was generated from.
    # @!attribute [rw] length
    #   @return [::Integer]
    #     The number of bytes of source code making up this stack trace element.
    class Position
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A collection of stack elements (frames) where an error occurred.
  # @!attribute [rw] elements
  #   @return [::Array<::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement>]
  #     An array of stack elements.
  class StackTrace
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error message and data returned represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human-readable stack trace string.
  # @!attribute [rw] stack_trace
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTrace]
  #     Stack trace with detailed information of where error was generated.
  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

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # 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 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

#result ⇒ ::String (readonly)

Returns Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is SUCCEEDED.

Returns:

  • (::String) —

    Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is SUCCEEDED.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'proto_docs/google/cloud/workflows/executions/v1/executions.rb', line 85

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A single stack element (frame) where an error occurred.
  # @!attribute [rw] step
  #   @return [::String]
  #     The step the error occurred at.
  # @!attribute [rw] routine
  #   @return [::String]
  #     The routine where the error occurred.
  # @!attribute [rw] position
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement::Position]
  #     The source position information of the stack trace element.
  class StackTraceElement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Position contains source position information about the stack trace
    # element such as line number, column number and length of the code block
    # in bytes.
    # @!attribute [rw] line
    #   @return [::Integer]
    #     The source code line number the current instruction was generated from.
    # @!attribute [rw] column
    #   @return [::Integer]
    #     The source code column position (of the line) the current instruction
    #     was generated from.
    # @!attribute [rw] length
    #   @return [::Integer]
    #     The number of bytes of source code making up this stack trace element.
    class Position
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A collection of stack elements (frames) where an error occurred.
  # @!attribute [rw] elements
  #   @return [::Array<::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement>]
  #     An array of stack elements.
  class StackTrace
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error message and data returned represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human-readable stack trace string.
  # @!attribute [rw] stack_trace
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTrace]
  #     Stack trace with detailed information of where error was generated.
  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

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # 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 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

#start_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Marks the beginning of execution.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'proto_docs/google/cloud/workflows/executions/v1/executions.rb', line 85

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A single stack element (frame) where an error occurred.
  # @!attribute [rw] step
  #   @return [::String]
  #     The step the error occurred at.
  # @!attribute [rw] routine
  #   @return [::String]
  #     The routine where the error occurred.
  # @!attribute [rw] position
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement::Position]
  #     The source position information of the stack trace element.
  class StackTraceElement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Position contains source position information about the stack trace
    # element such as line number, column number and length of the code block
    # in bytes.
    # @!attribute [rw] line
    #   @return [::Integer]
    #     The source code line number the current instruction was generated from.
    # @!attribute [rw] column
    #   @return [::Integer]
    #     The source code column position (of the line) the current instruction
    #     was generated from.
    # @!attribute [rw] length
    #   @return [::Integer]
    #     The number of bytes of source code making up this stack trace element.
    class Position
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A collection of stack elements (frames) where an error occurred.
  # @!attribute [rw] elements
  #   @return [::Array<::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement>]
  #     An array of stack elements.
  class StackTrace
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error message and data returned represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human-readable stack trace string.
  # @!attribute [rw] stack_trace
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTrace]
  #     Stack trace with detailed information of where error was generated.
  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

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # 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 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

#state ⇒ ::Google::Cloud::Workflows::Executions::V1::Execution::State (readonly)

Returns Output only. Current state of the execution.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'proto_docs/google/cloud/workflows/executions/v1/executions.rb', line 85

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A single stack element (frame) where an error occurred.
  # @!attribute [rw] step
  #   @return [::String]
  #     The step the error occurred at.
  # @!attribute [rw] routine
  #   @return [::String]
  #     The routine where the error occurred.
  # @!attribute [rw] position
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement::Position]
  #     The source position information of the stack trace element.
  class StackTraceElement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Position contains source position information about the stack trace
    # element such as line number, column number and length of the code block
    # in bytes.
    # @!attribute [rw] line
    #   @return [::Integer]
    #     The source code line number the current instruction was generated from.
    # @!attribute [rw] column
    #   @return [::Integer]
    #     The source code column position (of the line) the current instruction
    #     was generated from.
    # @!attribute [rw] length
    #   @return [::Integer]
    #     The number of bytes of source code making up this stack trace element.
    class Position
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A collection of stack elements (frames) where an error occurred.
  # @!attribute [rw] elements
  #   @return [::Array<::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement>]
  #     An array of stack elements.
  class StackTrace
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error message and data returned represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human-readable stack trace string.
  # @!attribute [rw] stack_trace
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTrace]
  #     Stack trace with detailed information of where error was generated.
  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

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # 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 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

#state_error ⇒ ::Google::Cloud::Workflows::Executions::V1::Execution::StateError (readonly)

Returns 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.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'proto_docs/google/cloud/workflows/executions/v1/executions.rb', line 85

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A single stack element (frame) where an error occurred.
  # @!attribute [rw] step
  #   @return [::String]
  #     The step the error occurred at.
  # @!attribute [rw] routine
  #   @return [::String]
  #     The routine where the error occurred.
  # @!attribute [rw] position
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement::Position]
  #     The source position information of the stack trace element.
  class StackTraceElement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Position contains source position information about the stack trace
    # element such as line number, column number and length of the code block
    # in bytes.
    # @!attribute [rw] line
    #   @return [::Integer]
    #     The source code line number the current instruction was generated from.
    # @!attribute [rw] column
    #   @return [::Integer]
    #     The source code column position (of the line) the current instruction
    #     was generated from.
    # @!attribute [rw] length
    #   @return [::Integer]
    #     The number of bytes of source code making up this stack trace element.
    class Position
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A collection of stack elements (frames) where an error occurred.
  # @!attribute [rw] elements
  #   @return [::Array<::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement>]
  #     An array of stack elements.
  class StackTrace
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error message and data returned represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human-readable stack trace string.
  # @!attribute [rw] stack_trace
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTrace]
  #     Stack trace with detailed information of where error was generated.
  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

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # 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 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

#status ⇒ ::Google::Cloud::Workflows::Executions::V1::Execution::Status (readonly)

Returns Output only. Status tracks the current steps and progress data of this execution.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'proto_docs/google/cloud/workflows/executions/v1/executions.rb', line 85

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A single stack element (frame) where an error occurred.
  # @!attribute [rw] step
  #   @return [::String]
  #     The step the error occurred at.
  # @!attribute [rw] routine
  #   @return [::String]
  #     The routine where the error occurred.
  # @!attribute [rw] position
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement::Position]
  #     The source position information of the stack trace element.
  class StackTraceElement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Position contains source position information about the stack trace
    # element such as line number, column number and length of the code block
    # in bytes.
    # @!attribute [rw] line
    #   @return [::Integer]
    #     The source code line number the current instruction was generated from.
    # @!attribute [rw] column
    #   @return [::Integer]
    #     The source code column position (of the line) the current instruction
    #     was generated from.
    # @!attribute [rw] length
    #   @return [::Integer]
    #     The number of bytes of source code making up this stack trace element.
    class Position
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A collection of stack elements (frames) where an error occurred.
  # @!attribute [rw] elements
  #   @return [::Array<::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement>]
  #     An array of stack elements.
  class StackTrace
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error message and data returned represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human-readable stack trace string.
  # @!attribute [rw] stack_trace
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTrace]
  #     Stack trace with detailed information of where error was generated.
  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

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # 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 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

#workflow_revision_id ⇒ ::String (readonly)

Returns Output only. Revision of the workflow this execution is using.

Returns:

  • (::String) —

    Output only. Revision of the workflow this execution is using.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'proto_docs/google/cloud/workflows/executions/v1/executions.rb', line 85

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A single stack element (frame) where an error occurred.
  # @!attribute [rw] step
  #   @return [::String]
  #     The step the error occurred at.
  # @!attribute [rw] routine
  #   @return [::String]
  #     The routine where the error occurred.
  # @!attribute [rw] position
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement::Position]
  #     The source position information of the stack trace element.
  class StackTraceElement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Position contains source position information about the stack trace
    # element such as line number, column number and length of the code block
    # in bytes.
    # @!attribute [rw] line
    #   @return [::Integer]
    #     The source code line number the current instruction was generated from.
    # @!attribute [rw] column
    #   @return [::Integer]
    #     The source code column position (of the line) the current instruction
    #     was generated from.
    # @!attribute [rw] length
    #   @return [::Integer]
    #     The number of bytes of source code making up this stack trace element.
    class Position
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A collection of stack elements (frames) where an error occurred.
  # @!attribute [rw] elements
  #   @return [::Array<::Google::Cloud::Workflows::Executions::V1::Execution::StackTraceElement>]
  #     An array of stack elements.
  class StackTrace
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Error describes why the execution was abnormally terminated.
  # @!attribute [rw] payload
  #   @return [::String]
  #     Error message and data returned represented as a JSON string.
  # @!attribute [rw] context
  #   @return [::String]
  #     Human-readable stack trace string.
  # @!attribute [rw] stack_trace
  #   @return [::Google::Cloud::Workflows::Executions::V1::Execution::StackTrace]
  #     Stack trace with detailed information of where error was generated.
  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

    # The execution is in progress.
    ACTIVE = 1

    # The execution finished successfully.
    SUCCEEDED = 2

    # 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 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