Chiebot-Mirror
/
googleapis
8
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

feat: add a DataLineage API

Browse Source 
PiperOrigin-RevId: 498346995
pull/767/head
Google APIs 2 years ago committed by Copybara-Service
parent e6a9ae2f0b
commit 797751748f
5 changed files with 1334 additions and 0 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 1
      google/cloud/datacatalog/lineage/BUILD.bazel
  2. 390
      google/cloud/datacatalog/lineage/v1/BUILD.bazel
  3. 44
      google/cloud/datacatalog/lineage/v1/datalineage_v1.yaml
  4. 879
      google/cloud/datacatalog/lineage/v1/lineage.proto
  5. 20
      google/cloud/datacatalog/lineage/v1/lineage_grpc_service_config.json

1
google/cloud/datacatalog/lineage/BUILD.bazel
Unescape View File

@ -0,0 +1 @@
exports_files(glob(["*.yaml"]))

390
google/cloud/datacatalog/lineage/v1/BUILD.bazel
Unescape View File

@ -0,0 +1,390 @@
# This file was automatically generated by BuildFileGenerator
# https://github.com/googleapis/rules_gapic/tree/master/bazel
# Most of the manual changes to this file will be overwritten.
# It's **only** allowed to change the following rule attribute values:
# - names of *_gapic_assembly_* rules
# - certain parameters of *_gapic_library rules, including but not limited to:
# * extra_protoc_parameters
# * extra_protoc_file_parameters
# The complete list of preserved parameters can be found in the source code.
# This is an API workspace, having public visibility by default makes perfect sense.
package(default_visibility = ["//visibility:public"])
##############################################################################
# Common
##############################################################################
load("@rules_proto//proto:defs.bzl", "proto_library")
load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info")
proto_library(
name = "lineage_proto",
srcs = [
"lineage.proto",
],
deps = [
"//google/api:annotations_proto",
"//google/api:client_proto",
"//google/api:field_behavior_proto",
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
"@com_google_protobuf//:empty_proto",
"@com_google_protobuf//:field_mask_proto",
"@com_google_protobuf//:struct_proto",
"@com_google_protobuf//:timestamp_proto",
],
)
proto_library_with_info(
name = "lineage_proto_with_info",
deps = [
":lineage_proto",
"//google/cloud:common_resources_proto",
],
)
##############################################################################
# Java
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"java_gapic_assembly_gradle_pkg",
"java_gapic_library",
"java_gapic_test",
"java_grpc_library",
"java_proto_library",
)
java_proto_library(
name = "lineage_java_proto",
deps = [":lineage_proto"],
)
java_grpc_library(
name = "lineage_java_grpc",
srcs = [":lineage_proto"],
deps = [":lineage_java_proto"],
)
java_gapic_library(
name = "lineage_java_gapic",
srcs = [":lineage_proto_with_info"],
gapic_yaml = None,
grpc_service_config = "lineage_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "datalineage_v1.yaml",
test_deps = [
":lineage_java_grpc",
],
transport = "grpc+rest",
deps = [
":lineage_java_proto",
"//google/api:api_java_proto",
],
)
java_gapic_test(
name = "lineage_java_gapic_test_suite",
test_classes = [
"com.google.cloud.datacatalog.lineage.v1.LineageClientHttpJsonTest",
"com.google.cloud.datacatalog.lineage.v1.LineageClientTest",
],
runtime_deps = [":lineage_java_gapic_test"],
)
# Open Source Packages
java_gapic_assembly_gradle_pkg(
name = "google-cloud-datacatalog-lineage-v1-java",
include_samples = True,
transport = "grpc+rest",
deps = [
":lineage_java_gapic",
":lineage_java_grpc",
":lineage_java_proto",
":lineage_proto",
],
)
##############################################################################
# Go
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"go_gapic_assembly_pkg",
"go_gapic_library",
"go_proto_library",
"go_test",
)
go_proto_library(
name = "lineage_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
importpath = "google.golang.org/genproto/googleapis/cloud/datacatalog/lineage/v1",
protos = [":lineage_proto"],
deps = [
"//google/api:annotations_go_proto",
"//google/longrunning:longrunning_go_proto",
],
)
go_gapic_library(
name = "lineage_go_gapic",
srcs = [":lineage_proto_with_info"],
grpc_service_config = "lineage_grpc_service_config.json",
importpath = "cloud.google.com/go/datacatalog/lineage/apiv1;lineage",
metadata = True,
rest_numeric_enums = True,
service_yaml = "datalineage_v1.yaml",
transport = "grpc+rest",
deps = [
":lineage_go_proto",
"//google/longrunning:longrunning_go_proto",
"@com_google_cloud_go_longrunning//:go_default_library",
"@com_google_cloud_go_longrunning//autogen:go_default_library",
"@io_bazel_rules_go//proto/wkt:struct_go_proto",
],
)
go_test(
name = "lineage_go_gapic_test",
srcs = [":lineage_go_gapic_srcjar_test"],
embed = [":lineage_go_gapic"],
importpath = "cloud.google.com/go/datacatalog/lineage/apiv1",
)
# Open Source Packages
go_gapic_assembly_pkg(
name = "gapi-cloud-datacatalog-lineage-v1-go",
deps = [
":lineage_go_gapic",
":lineage_go_gapic_srcjar-metadata.srcjar",
":lineage_go_gapic_srcjar-test.srcjar",
":lineage_go_proto",
],
)
##############################################################################
# Python
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"py_gapic_assembly_pkg",
"py_gapic_library",
"py_test",
)
py_gapic_library(
name = "lineage_py_gapic",
srcs = [":lineage_proto"],
grpc_service_config = "lineage_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "datalineage_v1.yaml",
transport = "grpc+rest",
deps = [
],
)
py_test(
name = "lineage_py_gapic_test",
srcs = [
"lineage_py_gapic_pytest.py",
"lineage_py_gapic_test.py",
],
legacy_create_init = False,
deps = [":lineage_py_gapic"],
)
# Open Source Packages
py_gapic_assembly_pkg(
name = "datacatalog-lineage-v1-py",
deps = [
":lineage_py_gapic",
],
)
##############################################################################
# PHP
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"php_gapic_assembly_pkg",
"php_gapic_library",
"php_grpc_library",
"php_proto_library",
)
php_proto_library(
name = "lineage_php_proto",
deps = [":lineage_proto"],
)
php_grpc_library(
name = "lineage_php_grpc",
srcs = [":lineage_proto"],
deps = [":lineage_php_proto"],
)
php_gapic_library(
name = "lineage_php_gapic",
srcs = [":lineage_proto_with_info"],
grpc_service_config = "lineage_grpc_service_config.json",
rest_numeric_enums = False,
service_yaml = "datalineage_v1.yaml",
transport = "grpc+rest",
deps = [
":lineage_php_grpc",
":lineage_php_proto",
],
)
# Open Source Packages
php_gapic_assembly_pkg(
name = "google-cloud-datacatalog-lineage-v1-php",
deps = [
":lineage_php_gapic",
":lineage_php_grpc",
":lineage_php_proto",
],
)
##############################################################################
# Node.js
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"nodejs_gapic_assembly_pkg",
"nodejs_gapic_library",
)
nodejs_gapic_library(
name = "lineage_nodejs_gapic",
package_name = "@google-cloud/lineage",
src = ":lineage_proto_with_info",
extra_protoc_parameters = ["metadata"],
grpc_service_config = "lineage_grpc_service_config.json",
package = "google.cloud.datacatalog.lineage.v1",
rest_numeric_enums = True,
service_yaml = "datalineage_v1.yaml",
transport = "grpc+rest",
deps = [],
)
nodejs_gapic_assembly_pkg(
name = "datacatalog-lineage-v1-nodejs",
deps = [
":lineage_nodejs_gapic",
":lineage_proto",
],
)
##############################################################################
# Ruby
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"ruby_cloud_gapic_library",
"ruby_gapic_assembly_pkg",
"ruby_grpc_library",
"ruby_proto_library",
)
ruby_proto_library(
name = "lineage_ruby_proto",
deps = [":lineage_proto"],
)
ruby_grpc_library(
name = "lineage_ruby_grpc",
srcs = [":lineage_proto"],
deps = [":lineage_ruby_proto"],
)
ruby_cloud_gapic_library(
name = "lineage_ruby_gapic",
srcs = [":lineage_proto_with_info"],
extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-datacatalog-lineage-v1"],
grpc_service_config = "lineage_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "datalineage_v1.yaml",
deps = [
":lineage_ruby_grpc",
":lineage_ruby_proto",
],
)
# Open Source Packages
ruby_gapic_assembly_pkg(
name = "google-cloud-datacatalog-lineage-v1-ruby",
deps = [
":lineage_ruby_gapic",
":lineage_ruby_grpc",
":lineage_ruby_proto",
],
)
##############################################################################
# C#
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"csharp_gapic_assembly_pkg",
"csharp_gapic_library",
"csharp_grpc_library",
"csharp_proto_library",
)
csharp_proto_library(
name = "lineage_csharp_proto",
deps = [":lineage_proto"],
)
csharp_grpc_library(
name = "lineage_csharp_grpc",
srcs = [":lineage_proto"],
deps = [":lineage_csharp_proto"],
)
csharp_gapic_library(
name = "lineage_csharp_gapic",
srcs = [":lineage_proto_with_info"],
common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json",
grpc_service_config = "lineage_grpc_service_config.json",
rest_numeric_enums = True,
service_yaml = "datalineage_v1.yaml",
deps = [
":lineage_csharp_grpc",
":lineage_csharp_proto",
],
)
# Open Source Packages
csharp_gapic_assembly_pkg(
name = "google-cloud-datacatalog-lineage-v1-csharp",
deps = [
":lineage_csharp_gapic",
":lineage_csharp_grpc",
":lineage_csharp_proto",
],
)
##############################################################################
# C++
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"cc_grpc_library",
"cc_proto_library",
)
cc_proto_library(
name = "lineage_cc_proto",
deps = [":lineage_proto"],
)
cc_grpc_library(
name = "lineage_cc_grpc",
srcs = [":lineage_proto"],
grpc_only = True,
deps = [":lineage_cc_proto"],
)

