-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
lineage.proto
945 lines (807 loc) · 33.1 KB
/
lineage.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.cloud.datacatalog.lineage.v1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.DataCatalog.Lineage.V1";
option go_package = "cloud.google.com/go/datacatalog/lineage/apiv1/lineagepb;lineagepb";
option java_multiple_files = true;
option java_outer_classname = "LineageProto";
option java_package = "com.google.cloud.datacatalog.lineage.v1";
option php_namespace = "Google\\Cloud\\DataCatalog\\Lineage\\V1";
option ruby_package = "Google::Cloud::DataCatalog::Lineage::V1";
// Lineage is used to track data flows between assets over time. You can
// create [LineageEvents][google.cloud.datacatalog.lineage.v1.LineageEvent]
// to record lineage between multiple sources and a single target, for
// example, when table data is based on data from multiple tables.
service Lineage {
option (google.api.default_host) = "datalineage.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform";
// Creates new lineage events together with their parents: process and run.
// Updates the process and run if they already exist.
// Mapped from Open Lineage specification:
// https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json.
rpc ProcessOpenLineageRunEvent(ProcessOpenLineageRunEventRequest)
returns (ProcessOpenLineageRunEventResponse) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}:processOpenLineageRunEvent"
body: "open_lineage"
};
option (google.api.method_signature) = "parent,open_lineage";
}
// Creates a new process.
rpc CreateProcess(CreateProcessRequest) returns (Process) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/processes"
body: "process"
};
option (google.api.method_signature) = "parent,process";
}
// Updates a process.
rpc UpdateProcess(UpdateProcessRequest) returns (Process) {
option (google.api.http) = {
patch: "/v1/{process.name=projects/*/locations/*/processes/*}"
body: "process"
};
option (google.api.method_signature) = "process,update_mask";
}
// Gets the details of the specified process.
rpc GetProcess(GetProcessRequest) returns (Process) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/processes/*}"
};
option (google.api.method_signature) = "name";
}
// List processes in the given project and location. List order is descending
// by insertion time.
rpc ListProcesses(ListProcessesRequest) returns (ListProcessesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/processes"
};
option (google.api.method_signature) = "parent";
}
// Deletes the process with the specified name.
rpc DeleteProcess(DeleteProcessRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/processes/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "google.cloud.datacatalog.lineage.v1.OperationMetadata"
};
}
// Creates a new run.
rpc CreateRun(CreateRunRequest) returns (Run) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/processes/*}/runs"
body: "run"
};
option (google.api.method_signature) = "parent,run";
}
// Updates a run.
rpc UpdateRun(UpdateRunRequest) returns (Run) {
option (google.api.http) = {
patch: "/v1/{run.name=projects/*/locations/*/processes/*/runs/*}"
body: "run"
};
option (google.api.method_signature) = "run,update_mask";
}
// Gets the details of the specified run.
rpc GetRun(GetRunRequest) returns (Run) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/processes/*/runs/*}"
};
option (google.api.method_signature) = "name";
}
// Lists runs in the given project and location. List order is descending by
// `start_time`.
rpc ListRuns(ListRunsRequest) returns (ListRunsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/processes/*}/runs"
};
option (google.api.method_signature) = "parent";
}
// Deletes the run with the specified name.
rpc DeleteRun(DeleteRunRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/processes/*/runs/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "google.cloud.datacatalog.lineage.v1.OperationMetadata"
};
}
// Creates a new lineage event.
rpc CreateLineageEvent(CreateLineageEventRequest) returns (LineageEvent) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/processes/*/runs/*}/lineageEvents"
body: "lineage_event"
};
option (google.api.method_signature) = "parent,lineage_event";
}
// Gets details of a specified lineage event.
rpc GetLineageEvent(GetLineageEventRequest) returns (LineageEvent) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/processes/*/runs/*/lineageEvents/*}"
};
option (google.api.method_signature) = "name";
}
// Lists lineage events in the given project and location. The list order is
// not defined.
rpc ListLineageEvents(ListLineageEventsRequest)
returns (ListLineageEventsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/processes/*/runs/*}/lineageEvents"
};
option (google.api.method_signature) = "parent";
}
// Deletes the lineage event with the specified name.
rpc DeleteLineageEvent(DeleteLineageEventRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/processes/*/runs/*/lineageEvents/*}"
};
option (google.api.method_signature) = "name";
}
// 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.
rpc SearchLinks(SearchLinksRequest) returns (SearchLinksResponse) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}:searchLinks"
body: "*"
};
}
// 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][google.cloud.datacatalog.lineage.v1.Lineage.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.
rpc BatchSearchLinkProcesses(BatchSearchLinkProcessesRequest)
returns (BatchSearchLinkProcessesResponse) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}:batchSearchLinkProcesses"
body: "*"
};
}
}
// A process is the definition of a data transformation operation.
message Process {
option (google.api.resource) = {
type: "datalineage.googleapis.com/Process"
pattern: "projects/{project}/locations/{location}/processes/{process}"
};
// 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_-:.`
string name = 1 [(google.api.field_behavior) = IMMUTABLE];
// 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 `_-:&.`
string display_name = 2 [(google.api.field_behavior) = OPTIONAL];
// 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.
map<string, google.protobuf.Value> attributes = 3
[(google.api.field_behavior) = OPTIONAL];
// Optional. The origin of this process and its runs and lineage events.
Origin origin = 4 [(google.api.field_behavior) = OPTIONAL];
}
// A lineage run represents an execution of a process that creates
// lineage events.
message Run {
option (google.api.resource) = {
type: "datalineage.googleapis.com/Run"
pattern: "projects/{project}/locations/{location}/processes/{process}/runs/{run}"
};
// The current state of the run.
enum State {
// The state is unknown. The true state may be any of the below or a
// different state that is not supported here explicitly.
UNKNOWN = 0;
// The run is still executing.
STARTED = 1;
// The run completed.
COMPLETED = 2;
// The run failed.
FAILED = 3;
// The run aborted.
ABORTED = 4;
}
// 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_-:.`
string name = 1 [(google.api.field_behavior) = IMMUTABLE];
// 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 `_-:&.`
string display_name = 2 [(google.api.field_behavior) = OPTIONAL];
// 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.
map<string, google.protobuf.Value> attributes = 3
[(google.api.field_behavior) = OPTIONAL];
// Required. The timestamp of the start of the run.
google.protobuf.Timestamp start_time = 4
[(google.api.field_behavior) = REQUIRED];
// Optional. The timestamp of the end of the run.
google.protobuf.Timestamp end_time = 5
[(google.api.field_behavior) = OPTIONAL];
// Required. The state of the run.
State state = 6 [(google.api.field_behavior) = REQUIRED];
}
// 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.
message LineageEvent {
option (google.api.resource) = {
type: "datalineage.googleapis.com/LineageEvent"
pattern: "projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}"
};
// 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_-:.`
string name = 1 [(google.api.field_behavior) = IMMUTABLE];
// Optional. List of source-target pairs. Can't contain more than 100 tuples.
repeated EventLink links = 8 [(google.api.field_behavior) = OPTIONAL];
// 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.
google.protobuf.Timestamp start_time = 6
[(google.api.field_behavior) = REQUIRED];
// 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.
google.protobuf.Timestamp end_time = 7
[(google.api.field_behavior) = OPTIONAL];
}
// A lineage between source and target entities.
message EventLink {
// Required. Reference to the source entity
EntityReference source = 1 [(google.api.field_behavior) = REQUIRED];
// Required. Reference to the target entity
EntityReference target = 2 [(google.api.field_behavior) = REQUIRED];
}
// The soft reference to everything you can attach a lineage event to.
message EntityReference {
// Required. [Fully Qualified Name
// (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names)
// of the entity.
string fully_qualified_name = 1 [(google.api.field_behavior) = REQUIRED];
}
// Metadata describing the operation.
message OperationMetadata {
// An enum with the state of the operation.
enum State {
// Unused.
STATE_UNSPECIFIED = 0;
// The operation has been created but is not yet started.
PENDING = 1;
// The operation is underway.
RUNNING = 2;
// The operation completed successfully.
SUCCEEDED = 3;
// The operation is no longer running and did not succeed.
FAILED = 4;
}
// Type of the long running operation.
enum Type {
// Unused.
TYPE_UNSPECIFIED = 0;
// The resource deletion operation.
DELETE = 1;
// The resource creation operation.
CREATE = 2;
}
// Output only. The current operation state.
State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The type of the operation being performed.
Type operation_type = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The [relative name]
// (https://cloud.google.com//apis/design/resource_names#relative_resource_name)
// of the resource being operated on.
string resource = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The UUID of the resource being operated on.
string resource_uuid = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The timestamp of the operation submission to the server.
google.protobuf.Timestamp create_time = 5
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The timestamp of the operation termination, regardless of its
// success. This field is unset if the operation is still ongoing.
google.protobuf.Timestamp end_time = 6
[(google.api.field_behavior) = OUTPUT_ONLY];
}
// Request message for
// [ProcessOpenLineageRunEvent][google.cloud.datacatalog.lineage.v1.ProcessOpenLineageRunEvent].
message ProcessOpenLineageRunEventRequest {
// Required. The name of the project and its location that should own the
// process, run, and lineage event.
string parent = 1 [(google.api.field_behavior) = REQUIRED];
// Required. OpenLineage message following OpenLineage format:
// https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json
google.protobuf.Struct open_lineage = 2
[(google.api.field_behavior) = REQUIRED];
// 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.
string request_id = 3;
}
// Response message for
// [ProcessOpenLineageRunEvent][google.cloud.datacatalog.lineage.v1.ProcessOpenLineageRunEvent].
message ProcessOpenLineageRunEventResponse {
// Created process name.
// Format: `projects/{project}/locations/{location}/processes/{process}`.
string process = 1 [(google.api.resource_reference) = {
type: "datalineage.googleapis.com/Process"
}];
// Created run name.
// Format:
// `projects/{project}/locations/{location}/processes/{process}/runs/{run}`.
string run = 2 [
(google.api.resource_reference) = { type: "datalineage.googleapis.com/Run" }
];
// Created lineage event names.
// Format:
// `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`.
repeated string lineage_events = 3 [(google.api.resource_reference) = {
type: "datalineage.googleapis.com/LineageEvent"
}];
}
// Request message for
// [CreateProcess][google.cloud.datacatalog.lineage.v1.CreateProcess].
message CreateProcessRequest {
// Required. The name of the project and its location that should own the
// process.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "datalineage.googleapis.com/Process"
}
];
// Required. The process to create.
Process process = 2 [(google.api.field_behavior) = REQUIRED];
// 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.
string request_id = 3;
}
// Request message for
// [UpdateProcess][google.cloud.datacatalog.lineage.v1.UpdateProcess].
message UpdateProcessRequest {
// Required. The lineage process to update.
//
// The process's `name` field is used to identify the process to update.
Process process = 1 [(google.api.field_behavior) = REQUIRED];
// The list of fields to update. Currently not used. The whole message is
// updated.
google.protobuf.FieldMask update_mask = 2;
// If set to true and the process is not found, the request inserts it.
bool allow_missing = 3;
}
// Request message for
// [GetProcess][google.cloud.datacatalog.lineage.v1.GetProcess].
message GetProcessRequest {
// Required. The name of the process to get.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "datalineage.googleapis.com/Process"
}
];
}
// Request message for
// [ListProcesses][google.cloud.datacatalog.lineage.v1.ListProcesses].
message ListProcessesRequest {
// Required. The name of the project and its location that owns this
// collection of processes.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "datalineage.googleapis.com/Process"
}
];
// 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.
int32 page_size = 2;
// 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.
string page_token = 3;
}
// Response message for
// [ListProcesses][google.cloud.datacatalog.lineage.v1.ListProcesses].
message ListProcessesResponse {
// The processes from the specified project and location.
repeated Process processes = 1;
// 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.
string next_page_token = 2;
}
// Request message for
// [DeleteProcess][google.cloud.datacatalog.lineage.v1.DeleteProcess].
message DeleteProcessRequest {
// Required. The name of the process to delete.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "datalineage.googleapis.com/Process"
}
];
// If set to true and the process is not found, the request
// succeeds but the server doesn't perform any actions.
bool allow_missing = 2;
}
// Request message for
// [CreateRun][google.cloud.datacatalog.lineage.v1.CreateRun].
message CreateRunRequest {
// Required. The name of the process that should own the run.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "datalineage.googleapis.com/Run"
}
];
// Required. The run to create.
Run run = 2 [(google.api.field_behavior) = REQUIRED];
// 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.
string request_id = 3;
}
// Request message for
// [UpdateRun][google.cloud.datacatalog.lineage.v1.UpdateRun].
message UpdateRunRequest {
// Required. The lineage run to update.
//
// The run's `name` field is used to identify the run to update.
//
// Format:
// `projects/{project}/locations/{location}/processes/{process}/runs/{run}`.
Run run = 1 [(google.api.field_behavior) = REQUIRED];
// The list of fields to update. Currently not used. The whole message is
// updated.
google.protobuf.FieldMask update_mask = 2;
// If set to true and the run is not found, the request creates it.
bool allow_missing = 3;
}
// Request message for
// [GetRun][google.cloud.datacatalog.lineage.v1.GetRun].
message GetRunRequest {
// Required. The name of the run to get.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = { type: "datalineage.googleapis.com/Run" }
];
}
// Request message for
// [ListRuns][google.cloud.datacatalog.lineage.v1.ListRuns].
message ListRunsRequest {
// Required. The name of process that owns this collection of runs.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "datalineage.googleapis.com/Run"
}
];
// 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.
int32 page_size = 2;
// 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.
string page_token = 3;
}
// Response message for
// [ListRuns][google.cloud.datacatalog.lineage.v1.ListRuns].
message ListRunsResponse {
// The runs from the specified project and location.
repeated Run runs = 1;
// 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.
string next_page_token = 2;
}
// Request message for
// [DeleteRun][google.cloud.datacatalog.lineage.v1.DeleteRun].
message DeleteRunRequest {
// Required. The name of the run to delete.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = { type: "datalineage.googleapis.com/Run" }
];
// If set to true and the run is not found, the request
// succeeds but the server doesn't perform any actions.
bool allow_missing = 2;
}
// Request message for
// [CreateLineageEvent][google.cloud.datacatalog.lineage.v1.CreateLineageEvent].
message CreateLineageEventRequest {
// Required. The name of the run that should own the lineage event.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "datalineage.googleapis.com/LineageEvent"
}
];
// Required. The lineage event to create.
LineageEvent lineage_event = 2 [(google.api.field_behavior) = REQUIRED];
// 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.
string request_id = 3;
}
// Request message for
// [GetLineageEvent][google.cloud.datacatalog.lineage.v1.GetLineageEvent].
message GetLineageEventRequest {
// Required. The name of the lineage event to get.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "datalineage.googleapis.com/LineageEvent"
}
];
}
// Request message for
// [ListLineageEvents][google.cloud.datacatalog.lineage.v1.ListLineageEvents].
message ListLineageEventsRequest {
// Required. The name of the run that owns the collection of lineage events to
// get.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "datalineage.googleapis.com/LineageEvent"
}
];
// 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.
int32 page_size = 2;
// 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.
string page_token = 3;
}
// Response message for
// [ListLineageEvents][google.cloud.datacatalog.lineage.v1.ListLineageEvents].
message ListLineageEventsResponse {
// Lineage events from the specified project and location.
repeated LineageEvent lineage_events = 1;
// 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.
string next_page_token = 2;
}
// Request message for
// [DeleteLineageEvent][google.cloud.datacatalog.lineage.v1.DeleteLineageEvent].
message DeleteLineageEventRequest {
// Required. The name of the lineage event to delete.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "datalineage.googleapis.com/LineageEvent"
}
];
// If set to true and the lineage event is not found, the request
// succeeds but the server doesn't perform any actions.
bool allow_missing = 2;
}
// Request message for
// [SearchLinks][google.cloud.datacatalog.lineage.v1.Lineage.SearchLinks].
message SearchLinksRequest {
// Required. The project and location you want search in.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "datalineage.googleapis.com/Process"
}
];
// The asset for which you want to retrieve links.
oneof criteria {
// Optional. Send asset information in the **source** field to retrieve all
// links that lead from the specified asset to downstream assets.
EntityReference source = 4 [(google.api.field_behavior) = OPTIONAL];
// Optional. Send asset information in the **target** field to retrieve all
// links that lead from upstream assets to the specified asset.
EntityReference target = 5 [(google.api.field_behavior) = OPTIONAL];
}
// 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.
int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
// 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.
string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
}
// Response message for
// [SearchLinks][google.cloud.datacatalog.lineage.v1.Lineage.SearchLinks].
message SearchLinksResponse {
// The list of links for a given asset. Can be empty if the asset has no
// relations of requested type (source or target).
repeated Link links = 1;
// 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.
string next_page_token = 2;
}
// 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.
message Link {
// Output only. Immutable. The name of the link. Format:
// `projects/{project}/locations/{location}/links/{link}`.
string name = 1 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.field_behavior) = IMMUTABLE
];
// The pointer to the entity that is the **source** of this link.
EntityReference source = 2;
// The pointer to the entity that is the **target** of this link.
EntityReference target = 3;
// The start of the first event establishing this link.
google.protobuf.Timestamp start_time = 4;
// The end of the last event establishing this link.
google.protobuf.Timestamp end_time = 5;
}
// Request message for
// [BatchSearchLinkProcesses][google.cloud.datacatalog.lineage.v1.Lineage.BatchSearchLinkProcesses].
message BatchSearchLinkProcessesRequest {
// Required. The project and location where you want to search.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "datalineage.googleapis.com/Process"
}
];
// 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}`.
repeated string links = 2 [(google.api.field_behavior) = REQUIRED];
// The maximum number of processes to return in a single page of the response.
// A page may contain fewer results than this value.
int32 page_size = 3;
// 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.
string page_token = 4;
}
// Response message for
// [BatchSearchLinkProcesses][google.cloud.datacatalog.lineage.v1.Lineage.BatchSearchLinkProcesses].
message BatchSearchLinkProcessesResponse {
// An array of processes associated with the specified links.
repeated ProcessLinks process_links = 1;
// 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.
string next_page_token = 2;
}
// Links associated with a specific process.
message ProcessLinks {
// The process name in the format of
// `projects/{project}/locations/{location}/processes/{process}`.
string process = 1 [(google.api.resource_reference) = {
type: "datalineage.googleapis.com/Process"
}];
// 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.
repeated ProcessLinkInfo links = 2;
}
// Link details.
message ProcessLinkInfo {
// The name of the link in the format of
// `projects/{project}/locations/{location}/links/{link}`.
string link = 1;
// The start of the first event establishing this link-process tuple.
google.protobuf.Timestamp start_time = 2;
// The end of the last event establishing this link-process tuple.
google.protobuf.Timestamp end_time = 3;
}
// Origin of a process.
message Origin {
// Type of the source of a process.
enum SourceType {
// Source is Unspecified
SOURCE_TYPE_UNSPECIFIED = 0;
// A custom source
CUSTOM = 1;
// BigQuery
BIGQUERY = 2;
// Data Fusion
DATA_FUSION = 3;
// Composer
COMPOSER = 4;
// Looker Studio
LOOKER_STUDIO = 5;
// Dataproc
DATAPROC = 6;
}
// 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.
SourceType source_type = 1;
// 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"}`
string name = 2;
}