google-apis-workflowexecutions_v1 0.25.0 → 0.27.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d79f44fefc117ab0411e25a926c77b89db273192e8ebe274adeee3d59ea8f62e
4
- data.tar.gz: bdefd0742be3bb5280d52d042c79fd6a2964fb887efdbed36f961ea55963e79c
3
+ metadata.gz: 1d140cc0f9a69f2a9730b20d55c27e70c90468e11fb689304e25f925b52dfcb7
4
+ data.tar.gz: 0cbdd954311552e80743983a63baa6b9340fea5090a3b9262f9d1c3803b48302
5
5
  SHA512:
6
- metadata.gz: dd661a06f574aa5160a991a9f48eb3e976d2f7d006c490f1996254c72b80dc3327211aa9841009a452934b7dcc2e72d4653de2a9a041a295667b3fb13be32773
7
- data.tar.gz: 5eda431713ea0d929acc3a67b3bc03bc0855f6f985034519dde2d2bcbc540ef1f5f28c2ab81f4803ee1ef3119bb82201d00d9415b509f638cddf2a802c21a2a1
6
+ metadata.gz: eb6074a4ab7db975e80ee8bdd091db0dcea456490001f56813c7f58b37e8a9c412aaa36582cbd031576e127af9c22074a24bba2a1d86638d0e540e86b4003635
7
+ data.tar.gz: d63d50ba4d1ac0ff75540e23eadf2bd8cb0660865ced528e44d58790fac5e9a1e317811a81e20530558a0f592e4e9920212b814e764c3dee9d179af28f6b1963
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-workflowexecutions_v1
2
2
 
3
+ ### v0.27.0 (2023-09-10)
4
+
5
+ * Regenerated from discovery document revision 20230829
6
+
7
+ ### v0.26.0 (2023-07-16)
8
+
9
+ * Regenerated from discovery document revision 20230710
10
+
3
11
  ### v0.25.0 (2023-06-18)
4
12
 
5
13
  * Regenerated from discovery document revision 20230607
@@ -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
@@ -237,30 +323,31 @@ module Google
237
323
  class PubsubMessage
238
324
  include Google::Apis::Core::Hashable
239
325
 
240
- # Attributes for this message. If this field is empty, the message must contain
241
- # non-empty data. This can be used to filter messages on the subscription.
326
+ # Optional. Attributes for this message. If this field is empty, the message
327
+ # must contain non-empty data. This can be used to filter messages on the
328
+ # subscription.
242
329
  # Corresponds to the JSON property `attributes`
243
330
  # @return [Hash<String,String>]
244
331
  attr_accessor :attributes
245
332
 
246
- # The message data field. If this field is empty, the message must contain at
247
- # least one attribute.
333
+ # Optional. The message data field. If this field is empty, the message must
334
+ # contain at least one attribute.
248
335
  # Corresponds to the JSON property `data`
249
336
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
250
337
  # @return [String]
251
338
  attr_accessor :data
252
339
 
253
- # ID of this message, assigned by the server when the message is published.
254
- # Guaranteed to be unique within the topic. This value may be read by a
255
- # subscriber that receives a `PubsubMessage` via a `Pull` call or a push
340
+ # Optional. ID of this message, assigned by the server when the message is
341
+ # published. Guaranteed to be unique within the topic. This value may be read by
342
+ # a subscriber that receives a `PubsubMessage` via a `Pull` call or a push
256
343
  # delivery. It must not be populated by the publisher in a `Publish` call.
257
344
  # Corresponds to the JSON property `messageId`
258
345
  # @return [String]
259
346
  attr_accessor :message_id
260
347
 
261
- # If non-empty, identifies related messages for which publish order should be
262
- # respected. If a `Subscription` has `enable_message_ordering` set to `true`,
263
- # messages published with the same non-empty `ordering_key` value will be
348
+ # Optional. If non-empty, identifies related messages for which publish order
349
+ # should be respected. If a `Subscription` has `enable_message_ordering` set to `
350
+ # true`, messages published with the same non-empty `ordering_key` value will be
264
351
  # delivered to subscribers in the order in which they are received by the Pub/
265
352
  # Sub system. All `PubsubMessage`s published in a given `PublishRequest` must
266
353
  # specify the same `ordering_key` value. For more information, see [ordering
@@ -269,9 +356,9 @@ module Google
269
356
  # @return [String]
270
357
  attr_accessor :ordering_key
271
358
 
272
- # The time at which the message was published, populated by the server when it
273
- # receives the `Publish` call. It must not be populated by the publisher in a `
274
- # Publish` call.
359
+ # Optional. The time at which the message was published, populated by the server
360
+ # when it receives the `Publish` call. It must not be populated by the publisher
361
+ # in a `Publish` call.
275
362
  # Corresponds to the JSON property `publishTime`
276
363
  # @return [String]
277
364
  attr_accessor :publish_time
@@ -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.25.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 = "20230607"
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.25.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-06-18 00:00:00.000000000 Z
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.25.0
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.2
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