google-cloud-workflows-v1beta 0.4.0 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,345 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "google/cloud/workflows/v1beta/workflows_pb"
20
+
21
+ module Google
22
+ module Cloud
23
+ module Workflows
24
+ module V1beta
25
+ module Workflows
26
+ module Rest
27
+ ##
28
+ # REST service stub for the Workflows service.
29
+ # Service stub contains baseline method implementations
30
+ # including transcoding, making the REST call, and deserialing the response.
31
+ #
32
+ class ServiceStub
33
+ def initialize endpoint:, credentials:
34
+ # These require statements are intentionally placed here to initialize
35
+ # the REST modules only when it's required.
36
+ require "gapic/rest"
37
+
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
39
+ numeric_enums: true,
40
+ raise_faraday_errors: false
41
+ end
42
+
43
+ ##
44
+ # Baseline implementation for the list_workflows REST call
45
+ #
46
+ # @param request_pb [::Google::Cloud::Workflows::V1beta::ListWorkflowsRequest]
47
+ # A request object representing the call parameters. Required.
48
+ # @param options [::Gapic::CallOptions]
49
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
50
+ #
51
+ # @yield [result, operation] Access the result along with the TransportOperation object
52
+ # @yieldparam result [::Google::Cloud::Workflows::V1beta::ListWorkflowsResponse]
53
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
54
+ #
55
+ # @return [::Google::Cloud::Workflows::V1beta::ListWorkflowsResponse]
56
+ # A result object deserialized from the server's reply
57
+ def list_workflows request_pb, options = nil
58
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
59
+
60
+ verb, uri, query_string_params, body = ServiceStub.transcode_list_workflows_request request_pb
61
+ query_string_params = if query_string_params.any?
62
+ query_string_params.to_h { |p| p.split("=", 2) }
63
+ else
64
+ {}
65
+ end
66
+
67
+ response = @client_stub.make_http_request(
68
+ verb,
69
+ uri: uri,
70
+ body: body || "",
71
+ params: query_string_params,
72
+ options: options
73
+ )
74
+ operation = ::Gapic::Rest::TransportOperation.new response
75
+ result = ::Google::Cloud::Workflows::V1beta::ListWorkflowsResponse.decode_json response.body, ignore_unknown_fields: true
76
+
77
+ yield result, operation if block_given?
78
+ result
79
+ end
80
+
81
+ ##
82
+ # Baseline implementation for the get_workflow REST call
83
+ #
84
+ # @param request_pb [::Google::Cloud::Workflows::V1beta::GetWorkflowRequest]
85
+ # A request object representing the call parameters. Required.
86
+ # @param options [::Gapic::CallOptions]
87
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
88
+ #
89
+ # @yield [result, operation] Access the result along with the TransportOperation object
90
+ # @yieldparam result [::Google::Cloud::Workflows::V1beta::Workflow]
91
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
92
+ #
93
+ # @return [::Google::Cloud::Workflows::V1beta::Workflow]
94
+ # A result object deserialized from the server's reply
95
+ def get_workflow request_pb, options = nil
96
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
97
+
98
+ verb, uri, query_string_params, body = ServiceStub.transcode_get_workflow_request request_pb
99
+ query_string_params = if query_string_params.any?
100
+ query_string_params.to_h { |p| p.split("=", 2) }
101
+ else
102
+ {}
103
+ end
104
+
105
+ response = @client_stub.make_http_request(
106
+ verb,
107
+ uri: uri,
108
+ body: body || "",
109
+ params: query_string_params,
110
+ options: options
111
+ )
112
+ operation = ::Gapic::Rest::TransportOperation.new response
113
+ result = ::Google::Cloud::Workflows::V1beta::Workflow.decode_json response.body, ignore_unknown_fields: true
114
+
115
+ yield result, operation if block_given?
116
+ result
117
+ end
118
+
119
+ ##
120
+ # Baseline implementation for the create_workflow REST call
121
+ #
122
+ # @param request_pb [::Google::Cloud::Workflows::V1beta::CreateWorkflowRequest]
123
+ # A request object representing the call parameters. Required.
124
+ # @param options [::Gapic::CallOptions]
125
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
126
+ #
127
+ # @yield [result, operation] Access the result along with the TransportOperation object
128
+ # @yieldparam result [::Google::Longrunning::Operation]
129
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
130
+ #
131
+ # @return [::Google::Longrunning::Operation]
132
+ # A result object deserialized from the server's reply
133
+ def create_workflow request_pb, options = nil
134
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
135
+
136
+ verb, uri, query_string_params, body = ServiceStub.transcode_create_workflow_request request_pb
137
+ query_string_params = if query_string_params.any?
138
+ query_string_params.to_h { |p| p.split("=", 2) }
139
+ else
140
+ {}
141
+ end
142
+
143
+ response = @client_stub.make_http_request(
144
+ verb,
145
+ uri: uri,
146
+ body: body || "",
147
+ params: query_string_params,
148
+ options: options
149
+ )
150
+ operation = ::Gapic::Rest::TransportOperation.new response
151
+ result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
152
+
153
+ yield result, operation if block_given?
154
+ result
155
+ end
156
+
157
+ ##
158
+ # Baseline implementation for the delete_workflow REST call
159
+ #
160
+ # @param request_pb [::Google::Cloud::Workflows::V1beta::DeleteWorkflowRequest]
161
+ # A request object representing the call parameters. Required.
162
+ # @param options [::Gapic::CallOptions]
163
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
164
+ #
165
+ # @yield [result, operation] Access the result along with the TransportOperation object
166
+ # @yieldparam result [::Google::Longrunning::Operation]
167
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
168
+ #
169
+ # @return [::Google::Longrunning::Operation]
170
+ # A result object deserialized from the server's reply
171
+ def delete_workflow request_pb, options = nil
172
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
173
+
174
+ verb, uri, query_string_params, body = ServiceStub.transcode_delete_workflow_request request_pb
175
+ query_string_params = if query_string_params.any?
176
+ query_string_params.to_h { |p| p.split("=", 2) }
177
+ else
178
+ {}
179
+ end
180
+
181
+ response = @client_stub.make_http_request(
182
+ verb,
183
+ uri: uri,
184
+ body: body || "",
185
+ params: query_string_params,
186
+ options: options
187
+ )
188
+ operation = ::Gapic::Rest::TransportOperation.new response
189
+ result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
190
+
191
+ yield result, operation if block_given?
192
+ result
193
+ end
194
+
195
+ ##
196
+ # Baseline implementation for the update_workflow REST call
197
+ #
198
+ # @param request_pb [::Google::Cloud::Workflows::V1beta::UpdateWorkflowRequest]
199
+ # A request object representing the call parameters. Required.
200
+ # @param options [::Gapic::CallOptions]
201
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
202
+ #
203
+ # @yield [result, operation] Access the result along with the TransportOperation object
204
+ # @yieldparam result [::Google::Longrunning::Operation]
205
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
206
+ #
207
+ # @return [::Google::Longrunning::Operation]
208
+ # A result object deserialized from the server's reply
209
+ def update_workflow request_pb, options = nil
210
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
211
+
212
+ verb, uri, query_string_params, body = ServiceStub.transcode_update_workflow_request request_pb
213
+ query_string_params = if query_string_params.any?
214
+ query_string_params.to_h { |p| p.split("=", 2) }
215
+ else
216
+ {}
217
+ end
218
+
219
+ response = @client_stub.make_http_request(
220
+ verb,
221
+ uri: uri,
222
+ body: body || "",
223
+ params: query_string_params,
224
+ options: options
225
+ )
226
+ operation = ::Gapic::Rest::TransportOperation.new response
227
+ result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
228
+
229
+ yield result, operation if block_given?
230
+ result
231
+ end
232
+
233
+ ##
234
+ # @private
235
+ #
236
+ # GRPC transcoding helper method for the list_workflows REST call
237
+ #
238
+ # @param request_pb [::Google::Cloud::Workflows::V1beta::ListWorkflowsRequest]
239
+ # A request object representing the call parameters. Required.
240
+ # @return [Array(String, [String, nil], Hash{String => String})]
241
+ # Uri, Body, Query string parameters
242
+ def self.transcode_list_workflows_request request_pb
243
+ transcoder = Gapic::Rest::GrpcTranscoder.new
244
+ .with_bindings(
245
+ uri_method: :get,
246
+ uri_template: "/v1beta/{parent}/workflows",
247
+ matches: [
248
+ ["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
249
+ ]
250
+ )
251
+ transcoder.transcode request_pb
252
+ end
253
+
254
+ ##
255
+ # @private
256
+ #
257
+ # GRPC transcoding helper method for the get_workflow REST call
258
+ #
259
+ # @param request_pb [::Google::Cloud::Workflows::V1beta::GetWorkflowRequest]
260
+ # A request object representing the call parameters. Required.
261
+ # @return [Array(String, [String, nil], Hash{String => String})]
262
+ # Uri, Body, Query string parameters
263
+ def self.transcode_get_workflow_request request_pb
264
+ transcoder = Gapic::Rest::GrpcTranscoder.new
265
+ .with_bindings(
266
+ uri_method: :get,
267
+ uri_template: "/v1beta/{name}",
268
+ matches: [
269
+ ["name", %r{^projects/[^/]+/locations/[^/]+/workflows/[^/]+/?$}, false]
270
+ ]
271
+ )
272
+ transcoder.transcode request_pb
273
+ end
274
+
275
+ ##
276
+ # @private
277
+ #
278
+ # GRPC transcoding helper method for the create_workflow REST call
279
+ #
280
+ # @param request_pb [::Google::Cloud::Workflows::V1beta::CreateWorkflowRequest]
281
+ # A request object representing the call parameters. Required.
282
+ # @return [Array(String, [String, nil], Hash{String => String})]
283
+ # Uri, Body, Query string parameters
284
+ def self.transcode_create_workflow_request request_pb
285
+ transcoder = Gapic::Rest::GrpcTranscoder.new
286
+ .with_bindings(
287
+ uri_method: :post,
288
+ uri_template: "/v1beta/{parent}/workflows",
289
+ body: "workflow",
290
+ matches: [
291
+ ["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
292
+ ]
293
+ )
294
+ transcoder.transcode request_pb
295
+ end
296
+
297
+ ##
298
+ # @private
299
+ #
300
+ # GRPC transcoding helper method for the delete_workflow REST call
301
+ #
302
+ # @param request_pb [::Google::Cloud::Workflows::V1beta::DeleteWorkflowRequest]
303
+ # A request object representing the call parameters. Required.
304
+ # @return [Array(String, [String, nil], Hash{String => String})]
305
+ # Uri, Body, Query string parameters
306
+ def self.transcode_delete_workflow_request request_pb
307
+ transcoder = Gapic::Rest::GrpcTranscoder.new
308
+ .with_bindings(
309
+ uri_method: :delete,
310
+ uri_template: "/v1beta/{name}",
311
+ matches: [
312
+ ["name", %r{^projects/[^/]+/locations/[^/]+/workflows/[^/]+/?$}, false]
313
+ ]
314
+ )
315
+ transcoder.transcode request_pb
316
+ end
317
+
318
+ ##
319
+ # @private
320
+ #
321
+ # GRPC transcoding helper method for the update_workflow REST call
322
+ #
323
+ # @param request_pb [::Google::Cloud::Workflows::V1beta::UpdateWorkflowRequest]
324
+ # A request object representing the call parameters. Required.
325
+ # @return [Array(String, [String, nil], Hash{String => String})]
326
+ # Uri, Body, Query string parameters
327
+ def self.transcode_update_workflow_request request_pb
328
+ transcoder = Gapic::Rest::GrpcTranscoder.new
329
+ .with_bindings(
330
+ uri_method: :patch,
331
+ uri_template: "/v1beta/{workflow.name}",
332
+ body: "workflow",
333
+ matches: [
334
+ ["workflow.name", %r{^projects/[^/]+/locations/[^/]+/workflows/[^/]+/?$}, false]
335
+ ]
336
+ )
337
+ transcoder.transcode request_pb
338
+ end
339
+ end
340
+ end
341
+ end
342
+ end
343
+ end
344
+ end
345
+ end
@@ -0,0 +1,55 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "gapic/rest"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/cloud/workflows/v1beta/version"
24
+
25
+ require "google/cloud/workflows/v1beta/workflows/credentials"
26
+ require "google/cloud/workflows/v1beta/workflows/paths"
27
+ require "google/cloud/workflows/v1beta/workflows/rest/operations"
28
+ require "google/cloud/workflows/v1beta/workflows/rest/client"
29
+
30
+ module Google
31
+ module Cloud
32
+ module Workflows
33
+ module V1beta
34
+ ##
35
+ # Workflows is used to deploy and execute workflow programs.
36
+ # Workflows makes sure the program executes reliably, despite hardware and
37
+ # networking interruptions.
38
+ #
39
+ # To load this service and instantiate a REST client:
40
+ #
41
+ # require "google/cloud/workflows/v1beta/workflows/rest"
42
+ # client = ::Google::Cloud::Workflows::V1beta::Workflows::Rest::Client.new
43
+ #
44
+ module Workflows
45
+ # Client for the REST transport
46
+ module Rest
47
+ end
48
+ end
49
+ end
50
+ end
51
+ end
52
+ end
53
+
54
+ helper_path = ::File.join __dir__, "rest", "helpers.rb"
55
+ require "google/cloud/workflows/v1beta/workflows/rest/helpers" if ::File.file? helper_path
@@ -26,6 +26,7 @@ require "google/cloud/workflows/v1beta/workflows/credentials"
26
26
  require "google/cloud/workflows/v1beta/workflows/paths"
27
27
  require "google/cloud/workflows/v1beta/workflows/operations"
28
28
  require "google/cloud/workflows/v1beta/workflows/client"
29
+ require "google/cloud/workflows/v1beta/workflows/rest"
29
30
 
30
31
  module Google
31
32
  module Cloud
@@ -36,11 +37,16 @@ module Google
36
37
  # Workflows makes sure the program executes reliably, despite hardware and
37
38
  # networking interruptions.
38
39
  #
39
- # To load this service and instantiate a client:
40
+ # @example Load this service and instantiate a gRPC client
40
41
  #
41
42
  # require "google/cloud/workflows/v1beta/workflows"
42
43
  # client = ::Google::Cloud::Workflows::V1beta::Workflows::Client.new
43
44
  #
45
+ # @example Load this service and instantiate a REST client
46
+ #
47
+ # require "google/cloud/workflows/v1beta/workflows/rest"
48
+ # client = ::Google::Cloud::Workflows::V1beta::Workflows::Rest::Client.new
49
+ #
44
50
  module Workflows
45
51
  end
46
52
  end
@@ -23,13 +23,18 @@ module Google
23
23
  module Cloud
24
24
  module Workflows
25
25
  ##
26
- # To load this package, including all its services, and instantiate a client:
26
+ # API client module.
27
27
  #
28
- # @example
28
+ # @example Load this package, including all its services, and instantiate a gRPC client
29
29
  #
30
30
  # require "google/cloud/workflows/v1beta"
31
31
  # client = ::Google::Cloud::Workflows::V1beta::Workflows::Client.new
32
32
  #
33
+ # @example Load this package, including all its services, and instantiate a REST client
34
+ #
35
+ # require "google/cloud/workflows/v1beta"
36
+ # client = ::Google::Cloud::Workflows::V1beta::Workflows::Rest::Client.new
37
+ #
33
38
  module V1beta
34
39
  end
35
40
  end