44
google/cloud/datacatalog/lineage/v1/datalineage_v1.yaml
Unescape View File

@ -0,0 +1,44 @@
type: google.api.Service
config_version: 3
name: datalineage.googleapis.com
title: Data Lineage API
apis:
- name: google.cloud.datacatalog.lineage.v1.Lineage
- name: google.longrunning.Operations
types:
- name: google.cloud.datacatalog.lineage.v1.OperationMetadata
http:
rules:
- selector: google.longrunning.Operations.CancelOperation
post: '/v1/{name=projects/*/locations/*/operations/*}:cancel'
body: '*'
- selector: google.longrunning.Operations.DeleteOperation
delete: '/v1/{name=projects/*/locations/*/operations/*}'
- selector: google.longrunning.Operations.GetOperation
get: '/v1/{name=projects/*/locations/*/operations/*}'
- selector: google.longrunning.Operations.ListOperations
get: '/v1/{name=projects/*/locations/*}/operations'
authentication:
rules:
- selector: 'google.cloud.datacatalog.lineage.v1.Lineage.*'
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
- selector: 'google.longrunning.Operations.*'
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
publishing:
organization: CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED
new_issue_uri: ''
documentation_uri: ''
api_short_name: ''
github_label: ''
doc_tag_prefix: ''
codeowner_github_teams:
library_settings:

