google-apis-workflowexecutions_v1 0.26.0 → 0.27.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/google/apis/workflowexecutions_v1/classes.rb +86 -0
- data/lib/google/apis/workflowexecutions_v1/gem_version.rb +2 -2
- data/lib/google/apis/workflowexecutions_v1/representations.rb +44 -0
- data/lib/google/apis/workflowexecutions_v1/service.rb +75 -0
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1d140cc0f9a69f2a9730b20d55c27e70c90468e11fb689304e25f925b52dfcb7
|
4
|
+
data.tar.gz: 0cbdd954311552e80743983a63baa6b9340fea5090a3b9262f9d1c3803b48302
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: eb6074a4ab7db975e80ee8bdd091db0dcea456490001f56813c7f58b37e8a9c412aaa36582cbd031576e127af9c22074a24bba2a1d86638d0e540e86b4003635
|
7
|
+
data.tar.gz: d63d50ba4d1ac0ff75540e23eadf2bd8cb0660865ced528e44d58790fac5e9a1e317811a81e20530558a0f592e4e9920212b814e764c3dee9d179af28f6b1963
|
data/CHANGELOG.md
CHANGED
@@ -22,6 +22,46 @@ module Google
|
|
22
22
|
module Apis
|
23
23
|
module WorkflowexecutionsV1
|
24
24
|
|
25
|
+
# An instance of a Callback created by an execution.
|
26
|
+
class Callback
|
27
|
+
include Google::Apis::Core::Hashable
|
28
|
+
|
29
|
+
# Output only. The payloads received by the callback that have not been
|
30
|
+
# processed by a waiting execution step.
|
31
|
+
# Corresponds to the JSON property `availablePayloads`
|
32
|
+
# @return [Array<String>]
|
33
|
+
attr_accessor :available_payloads
|
34
|
+
|
35
|
+
# Output only. The method accepted by the callback. E.g. GET, POST, PUT.
|
36
|
+
# Corresponds to the JSON property `method`
|
37
|
+
# @return [String]
|
38
|
+
attr_accessor :method_prop
|
39
|
+
|
40
|
+
# Output only. The resource name of the callback. Format: projects/`project`/
|
41
|
+
# locations/`location`/workflows/`workflow`/executions/`execution`/callback/`
|
42
|
+
# callback`
|
43
|
+
# Corresponds to the JSON property `name`
|
44
|
+
# @return [String]
|
45
|
+
attr_accessor :name
|
46
|
+
|
47
|
+
# Output only. Number of execution steps waiting on this callback.
|
48
|
+
# Corresponds to the JSON property `waiters`
|
49
|
+
# @return [Fixnum]
|
50
|
+
attr_accessor :waiters
|
51
|
+
|
52
|
+
def initialize(**args)
|
53
|
+
update!(**args)
|
54
|
+
end
|
55
|
+
|
56
|
+
# Update properties of this object
|
57
|
+
def update!(**args)
|
58
|
+
@available_payloads = args[:available_payloads] if args.key?(:available_payloads)
|
59
|
+
@method_prop = args[:method_prop] if args.key?(:method_prop)
|
60
|
+
@name = args[:name] if args.key?(:name)
|
61
|
+
@waiters = args[:waiters] if args.key?(:waiters)
|
62
|
+
end
|
63
|
+
end
|
64
|
+
|
25
65
|
# Request for the CancelExecution method.
|
26
66
|
class CancelExecutionRequest
|
27
67
|
include Google::Apis::Core::Hashable
|
@@ -168,6 +208,52 @@ module Google
|
|
168
208
|
end
|
169
209
|
end
|
170
210
|
|
211
|
+
# Response for the ExportData method.
|
212
|
+
class ExportDataResponse
|
213
|
+
include Google::Apis::Core::Hashable
|
214
|
+
|
215
|
+
# The JSON string with customer data and metadata of an execution of the given
|
216
|
+
# name
|
217
|
+
# Corresponds to the JSON property `data`
|
218
|
+
# @return [String]
|
219
|
+
attr_accessor :data
|
220
|
+
|
221
|
+
def initialize(**args)
|
222
|
+
update!(**args)
|
223
|
+
end
|
224
|
+
|
225
|
+
# Update properties of this object
|
226
|
+
def update!(**args)
|
227
|
+
@data = args[:data] if args.key?(:data)
|
228
|
+
end
|
229
|
+
end
|
230
|
+
|
231
|
+
# RPC response object for the ListCallbacks method.
|
232
|
+
class ListCallbacksResponse
|
233
|
+
include Google::Apis::Core::Hashable
|
234
|
+
|
235
|
+
# The callbacks which match the request.
|
236
|
+
# Corresponds to the JSON property `callbacks`
|
237
|
+
# @return [Array<Google::Apis::WorkflowexecutionsV1::Callback>]
|
238
|
+
attr_accessor :callbacks
|
239
|
+
|
240
|
+
# A token, which can be sent as `page_token` to retrieve the next page. If this
|
241
|
+
# field is omitted, there are no subsequent pages.
|
242
|
+
# Corresponds to the JSON property `nextPageToken`
|
243
|
+
# @return [String]
|
244
|
+
attr_accessor :next_page_token
|
245
|
+
|
246
|
+
def initialize(**args)
|
247
|
+
update!(**args)
|
248
|
+
end
|
249
|
+
|
250
|
+
# Update properties of this object
|
251
|
+
def update!(**args)
|
252
|
+
@callbacks = args[:callbacks] if args.key?(:callbacks)
|
253
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
254
|
+
end
|
255
|
+
end
|
256
|
+
|
171
257
|
# Response for the ListExecutions method.
|
172
258
|
class ListExecutionsResponse
|
173
259
|
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.27.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 = "20230829"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -22,6 +22,12 @@ module Google
|
|
22
22
|
module Apis
|
23
23
|
module WorkflowexecutionsV1
|
24
24
|
|
25
|
+
class Callback
|
26
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
27
|
+
|
28
|
+
include Google::Apis::Core::JsonObjectSupport
|
29
|
+
end
|
30
|
+
|
25
31
|
class CancelExecutionRequest
|
26
32
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
27
33
|
|
@@ -40,6 +46,18 @@ module Google
|
|
40
46
|
include Google::Apis::Core::JsonObjectSupport
|
41
47
|
end
|
42
48
|
|
49
|
+
class ExportDataResponse
|
50
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
51
|
+
|
52
|
+
include Google::Apis::Core::JsonObjectSupport
|
53
|
+
end
|
54
|
+
|
55
|
+
class ListCallbacksResponse
|
56
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
57
|
+
|
58
|
+
include Google::Apis::Core::JsonObjectSupport
|
59
|
+
end
|
60
|
+
|
43
61
|
class ListExecutionsResponse
|
44
62
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
45
63
|
|
@@ -94,6 +112,16 @@ module Google
|
|
94
112
|
include Google::Apis::Core::JsonObjectSupport
|
95
113
|
end
|
96
114
|
|
115
|
+
class Callback
|
116
|
+
# @private
|
117
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
118
|
+
collection :available_payloads, as: 'availablePayloads'
|
119
|
+
property :method_prop, as: 'method'
|
120
|
+
property :name, as: 'name'
|
121
|
+
property :waiters, :numeric_string => true, as: 'waiters'
|
122
|
+
end
|
123
|
+
end
|
124
|
+
|
97
125
|
class CancelExecutionRequest
|
98
126
|
# @private
|
99
127
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -132,6 +160,22 @@ module Google
|
|
132
160
|
end
|
133
161
|
end
|
134
162
|
|
163
|
+
class ExportDataResponse
|
164
|
+
# @private
|
165
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
166
|
+
property :data, as: 'data'
|
167
|
+
end
|
168
|
+
end
|
169
|
+
|
170
|
+
class ListCallbacksResponse
|
171
|
+
# @private
|
172
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
173
|
+
collection :callbacks, as: 'callbacks', class: Google::Apis::WorkflowexecutionsV1::Callback, decorator: Google::Apis::WorkflowexecutionsV1::Callback::Representation
|
174
|
+
|
175
|
+
property :next_page_token, as: 'nextPageToken'
|
176
|
+
end
|
177
|
+
end
|
178
|
+
|
135
179
|
class ListExecutionsResponse
|
136
180
|
# @private
|
137
181
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -153,6 +153,38 @@ module Google
|
|
153
153
|
execute_or_queue_command(command, &block)
|
154
154
|
end
|
155
155
|
|
156
|
+
# Returns all metadata stored about an execution, excluding most data that is
|
157
|
+
# already accessible via other API methods.
|
158
|
+
# @param [String] name
|
159
|
+
# Required. Name of the execution to be data exported. Format: projects/`project`
|
160
|
+
# /locations/`location`/workflows/`workflow`/executions/`execution`
|
161
|
+
# @param [String] fields
|
162
|
+
# Selector specifying which fields to include in a partial response.
|
163
|
+
# @param [String] quota_user
|
164
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
165
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
166
|
+
# @param [Google::Apis::RequestOptions] options
|
167
|
+
# Request-specific options
|
168
|
+
#
|
169
|
+
# @yield [result, err] Result & error if block supplied
|
170
|
+
# @yieldparam result [Google::Apis::WorkflowexecutionsV1::ExportDataResponse] parsed result object
|
171
|
+
# @yieldparam err [StandardError] error object if request failed
|
172
|
+
#
|
173
|
+
# @return [Google::Apis::WorkflowexecutionsV1::ExportDataResponse]
|
174
|
+
#
|
175
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
176
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
177
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
178
|
+
def export_project_location_workflow_execution_data(name, fields: nil, quota_user: nil, options: nil, &block)
|
179
|
+
command = make_simple_command(:get, 'v1/{+name}:exportData', options)
|
180
|
+
command.response_representation = Google::Apis::WorkflowexecutionsV1::ExportDataResponse::Representation
|
181
|
+
command.response_class = Google::Apis::WorkflowexecutionsV1::ExportDataResponse
|
182
|
+
command.params['name'] = name unless name.nil?
|
183
|
+
command.query['fields'] = fields unless fields.nil?
|
184
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
185
|
+
execute_or_queue_command(command, &block)
|
186
|
+
end
|
187
|
+
|
156
188
|
# Returns an execution of the given name.
|
157
189
|
# @param [String] name
|
158
190
|
# Required. Name of the execution to be retrieved. Format: projects/`project`/
|
@@ -248,6 +280,49 @@ module Google
|
|
248
280
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
249
281
|
execute_or_queue_command(command, &block)
|
250
282
|
end
|
283
|
+
|
284
|
+
# Returns a list of active callbacks which belong to the execution with the
|
285
|
+
# given name. The returned callbacks are ordered by callback ID. first).
|
286
|
+
# @param [String] parent
|
287
|
+
# Required. Name of the execution for which the callbacks should be listed.
|
288
|
+
# Format: projects/`project`/locations/`location`/workflows/`workflow`/
|
289
|
+
# executions/`execution`
|
290
|
+
# @param [Fixnum] page_size
|
291
|
+
# Maximum number of callbacks to return per call. The default value is 100 and
|
292
|
+
# is also the maximum value.
|
293
|
+
# @param [String] page_token
|
294
|
+
# A page token, received from a previous `ListCallbacks` call. Provide this to
|
295
|
+
# retrieve the subsequent page. Note that pagination is applied to dynamic data.
|
296
|
+
# The list of callbacks returned can change between page requests if callbacks
|
297
|
+
# are created or deleted.
|
298
|
+
# @param [String] fields
|
299
|
+
# Selector specifying which fields to include in a partial response.
|
300
|
+
# @param [String] quota_user
|
301
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
302
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
303
|
+
# @param [Google::Apis::RequestOptions] options
|
304
|
+
# Request-specific options
|
305
|
+
#
|
306
|
+
# @yield [result, err] Result & error if block supplied
|
307
|
+
# @yieldparam result [Google::Apis::WorkflowexecutionsV1::ListCallbacksResponse] parsed result object
|
308
|
+
# @yieldparam err [StandardError] error object if request failed
|
309
|
+
#
|
310
|
+
# @return [Google::Apis::WorkflowexecutionsV1::ListCallbacksResponse]
|
311
|
+
#
|
312
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
313
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
314
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
315
|
+
def list_project_location_workflow_execution_callbacks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
316
|
+
command = make_simple_command(:get, 'v1/{+parent}/callbacks', options)
|
317
|
+
command.response_representation = Google::Apis::WorkflowexecutionsV1::ListCallbacksResponse::Representation
|
318
|
+
command.response_class = Google::Apis::WorkflowexecutionsV1::ListCallbacksResponse
|
319
|
+
command.params['parent'] = parent unless parent.nil?
|
320
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
321
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
322
|
+
command.query['fields'] = fields unless fields.nil?
|
323
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
324
|
+
execute_or_queue_command(command, &block)
|
325
|
+
end
|
251
326
|
|
252
327
|
protected
|
253
328
|
|
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.27.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-09-10 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.27.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: []
|
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
75
75
|
- !ruby/object:Gem::Version
|
76
76
|
version: '0'
|
77
77
|
requirements: []
|
78
|
-
rubygems_version: 3.4.
|
78
|
+
rubygems_version: 3.4.19
|
79
79
|
signing_key:
|
80
80
|
specification_version: 4
|
81
81
|
summary: Simple REST client for Workflow Executions API V1
|