google-apis-workflowexecutions_v1 0.27.0 → 0.29.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/lib/google/apis/workflowexecutions_v1/classes.rb +214 -3
- data/lib/google/apis/workflowexecutions_v1/gem_version.rb +2 -2
- data/lib/google/apis/workflowexecutions_v1/representations.rb +86 -0
- data/lib/google/apis/workflowexecutions_v1/service.rb +110 -12
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5f2ea8ed99b8a2e3e20f74dc03aeb04c545904001059bf938d9123dcc83f6ee5
|
4
|
+
data.tar.gz: 5d3c6b1ba1f60c8d179037b71c22681bb773a7d89bb64ef29209e26ee47acb98
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ab61932a77b13dcbdb7ac77a17faadf60241358574c3386df17eed18c5131d9ee8b5b24fe7d1596b828eac6ed0fb99ceaa1f34f515329f21a5631fe8aa8c2e6c
|
7
|
+
data.tar.gz: 5e098504de28a22ba4e6083f153c0c04e5094934414cd74f2b36bab5a8e69c760eec95ca4dba037ab8a53cf83d8a5ed47afcaa1ecc6500b990b88cdcd08a43a0
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Release history for google-apis-workflowexecutions_v1
|
2
2
|
|
3
|
+
### v0.29.0 (2023-10-29)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20231017
|
6
|
+
|
7
|
+
### v0.28.0 (2023-10-01)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20230912
|
10
|
+
|
3
11
|
### v0.27.0 (2023-09-10)
|
4
12
|
|
5
13
|
* Regenerated from discovery document revision 20230829
|
@@ -32,7 +32,7 @@ module Google
|
|
32
32
|
# @return [Array<String>]
|
33
33
|
attr_accessor :available_payloads
|
34
34
|
|
35
|
-
# Output only. The method accepted by the callback.
|
35
|
+
# Output only. The method accepted by the callback. For example: GET, POST, PUT.
|
36
36
|
# Corresponds to the JSON property `method`
|
37
37
|
# @return [String]
|
38
38
|
attr_accessor :method_prop
|
@@ -106,6 +106,25 @@ module Google
|
|
106
106
|
end
|
107
107
|
end
|
108
108
|
|
109
|
+
# Exception describes why the step entry failed.
|
110
|
+
class Exception
|
111
|
+
include Google::Apis::Core::Hashable
|
112
|
+
|
113
|
+
# Error message represented as a JSON string.
|
114
|
+
# Corresponds to the JSON property `payload`
|
115
|
+
# @return [String]
|
116
|
+
attr_accessor :payload
|
117
|
+
|
118
|
+
def initialize(**args)
|
119
|
+
update!(**args)
|
120
|
+
end
|
121
|
+
|
122
|
+
# Update properties of this object
|
123
|
+
def update!(**args)
|
124
|
+
@payload = args[:payload] if args.key?(:payload)
|
125
|
+
end
|
126
|
+
end
|
127
|
+
|
109
128
|
# A running instance of a [Workflow](/workflows/docs/reference/rest/v1/projects.
|
110
129
|
# locations.workflows).
|
111
130
|
class Execution
|
@@ -212,8 +231,8 @@ module Google
|
|
212
231
|
class ExportDataResponse
|
213
232
|
include Google::Apis::Core::Hashable
|
214
233
|
|
215
|
-
# The JSON string with customer data and metadata
|
216
|
-
# name
|
234
|
+
# The JSON string with customer data and metadata for an execution with the
|
235
|
+
# given name
|
217
236
|
# Corresponds to the JSON property `data`
|
218
237
|
# @return [String]
|
219
238
|
attr_accessor :data
|
@@ -280,6 +299,80 @@ module Google
|
|
280
299
|
end
|
281
300
|
end
|
282
301
|
|
302
|
+
# Response message for ExecutionHistory.ListStepEntries.
|
303
|
+
class ListStepEntriesResponse
|
304
|
+
include Google::Apis::Core::Hashable
|
305
|
+
|
306
|
+
# A token to retrieve next page of results. Pass this value in the
|
307
|
+
# ListStepEntriesRequest.page_token field in the subsequent call to `
|
308
|
+
# ListStepEntries` method to retrieve the next page of results.
|
309
|
+
# Corresponds to the JSON property `nextPageToken`
|
310
|
+
# @return [String]
|
311
|
+
attr_accessor :next_page_token
|
312
|
+
|
313
|
+
# The list of entries.
|
314
|
+
# Corresponds to the JSON property `stepEntries`
|
315
|
+
# @return [Array<Google::Apis::WorkflowexecutionsV1::StepEntry>]
|
316
|
+
attr_accessor :step_entries
|
317
|
+
|
318
|
+
# Indicates the total number of StepEntries that matched the request filter. For
|
319
|
+
# running executions, this number shows the number of StepEntries that are
|
320
|
+
# executed thus far.
|
321
|
+
# Corresponds to the JSON property `totalSize`
|
322
|
+
# @return [Fixnum]
|
323
|
+
attr_accessor :total_size
|
324
|
+
|
325
|
+
def initialize(**args)
|
326
|
+
update!(**args)
|
327
|
+
end
|
328
|
+
|
329
|
+
# Update properties of this object
|
330
|
+
def update!(**args)
|
331
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
332
|
+
@step_entries = args[:step_entries] if args.key?(:step_entries)
|
333
|
+
@total_size = args[:total_size] if args.key?(:total_size)
|
334
|
+
end
|
335
|
+
end
|
336
|
+
|
337
|
+
# NavigationInfo describes what steps if any come before or after this step, or
|
338
|
+
# what steps are parents or children of this step.
|
339
|
+
class NavigationInfo
|
340
|
+
include Google::Apis::Core::Hashable
|
341
|
+
|
342
|
+
# Step entries that can be reached by "stepping into" e.g. a subworkflow call.
|
343
|
+
# Corresponds to the JSON property `children`
|
344
|
+
# @return [Array<Fixnum>]
|
345
|
+
attr_accessor :children
|
346
|
+
|
347
|
+
# The index of the next step in the current workflow, if any.
|
348
|
+
# Corresponds to the JSON property `next`
|
349
|
+
# @return [Fixnum]
|
350
|
+
attr_accessor :next
|
351
|
+
|
352
|
+
# The step entry, if any, that can be reached by "stepping out" of the current
|
353
|
+
# workflow being executed.
|
354
|
+
# Corresponds to the JSON property `parent`
|
355
|
+
# @return [Fixnum]
|
356
|
+
attr_accessor :parent
|
357
|
+
|
358
|
+
# The index of the previous step in the current workflow, if any.
|
359
|
+
# Corresponds to the JSON property `previous`
|
360
|
+
# @return [Fixnum]
|
361
|
+
attr_accessor :previous
|
362
|
+
|
363
|
+
def initialize(**args)
|
364
|
+
update!(**args)
|
365
|
+
end
|
366
|
+
|
367
|
+
# Update properties of this object
|
368
|
+
def update!(**args)
|
369
|
+
@children = args[:children] if args.key?(:children)
|
370
|
+
@next = args[:next] if args.key?(:next)
|
371
|
+
@parent = args[:parent] if args.key?(:parent)
|
372
|
+
@previous = args[:previous] if args.key?(:previous)
|
373
|
+
end
|
374
|
+
end
|
375
|
+
|
283
376
|
# Position contains source position information about the stack trace element
|
284
377
|
# such as line number, column number and length of the code block in bytes.
|
285
378
|
class Position
|
@@ -502,6 +595,124 @@ module Google
|
|
502
595
|
end
|
503
596
|
end
|
504
597
|
|
598
|
+
# An StepEntry contains debugging information for a step transition in a
|
599
|
+
# workflow execution.
|
600
|
+
class StepEntry
|
601
|
+
include Google::Apis::Core::Hashable
|
602
|
+
|
603
|
+
# Output only. The creation time of the step entry.
|
604
|
+
# Corresponds to the JSON property `createTime`
|
605
|
+
# @return [String]
|
606
|
+
attr_accessor :create_time
|
607
|
+
|
608
|
+
# Output only. The numeric ID of this step entry, used for navigation.
|
609
|
+
# Corresponds to the JSON property `entryId`
|
610
|
+
# @return [Fixnum]
|
611
|
+
attr_accessor :entry_id
|
612
|
+
|
613
|
+
# Exception describes why the step entry failed.
|
614
|
+
# Corresponds to the JSON property `exception`
|
615
|
+
# @return [Google::Apis::WorkflowexecutionsV1::Exception]
|
616
|
+
attr_accessor :exception
|
617
|
+
|
618
|
+
# Output only. The full resource name of the step entry. Each step entry has a
|
619
|
+
# unique entry ID, which is a monotonically increasing counter. Step entry names
|
620
|
+
# have the format: `projects/`project`/locations/`location`/workflows/`workflow`/
|
621
|
+
# executions/`execution`/stepEntries/`step_entry``.
|
622
|
+
# Corresponds to the JSON property `name`
|
623
|
+
# @return [String]
|
624
|
+
attr_accessor :name
|
625
|
+
|
626
|
+
# NavigationInfo describes what steps if any come before or after this step, or
|
627
|
+
# what steps are parents or children of this step.
|
628
|
+
# Corresponds to the JSON property `navigationInfo`
|
629
|
+
# @return [Google::Apis::WorkflowexecutionsV1::NavigationInfo]
|
630
|
+
attr_accessor :navigation_info
|
631
|
+
|
632
|
+
# Output only. The name of the routine this step entry belongs to. A routine
|
633
|
+
# name is the subworkflow name defined in the YAML source code. The top level
|
634
|
+
# routine name is `main`.
|
635
|
+
# Corresponds to the JSON property `routine`
|
636
|
+
# @return [String]
|
637
|
+
attr_accessor :routine
|
638
|
+
|
639
|
+
# Output only. The state of the step entry.
|
640
|
+
# Corresponds to the JSON property `state`
|
641
|
+
# @return [String]
|
642
|
+
attr_accessor :state
|
643
|
+
|
644
|
+
# Output only. The name of the step this step entry belongs to.
|
645
|
+
# Corresponds to the JSON property `step`
|
646
|
+
# @return [String]
|
647
|
+
attr_accessor :step
|
648
|
+
|
649
|
+
# StepEntryMetadata contains metadata information about this step.
|
650
|
+
# Corresponds to the JSON property `stepEntryMetadata`
|
651
|
+
# @return [Google::Apis::WorkflowexecutionsV1::StepEntryMetadata]
|
652
|
+
attr_accessor :step_entry_metadata
|
653
|
+
|
654
|
+
# Output only. The type of the step this step entry belongs to.
|
655
|
+
# Corresponds to the JSON property `stepType`
|
656
|
+
# @return [String]
|
657
|
+
attr_accessor :step_type
|
658
|
+
|
659
|
+
# Output only. The most recently updated time of the step entry.
|
660
|
+
# Corresponds to the JSON property `updateTime`
|
661
|
+
# @return [String]
|
662
|
+
attr_accessor :update_time
|
663
|
+
|
664
|
+
def initialize(**args)
|
665
|
+
update!(**args)
|
666
|
+
end
|
667
|
+
|
668
|
+
# Update properties of this object
|
669
|
+
def update!(**args)
|
670
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
671
|
+
@entry_id = args[:entry_id] if args.key?(:entry_id)
|
672
|
+
@exception = args[:exception] if args.key?(:exception)
|
673
|
+
@name = args[:name] if args.key?(:name)
|
674
|
+
@navigation_info = args[:navigation_info] if args.key?(:navigation_info)
|
675
|
+
@routine = args[:routine] if args.key?(:routine)
|
676
|
+
@state = args[:state] if args.key?(:state)
|
677
|
+
@step = args[:step] if args.key?(:step)
|
678
|
+
@step_entry_metadata = args[:step_entry_metadata] if args.key?(:step_entry_metadata)
|
679
|
+
@step_type = args[:step_type] if args.key?(:step_type)
|
680
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
681
|
+
end
|
682
|
+
end
|
683
|
+
|
684
|
+
# StepEntryMetadata contains metadata information about this step.
|
685
|
+
class StepEntryMetadata
|
686
|
+
include Google::Apis::Core::Hashable
|
687
|
+
|
688
|
+
# Progress number represents the current state of the current progress. eg: A
|
689
|
+
# step entry represents the 4th iteration in a progress of PROGRESS_TYPE_FOR.
|
690
|
+
# Corresponds to the JSON property `progressNumber`
|
691
|
+
# @return [Fixnum]
|
692
|
+
attr_accessor :progress_number
|
693
|
+
|
694
|
+
# Progress type of this step entry.
|
695
|
+
# Corresponds to the JSON property `progressType`
|
696
|
+
# @return [String]
|
697
|
+
attr_accessor :progress_type
|
698
|
+
|
699
|
+
# Child thread id that this step entry belongs to.
|
700
|
+
# Corresponds to the JSON property `threadId`
|
701
|
+
# @return [String]
|
702
|
+
attr_accessor :thread_id
|
703
|
+
|
704
|
+
def initialize(**args)
|
705
|
+
update!(**args)
|
706
|
+
end
|
707
|
+
|
708
|
+
# Update properties of this object
|
709
|
+
def update!(**args)
|
710
|
+
@progress_number = args[:progress_number] if args.key?(:progress_number)
|
711
|
+
@progress_type = args[:progress_type] if args.key?(:progress_type)
|
712
|
+
@thread_id = args[:thread_id] if args.key?(:thread_id)
|
713
|
+
end
|
714
|
+
end
|
715
|
+
|
505
716
|
# Request for the TriggerPubsubExecution method.
|
506
717
|
class TriggerPubsubExecutionRequest
|
507
718
|
include Google::Apis::Core::Hashable
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module WorkflowexecutionsV1
|
18
18
|
# Version of the google-apis-workflowexecutions_v1 gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.29.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.12.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20231017"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -40,6 +40,12 @@ module Google
|
|
40
40
|
include Google::Apis::Core::JsonObjectSupport
|
41
41
|
end
|
42
42
|
|
43
|
+
class Exception
|
44
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
45
|
+
|
46
|
+
include Google::Apis::Core::JsonObjectSupport
|
47
|
+
end
|
48
|
+
|
43
49
|
class Execution
|
44
50
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
45
51
|
|
@@ -64,6 +70,18 @@ module Google
|
|
64
70
|
include Google::Apis::Core::JsonObjectSupport
|
65
71
|
end
|
66
72
|
|
73
|
+
class ListStepEntriesResponse
|
74
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
75
|
+
|
76
|
+
include Google::Apis::Core::JsonObjectSupport
|
77
|
+
end
|
78
|
+
|
79
|
+
class NavigationInfo
|
80
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
81
|
+
|
82
|
+
include Google::Apis::Core::JsonObjectSupport
|
83
|
+
end
|
84
|
+
|
67
85
|
class Position
|
68
86
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
69
87
|
|
@@ -106,6 +124,18 @@ module Google
|
|
106
124
|
include Google::Apis::Core::JsonObjectSupport
|
107
125
|
end
|
108
126
|
|
127
|
+
class StepEntry
|
128
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
129
|
+
|
130
|
+
include Google::Apis::Core::JsonObjectSupport
|
131
|
+
end
|
132
|
+
|
133
|
+
class StepEntryMetadata
|
134
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
135
|
+
|
136
|
+
include Google::Apis::Core::JsonObjectSupport
|
137
|
+
end
|
138
|
+
|
109
139
|
class TriggerPubsubExecutionRequest
|
110
140
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
111
141
|
|
@@ -138,6 +168,13 @@ module Google
|
|
138
168
|
end
|
139
169
|
end
|
140
170
|
|
171
|
+
class Exception
|
172
|
+
# @private
|
173
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
174
|
+
property :payload, as: 'payload'
|
175
|
+
end
|
176
|
+
end
|
177
|
+
|
141
178
|
class Execution
|
142
179
|
# @private
|
143
180
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -185,6 +222,26 @@ module Google
|
|
185
222
|
end
|
186
223
|
end
|
187
224
|
|
225
|
+
class ListStepEntriesResponse
|
226
|
+
# @private
|
227
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
228
|
+
property :next_page_token, as: 'nextPageToken'
|
229
|
+
collection :step_entries, as: 'stepEntries', class: Google::Apis::WorkflowexecutionsV1::StepEntry, decorator: Google::Apis::WorkflowexecutionsV1::StepEntry::Representation
|
230
|
+
|
231
|
+
property :total_size, as: 'totalSize'
|
232
|
+
end
|
233
|
+
end
|
234
|
+
|
235
|
+
class NavigationInfo
|
236
|
+
# @private
|
237
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
238
|
+
collection :children, as: 'children'
|
239
|
+
property :next, :numeric_string => true, as: 'next'
|
240
|
+
property :parent, :numeric_string => true, as: 'parent'
|
241
|
+
property :previous, :numeric_string => true, as: 'previous'
|
242
|
+
end
|
243
|
+
end
|
244
|
+
|
188
245
|
class Position
|
189
246
|
# @private
|
190
247
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -247,6 +304,35 @@ module Google
|
|
247
304
|
end
|
248
305
|
end
|
249
306
|
|
307
|
+
class StepEntry
|
308
|
+
# @private
|
309
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
310
|
+
property :create_time, as: 'createTime'
|
311
|
+
property :entry_id, :numeric_string => true, as: 'entryId'
|
312
|
+
property :exception, as: 'exception', class: Google::Apis::WorkflowexecutionsV1::Exception, decorator: Google::Apis::WorkflowexecutionsV1::Exception::Representation
|
313
|
+
|
314
|
+
property :name, as: 'name'
|
315
|
+
property :navigation_info, as: 'navigationInfo', class: Google::Apis::WorkflowexecutionsV1::NavigationInfo, decorator: Google::Apis::WorkflowexecutionsV1::NavigationInfo::Representation
|
316
|
+
|
317
|
+
property :routine, as: 'routine'
|
318
|
+
property :state, as: 'state'
|
319
|
+
property :step, as: 'step'
|
320
|
+
property :step_entry_metadata, as: 'stepEntryMetadata', class: Google::Apis::WorkflowexecutionsV1::StepEntryMetadata, decorator: Google::Apis::WorkflowexecutionsV1::StepEntryMetadata::Representation
|
321
|
+
|
322
|
+
property :step_type, as: 'stepType'
|
323
|
+
property :update_time, as: 'updateTime'
|
324
|
+
end
|
325
|
+
end
|
326
|
+
|
327
|
+
class StepEntryMetadata
|
328
|
+
# @private
|
329
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
330
|
+
property :progress_number, :numeric_string => true, as: 'progressNumber'
|
331
|
+
property :progress_type, as: 'progressType'
|
332
|
+
property :thread_id, as: 'threadId'
|
333
|
+
end
|
334
|
+
end
|
335
|
+
|
250
336
|
class TriggerPubsubExecutionRequest
|
251
337
|
# @private
|
252
338
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -154,10 +154,11 @@ module Google
|
|
154
154
|
end
|
155
155
|
|
156
156
|
# Returns all metadata stored about an execution, excluding most data that is
|
157
|
-
# already accessible
|
157
|
+
# already accessible using other API methods.
|
158
158
|
# @param [String] name
|
159
|
-
# Required. Name of the execution to be
|
160
|
-
#
|
159
|
+
# Required. Name of the execution for which data is to be exported. Format:
|
160
|
+
# projects/`project`/locations/`location`/workflows/`workflow`/executions/`
|
161
|
+
# execution`
|
161
162
|
# @param [String] fields
|
162
163
|
# Selector specifying which fields to include in a partial response.
|
163
164
|
# @param [String] quota_user
|
@@ -227,14 +228,18 @@ module Google
|
|
227
228
|
# Required. Name of the workflow for which the executions should be listed.
|
228
229
|
# Format: projects/`project`/locations/`location`/workflows/`workflow`
|
229
230
|
# @param [String] filter
|
230
|
-
# Optional. Filters applied to the [Executions.ListExecutions] results. The
|
231
|
-
# following fields are supported for filtering:
|
232
|
-
# endTime
|
231
|
+
# Optional. Filters applied to the `[Executions.ListExecutions]` results. The
|
232
|
+
# following fields are supported for filtering: `executionId`, `state`, `
|
233
|
+
# startTime`, `endTime`, `duration`, `workflowRevisionId`, `stepName`, and `
|
234
|
+
# label`. For details, see AIP-160. For example, if you are using the Google
|
235
|
+
# APIs Explorer: `state="SUCCEEDED"` or `startTime>"2023-08-01" AND state="
|
236
|
+
# FAILED"`
|
233
237
|
# @param [String] order_by
|
234
|
-
# Optional.
|
235
|
-
# default the ordering is based on
|
236
|
-
#
|
237
|
-
# and
|
238
|
+
# Optional. Comma-separated list of fields that specify the ordering applied to
|
239
|
+
# the `[Executions.ListExecutions]` results. By default the ordering is based on
|
240
|
+
# descending `startTime`. The following fields are supported for ordering: `
|
241
|
+
# executionId`, `state`, `startTime`, `endTime`, `duration`, and `
|
242
|
+
# workflowRevisionId`. For details, see AIP-132.
|
238
243
|
# @param [Fixnum] page_size
|
239
244
|
# Maximum number of executions to return per call. Max supported value depends
|
240
245
|
# on the selected Execution view: it's 1000 for BASIC and 100 for FULL. The
|
@@ -281,8 +286,8 @@ module Google
|
|
281
286
|
execute_or_queue_command(command, &block)
|
282
287
|
end
|
283
288
|
|
284
|
-
# Returns a list of active callbacks
|
285
|
-
#
|
289
|
+
# Returns a list of active callbacks that belong to the execution with the given
|
290
|
+
# name. The returned callbacks are ordered by callback ID.
|
286
291
|
# @param [String] parent
|
287
292
|
# Required. Name of the execution for which the callbacks should be listed.
|
288
293
|
# Format: projects/`project`/locations/`location`/workflows/`workflow`/
|
@@ -323,6 +328,99 @@ module Google
|
|
323
328
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
324
329
|
execute_or_queue_command(command, &block)
|
325
330
|
end
|
331
|
+
|
332
|
+
# Gets a step entry.
|
333
|
+
# @param [String] name
|
334
|
+
# Required. The name of the step entry to retrieve. Format: projects/`project`/
|
335
|
+
# locations/`location`/workflows/`workflow`/executions/`execution`/stepEntries/`
|
336
|
+
# step_entry`
|
337
|
+
# @param [String] fields
|
338
|
+
# Selector specifying which fields to include in a partial response.
|
339
|
+
# @param [String] quota_user
|
340
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
341
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
342
|
+
# @param [Google::Apis::RequestOptions] options
|
343
|
+
# Request-specific options
|
344
|
+
#
|
345
|
+
# @yield [result, err] Result & error if block supplied
|
346
|
+
# @yieldparam result [Google::Apis::WorkflowexecutionsV1::StepEntry] parsed result object
|
347
|
+
# @yieldparam err [StandardError] error object if request failed
|
348
|
+
#
|
349
|
+
# @return [Google::Apis::WorkflowexecutionsV1::StepEntry]
|
350
|
+
#
|
351
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
352
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
353
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
354
|
+
def get_project_location_workflow_execution_step_entry(name, fields: nil, quota_user: nil, options: nil, &block)
|
355
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
356
|
+
command.response_representation = Google::Apis::WorkflowexecutionsV1::StepEntry::Representation
|
357
|
+
command.response_class = Google::Apis::WorkflowexecutionsV1::StepEntry
|
358
|
+
command.params['name'] = name unless name.nil?
|
359
|
+
command.query['fields'] = fields unless fields.nil?
|
360
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
361
|
+
execute_or_queue_command(command, &block)
|
362
|
+
end
|
363
|
+
|
364
|
+
# Lists step entries for the corresponding workflow execution. Returned entries
|
365
|
+
# are ordered by their create_time.
|
366
|
+
# @param [String] parent
|
367
|
+
# Required. Name of the workflow execution to list entries for. Format: projects/
|
368
|
+
# `project`/locations/`location`/workflows/`workflow`/executions/`execution`/
|
369
|
+
# stepEntries/
|
370
|
+
# @param [String] filter
|
371
|
+
# Optional. Filters applied to the `[StepEntries.ListStepEntries]` results. The
|
372
|
+
# following fields are supported for filtering: `entryId`, `createTime`, `
|
373
|
+
# updateTime`, `routine`, `step`, `stepType`, `state`. For details, see AIP-160.
|
374
|
+
# For example, if you are using the Google APIs Explorer: `state="SUCCEEDED"` or
|
375
|
+
# `createTime>"2023-08-01" AND state="FAILED"`
|
376
|
+
# @param [String] order_by
|
377
|
+
# Optional. Comma-separated list of fields that specify the ordering applied to
|
378
|
+
# the `[StepEntries.ListStepEntries]` results. By default the ordering is based
|
379
|
+
# on ascending `entryId`. The following fields are supported for ordering: `
|
380
|
+
# entryId`, `createTime`, `updateTime`, `routine`, `step`, `stepType`, `state`.
|
381
|
+
# For details, see AIP-132.
|
382
|
+
# @param [Fixnum] page_size
|
383
|
+
# Optional. Number of step entries to return per call. The default max is 1000.
|
384
|
+
# @param [String] page_token
|
385
|
+
# Optional. A page token, received from a previous `ListStepEntries` call.
|
386
|
+
# Provide this to retrieve the subsequent page. When paginating, all other
|
387
|
+
# parameters provided to `ListStepEntries` must match the call that provided the
|
388
|
+
# page token.
|
389
|
+
# @param [Fixnum] skip
|
390
|
+
# Optional. The number of step entries to skip. It can be used with or without a
|
391
|
+
# pageToken. If used with a pageToken, then it indicates the number of step
|
392
|
+
# entries to skip starting from the requested page.
|
393
|
+
# @param [String] fields
|
394
|
+
# Selector specifying which fields to include in a partial response.
|
395
|
+
# @param [String] quota_user
|
396
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
397
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
398
|
+
# @param [Google::Apis::RequestOptions] options
|
399
|
+
# Request-specific options
|
400
|
+
#
|
401
|
+
# @yield [result, err] Result & error if block supplied
|
402
|
+
# @yieldparam result [Google::Apis::WorkflowexecutionsV1::ListStepEntriesResponse] parsed result object
|
403
|
+
# @yieldparam err [StandardError] error object if request failed
|
404
|
+
#
|
405
|
+
# @return [Google::Apis::WorkflowexecutionsV1::ListStepEntriesResponse]
|
406
|
+
#
|
407
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
408
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
409
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
410
|
+
def list_project_location_workflow_execution_step_entries(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, skip: nil, fields: nil, quota_user: nil, options: nil, &block)
|
411
|
+
command = make_simple_command(:get, 'v1/{+parent}/stepEntries', options)
|
412
|
+
command.response_representation = Google::Apis::WorkflowexecutionsV1::ListStepEntriesResponse::Representation
|
413
|
+
command.response_class = Google::Apis::WorkflowexecutionsV1::ListStepEntriesResponse
|
414
|
+
command.params['parent'] = parent unless parent.nil?
|
415
|
+
command.query['filter'] = filter unless filter.nil?
|
416
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
417
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
418
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
419
|
+
command.query['skip'] = skip unless skip.nil?
|
420
|
+
command.query['fields'] = fields unless fields.nil?
|
421
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
422
|
+
execute_or_queue_command(command, &block)
|
423
|
+
end
|
326
424
|
|
327
425
|
protected
|
328
426
|
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-workflowexecutions_v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.29.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-10-29 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -58,7 +58,7 @@ licenses:
|
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-workflowexecutions_v1/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-workflowexecutions_v1/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-workflowexecutions_v1/v0.29.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-workflowexecutions_v1
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|