879
google/cloud/datacatalog/lineage/v1/lineage.proto
Unescape View File

@ -0,0 +1,879 @@
// Copyright 2022 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 = "google.golang.org/genproto/googleapis/cloud/datacatalog/lineage/v1;lineage";
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 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. Can be anything, for example,
// "author". 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. Can be anything, for example, a string
// with an SQL request. 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];
// Optional. 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) = OPTIONAL];
// 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 of the entity. Useful for referencing
// entities that aren't represented as GCP resources, for example, tables in
// Dataproc Metastore API.
//
// Examples:
//
// * `bigquery:dataset.project_id.dataset_id`
// * `bigquery:table.project_id.dataset_id.table_id`
// * `pubsub:project_id.topic_id`
// * `dataproc_metastore:projectId.locationId.instanceId.databaseId.tableId`
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;
}
// 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
// [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;
}
// 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;
}
// Type of the source.
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;
}

20
google/cloud/datacatalog/lineage/v1/lineage_grpc_service_config.json
Unescape View File

@ -0,0 +1,20 @@
{
"methodConfig": [
{
"name": [
{
"service": "google.cloud.datacatalog.lineage.v1.Lineage"
}
],
"timeout": "60s",
"retryPolicy": {
"initialBackoff": "0.100s",
"maxBackoff": "60s",
"backoffMultiplier": 1.3,
"retryableStatusCodes": [
"UNAVAILABLE"
]
}
}
]
}
Write Preview
Loading…
Cancel
Save