1{
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/cloud-platform": {
6 "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
7 }
8 }
9 }
10 },
11 "basePath": "",
12 "baseUrl": "https://datalineage.googleapis.com/",
13 "batchPath": "batch",
14 "canonicalName": "Datalineage",
15 "description": "",
16 "discoveryVersion": "v1",
17 "documentationLink": "https://cloud.google.com/data-catalog",
18 "fullyEncodeReservedExpansion": true,
19 "icons": {
20 "x16": "http://www.google.com/images/icons/product/search-16.gif",
21 "x32": "http://www.google.com/images/icons/product/search-32.gif"
22 },
23 "id": "datalineage:v1",
24 "kind": "discovery#restDescription",
25 "mtlsRootUrl": "https://datalineage.mtls.googleapis.com/",
26 "name": "datalineage",
27 "ownerDomain": "google.com",
28 "ownerName": "Google",
29 "parameters": {
30 "$.xgafv": {
31 "description": "V1 error format.",
32 "enum": [
33 "1",
34 "2"
35 ],
36 "enumDescriptions": [
37 "v1 error format",
38 "v2 error format"
39 ],
40 "location": "query",
41 "type": "string"
42 },
43 "access_token": {
44 "description": "OAuth access token.",
45 "location": "query",
46 "type": "string"
47 },
48 "alt": {
49 "default": "json",
50 "description": "Data format for response.",
51 "enum": [
52 "json",
53 "media",
54 "proto"
55 ],
56 "enumDescriptions": [
57 "Responses with Content-Type of application/json",
58 "Media download with context-dependent Content-Type",
59 "Responses with Content-Type of application/x-protobuf"
60 ],
61 "location": "query",
62 "type": "string"
63 },
64 "callback": {
65 "description": "JSONP",
66 "location": "query",
67 "type": "string"
68 },
69 "fields": {
70 "description": "Selector specifying which fields to include in a partial response.",
71 "location": "query",
72 "type": "string"
73 },
74 "key": {
75 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
76 "location": "query",
77 "type": "string"
78 },
79 "oauth_token": {
80 "description": "OAuth 2.0 token for the current user.",
81 "location": "query",
82 "type": "string"
83 },
84 "prettyPrint": {
85 "default": "true",
86 "description": "Returns response with indentations and line breaks.",
87 "location": "query",
88 "type": "boolean"
89 },
90 "quotaUser": {
91 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
92 "location": "query",
93 "type": "string"
94 },
95 "uploadType": {
96 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
97 "location": "query",
98 "type": "string"
99 },
100 "upload_protocol": {
101 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
102 "location": "query",
103 "type": "string"
104 }
105 },
106 "protocol": "rest",
107 "resources": {
108 "projects": {
109 "resources": {
110 "locations": {
111 "methods": {
112 "batchSearchLinkProcesses": {
113 "description": "Retrieve information about LineageProcesses associated with specific links. LineageProcesses are transformation pipelines that result in data flowing from **source** to **target** assets. Links between assets represent this operation. If you have specific link names, you can use this method to verify which LineageProcesses contribute to creating those links. See the SearchLinks method for more information on how to retrieve link name. You can retrieve the LineageProcess information in every project where you have the `datalineage.events.get` permission. The project provided in the URL is used for Billing and Quota.",
114 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:batchSearchLinkProcesses",
115 "httpMethod": "POST",
116 "id": "datalineage.projects.locations.batchSearchLinkProcesses",
117 "parameterOrder": [
118 "parent"
119 ],
120 "parameters": {
121 "parent": {
122 "description": "Required. The project and location where you want to search.",
123 "location": "path",
124 "pattern": "^projects/[^/]+/locations/[^/]+$",
125 "required": true,
126 "type": "string"
127 }
128 },
129 "path": "v1/{+parent}:batchSearchLinkProcesses",
130 "request": {
131 "$ref": "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest"
132 },
133 "response": {
134 "$ref": "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse"
135 },
136 "scopes": [
137 "https://www.googleapis.com/auth/cloud-platform"
138 ]
139 },
140 "searchLinks": {
141 "description": "Retrieve a list of links connected to a specific asset. Links represent the data flow between **source** (upstream) and **target** (downstream) assets in transformation pipelines. Links are stored in the same project as the Lineage Events that create them. You can retrieve links in every project where you have the `datalineage.events.get` permission. The project provided in the URL is used for Billing and Quota.",
142 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:searchLinks",
143 "httpMethod": "POST",
144 "id": "datalineage.projects.locations.searchLinks",
145 "parameterOrder": [
146 "parent"
147 ],
148 "parameters": {
149 "parent": {
150 "description": "Required. The project and location you want search in.",
151 "location": "path",
152 "pattern": "^projects/[^/]+/locations/[^/]+$",
153 "required": true,
154 "type": "string"
155 }
156 },
157 "path": "v1/{+parent}:searchLinks",
158 "request": {
159 "$ref": "GoogleCloudDatacatalogLineageV1SearchLinksRequest"
160 },
161 "response": {
162 "$ref": "GoogleCloudDatacatalogLineageV1SearchLinksResponse"
163 },
164 "scopes": [
165 "https://www.googleapis.com/auth/cloud-platform"
166 ]
167 }
168 },
169 "resources": {
170 "operations": {
171 "methods": {
172 "cancel": {
173 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
174 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
175 "httpMethod": "POST",
176 "id": "datalineage.projects.locations.operations.cancel",
177 "parameterOrder": [
178 "name"
179 ],
180 "parameters": {
181 "name": {
182 "description": "The name of the operation resource to be cancelled.",
183 "location": "path",
184 "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
185 "required": true,
186 "type": "string"
187 }
188 },
189 "path": "v1/{+name}:cancel",
190 "request": {
191 "$ref": "GoogleLongrunningCancelOperationRequest"
192 },
193 "response": {
194 "$ref": "GoogleProtobufEmpty"
195 },
196 "scopes": [
197 "https://www.googleapis.com/auth/cloud-platform"
198 ]
199 },
200 "delete": {
201 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
202 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
203 "httpMethod": "DELETE",
204 "id": "datalineage.projects.locations.operations.delete",
205 "parameterOrder": [
206 "name"
207 ],
208 "parameters": {
209 "name": {
210 "description": "The name of the operation resource to be deleted.",
211 "location": "path",
212 "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
213 "required": true,
214 "type": "string"
215 }
216 },
217 "path": "v1/{+name}",
218 "response": {
219 "$ref": "GoogleProtobufEmpty"
220 },
221 "scopes": [
222 "https://www.googleapis.com/auth/cloud-platform"
223 ]
224 },
225 "get": {
226 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
227 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
228 "httpMethod": "GET",
229 "id": "datalineage.projects.locations.operations.get",
230 "parameterOrder": [
231 "name"
232 ],
233 "parameters": {
234 "name": {
235 "description": "The name of the operation resource.",
236 "location": "path",
237 "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
238 "required": true,
239 "type": "string"
240 }
241 },
242 "path": "v1/{+name}",
243 "response": {
244 "$ref": "GoogleLongrunningOperation"
245 },
246 "scopes": [
247 "https://www.googleapis.com/auth/cloud-platform"
248 ]
249 },
250 "list": {
251 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
252 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations",
253 "httpMethod": "GET",
254 "id": "datalineage.projects.locations.operations.list",
255 "parameterOrder": [
256 "name"
257 ],
258 "parameters": {
259 "filter": {
260 "description": "The standard list filter.",
261 "location": "query",
262 "type": "string"
263 },
264 "name": {
265 "description": "The name of the operation's parent resource.",
266 "location": "path",
267 "pattern": "^projects/[^/]+/locations/[^/]+$",
268 "required": true,
269 "type": "string"
270 },
271 "pageSize": {
272 "description": "The standard list page size.",
273 "format": "int32",
274 "location": "query",
275 "type": "integer"
276 },
277 "pageToken": {
278 "description": "The standard list page token.",
279 "location": "query",
280 "type": "string"
281 }
282 },
283 "path": "v1/{+name}/operations",
284 "response": {
285 "$ref": "GoogleLongrunningListOperationsResponse"
286 },
287 "scopes": [
288 "https://www.googleapis.com/auth/cloud-platform"
289 ]
290 }
291 }
292 },
293 "processes": {
294 "methods": {
295 "create": {
296 "description": "Creates a new process.",
297 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes",
298 "httpMethod": "POST",
299 "id": "datalineage.projects.locations.processes.create",
300 "parameterOrder": [
301 "parent"
302 ],
303 "parameters": {
304 "parent": {
305 "description": "Required. The name of the project and its location that should own the process.",
306 "location": "path",
307 "pattern": "^projects/[^/]+/locations/[^/]+$",
308 "required": true,
309 "type": "string"
310 },
311 "requestId": {
312 "description": "A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is idempotent only if a `request_id` is provided.",
313 "location": "query",
314 "type": "string"
315 }
316 },
317 "path": "v1/{+parent}/processes",
318 "request": {
319 "$ref": "GoogleCloudDatacatalogLineageV1Process"
320 },
321 "response": {
322 "$ref": "GoogleCloudDatacatalogLineageV1Process"
323 },
324 "scopes": [
325 "https://www.googleapis.com/auth/cloud-platform"
326 ]
327 },
328 "delete": {
329 "description": "Deletes the process with the specified name.",
330 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}",
331 "httpMethod": "DELETE",
332 "id": "datalineage.projects.locations.processes.delete",
333 "parameterOrder": [
334 "name"
335 ],
336 "parameters": {
337 "allowMissing": {
338 "description": "If set to true and the process is not found, the request succeeds but the server doesn't perform any actions.",
339 "location": "query",
340 "type": "boolean"
341 },
342 "name": {
343 "description": "Required. The name of the process to delete.",
344 "location": "path",
345 "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+$",
346 "required": true,
347 "type": "string"
348 }
349 },
350 "path": "v1/{+name}",
351 "response": {
352 "$ref": "GoogleLongrunningOperation"
353 },
354 "scopes": [
355 "https://www.googleapis.com/auth/cloud-platform"
356 ]
357 },
358 "get": {
359 "description": "Gets the details of the specified process.",
360 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}",
361 "httpMethod": "GET",
362 "id": "datalineage.projects.locations.processes.get",
363 "parameterOrder": [
364 "name"
365 ],
366 "parameters": {
367 "name": {
368 "description": "Required. The name of the process to get.",
369 "location": "path",
370 "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+$",
371 "required": true,
372 "type": "string"
373 }
374 },
375 "path": "v1/{+name}",
376 "response": {
377 "$ref": "GoogleCloudDatacatalogLineageV1Process"
378 },
379 "scopes": [
380 "https://www.googleapis.com/auth/cloud-platform"
381 ]
382 },
383 "list": {
384 "description": "List processes in the given project and location. List order is descending by insertion time.",
385 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes",
386 "httpMethod": "GET",
387 "id": "datalineage.projects.locations.processes.list",
388 "parameterOrder": [
389 "parent"
390 ],
391 "parameters": {
392 "pageSize": {
393 "description": "The maximum number of processes to return. The service may return fewer than this value. If unspecified, at most 50 processes are returned. The maximum value is 100; values greater than 100 are cut to 100.",
394 "format": "int32",
395 "location": "query",
396 "type": "integer"
397 },
398 "pageToken": {
399 "description": "The page token received from a previous `ListProcesses` call. Specify it to get the next page. When paginating, all other parameters specified in this call must match the parameters of the call that provided the page token.",
400 "location": "query",
401 "type": "string"
402 },
403 "parent": {
404 "description": "Required. The name of the project and its location that owns this collection of processes.",
405 "location": "path",
406 "pattern": "^projects/[^/]+/locations/[^/]+$",
407 "required": true,
408 "type": "string"
409 }
410 },
411 "path": "v1/{+parent}/processes",
412 "response": {
413 "$ref": "GoogleCloudDatacatalogLineageV1ListProcessesResponse"
414 },
415 "scopes": [
416 "https://www.googleapis.com/auth/cloud-platform"
417 ]
418 },
419 "patch": {
420 "description": "Updates a process.",
421 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}",
422 "httpMethod": "PATCH",
423 "id": "datalineage.projects.locations.processes.patch",
424 "parameterOrder": [
425 "name"
426 ],
427 "parameters": {
428 "allowMissing": {
429 "description": "If set to true and the process is not found, the request inserts it.",
430 "location": "query",
431 "type": "boolean"
432 },
433 "name": {
434 "description": "Immutable. The resource name of the lineage process. Format: `projects/{project}/locations/{location}/processes/{process}`. Can be specified or auto-assigned. {process} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.`",
435 "location": "path",
436 "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+$",
437 "required": true,
438 "type": "string"
439 },
440 "updateMask": {
441 "description": "The list of fields to update. Currently not used. The whole message is updated.",
442 "format": "google-fieldmask",
443 "location": "query",
444 "type": "string"
445 }
446 },
447 "path": "v1/{+name}",
448 "request": {
449 "$ref": "GoogleCloudDatacatalogLineageV1Process"
450 },
451 "response": {
452 "$ref": "GoogleCloudDatacatalogLineageV1Process"
453 },
454 "scopes": [
455 "https://www.googleapis.com/auth/cloud-platform"
456 ]
457 }
458 },
459 "resources": {
460 "runs": {
461 "methods": {
462 "create": {
463 "description": "Creates a new run.",
464 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs",
465 "httpMethod": "POST",
466 "id": "datalineage.projects.locations.processes.runs.create",
467 "parameterOrder": [
468 "parent"
469 ],
470 "parameters": {
471 "parent": {
472 "description": "Required. The name of the process that should own the run.",
473 "location": "path",
474 "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+$",
475 "required": true,
476 "type": "string"
477 },
478 "requestId": {
479 "description": "A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is idempotent only if a `request_id` is provided.",
480 "location": "query",
481 "type": "string"
482 }
483 },
484 "path": "v1/{+parent}/runs",
485 "request": {
486 "$ref": "GoogleCloudDatacatalogLineageV1Run"
487 },
488 "response": {
489 "$ref": "GoogleCloudDatacatalogLineageV1Run"
490 },
491 "scopes": [
492 "https://www.googleapis.com/auth/cloud-platform"
493 ]
494 },
495 "delete": {
496 "description": "Deletes the run with the specified name.",
497 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}",
498 "httpMethod": "DELETE",
499 "id": "datalineage.projects.locations.processes.runs.delete",
500 "parameterOrder": [
501 "name"
502 ],
503 "parameters": {
504 "allowMissing": {
505 "description": "If set to true and the run is not found, the request succeeds but the server doesn't perform any actions.",
506 "location": "query",
507 "type": "boolean"
508 },
509 "name": {
510 "description": "Required. The name of the run to delete.",
511 "location": "path",
512 "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+$",
513 "required": true,
514 "type": "string"
515 }
516 },
517 "path": "v1/{+name}",
518 "response": {
519 "$ref": "GoogleLongrunningOperation"
520 },
521 "scopes": [
522 "https://www.googleapis.com/auth/cloud-platform"
523 ]
524 },
525 "get": {
526 "description": "Gets the details of the specified run.",
527 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}",
528 "httpMethod": "GET",
529 "id": "datalineage.projects.locations.processes.runs.get",
530 "parameterOrder": [
531 "name"
532 ],
533 "parameters": {
534 "name": {
535 "description": "Required. The name of the run to get.",
536 "location": "path",
537 "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+$",
538 "required": true,
539 "type": "string"
540 }
541 },
542 "path": "v1/{+name}",
543 "response": {
544 "$ref": "GoogleCloudDatacatalogLineageV1Run"
545 },
546 "scopes": [
547 "https://www.googleapis.com/auth/cloud-platform"
548 ]
549 },
550 "list": {
551 "description": "Lists runs in the given project and location. List order is descending by `start_time`.",
552 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs",
553 "httpMethod": "GET",
554 "id": "datalineage.projects.locations.processes.runs.list",
555 "parameterOrder": [
556 "parent"
557 ],
558 "parameters": {
559 "pageSize": {
560 "description": "The maximum number of runs to return. The service may return fewer than this value. If unspecified, at most 50 runs are returned. The maximum value is 100; values greater than 100 are cut to 100.",
561 "format": "int32",
562 "location": "query",
563 "type": "integer"
564 },
565 "pageToken": {
566 "description": "The page token received from a previous `ListRuns` call. Specify it to get the next page. When paginating, all other parameters specified in this call must match the parameters of the call that provided the page token.",
567 "location": "query",
568 "type": "string"
569 },
570 "parent": {
571 "description": "Required. The name of process that owns this collection of runs.",
572 "location": "path",
573 "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+$",
574 "required": true,
575 "type": "string"
576 }
577 },
578 "path": "v1/{+parent}/runs",
579 "response": {
580 "$ref": "GoogleCloudDatacatalogLineageV1ListRunsResponse"
581 },
582 "scopes": [
583 "https://www.googleapis.com/auth/cloud-platform"
584 ]
585 },
586 "patch": {
587 "description": "Updates a run.",
588 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}",
589 "httpMethod": "PATCH",
590 "id": "datalineage.projects.locations.processes.runs.patch",
591 "parameterOrder": [
592 "name"
593 ],
594 "parameters": {
595 "allowMissing": {
596 "description": "If set to true and the run is not found, the request creates it.",
597 "location": "query",
598 "type": "boolean"
599 },
600 "name": {
601 "description": "Immutable. The resource name of the run. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.`",
602 "location": "path",
603 "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+$",
604 "required": true,
605 "type": "string"
606 },
607 "updateMask": {
608 "description": "The list of fields to update. Currently not used. The whole message is updated.",
609 "format": "google-fieldmask",
610 "location": "query",
611 "type": "string"
612 }
613 },
614 "path": "v1/{+name}",
615 "request": {
616 "$ref": "GoogleCloudDatacatalogLineageV1Run"
617 },
618 "response": {
619 "$ref": "GoogleCloudDatacatalogLineageV1Run"
620 },
621 "scopes": [
622 "https://www.googleapis.com/auth/cloud-platform"
623 ]
624 }
625 },
626 "resources": {
627 "lineageEvents": {
628 "methods": {
629 "create": {
630 "description": "Creates a new lineage event.",
631 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents",
632 "httpMethod": "POST",
633 "id": "datalineage.projects.locations.processes.runs.lineageEvents.create",
634 "parameterOrder": [
635 "parent"
636 ],
637 "parameters": {
638 "parent": {
639 "description": "Required. The name of the run that should own the lineage event.",
640 "location": "path",
641 "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+$",
642 "required": true,
643 "type": "string"
644 },
645 "requestId": {
646 "description": "A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is idempotent only if a `request_id` is provided.",
647 "location": "query",
648 "type": "string"
649 }
650 },
651 "path": "v1/{+parent}/lineageEvents",
652 "request": {
653 "$ref": "GoogleCloudDatacatalogLineageV1LineageEvent"
654 },
655 "response": {
656 "$ref": "GoogleCloudDatacatalogLineageV1LineageEvent"
657 },
658 "scopes": [
659 "https://www.googleapis.com/auth/cloud-platform"
660 ]
661 },
662 "delete": {
663 "description": "Deletes the lineage event with the specified name.",
664 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents/{lineageEventsId}",
665 "httpMethod": "DELETE",
666 "id": "datalineage.projects.locations.processes.runs.lineageEvents.delete",
667 "parameterOrder": [
668 "name"
669 ],
670 "parameters": {
671 "allowMissing": {
672 "description": "If set to true and the lineage event is not found, the request succeeds but the server doesn't perform any actions.",
673 "location": "query",
674 "type": "boolean"
675 },
676 "name": {
677 "description": "Required. The name of the lineage event to delete.",
678 "location": "path",
679 "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+/lineageEvents/[^/]+$",
680 "required": true,
681 "type": "string"
682 }
683 },
684 "path": "v1/{+name}",
685 "response": {
686 "$ref": "GoogleProtobufEmpty"
687 },
688 "scopes": [
689 "https://www.googleapis.com/auth/cloud-platform"
690 ]
691 },
692 "get": {
693 "description": "Gets details of a specified lineage event.",
694 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents/{lineageEventsId}",
695 "httpMethod": "GET",
696 "id": "datalineage.projects.locations.processes.runs.lineageEvents.get",
697 "parameterOrder": [
698 "name"
699 ],
700 "parameters": {
701 "name": {
702 "description": "Required. The name of the lineage event to get.",
703 "location": "path",
704 "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+/lineageEvents/[^/]+$",
705 "required": true,
706 "type": "string"
707 }
708 },
709 "path": "v1/{+name}",
710 "response": {
711 "$ref": "GoogleCloudDatacatalogLineageV1LineageEvent"
712 },
713 "scopes": [
714 "https://www.googleapis.com/auth/cloud-platform"
715 ]
716 },
717 "list": {
718 "description": "Lists lineage events in the given project and location. The list order is not defined.",
719 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents",
720 "httpMethod": "GET",
721 "id": "datalineage.projects.locations.processes.runs.lineageEvents.list",
722 "parameterOrder": [
723 "parent"
724 ],
725 "parameters": {
726 "pageSize": {
727 "description": "The maximum number of lineage events to return. The service may return fewer events than this value. If unspecified, at most 50 events are returned. The maximum value is 100; values greater than 100 are cut to 100.",
728 "format": "int32",
729 "location": "query",
730 "type": "integer"
731 },
732 "pageToken": {
733 "description": "The page token received from a previous `ListLineageEvents` call. Specify it to get the next page. When paginating, all other parameters specified in this call must match the parameters of the call that provided the page token.",
734 "location": "query",
735 "type": "string"
736 },
737 "parent": {
738 "description": "Required. The name of the run that owns the collection of lineage events to get.",
739 "location": "path",
740 "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+$",
741 "required": true,
742 "type": "string"
743 }
744 },
745 "path": "v1/{+parent}/lineageEvents",
746 "response": {
747 "$ref": "GoogleCloudDatacatalogLineageV1ListLineageEventsResponse"
748 },
749 "scopes": [
750 "https://www.googleapis.com/auth/cloud-platform"
751 ]
752 }
753 }
754 }
755 }
756 }
757 }
758 }
759 }
760 }
761 }
762 }
763 },
764 "revision": "20230623",
765 "rootUrl": "https://datalineage.googleapis.com/",
766 "schemas": {
767 "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest": {
768 "description": "Request message for BatchSearchLinkProcesses.",
769 "id": "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest",
770 "properties": {
771 "links": {
772 "description": "Required. An array of links to check for their associated LineageProcesses. The maximum number of items in this array is 100. If the request contains more than 100 links, it returns the `INVALID_ARGUMENT` error. Format: `projects/{project}/locations/{location}/links/{link}`.",
773 "items": {
774 "type": "string"
775 },
776 "type": "array"
777 },
778 "pageSize": {
779 "description": "The maximum number of processes to return in a single page of the response. A page may contain fewer results than this value.",
780 "format": "int32",
781 "type": "integer"
782 },
783 "pageToken": {
784 "description": "The page token received from a previous `BatchSearchLinkProcesses` call. Use it to get the next page. When requesting subsequent pages of a response, remember that all parameters must match the values you provided in the original request.",
785 "type": "string"
786 }
787 },
788 "type": "object"
789 },
790 "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse": {
791 "description": "Response message for BatchSearchLinkProcesses.",
792 "id": "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse",
793 "properties": {
794 "nextPageToken": {
795 "description": "The token to specify as `page_token` in the subsequent call to get the next page. Omitted if there are no more pages in the response.",
796 "type": "string"
797 },
798 "processLinks": {
799 "description": "An array of processes associated with the specified links.",
800 "items": {
801 "$ref": "GoogleCloudDatacatalogLineageV1ProcessLinks"
802 },
803 "type": "array"
804 }
805 },
806 "type": "object"
807 },
808 "GoogleCloudDatacatalogLineageV1EntityReference": {
809 "description": "The soft reference to everything you can attach a lineage event to.",
810 "id": "GoogleCloudDatacatalogLineageV1EntityReference",
811 "properties": {
812 "fullyQualifiedName": {
813 "description": "Required. [Fully Qualified Name (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) of the entity.",
814 "type": "string"
815 }
816 },
817 "type": "object"
818 },
819 "GoogleCloudDatacatalogLineageV1EventLink": {
820 "description": "A lineage between source and target entities.",
821 "id": "GoogleCloudDatacatalogLineageV1EventLink",
822 "properties": {
823 "source": {
824 "$ref": "GoogleCloudDatacatalogLineageV1EntityReference",
825 "description": "Required. Reference to the source entity"
826 },
827 "target": {
828 "$ref": "GoogleCloudDatacatalogLineageV1EntityReference",
829 "description": "Required. Reference to the target entity"
830 }
831 },
832 "type": "object"
833 },
834 "GoogleCloudDatacatalogLineageV1LineageEvent": {
835 "description": "A lineage event represents an operation on assets. Within the operation, the data flows from the source to the target defined in the links field.",
836 "id": "GoogleCloudDatacatalogLineageV1LineageEvent",
837 "properties": {
838 "endTime": {
839 "description": "Optional. The end of the transformation which resulted in this lineage event. For streaming scenarios, it should be the end of the period from which the lineage is being reported.",
840 "format": "google-datetime",
841 "type": "string"
842 },
843 "links": {
844 "description": "Optional. List of source-target pairs. Can't contain more than 100 tuples.",
845 "items": {
846 "$ref": "GoogleCloudDatacatalogLineageV1EventLink"
847 },
848 "type": "array"
849 },
850 "name": {
851 "description": "Immutable. The resource name of the lineage event. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. Can be specified or auto-assigned. {lineage_event} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.`",
852 "type": "string"
853 },
854 "startTime": {
855 "description": "Required. The beginning of the transformation which resulted in this lineage event. For streaming scenarios, it should be the beginning of the period from which the lineage is being reported.",
856 "format": "google-datetime",
857 "type": "string"
858 }
859 },
860 "type": "object"
861 },
862 "GoogleCloudDatacatalogLineageV1Link": {
863 "description": "Links represent the data flow between **source** (upstream) and **target** (downstream) assets in transformation pipelines. Links are created when LineageEvents record data transformation between related assets.",
864 "id": "GoogleCloudDatacatalogLineageV1Link",
865 "properties": {
866 "endTime": {
867 "description": "The end of the last event establishing this link.",
868 "format": "google-datetime",
869 "type": "string"
870 },
871 "name": {
872 "description": "Output only. Immutable. The name of the link. Format: `projects/{project}/locations/{location}/links/{link}`.",
873 "readOnly": true,
874 "type": "string"
875 },
876 "source": {
877 "$ref": "GoogleCloudDatacatalogLineageV1EntityReference",
878 "description": "The pointer to the entity that is the **source** of this link."
879 },
880 "startTime": {
881 "description": "The start of the first event establishing this link.",
882 "format": "google-datetime",
883 "type": "string"
884 },
885 "target": {
886 "$ref": "GoogleCloudDatacatalogLineageV1EntityReference",
887 "description": "The pointer to the entity that is the **target** of this link."
888 }
889 },
890 "type": "object"
891 },
892 "GoogleCloudDatacatalogLineageV1ListLineageEventsResponse": {
893 "description": "Response message for ListLineageEvents.",
894 "id": "GoogleCloudDatacatalogLineageV1ListLineageEventsResponse",
895 "properties": {
896 "lineageEvents": {
897 "description": "Lineage events from the specified project and location.",
898 "items": {
899 "$ref": "GoogleCloudDatacatalogLineageV1LineageEvent"
900 },
901 "type": "array"
902 },
903 "nextPageToken": {
904 "description": "The token to specify as `page_token` in the next call to get the next page. If this field is omitted, there are no subsequent pages.",
905 "type": "string"
906 }
907 },
908 "type": "object"
909 },
910 "GoogleCloudDatacatalogLineageV1ListProcessesResponse": {
911 "description": "Response message for ListProcesses.",
912 "id": "GoogleCloudDatacatalogLineageV1ListProcessesResponse",
913 "properties": {
914 "nextPageToken": {
915 "description": "The token to specify as `page_token` in the next call to get the next page. If this field is omitted, there are no subsequent pages.",
916 "type": "string"
917 },
918 "processes": {
919 "description": "The processes from the specified project and location.",
920 "items": {
921 "$ref": "GoogleCloudDatacatalogLineageV1Process"
922 },
923 "type": "array"
924 }
925 },
926 "type": "object"
927 },
928 "GoogleCloudDatacatalogLineageV1ListRunsResponse": {
929 "description": "Response message for ListRuns.",
930 "id": "GoogleCloudDatacatalogLineageV1ListRunsResponse",
931 "properties": {
932 "nextPageToken": {
933 "description": "The token to specify as `page_token` in the next call to get the next page. If this field is omitted, there are no subsequent pages.",
934 "type": "string"
935 },
936 "runs": {
937 "description": "The runs from the specified project and location.",
938 "items": {
939 "$ref": "GoogleCloudDatacatalogLineageV1Run"
940 },
941 "type": "array"
942 }
943 },
944 "type": "object"
945 },
946 "GoogleCloudDatacatalogLineageV1OperationMetadata": {
947 "description": "Metadata describing the operation.",
948 "id": "GoogleCloudDatacatalogLineageV1OperationMetadata",
949 "properties": {
950 "createTime": {
951 "description": "Output only. The timestamp of the operation submission to the server.",
952 "format": "google-datetime",
953 "readOnly": true,
954 "type": "string"
955 },
956 "endTime": {
957 "description": "Output only. The timestamp of the operation termination, regardless of its success. This field is unset if the operation is still ongoing.",
958 "format": "google-datetime",
959 "readOnly": true,
960 "type": "string"
961 },
962 "operationType": {
963 "description": "Output only. The type of the operation being performed.",
964 "enum": [
965 "TYPE_UNSPECIFIED",
966 "DELETE",
967 "CREATE"
968 ],
969 "enumDescriptions": [
970 "Unused.",
971 "The resource deletion operation.",
972 "The resource creation operation."
973 ],
974 "readOnly": true,
975 "type": "string"
976 },
977 "resource": {
978 "description": "Output only. The [relative name] (https://cloud.google.com//apis/design/resource_names#relative_resource_name) of the resource being operated on.",
979 "readOnly": true,
980 "type": "string"
981 },
982 "resourceUuid": {
983 "description": "Output only. The UUID of the resource being operated on.",
984 "readOnly": true,
985 "type": "string"
986 },
987 "state": {
988 "description": "Output only. The current operation state.",
989 "enum": [
990 "STATE_UNSPECIFIED",
991 "PENDING",
992 "RUNNING",
993 "SUCCEEDED",
994 "FAILED"
995 ],
996 "enumDescriptions": [
997 "Unused.",
998 "The operation has been created but is not yet started.",
999 "The operation is underway.",
1000 "The operation completed successfully.",
1001 "The operation is no longer running and did not succeed."
1002 ],
1003 "readOnly": true,
1004 "type": "string"
1005 }
1006 },
1007 "type": "object"
1008 },
1009 "GoogleCloudDatacatalogLineageV1Origin": {
1010 "description": "Origin of a process.",
1011 "id": "GoogleCloudDatacatalogLineageV1Origin",
1012 "properties": {
1013 "name": {
1014 "description": "If the source_type isn't CUSTOM, the value of this field should be a GCP resource name of the system, which reports lineage. The project and location parts of the resource name must match the project and location of the lineage resource being created. Examples: - `{source_type: COMPOSER, name: \"projects/foo/locations/us/environments/bar\"}` - `{source_type: BIGQUERY, name: \"projects/foo/locations/eu\"}` - `{source_type: CUSTOM, name: \"myCustomIntegration\"}`",
1015 "type": "string"
1016 },
1017 "sourceType": {
1018 "description": "Type of the source. Use of a source_type other than `CUSTOM` for process creation or updating is highly discouraged, and may be restricted in the future without notice.",
1019 "enum": [
1020 "SOURCE_TYPE_UNSPECIFIED",
1021 "CUSTOM",
1022 "BIGQUERY",
1023 "DATA_FUSION",
1024 "COMPOSER",
1025 "LOOKER_STUDIO",
1026 "DATAPROC"
1027 ],
1028 "enumDescriptions": [
1029 "Source is Unspecified",
1030 "A custom source",
1031 "BigQuery",
1032 "Data Fusion",
1033 "Composer",
1034 "Looker Studio",
1035 "Dataproc"
1036 ],
1037 "type": "string"
1038 }
1039 },
1040 "type": "object"
1041 },
1042 "GoogleCloudDatacatalogLineageV1Process": {
1043 "description": "A process is the definition of a data transformation operation.",
1044 "id": "GoogleCloudDatacatalogLineageV1Process",
1045 "properties": {
1046 "attributes": {
1047 "additionalProperties": {
1048 "type": "any"
1049 },
1050 "description": "Optional. The attributes of the process. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the process). Up to 100 attributes are allowed.",
1051 "type": "object"
1052 },
1053 "displayName": {
1054 "description": "Optional. A human-readable name you can set to display in a user interface. Must be not longer than 200 characters and only contain UTF-8 letters or numbers, spaces or characters like `_-:\u0026.`",
1055 "type": "string"
1056 },
1057 "name": {
1058 "description": "Immutable. The resource name of the lineage process. Format: `projects/{project}/locations/{location}/processes/{process}`. Can be specified or auto-assigned. {process} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.`",
1059 "type": "string"
1060 },
1061 "origin": {
1062 "$ref": "GoogleCloudDatacatalogLineageV1Origin",
1063 "description": "Optional. The origin of this process and its runs and lineage events."
1064 }
1065 },
1066 "type": "object"
1067 },
1068 "GoogleCloudDatacatalogLineageV1ProcessLinkInfo": {
1069 "description": "Link details.",
1070 "id": "GoogleCloudDatacatalogLineageV1ProcessLinkInfo",
1071 "properties": {
1072 "endTime": {
1073 "description": "The end of the last event establishing this link-process tuple.",
1074 "format": "google-datetime",
1075 "type": "string"
1076 },
1077 "link": {
1078 "description": "The name of the link in the format of `projects/{project}/locations/{location}/links/{link}`.",
1079 "type": "string"
1080 },
1081 "startTime": {
1082 "description": "The start of the first event establishing this link-process tuple.",
1083 "format": "google-datetime",
1084 "type": "string"
1085 }
1086 },
1087 "type": "object"
1088 },
1089 "GoogleCloudDatacatalogLineageV1ProcessLinks": {
1090 "description": "Links associated with a specific process.",
1091 "id": "GoogleCloudDatacatalogLineageV1ProcessLinks",
1092 "properties": {
1093 "links": {
1094 "description": "An array containing link details objects of the links provided in the original request. A single process can result in creating multiple links. If any of the links you provide in the request are created by the same process, they all are included in this array.",
1095 "items": {
1096 "$ref": "GoogleCloudDatacatalogLineageV1ProcessLinkInfo"
1097 },
1098 "type": "array"
1099 },
1100 "process": {
1101 "description": "The process name in the format of `projects/{project}/locations/{location}/processes/{process}`.",
1102 "type": "string"
1103 }
1104 },
1105 "type": "object"
1106 },
1107 "GoogleCloudDatacatalogLineageV1Run": {
1108 "description": "A lineage run represents an execution of a process that creates lineage events.",
1109 "id": "GoogleCloudDatacatalogLineageV1Run",
1110 "properties": {
1111 "attributes": {
1112 "additionalProperties": {
1113 "type": "any"
1114 },
1115 "description": "Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed.",
1116 "type": "object"
1117 },
1118 "displayName": {
1119 "description": "Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like `_-:\u0026.`",
1120 "type": "string"
1121 },
1122 "endTime": {
1123 "description": "Optional. The timestamp of the end of the run.",
1124 "format": "google-datetime",
1125 "type": "string"
1126 },
1127 "name": {
1128 "description": "Immutable. The resource name of the run. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.`",
1129 "type": "string"
1130 },
1131 "startTime": {
1132 "description": "Required. The timestamp of the start of the run.",
1133 "format": "google-datetime",
1134 "type": "string"
1135 },
1136 "state": {
1137 "description": "Required. The state of the run.",
1138 "enum": [
1139 "UNKNOWN",
1140 "STARTED",
1141 "COMPLETED",
1142 "FAILED",
1143 "ABORTED"
1144 ],
1145 "enumDescriptions": [
1146 "The state is unknown. The true state may be any of the below or a different state that is not supported here explicitly.",
1147 "The run is still executing.",
1148 "The run completed.",
1149 "The run failed.",
1150 "The run aborted."
1151 ],
1152 "type": "string"
1153 }
1154 },
1155 "type": "object"
1156 },
1157 "GoogleCloudDatacatalogLineageV1SearchLinksRequest": {
1158 "description": "Request message for SearchLinks.",
1159 "id": "GoogleCloudDatacatalogLineageV1SearchLinksRequest",
1160 "properties": {
1161 "pageSize": {
1162 "description": "Optional. The maximum number of links to return in a single page of the response. A page may contain fewer links than this value. If unspecified, at most 10 links are returned. Maximum value is 100; values greater than 100 are reduced to 100.",
1163 "format": "int32",
1164 "type": "integer"
1165 },
1166 "pageToken": {
1167 "description": "Optional. The page token received from a previous `SearchLinksRequest` call. Use it to get the next page. When requesting subsequent pages of a response, remember that all parameters must match the values you provided in the original request.",
1168 "type": "string"
1169 },
1170 "source": {
1171 "$ref": "GoogleCloudDatacatalogLineageV1EntityReference",
1172 "description": "Optional. Send asset information in the **source** field to retrieve all links that lead from the specified asset to downstream assets."
1173 },
1174 "target": {
1175 "$ref": "GoogleCloudDatacatalogLineageV1EntityReference",
1176 "description": "Optional. Send asset information in the **target** field to retrieve all links that lead from upstream assets to the specified asset."
1177 }
1178 },
1179 "type": "object"
1180 },
1181 "GoogleCloudDatacatalogLineageV1SearchLinksResponse": {
1182 "description": "Response message for SearchLinks.",
1183 "id": "GoogleCloudDatacatalogLineageV1SearchLinksResponse",
1184 "properties": {
1185 "links": {
1186 "description": "The list of links for a given asset. Can be empty if the asset has no relations of requested type (source or target).",
1187 "items": {
1188 "$ref": "GoogleCloudDatacatalogLineageV1Link"
1189 },
1190 "type": "array"
1191 },
1192 "nextPageToken": {
1193 "description": "The token to specify as `page_token` in the subsequent call to get the next page. Omitted if there are no more pages in the response.",
1194 "type": "string"
1195 }
1196 },
1197 "type": "object"
1198 },
1199 "GoogleLongrunningCancelOperationRequest": {
1200 "description": "The request message for Operations.CancelOperation.",
1201 "id": "GoogleLongrunningCancelOperationRequest",
1202 "properties": {},
1203 "type": "object"
1204 },
1205 "GoogleLongrunningListOperationsResponse": {
1206 "description": "The response message for Operations.ListOperations.",
1207 "id": "GoogleLongrunningListOperationsResponse",
1208 "properties": {
1209 "nextPageToken": {
1210 "description": "The standard List next-page token.",
1211 "type": "string"
1212 },
1213 "operations": {
1214 "description": "A list of operations that matches the specified filter in the request.",
1215 "items": {
1216 "$ref": "GoogleLongrunningOperation"
1217 },
1218 "type": "array"
1219 }
1220 },
1221 "type": "object"
1222 },
1223 "GoogleLongrunningOperation": {
1224 "description": "This resource represents a long-running operation that is the result of a network API call.",
1225 "id": "GoogleLongrunningOperation",
1226 "properties": {
1227 "done": {
1228 "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
1229 "type": "boolean"
1230 },
1231 "error": {
1232 "$ref": "GoogleRpcStatus",
1233 "description": "The error result of the operation in case of failure or cancellation."
1234 },
1235 "metadata": {
1236 "additionalProperties": {
1237 "description": "Properties of the object. Contains field @type with type URL.",
1238 "type": "any"
1239 },
1240 "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
1241 "type": "object"
1242 },
1243 "name": {
1244 "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
1245 "type": "string"
1246 },
1247 "response": {
1248 "additionalProperties": {
1249 "description": "Properties of the object. Contains field @type with type URL.",
1250 "type": "any"
1251 },
1252 "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
1253 "type": "object"
1254 }
1255 },
1256 "type": "object"
1257 },
1258 "GoogleProtobufEmpty": {
1259 "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
1260 "id": "GoogleProtobufEmpty",
1261 "properties": {},
1262 "type": "object"
1263 },
1264 "GoogleRpcStatus": {
1265 "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
1266 "id": "GoogleRpcStatus",
1267 "properties": {
1268 "code": {
1269 "description": "The status code, which should be an enum value of google.rpc.Code.",
1270 "format": "int32",
1271 "type": "integer"
1272 },
1273 "details": {
1274 "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
1275 "items": {
1276 "additionalProperties": {
1277 "description": "Properties of the object. Contains field @type with type URL.",
1278 "type": "any"
1279 },
1280 "type": "object"
1281 },
1282 "type": "array"
1283 },
1284 "message": {
1285 "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
1286 "type": "string"
1287 }
1288 },
1289 "type": "object"
1290 }
1291 },
1292 "servicePath": "",
1293 "title": "Data Lineage API",
1294 "version": "v1",
1295 "version_module": true
1296}View as plain text