google-apis-datalineage_v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,799 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module DatalineageV1
23
+ # Data Lineage API
24
+ #
25
+ #
26
+ #
27
+ # @example
28
+ # require 'google/apis/datalineage_v1'
29
+ #
30
+ # Datalineage = Google::Apis::DatalineageV1 # Alias the module
31
+ # service = Datalineage::DatalineageService.new
32
+ #
33
+ # @see https://cloud.google.com/data-catalog
34
+ class DatalineageService < Google::Apis::Core::BaseService
35
+ # @return [String]
36
+ # API key. Your API key identifies your project and provides you with API access,
37
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
38
+ attr_accessor :key
39
+
40
+ # @return [String]
41
+ # Available to use for quota purposes for server-side applications. Can be any
42
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
43
+ attr_accessor :quota_user
44
+
45
+ def initialize
46
+ super('https://datalineage.googleapis.com/', '',
47
+ client_name: 'google-apis-datalineage_v1',
48
+ client_version: Google::Apis::DatalineageV1::GEM_VERSION)
49
+ @batch_path = 'batch'
50
+ end
51
+
52
+ # Retrieve information about LineageProcesses associated with specific links.
53
+ # LineageProcesses are transformation pipelines that result in data flowing from
54
+ # **source** to **target** assets. Links between assets represent this operation.
55
+ # If you have specific link names, you can use this method to verify which
56
+ # LineageProcesses contribute to creating those links. See the SearchLinks
57
+ # method for more information on how to retrieve link name. You can retrieve the
58
+ # LineageProcess information in every project where you have the `datalineage.
59
+ # events.get` permission. The project provided in the URL is used for Billing
60
+ # and Quota.
61
+ # @param [String] parent
62
+ # Required. The project and location where you want to search.
63
+ # @param [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest] google_cloud_datacatalog_lineage_v1_batch_search_link_processes_request_object
64
+ # @param [String] fields
65
+ # Selector specifying which fields to include in a partial response.
66
+ # @param [String] quota_user
67
+ # Available to use for quota purposes for server-side applications. Can be any
68
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
69
+ # @param [Google::Apis::RequestOptions] options
70
+ # Request-specific options
71
+ #
72
+ # @yield [result, err] Result & error if block supplied
73
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse] parsed result object
74
+ # @yieldparam err [StandardError] error object if request failed
75
+ #
76
+ # @return [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse]
77
+ #
78
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
79
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
80
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
81
+ def batch_project_location_search_link_processes(parent, google_cloud_datacatalog_lineage_v1_batch_search_link_processes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
82
+ command = make_simple_command(:post, 'v1/{+parent}:batchSearchLinkProcesses', options)
83
+ command.request_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest::Representation
84
+ command.request_object = google_cloud_datacatalog_lineage_v1_batch_search_link_processes_request_object
85
+ command.response_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse::Representation
86
+ command.response_class = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse
87
+ command.params['parent'] = parent unless parent.nil?
88
+ command.query['fields'] = fields unless fields.nil?
89
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
90
+ execute_or_queue_command(command, &block)
91
+ end
92
+
93
+ # Retrieve a list of links connected to a specific asset. Links represent the
94
+ # data flow between **source** (upstream) and **target** (downstream) assets in
95
+ # transformation pipelines. Links are stored in the same project as the Lineage
96
+ # Events that create them. You can retrieve links in every project where you
97
+ # have the `datalineage.events.get` permission. The project provided in the URL
98
+ # is used for Billing and Quota.
99
+ # @param [String] parent
100
+ # Required. The project and location you want search in.
101
+ # @param [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1SearchLinksRequest] google_cloud_datacatalog_lineage_v1_search_links_request_object
102
+ # @param [String] fields
103
+ # Selector specifying which fields to include in a partial response.
104
+ # @param [String] quota_user
105
+ # Available to use for quota purposes for server-side applications. Can be any
106
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
107
+ # @param [Google::Apis::RequestOptions] options
108
+ # Request-specific options
109
+ #
110
+ # @yield [result, err] Result & error if block supplied
111
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1SearchLinksResponse] parsed result object
112
+ # @yieldparam err [StandardError] error object if request failed
113
+ #
114
+ # @return [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1SearchLinksResponse]
115
+ #
116
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
117
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
118
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
119
+ def search_project_location_links(parent, google_cloud_datacatalog_lineage_v1_search_links_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
120
+ command = make_simple_command(:post, 'v1/{+parent}:searchLinks', options)
121
+ command.request_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1SearchLinksRequest::Representation
122
+ command.request_object = google_cloud_datacatalog_lineage_v1_search_links_request_object
123
+ command.response_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1SearchLinksResponse::Representation
124
+ command.response_class = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1SearchLinksResponse
125
+ command.params['parent'] = parent unless parent.nil?
126
+ command.query['fields'] = fields unless fields.nil?
127
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
128
+ execute_or_queue_command(command, &block)
129
+ end
130
+
131
+ # Starts asynchronous cancellation on a long-running operation. The server makes
132
+ # a best effort to cancel the operation, but success is not guaranteed. If the
133
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
134
+ # Clients can use Operations.GetOperation or other methods to check whether the
135
+ # cancellation succeeded or whether the operation completed despite cancellation.
136
+ # On successful cancellation, the operation is not deleted; instead, it becomes
137
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
138
+ # corresponding to `Code.CANCELLED`.
139
+ # @param [String] name
140
+ # The name of the operation resource to be cancelled.
141
+ # @param [Google::Apis::DatalineageV1::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
142
+ # @param [String] fields
143
+ # Selector specifying which fields to include in a partial response.
144
+ # @param [String] quota_user
145
+ # Available to use for quota purposes for server-side applications. Can be any
146
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
147
+ # @param [Google::Apis::RequestOptions] options
148
+ # Request-specific options
149
+ #
150
+ # @yield [result, err] Result & error if block supplied
151
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleProtobufEmpty] parsed result object
152
+ # @yieldparam err [StandardError] error object if request failed
153
+ #
154
+ # @return [Google::Apis::DatalineageV1::GoogleProtobufEmpty]
155
+ #
156
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
157
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
158
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
159
+ def cancel_project_location_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
160
+ command = make_simple_command(:post, 'v1/{+name}:cancel', options)
161
+ command.request_representation = Google::Apis::DatalineageV1::GoogleLongrunningCancelOperationRequest::Representation
162
+ command.request_object = google_longrunning_cancel_operation_request_object
163
+ command.response_representation = Google::Apis::DatalineageV1::GoogleProtobufEmpty::Representation
164
+ command.response_class = Google::Apis::DatalineageV1::GoogleProtobufEmpty
165
+ command.params['name'] = name unless name.nil?
166
+ command.query['fields'] = fields unless fields.nil?
167
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
168
+ execute_or_queue_command(command, &block)
169
+ end
170
+
171
+ # Deletes a long-running operation. This method indicates that the client is no
172
+ # longer interested in the operation result. It does not cancel the operation.
173
+ # If the server doesn't support this method, it returns `google.rpc.Code.
174
+ # UNIMPLEMENTED`.
175
+ # @param [String] name
176
+ # The name of the operation resource to be deleted.
177
+ # @param [String] fields
178
+ # Selector specifying which fields to include in a partial response.
179
+ # @param [String] quota_user
180
+ # Available to use for quota purposes for server-side applications. Can be any
181
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
182
+ # @param [Google::Apis::RequestOptions] options
183
+ # Request-specific options
184
+ #
185
+ # @yield [result, err] Result & error if block supplied
186
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleProtobufEmpty] parsed result object
187
+ # @yieldparam err [StandardError] error object if request failed
188
+ #
189
+ # @return [Google::Apis::DatalineageV1::GoogleProtobufEmpty]
190
+ #
191
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
192
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
193
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
194
+ def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
195
+ command = make_simple_command(:delete, 'v1/{+name}', options)
196
+ command.response_representation = Google::Apis::DatalineageV1::GoogleProtobufEmpty::Representation
197
+ command.response_class = Google::Apis::DatalineageV1::GoogleProtobufEmpty
198
+ command.params['name'] = name unless name.nil?
199
+ command.query['fields'] = fields unless fields.nil?
200
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
201
+ execute_or_queue_command(command, &block)
202
+ end
203
+
204
+ # Gets the latest state of a long-running operation. Clients can use this method
205
+ # to poll the operation result at intervals as recommended by the API service.
206
+ # @param [String] name
207
+ # The name of the operation resource.
208
+ # @param [String] fields
209
+ # Selector specifying which fields to include in a partial response.
210
+ # @param [String] quota_user
211
+ # Available to use for quota purposes for server-side applications. Can be any
212
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
213
+ # @param [Google::Apis::RequestOptions] options
214
+ # Request-specific options
215
+ #
216
+ # @yield [result, err] Result & error if block supplied
217
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleLongrunningOperation] parsed result object
218
+ # @yieldparam err [StandardError] error object if request failed
219
+ #
220
+ # @return [Google::Apis::DatalineageV1::GoogleLongrunningOperation]
221
+ #
222
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
223
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
224
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
225
+ def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
226
+ command = make_simple_command(:get, 'v1/{+name}', options)
227
+ command.response_representation = Google::Apis::DatalineageV1::GoogleLongrunningOperation::Representation
228
+ command.response_class = Google::Apis::DatalineageV1::GoogleLongrunningOperation
229
+ command.params['name'] = name unless name.nil?
230
+ command.query['fields'] = fields unless fields.nil?
231
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
232
+ execute_or_queue_command(command, &block)
233
+ end
234
+
235
+ # Lists operations that match the specified filter in the request. If the server
236
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
237
+ # @param [String] name
238
+ # The name of the operation's parent resource.
239
+ # @param [String] filter
240
+ # The standard list filter.
241
+ # @param [Fixnum] page_size
242
+ # The standard list page size.
243
+ # @param [String] page_token
244
+ # The standard list page token.
245
+ # @param [String] fields
246
+ # Selector specifying which fields to include in a partial response.
247
+ # @param [String] quota_user
248
+ # Available to use for quota purposes for server-side applications. Can be any
249
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
250
+ # @param [Google::Apis::RequestOptions] options
251
+ # Request-specific options
252
+ #
253
+ # @yield [result, err] Result & error if block supplied
254
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleLongrunningListOperationsResponse] parsed result object
255
+ # @yieldparam err [StandardError] error object if request failed
256
+ #
257
+ # @return [Google::Apis::DatalineageV1::GoogleLongrunningListOperationsResponse]
258
+ #
259
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
260
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
261
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
262
+ def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
263
+ command = make_simple_command(:get, 'v1/{+name}/operations', options)
264
+ command.response_representation = Google::Apis::DatalineageV1::GoogleLongrunningListOperationsResponse::Representation
265
+ command.response_class = Google::Apis::DatalineageV1::GoogleLongrunningListOperationsResponse
266
+ command.params['name'] = name unless name.nil?
267
+ command.query['filter'] = filter unless filter.nil?
268
+ command.query['pageSize'] = page_size unless page_size.nil?
269
+ command.query['pageToken'] = page_token unless page_token.nil?
270
+ command.query['fields'] = fields unless fields.nil?
271
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
272
+ execute_or_queue_command(command, &block)
273
+ end
274
+
275
+ # Creates a new process.
276
+ # @param [String] parent
277
+ # Required. The name of the project and its location that should own the process.
278
+ # @param [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Process] google_cloud_datacatalog_lineage_v1_process_object
279
+ # @param [String] request_id
280
+ # A unique identifier for this request. Restricted to 36 ASCII characters. A
281
+ # random UUID is recommended. This request is idempotent only if a `request_id`
282
+ # is provided.
283
+ # @param [String] fields
284
+ # Selector specifying which fields to include in a partial response.
285
+ # @param [String] quota_user
286
+ # Available to use for quota purposes for server-side applications. Can be any
287
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
288
+ # @param [Google::Apis::RequestOptions] options
289
+ # Request-specific options
290
+ #
291
+ # @yield [result, err] Result & error if block supplied
292
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Process] parsed result object
293
+ # @yieldparam err [StandardError] error object if request failed
294
+ #
295
+ # @return [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Process]
296
+ #
297
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
298
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
299
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
300
+ def create_project_location_process(parent, google_cloud_datacatalog_lineage_v1_process_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
301
+ command = make_simple_command(:post, 'v1/{+parent}/processes', options)
302
+ command.request_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Process::Representation
303
+ command.request_object = google_cloud_datacatalog_lineage_v1_process_object
304
+ command.response_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Process::Representation
305
+ command.response_class = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Process
306
+ command.params['parent'] = parent unless parent.nil?
307
+ command.query['requestId'] = request_id unless request_id.nil?
308
+ command.query['fields'] = fields unless fields.nil?
309
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
310
+ execute_or_queue_command(command, &block)
311
+ end
312
+
313
+ # Deletes the process with the specified name.
314
+ # @param [String] name
315
+ # Required. The name of the process to delete.
316
+ # @param [Boolean] allow_missing
317
+ # If set to true and the process is not found, the request succeeds but the
318
+ # server doesn't perform any actions.
319
+ # @param [String] fields
320
+ # Selector specifying which fields to include in a partial response.
321
+ # @param [String] quota_user
322
+ # Available to use for quota purposes for server-side applications. Can be any
323
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
324
+ # @param [Google::Apis::RequestOptions] options
325
+ # Request-specific options
326
+ #
327
+ # @yield [result, err] Result & error if block supplied
328
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleLongrunningOperation] parsed result object
329
+ # @yieldparam err [StandardError] error object if request failed
330
+ #
331
+ # @return [Google::Apis::DatalineageV1::GoogleLongrunningOperation]
332
+ #
333
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
334
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
335
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
336
+ def delete_project_location_process(name, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block)
337
+ command = make_simple_command(:delete, 'v1/{+name}', options)
338
+ command.response_representation = Google::Apis::DatalineageV1::GoogleLongrunningOperation::Representation
339
+ command.response_class = Google::Apis::DatalineageV1::GoogleLongrunningOperation
340
+ command.params['name'] = name unless name.nil?
341
+ command.query['allowMissing'] = allow_missing unless allow_missing.nil?
342
+ command.query['fields'] = fields unless fields.nil?
343
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
344
+ execute_or_queue_command(command, &block)
345
+ end
346
+
347
+ # Gets the details of the specified process.
348
+ # @param [String] name
349
+ # Required. The name of the process to get.
350
+ # @param [String] fields
351
+ # Selector specifying which fields to include in a partial response.
352
+ # @param [String] quota_user
353
+ # Available to use for quota purposes for server-side applications. Can be any
354
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
355
+ # @param [Google::Apis::RequestOptions] options
356
+ # Request-specific options
357
+ #
358
+ # @yield [result, err] Result & error if block supplied
359
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Process] parsed result object
360
+ # @yieldparam err [StandardError] error object if request failed
361
+ #
362
+ # @return [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Process]
363
+ #
364
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
365
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
366
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
367
+ def get_project_location_process(name, fields: nil, quota_user: nil, options: nil, &block)
368
+ command = make_simple_command(:get, 'v1/{+name}', options)
369
+ command.response_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Process::Representation
370
+ command.response_class = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Process
371
+ command.params['name'] = name unless name.nil?
372
+ command.query['fields'] = fields unless fields.nil?
373
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
374
+ execute_or_queue_command(command, &block)
375
+ end
376
+
377
+ # List processes in the given project and location. List order is descending by
378
+ # insertion time.
379
+ # @param [String] parent
380
+ # Required. The name of the project and its location that owns this collection
381
+ # of processes.
382
+ # @param [Fixnum] page_size
383
+ # The maximum number of processes to return. The service may return fewer than
384
+ # this value. If unspecified, at most 50 processes are returned. The maximum
385
+ # value is 100; values greater than 100 are cut to 100.
386
+ # @param [String] page_token
387
+ # The page token received from a previous `ListProcesses` call. Specify it to
388
+ # get the next page. When paginating, all other parameters specified in this
389
+ # call must match the parameters of the call that provided the page token.
390
+ # @param [String] fields
391
+ # Selector specifying which fields to include in a partial response.
392
+ # @param [String] quota_user
393
+ # Available to use for quota purposes for server-side applications. Can be any
394
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
395
+ # @param [Google::Apis::RequestOptions] options
396
+ # Request-specific options
397
+ #
398
+ # @yield [result, err] Result & error if block supplied
399
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1ListProcessesResponse] parsed result object
400
+ # @yieldparam err [StandardError] error object if request failed
401
+ #
402
+ # @return [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1ListProcessesResponse]
403
+ #
404
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
405
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
406
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
407
+ def list_project_location_processes(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
408
+ command = make_simple_command(:get, 'v1/{+parent}/processes', options)
409
+ command.response_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1ListProcessesResponse::Representation
410
+ command.response_class = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1ListProcessesResponse
411
+ command.params['parent'] = parent unless parent.nil?
412
+ command.query['pageSize'] = page_size unless page_size.nil?
413
+ command.query['pageToken'] = page_token unless page_token.nil?
414
+ command.query['fields'] = fields unless fields.nil?
415
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
416
+ execute_or_queue_command(command, &block)
417
+ end
418
+
419
+ # Updates a process.
420
+ # @param [String] name
421
+ # Immutable. The resource name of the lineage process. Format: `projects/`
422
+ # project`/locations/`location`/processes/`process``. Can be specified or auto-
423
+ # assigned. `process` must be not longer than 200 characters and only contain
424
+ # characters in a set: `a-zA-Z0-9_-:.`
425
+ # @param [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Process] google_cloud_datacatalog_lineage_v1_process_object
426
+ # @param [Boolean] allow_missing
427
+ # If set to true and the process is not found, the request inserts it.
428
+ # @param [String] update_mask
429
+ # The list of fields to update. Currently not used. The whole message is updated.
430
+ # @param [String] fields
431
+ # Selector specifying which fields to include in a partial response.
432
+ # @param [String] quota_user
433
+ # Available to use for quota purposes for server-side applications. Can be any
434
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
435
+ # @param [Google::Apis::RequestOptions] options
436
+ # Request-specific options
437
+ #
438
+ # @yield [result, err] Result & error if block supplied
439
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Process] parsed result object
440
+ # @yieldparam err [StandardError] error object if request failed
441
+ #
442
+ # @return [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Process]
443
+ #
444
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
445
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
446
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
447
+ def patch_project_location_process(name, google_cloud_datacatalog_lineage_v1_process_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
448
+ command = make_simple_command(:patch, 'v1/{+name}', options)
449
+ command.request_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Process::Representation
450
+ command.request_object = google_cloud_datacatalog_lineage_v1_process_object
451
+ command.response_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Process::Representation
452
+ command.response_class = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Process
453
+ command.params['name'] = name unless name.nil?
454
+ command.query['allowMissing'] = allow_missing unless allow_missing.nil?
455
+ command.query['updateMask'] = update_mask unless update_mask.nil?
456
+ command.query['fields'] = fields unless fields.nil?
457
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
458
+ execute_or_queue_command(command, &block)
459
+ end
460
+
461
+ # Creates a new run.
462
+ # @param [String] parent
463
+ # Required. The name of the process that should own the run.
464
+ # @param [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Run] google_cloud_datacatalog_lineage_v1_run_object
465
+ # @param [String] request_id
466
+ # A unique identifier for this request. Restricted to 36 ASCII characters. A
467
+ # random UUID is recommended. This request is idempotent only if a `request_id`
468
+ # is provided.
469
+ # @param [String] fields
470
+ # Selector specifying which fields to include in a partial response.
471
+ # @param [String] quota_user
472
+ # Available to use for quota purposes for server-side applications. Can be any
473
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
474
+ # @param [Google::Apis::RequestOptions] options
475
+ # Request-specific options
476
+ #
477
+ # @yield [result, err] Result & error if block supplied
478
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Run] parsed result object
479
+ # @yieldparam err [StandardError] error object if request failed
480
+ #
481
+ # @return [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Run]
482
+ #
483
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
484
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
485
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
486
+ def create_project_location_process_run(parent, google_cloud_datacatalog_lineage_v1_run_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
487
+ command = make_simple_command(:post, 'v1/{+parent}/runs', options)
488
+ command.request_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Run::Representation
489
+ command.request_object = google_cloud_datacatalog_lineage_v1_run_object
490
+ command.response_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Run::Representation
491
+ command.response_class = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Run
492
+ command.params['parent'] = parent unless parent.nil?
493
+ command.query['requestId'] = request_id unless request_id.nil?
494
+ command.query['fields'] = fields unless fields.nil?
495
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
496
+ execute_or_queue_command(command, &block)
497
+ end
498
+
499
+ # Deletes the run with the specified name.
500
+ # @param [String] name
501
+ # Required. The name of the run to delete.
502
+ # @param [Boolean] allow_missing
503
+ # If set to true and the run is not found, the request succeeds but the server
504
+ # doesn't perform any actions.
505
+ # @param [String] fields
506
+ # Selector specifying which fields to include in a partial response.
507
+ # @param [String] quota_user
508
+ # Available to use for quota purposes for server-side applications. Can be any
509
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
510
+ # @param [Google::Apis::RequestOptions] options
511
+ # Request-specific options
512
+ #
513
+ # @yield [result, err] Result & error if block supplied
514
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleLongrunningOperation] parsed result object
515
+ # @yieldparam err [StandardError] error object if request failed
516
+ #
517
+ # @return [Google::Apis::DatalineageV1::GoogleLongrunningOperation]
518
+ #
519
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
520
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
521
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
522
+ def delete_project_location_process_run(name, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block)
523
+ command = make_simple_command(:delete, 'v1/{+name}', options)
524
+ command.response_representation = Google::Apis::DatalineageV1::GoogleLongrunningOperation::Representation
525
+ command.response_class = Google::Apis::DatalineageV1::GoogleLongrunningOperation
526
+ command.params['name'] = name unless name.nil?
527
+ command.query['allowMissing'] = allow_missing unless allow_missing.nil?
528
+ command.query['fields'] = fields unless fields.nil?
529
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
530
+ execute_or_queue_command(command, &block)
531
+ end
532
+
533
+ # Gets the details of the specified run.
534
+ # @param [String] name
535
+ # Required. The name of the run to get.
536
+ # @param [String] fields
537
+ # Selector specifying which fields to include in a partial response.
538
+ # @param [String] quota_user
539
+ # Available to use for quota purposes for server-side applications. Can be any
540
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
541
+ # @param [Google::Apis::RequestOptions] options
542
+ # Request-specific options
543
+ #
544
+ # @yield [result, err] Result & error if block supplied
545
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Run] parsed result object
546
+ # @yieldparam err [StandardError] error object if request failed
547
+ #
548
+ # @return [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Run]
549
+ #
550
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
551
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
552
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
553
+ def get_project_location_process_run(name, fields: nil, quota_user: nil, options: nil, &block)
554
+ command = make_simple_command(:get, 'v1/{+name}', options)
555
+ command.response_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Run::Representation
556
+ command.response_class = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Run
557
+ command.params['name'] = name unless name.nil?
558
+ command.query['fields'] = fields unless fields.nil?
559
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
560
+ execute_or_queue_command(command, &block)
561
+ end
562
+
563
+ # Lists runs in the given project and location. List order is descending by `
564
+ # start_time`.
565
+ # @param [String] parent
566
+ # Required. The name of process that owns this collection of runs.
567
+ # @param [Fixnum] page_size
568
+ # The maximum number of runs to return. The service may return fewer than this
569
+ # value. If unspecified, at most 50 runs are returned. The maximum value is 100;
570
+ # values greater than 100 are cut to 100.
571
+ # @param [String] page_token
572
+ # The page token received from a previous `ListRuns` call. Specify it to get the
573
+ # next page. When paginating, all other parameters specified in this call must
574
+ # match the parameters of the call that provided the page token.
575
+ # @param [String] fields
576
+ # Selector specifying which fields to include in a partial response.
577
+ # @param [String] quota_user
578
+ # Available to use for quota purposes for server-side applications. Can be any
579
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
580
+ # @param [Google::Apis::RequestOptions] options
581
+ # Request-specific options
582
+ #
583
+ # @yield [result, err] Result & error if block supplied
584
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1ListRunsResponse] parsed result object
585
+ # @yieldparam err [StandardError] error object if request failed
586
+ #
587
+ # @return [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1ListRunsResponse]
588
+ #
589
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
590
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
591
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
592
+ def list_project_location_process_runs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
593
+ command = make_simple_command(:get, 'v1/{+parent}/runs', options)
594
+ command.response_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1ListRunsResponse::Representation
595
+ command.response_class = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1ListRunsResponse
596
+ command.params['parent'] = parent unless parent.nil?
597
+ command.query['pageSize'] = page_size unless page_size.nil?
598
+ command.query['pageToken'] = page_token unless page_token.nil?
599
+ command.query['fields'] = fields unless fields.nil?
600
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
601
+ execute_or_queue_command(command, &block)
602
+ end
603
+
604
+ # Updates a run.
605
+ # @param [String] name
606
+ # Immutable. The resource name of the run. Format: `projects/`project`/locations/
607
+ # `location`/processes/`process`/runs/`run``. Can be specified or auto-assigned.
608
+ # `run` must be not longer than 200 characters and only contain characters in a
609
+ # set: `a-zA-Z0-9_-:.`
610
+ # @param [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Run] google_cloud_datacatalog_lineage_v1_run_object
611
+ # @param [Boolean] allow_missing
612
+ # If set to true and the run is not found, the request creates it.
613
+ # @param [String] update_mask
614
+ # The list of fields to update. Currently not used. The whole message is updated.
615
+ # @param [String] fields
616
+ # Selector specifying which fields to include in a partial response.
617
+ # @param [String] quota_user
618
+ # Available to use for quota purposes for server-side applications. Can be any
619
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
620
+ # @param [Google::Apis::RequestOptions] options
621
+ # Request-specific options
622
+ #
623
+ # @yield [result, err] Result & error if block supplied
624
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Run] parsed result object
625
+ # @yieldparam err [StandardError] error object if request failed
626
+ #
627
+ # @return [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Run]
628
+ #
629
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
630
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
631
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
632
+ def patch_project_location_process_run(name, google_cloud_datacatalog_lineage_v1_run_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
633
+ command = make_simple_command(:patch, 'v1/{+name}', options)
634
+ command.request_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Run::Representation
635
+ command.request_object = google_cloud_datacatalog_lineage_v1_run_object
636
+ command.response_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Run::Representation
637
+ command.response_class = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1Run
638
+ command.params['name'] = name unless name.nil?
639
+ command.query['allowMissing'] = allow_missing unless allow_missing.nil?
640
+ command.query['updateMask'] = update_mask unless update_mask.nil?
641
+ command.query['fields'] = fields unless fields.nil?
642
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
643
+ execute_or_queue_command(command, &block)
644
+ end
645
+
646
+ # Creates a new lineage event.
647
+ # @param [String] parent
648
+ # Required. The name of the run that should own the lineage event.
649
+ # @param [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1LineageEvent] google_cloud_datacatalog_lineage_v1_lineage_event_object
650
+ # @param [String] request_id
651
+ # A unique identifier for this request. Restricted to 36 ASCII characters. A
652
+ # random UUID is recommended. This request is idempotent only if a `request_id`
653
+ # is provided.
654
+ # @param [String] fields
655
+ # Selector specifying which fields to include in a partial response.
656
+ # @param [String] quota_user
657
+ # Available to use for quota purposes for server-side applications. Can be any
658
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
659
+ # @param [Google::Apis::RequestOptions] options
660
+ # Request-specific options
661
+ #
662
+ # @yield [result, err] Result & error if block supplied
663
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1LineageEvent] parsed result object
664
+ # @yieldparam err [StandardError] error object if request failed
665
+ #
666
+ # @return [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1LineageEvent]
667
+ #
668
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
669
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
670
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
671
+ def create_project_location_process_run_lineage_event(parent, google_cloud_datacatalog_lineage_v1_lineage_event_object = nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
672
+ command = make_simple_command(:post, 'v1/{+parent}/lineageEvents', options)
673
+ command.request_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1LineageEvent::Representation
674
+ command.request_object = google_cloud_datacatalog_lineage_v1_lineage_event_object
675
+ command.response_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1LineageEvent::Representation
676
+ command.response_class = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1LineageEvent
677
+ command.params['parent'] = parent unless parent.nil?
678
+ command.query['requestId'] = request_id unless request_id.nil?
679
+ command.query['fields'] = fields unless fields.nil?
680
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
681
+ execute_or_queue_command(command, &block)
682
+ end
683
+
684
+ # Deletes the lineage event with the specified name.
685
+ # @param [String] name
686
+ # Required. The name of the lineage event to delete.
687
+ # @param [Boolean] allow_missing
688
+ # If set to true and the lineage event is not found, the request succeeds but
689
+ # the server doesn't perform any actions.
690
+ # @param [String] fields
691
+ # Selector specifying which fields to include in a partial response.
692
+ # @param [String] quota_user
693
+ # Available to use for quota purposes for server-side applications. Can be any
694
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
695
+ # @param [Google::Apis::RequestOptions] options
696
+ # Request-specific options
697
+ #
698
+ # @yield [result, err] Result & error if block supplied
699
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleProtobufEmpty] parsed result object
700
+ # @yieldparam err [StandardError] error object if request failed
701
+ #
702
+ # @return [Google::Apis::DatalineageV1::GoogleProtobufEmpty]
703
+ #
704
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
705
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
706
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
707
+ def delete_project_location_process_run_lineage_event(name, allow_missing: nil, fields: nil, quota_user: nil, options: nil, &block)
708
+ command = make_simple_command(:delete, 'v1/{+name}', options)
709
+ command.response_representation = Google::Apis::DatalineageV1::GoogleProtobufEmpty::Representation
710
+ command.response_class = Google::Apis::DatalineageV1::GoogleProtobufEmpty
711
+ command.params['name'] = name unless name.nil?
712
+ command.query['allowMissing'] = allow_missing unless allow_missing.nil?
713
+ command.query['fields'] = fields unless fields.nil?
714
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
715
+ execute_or_queue_command(command, &block)
716
+ end
717
+
718
+ # Gets details of a specified lineage event.
719
+ # @param [String] name
720
+ # Required. The name of the lineage event to get.
721
+ # @param [String] fields
722
+ # Selector specifying which fields to include in a partial response.
723
+ # @param [String] quota_user
724
+ # Available to use for quota purposes for server-side applications. Can be any
725
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
726
+ # @param [Google::Apis::RequestOptions] options
727
+ # Request-specific options
728
+ #
729
+ # @yield [result, err] Result & error if block supplied
730
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1LineageEvent] parsed result object
731
+ # @yieldparam err [StandardError] error object if request failed
732
+ #
733
+ # @return [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1LineageEvent]
734
+ #
735
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
736
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
737
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
738
+ def get_project_location_process_run_lineage_event(name, fields: nil, quota_user: nil, options: nil, &block)
739
+ command = make_simple_command(:get, 'v1/{+name}', options)
740
+ command.response_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1LineageEvent::Representation
741
+ command.response_class = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1LineageEvent
742
+ command.params['name'] = name unless name.nil?
743
+ command.query['fields'] = fields unless fields.nil?
744
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
745
+ execute_or_queue_command(command, &block)
746
+ end
747
+
748
+ # Lists lineage events in the given project and location. The list order is not
749
+ # defined.
750
+ # @param [String] parent
751
+ # Required. The name of the run that owns the collection of lineage events to
752
+ # get.
753
+ # @param [Fixnum] page_size
754
+ # The maximum number of lineage events to return. The service may return fewer
755
+ # events than this value. If unspecified, at most 50 events are returned. The
756
+ # maximum value is 100; values greater than 100 are cut to 100.
757
+ # @param [String] page_token
758
+ # The page token received from a previous `ListLineageEvents` call. Specify it
759
+ # to get the next page. When paginating, all other parameters specified in this
760
+ # call must match the parameters of the call that provided the page token.
761
+ # @param [String] fields
762
+ # Selector specifying which fields to include in a partial response.
763
+ # @param [String] quota_user
764
+ # Available to use for quota purposes for server-side applications. Can be any
765
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
766
+ # @param [Google::Apis::RequestOptions] options
767
+ # Request-specific options
768
+ #
769
+ # @yield [result, err] Result & error if block supplied
770
+ # @yieldparam result [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1ListLineageEventsResponse] parsed result object
771
+ # @yieldparam err [StandardError] error object if request failed
772
+ #
773
+ # @return [Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1ListLineageEventsResponse]
774
+ #
775
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
776
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
777
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
778
+ def list_project_location_process_run_lineage_events(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
779
+ command = make_simple_command(:get, 'v1/{+parent}/lineageEvents', options)
780
+ command.response_representation = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1ListLineageEventsResponse::Representation
781
+ command.response_class = Google::Apis::DatalineageV1::GoogleCloudDatacatalogLineageV1ListLineageEventsResponse
782
+ command.params['parent'] = parent unless parent.nil?
783
+ command.query['pageSize'] = page_size unless page_size.nil?
784
+ command.query['pageToken'] = page_token unless page_token.nil?
785
+ command.query['fields'] = fields unless fields.nil?
786
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
787
+ execute_or_queue_command(command, &block)
788
+ end
789
+
790
+ protected
791
+
792
+ def apply_command_defaults(command)
793
+ command.query['key'] = key unless key.nil?
794
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
795
+ end
796
+ end
797
+ end
798
+ end
799
+ end