{ "baseUrl": "https://datalineage.googleapis.com/", "title": "Data Lineage API", "kind": "discovery#restDescription", "version_module": true, "parameters": { "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "key": { "type": "string", "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.", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ] }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "location": "query", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ] }, "quotaUser": { "type": "string", "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.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" } }, "endpoints": [ { "location": "africa-south1", "description": "Regional Endpoint", "endpointUrl": "https://datalineage.africa-south1.rep.googleapis.com/" }, { "endpointUrl": "https://datalineage.asia-east1.rep.googleapis.com/", "location": "asia-east1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datalineage.asia-east2.rep.googleapis.com/", "location": "asia-east2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datalineage.asia-northeast1.rep.googleapis.com/", "location": "asia-northeast1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datalineage.asia-northeast2.rep.googleapis.com/", "location": "asia-northeast2", "description": "Regional Endpoint" }, { "location": "asia-northeast3", "description": "Regional Endpoint", "endpointUrl": "https://datalineage.asia-northeast3.rep.googleapis.com/" }, { "location": "asia-south1", "description": "Regional Endpoint", "endpointUrl": "https://datalineage.asia-south1.rep.googleapis.com/" }, { "endpointUrl": "https://datalineage.asia-south2.rep.googleapis.com/", "location": "asia-south2", "description": "Regional Endpoint" }, { "location": "asia-southeast1", "description": "Regional Endpoint", "endpointUrl": "https://datalineage.asia-southeast1.rep.googleapis.com/" }, { "endpointUrl": "https://datalineage.asia-southeast2.rep.googleapis.com/", "location": "asia-southeast2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datalineage.asia-southeast3.rep.googleapis.com/", "location": "asia-southeast3", "description": "Regional Endpoint" }, { "location": "australia-southeast1", "description": "Regional Endpoint", "endpointUrl": "https://datalineage.australia-southeast1.rep.googleapis.com/" }, { "endpointUrl": "https://datalineage.australia-southeast2.rep.googleapis.com/", "location": "australia-southeast2", "description": "Regional Endpoint" }, { "location": "europe-central2", "description": "Regional Endpoint", "endpointUrl": "https://datalineage.europe-central2.rep.googleapis.com/" }, { "location": "europe-north1", "description": "Regional Endpoint", "endpointUrl": "https://datalineage.europe-north1.rep.googleapis.com/" }, { "endpointUrl": "https://datalineage.europe-north2.rep.googleapis.com/", "location": "europe-north2", "description": "Regional Endpoint" }, { "location": "europe-north3", "description": "Regional Endpoint", "endpointUrl": "https://datalineage.europe-north3.rep.googleapis.com/" }, { "endpointUrl": "https://datalineage.europe-southwest1.rep.googleapis.com/", "location": "europe-southwest1", "description": "Regional Endpoint" }, { "location": "europe-west1", "description": "Regional Endpoint", "endpointUrl": "https://datalineage.europe-west1.rep.googleapis.com/" }, { "endpointUrl": "https://datalineage.europe-west10.rep.googleapis.com/", "location": "europe-west10", "description": "Regional Endpoint" }, { "location": "europe-west12", "description": "Regional Endpoint", "endpointUrl": "https://datalineage.europe-west12.rep.googleapis.com/" }, { "endpointUrl": "https://datalineage.europe-west15.rep.googleapis.com/", "location": "europe-west15", "description": "Regional Endpoint" }, { "location": "europe-west2", "description": "Regional Endpoint", "endpointUrl": "https://datalineage.europe-west2.rep.googleapis.com/" }, { "endpointUrl": "https://datalineage.europe-west3.rep.googleapis.com/", "location": "europe-west3", "description": "Regional Endpoint" }, { "endpointUrl": "https://datalineage.europe-west4.rep.googleapis.com/", "location": "europe-west4", "description": "Regional Endpoint" }, { "location": "europe-west6", "description": "Regional Endpoint", "endpointUrl": "https://datalineage.europe-west6.rep.googleapis.com/" }, { "endpointUrl": "https://datalineage.europe-west8.rep.googleapis.com/", "location": "europe-west8", "description": "Regional Endpoint" }, { "endpointUrl": "https://datalineage.europe-west9.rep.googleapis.com/", "location": "europe-west9", "description": "Regional Endpoint" }, { "location": "me-central1", "description": "Regional Endpoint", "endpointUrl": "https://datalineage.me-central1.rep.googleapis.com/" }, { "endpointUrl": "https://datalineage.me-central2.rep.googleapis.com/", "location": "me-central2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datalineage.me-west1.rep.googleapis.com/", "location": "me-west1", "description": "Regional Endpoint" }, { "location": "northamerica-northeast1", "description": "Regional Endpoint", "endpointUrl": "https://datalineage.northamerica-northeast1.rep.googleapis.com/" }, { "location": "northamerica-northeast2", "description": "Regional Endpoint", "endpointUrl": "https://datalineage.northamerica-northeast2.rep.googleapis.com/" }, { "endpointUrl": "https://datalineage.northamerica-south1.rep.googleapis.com/", "location": "northamerica-south1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datalineage.southamerica-east1.rep.googleapis.com/", "location": "southamerica-east1", "description": "Regional Endpoint" }, { "location": "southamerica-west1", "description": "Regional Endpoint", "endpointUrl": "https://datalineage.southamerica-west1.rep.googleapis.com/" }, { "endpointUrl": "https://datalineage.us-central1.rep.googleapis.com/", "location": "us-central1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datalineage.us-central2.rep.googleapis.com/", "location": "us-central2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datalineage.us-east1.rep.googleapis.com/", "location": "us-east1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datalineage.us-east4.rep.googleapis.com/", "location": "us-east4", "description": "Regional Endpoint" }, { "endpointUrl": "https://datalineage.us-east5.rep.googleapis.com/", "location": "us-east5", "description": "Regional Endpoint" }, { "endpointUrl": "https://datalineage.us-east7.rep.googleapis.com/", "location": "us-east7", "description": "Regional Endpoint" }, { "endpointUrl": "https://datalineage.us-south1.rep.googleapis.com/", "location": "us-south1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datalineage.us-west1.rep.googleapis.com/", "location": "us-west1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datalineage.us-west2.rep.googleapis.com/", "location": "us-west2", "description": "Regional Endpoint" }, { "location": "us-west3", "description": "Regional Endpoint", "endpointUrl": "https://datalineage.us-west3.rep.googleapis.com/" }, { "endpointUrl": "https://datalineage.us-west4.rep.googleapis.com/", "location": "us-west4", "description": "Regional Endpoint" }, { "location": "us-west8", "description": "Regional Endpoint", "endpointUrl": "https://datalineage.us-west8.rep.googleapis.com/" }, { "location": "us", "description": "Regional Endpoint", "endpointUrl": "https://datalineage.us.rep.googleapis.com/" }, { "endpointUrl": "https://datalineage.eu.rep.googleapis.com/", "location": "eu", "description": "Regional Endpoint" } ], "protocol": "rest", "schemas": { "GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRule": { "description": "Ingestion rule for Data Lineage ingestion.", "type": "object", "id": "GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRule", "properties": { "integrationSelector": { "description": "Required. Integration selector of the rule. The rule is only applied to the Integration selected by the selector.", "$ref": "GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRuleIntegrationSelector" }, "lineageEnablement": { "$ref": "GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRuleLineageEnablement", "description": "Required. Lineage enablement configuration. Defines configurations for the ingestion of lineage for the resource and its children. If unspecified, the ingestion will be enabled only if it was configured in the resource's parent." } } }, "GoogleCloudDatacatalogLineageV1SearchLinksRequest": { "description": "Request message for SearchLinks.", "type": "object", "id": "GoogleCloudDatacatalogLineageV1SearchLinksRequest", "properties": { "sources": { "description": "Optional. Send a list of asset information in the **sources** field to retrieve all links that lead from the specified assets to downstream assets. This field is similar to the `source` source field but allows providing multiple entities. All entities within the `MultipleEntityReference` must have the same `fully_qualified_name`.", "$ref": "GoogleCloudDatacatalogLineageV1MultipleEntityReference" }, "source": { "$ref": "GoogleCloudDatacatalogLineageV1EntityReference", "description": "Optional. Send asset information in the **source** field to retrieve all links that lead from the specified asset to downstream assets." }, "targets": { "$ref": "GoogleCloudDatacatalogLineageV1MultipleEntityReference", "description": "Optional. Send a list of asset information in the **targets** field to retrieve all links that lead from upstream assets to the specified assets. This field is similar to the `target` target field but allows providing multiple entities. All entities within the `MultipleEntityReference` must have the same `fully_qualified_name`." }, "pageSize": { "format": "int32", "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.", "type": "integer" }, "target": { "description": "Optional. Send asset information in the **target** field to retrieve all links that lead from upstream assets to the specified asset.", "$ref": "GoogleCloudDatacatalogLineageV1EntityReference" }, "pageToken": { "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.", "type": "string" } } }, "GoogleTypeInterval": { "id": "GoogleTypeInterval", "properties": { "startTime": { "format": "google-datetime", "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", "type": "string" }, "endTime": { "format": "google-datetime", "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", "type": "string" } }, "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.", "type": "object" }, "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequestSearchLimits": { "description": "Limits for the search results.", "type": "object", "properties": { "maxProcessPerLink": { "description": "Optional. The maximum number of processes to return per link. The default value is 0 and the maximum value is 100. If this value is non-zero, the response will contain process names for the links. To retrieve full process details in the response, include `links.processes.process` in the [FieldMask](https://developers.google.com/workspace/docs/api/how-tos/field-masks#read_with_a_field_mask).", "type": "integer", "format": "int32" }, "maxDepth": { "description": "Optional. The maximum depth of the search. The default value is 5 and maximum value is 100.", "type": "integer", "format": "int32" }, "maxResults": { "format": "int32", "description": "Optional. The maximum number of links to return in the response. The default value is 1_000 and the maximum value is 10_000.", "type": "integer" } }, "id": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequestSearchLimits" }, "GoogleCloudDatacatalogLineageV1OperationMetadata": { "properties": { "endTime": { "format": "google-datetime", "description": "Output only. The timestamp of the operation termination, regardless of its success. This field is unset if the operation is still ongoing.", "type": "string", "readOnly": true }, "resource": { "readOnly": true, "description": "Output only. The [relative name] (https://cloud.google.com//apis/design/resource_names#relative_resource_name) of the resource being operated on.", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The timestamp of the operation submission to the server.", "type": "string" }, "operationType": { "description": "Output only. The type of the operation being performed.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "DELETE", "CREATE" ], "enumDescriptions": [ "Unused.", "The resource deletion operation.", "The resource creation operation." ], "readOnly": true }, "state": { "readOnly": true, "enumDescriptions": [ "Unused.", "The operation has been created but is not yet started.", "The operation is underway.", "The operation completed successfully.", "The operation is no longer running and did not succeed." ], "description": "Output only. The current operation state.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "PENDING", "RUNNING", "SUCCEEDED", "FAILED" ] }, "resourceUuid": { "description": "Output only. The UUID of the resource being operated on.", "type": "string", "readOnly": true } }, "id": "GoogleCloudDatacatalogLineageV1OperationMetadata", "description": "Metadata describing the operation.", "type": "object" }, "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequest": { "id": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequest", "properties": { "rootCriteria": { "$ref": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequestRootCriteria", "description": "Required. Criteria for the root of the search." }, "limits": { "description": "Optional. Limits for the search.", "$ref": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequestSearchLimits" }, "filters": { "$ref": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequestSearchFilters", "description": "Optional. Filters for the search." }, "locations": { "items": { "type": "string" }, "description": "Required. The locations to search in. This list should contain the location from the `parent` field.", "type": "array" }, "direction": { "description": "Required. Direction of the search.", "type": "string", "enum": [ "SEARCH_DIRECTION_UNSPECIFIED", "DOWNSTREAM", "UPSTREAM" ], "enumDescriptions": [ "Direction is unspecified.", "Retrieve links that lead from the specified asset to downstream assets.", "Retrieve links that lead from upstream assets to the specified asset." ] } }, "description": "Request message for SearchLineageStreaming.", "type": "object" }, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "type": "object", "properties": {}, "id": "GoogleLongrunningCancelOperationRequest" }, "GoogleCloudDatacatalogLineageV1MultipleEntityReference": { "description": "Multiple entity reference for SearchLinksRequest.", "type": "object", "id": "GoogleCloudDatacatalogLineageV1MultipleEntityReference", "properties": { "entities": { "items": { "$ref": "GoogleCloudDatacatalogLineageV1EntityReference" }, "description": "Optional. The list of entities to search for links. The maximum number of entities is 20.", "type": "array" } } }, "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequestSearchFilters": { "description": "Filters for the search.", "type": "object", "id": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequestSearchFilters", "properties": { "dependencyTypes": { "items": { "type": "string", "enum": [ "DEPENDENCY_TYPE_UNSPECIFIED", "EXACT_COPY", "OTHER" ], "enumDescriptions": [ "Dependency type unspecified.", "Exact data copy without any change.", "Other types of dependencies like filtering or grouping." ] }, "description": "Optional. Types of dependencies between entities to retrieve. If unspecified, all dependency types are returned.", "type": "array" }, "entitySet": { "description": "Optional. Entity set restriction. If unspecified, the method returns all entities.", "type": "string", "enum": [ "ENTITY_SET_UNSPECIFIED", "ENTITIES" ], "enumDescriptions": [ "The entity set is unspecified. Returns all the data.", "Returns entities with only FQN specified. For example, entities with the `field` field set are not returned." ] }, "timeRange": { "description": "Optional. Time interval to search for lineage. If unspecified, all lineage is returned. Currently, at most one of `start_time` and `end_time` can be set.", "$ref": "GoogleTypeInterval" } } }, "GoogleCloudDatacatalogLineageV1Origin": { "description": "Origin of a process.", "type": "object", "id": "GoogleCloudDatacatalogLineageV1Origin", "properties": { "name": { "description": "If the source_type isn't CUSTOM, the value of this field should be a Google Cloud 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\"}`", "type": "string" }, "sourceType": { "enumDescriptions": [ "Source is Unspecified", "A custom source", "BigQuery", "Data Fusion", "Composer", "Looker Studio", "Dataproc", "Vertex AI", "Dataflow", "Looker Core" ], "description": "Type of the source. Use of a source_type other than `CUSTOM` for process creation or updating is highly discouraged. It might be restricted in the future without notice. There will be increase in cost if you use any of the source types other than `CUSTOM`.", "type": "string", "enum": [ "SOURCE_TYPE_UNSPECIFIED", "CUSTOM", "BIGQUERY", "DATA_FUSION", "COMPOSER", "LOOKER_STUDIO", "DATAPROC", "VERTEX_AI", "DATAFLOW", "LOOKER_CORE" ] } } }, "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest": { "description": "Request message for BatchSearchLinkProcesses.", "type": "object", "properties": { "pageToken": { "description": "Optional. 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.", "type": "string" }, "links": { "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}`.", "type": "array", "items": { "type": "string" } }, "pageSize": { "description": "Optional. The maximum number of processes to return in a single page of the response. A page may contain fewer results than this value.", "type": "integer", "format": "int32" } }, "id": "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest" }, "GoogleLongrunningListOperationsResponse": { "properties": { "unreachable": { "items": { "type": "string" }, "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array" }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "operations": { "items": { "$ref": "GoogleLongrunningOperation" }, "description": "A list of operations that matches the specified filter in the request.", "type": "array" } }, "id": "GoogleLongrunningListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object" }, "GoogleCloudDatacatalogLineageV1ListProcessesResponse": { "description": "Response message for ListProcesses.", "type": "object", "properties": { "nextPageToken": { "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.", "type": "string" }, "processes": { "items": { "$ref": "GoogleCloudDatacatalogLineageV1Process" }, "description": "The processes from the specified project and location.", "type": "array" } }, "id": "GoogleCloudDatacatalogLineageV1ListProcessesResponse" }, "GoogleCloudDatacatalogLineageV1LineageEvent": { "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.", "type": "object", "id": "GoogleCloudDatacatalogLineageV1LineageEvent", "properties": { "links": { "description": "Optional. List of source-target pairs. Can't contain more than 100 tuples.", "type": "array", "items": { "$ref": "GoogleCloudDatacatalogLineageV1EventLink" } }, "startTime": { "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.", "type": "string", "format": "google-datetime" }, "name": { "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_-:.`", "type": "string" }, "endTime": { "format": "google-datetime", "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.", "type": "string" } } }, "GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRuleLineageEnablement": { "description": "Lineage enablement configuration. Defines configurations for the ingestion of lineage for the resource and its children.", "type": "object", "id": "GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRuleLineageEnablement", "properties": { "enabled": { "description": "Optional. If true, ingestion of lineage should be enabled. If false, it should be disabled. If unspecified, the system default value is used.", "type": "boolean" } } }, "GoogleCloudDatacatalogLineageV1Link": { "properties": { "name": { "readOnly": true, "description": "Output only. Immutable. The name of the link. Format: `projects/{project}/locations/{location}/links/{link}`.", "type": "string" }, "source": { "description": "The pointer to the entity that is the **source** of this link.", "$ref": "GoogleCloudDatacatalogLineageV1EntityReference" }, "endTime": { "format": "google-datetime", "description": "The end of the last event establishing this link.", "type": "string" }, "dependencyInfo": { "items": { "$ref": "GoogleCloudDatacatalogLineageV1LinkDependencyInfo" }, "description": "Optional. The dependency info of the link (applies only to column level links).", "type": "array" }, "target": { "description": "The pointer to the entity that is the **target** of this link.", "$ref": "GoogleCloudDatacatalogLineageV1EntityReference" }, "startTime": { "description": "The start of the first event establishing this link.", "type": "string", "format": "google-datetime" } }, "id": "GoogleCloudDatacatalogLineageV1Link", "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.", "type": "object" }, "GoogleCloudDatacatalogLineageV1SearchLineageStreamingResponse": { "description": "Response message for SearchLineageStreaming.", "type": "object", "id": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingResponse", "properties": { "links": { "readOnly": true, "items": { "$ref": "GoogleCloudDatacatalogLineageV1LineageLink" }, "description": "Output only. The lineage links that match the search criteria. Can be empty if no links match.", "type": "array" }, "unreachable": { "description": "Unordered list. Unreachable resources. If non-empty, the result set might be incomplete. Currently, only locations are supported. Format: `projects/[PROJECT_NUMBER]/locations/[LOCATION]` Example: projects/123456789/locations/us-east1", "type": "array", "items": { "type": "string" } } } }, "GoogleCloudDatacatalogLineageV1EntityReference": { "description": "The soft reference to everything you can attach a lineage event to.", "type": "object", "properties": { "fullyQualifiedName": { "description": "Required. [Fully Qualified Name (FQN)](https://cloud.google.com/dataplex/docs/fully-qualified-names) of the entity.", "type": "string" }, "field": { "description": "Optional. Field path within the entity. Each nesting level should be a separate value in the repeated field. The order matters. Must be empty for asset level lineage For example to address \"salary.net\" subfield where \"salary\" is a column and \"net\" is a proto field two values in the `field` should be reported, the first is \"salary\" and the second is \"net\". Each field length is limited to 500 characters. Maximum supported nesting level is 20.", "type": "array", "items": { "type": "string" } } }, "id": "GoogleCloudDatacatalogLineageV1EntityReference" }, "GoogleCloudDatacatalogLineageV1ListRunsResponse": { "id": "GoogleCloudDatacatalogLineageV1ListRunsResponse", "properties": { "runs": { "items": { "$ref": "GoogleCloudDatacatalogLineageV1Run" }, "description": "The runs from the specified project and location.", "type": "array" }, "nextPageToken": { "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.", "type": "string" } }, "description": "Response message for ListRuns.", "type": "object" }, "GoogleCloudDatacatalogLineageV1LinkDependencyInfo": { "description": "Dependency info describes how one entity depends on another.", "type": "object", "properties": { "dependencyType": { "description": "The type of dependency.", "type": "string", "enum": [ "DEPENDENCY_TYPE_UNSPECIFIED", "EXACT_COPY", "OTHER" ], "enumDescriptions": [ "Dependency type unspecified.", "Exact data copy without any change.", "Other types of dependencies like filtering or grouping." ] } }, "id": "GoogleCloudDatacatalogLineageV1LinkDependencyInfo" }, "GoogleCloudDatacatalogLineageV1LineageLinkDependencyInfo": { "description": "Dependency info describes how one entity is dependent on another.", "type": "object", "properties": { "dependencyType": { "description": "The type of dependency.", "type": "string", "enum": [ "DEPENDENCY_TYPE_UNSPECIFIED", "EXACT_COPY", "OTHER" ], "enumDescriptions": [ "Dependency type unspecified.", "Exact data copy without any change.", "Other types of dependencies like filtering or grouping." ] } }, "id": "GoogleCloudDatacatalogLineageV1LineageLinkDependencyInfo" }, "GoogleLongrunningOperation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "id": "GoogleLongrunningOperation", "properties": { "name": { "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}`.", "type": "string" }, "done": { "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.", "type": "boolean" }, "response": { "description": "The normal, successful response of the operation. 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`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "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.", "type": "object" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "GoogleRpcStatus" } } }, "GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestion": { "id": "GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestion", "properties": { "rules": { "description": "Optional. List of rules for Data Lineage ingestion.", "type": "array", "items": { "$ref": "GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRule" } } }, "description": "Defines how Lineage should be ingested for a given resource.", "type": "object" }, "GoogleCloudDatacatalogLineageV1LineageLink": { "properties": { "target": { "$ref": "GoogleCloudDatacatalogLineageV1EntityReference", "description": "The entity that is the **target** of this link." }, "location": { "description": "The location where the LineageEvent that created the link is stored.", "type": "string" }, "source": { "description": "The entity that is the **source** of this link.", "$ref": "GoogleCloudDatacatalogLineageV1EntityReference" }, "depth": { "format": "int32", "description": "Depth of the current link in the graph starting from 1.", "type": "integer" }, "processes": { "items": { "$ref": "GoogleCloudDatacatalogLineageV1LineageLinkLineageProcess" }, "description": "Processes metadata associated with the link.", "type": "array" }, "dependencyInfo": { "items": { "$ref": "GoogleCloudDatacatalogLineageV1LineageLinkDependencyInfo" }, "description": "Describes how the target entity is dependent on the source entity.", "type": "array" } }, "id": "GoogleCloudDatacatalogLineageV1LineageLink", "description": "Lineage link between two entities.", "type": "object" }, "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse": { "properties": { "processLinks": { "items": { "$ref": "GoogleCloudDatacatalogLineageV1ProcessLinks" }, "description": "An array of processes associated with the specified links.", "type": "array" }, "nextPageToken": { "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.", "type": "string" } }, "id": "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse", "description": "Response message for BatchSearchLinkProcesses.", "type": "object" }, "GoogleCloudDatacatalogLineageConfigmanagementV1Config": { "description": "Configuration for Data Lineage. Defines different configuration options for Lineage customers to control behaviour of lineage systems.", "type": "object", "id": "GoogleCloudDatacatalogLineageConfigmanagementV1Config", "properties": { "ingestion": { "description": "Optional. Ingestion rule for Data Lineage ingestion.", "$ref": "GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestion" }, "etag": { "description": "Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a config from overwriting each other. It is required that systems make use of the `etag` in the read-modify-write cycle to perform config updates in order to avoid race conditions: An `etag` is returned in the response to `GetConfig`, and systems are expected to put that etag in the request to `UpdateConfig` to ensure that their change will be applied to the same version of the config. If an `etag` is not provided in the call to `UpdateConfig`, then the existing config, if any, will be overwritten.", "type": "string" }, "name": { "description": "Identifier. The resource name of the config. Format: `organizations/{organization_id}/locations/global/config` `folders/{folder_id}/locations/global/config` `projects/{project_id}/locations/global/config` `projects/{project_number}/locations/global/config`", "type": "string" } } }, "GoogleCloudDatacatalogLineageV1Run": { "description": "A lineage run represents an execution of a process that creates lineage events.", "type": "object", "id": "GoogleCloudDatacatalogLineageV1Run", "properties": { "name": { "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_-:.`", "type": "string" }, "endTime": { "format": "google-datetime", "description": "Optional. The timestamp of the end of the run.", "type": "string" }, "startTime": { "description": "Required. The timestamp of the start of the run.", "type": "string", "format": "google-datetime" }, "state": { "enumDescriptions": [ "The state is unknown. The true state may be any of the below or a different state that is not supported here explicitly.", "The run is still executing.", "The run completed.", "The run failed.", "The run aborted." ], "description": "Required. The state of the run.", "type": "string", "enum": [ "UNKNOWN", "STARTED", "COMPLETED", "FAILED", "ABORTED" ] }, "attributes": { "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.", "type": "object", "additionalProperties": { "type": "any" } }, "displayName": { "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 `_-:&.`", "type": "string" } } }, "GoogleCloudDatacatalogLineageV1ProcessLinks": { "description": "Links associated with a specific process.", "type": "object", "id": "GoogleCloudDatacatalogLineageV1ProcessLinks", "properties": { "links": { "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.", "type": "array", "items": { "$ref": "GoogleCloudDatacatalogLineageV1ProcessLinkInfo" } }, "process": { "description": "The process name in the format of `projects/{project}/locations/{location}/processes/{process}`.", "type": "string" } } }, "GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse": { "id": "GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse", "properties": { "process": { "description": "Created process name. Format: `projects/{project}/locations/{location}/processes/{process}`.", "type": "string" }, "run": { "description": "Created run name. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}`.", "type": "string" }, "lineageEvents": { "items": { "type": "string" }, "description": "Created lineage event names. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`.", "type": "array" } }, "description": "Response message for ProcessOpenLineageRunEvent.", "type": "object" }, "GoogleCloudDatacatalogLineageV1SearchLinksResponse": { "properties": { "nextPageToken": { "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.", "type": "string" }, "links": { "items": { "$ref": "GoogleCloudDatacatalogLineageV1Link" }, "description": "The list of links for a given asset. Can be empty if the asset has no relations of requested type (source or target).", "type": "array" } }, "id": "GoogleCloudDatacatalogLineageV1SearchLinksResponse", "description": "Response message for SearchLinks.", "type": "object" }, "GoogleProtobufEmpty": { "properties": {}, "id": "GoogleProtobufEmpty", "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); }", "type": "object" }, "GoogleRpcStatus": { "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).", "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "message": { "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.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" } } }, "id": "GoogleRpcStatus" }, "GoogleCloudDatacatalogLineageV1Process": { "id": "GoogleCloudDatacatalogLineageV1Process", "properties": { "attributes": { "additionalProperties": { "type": "any" }, "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.", "type": "object" }, "name": { "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_-:.`", "type": "string" }, "displayName": { "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 `_-:&.`", "type": "string" }, "origin": { "$ref": "GoogleCloudDatacatalogLineageV1Origin", "description": "Optional. The origin of this process and its runs and lineage events." } }, "description": "A process is the definition of a data transformation operation.", "type": "object" }, "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequestRootCriteria": { "description": "Criteria for the root of the search.", "type": "object", "id": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequestRootCriteria", "properties": { "entities": { "$ref": "GoogleCloudDatacatalogLineageV1MultipleEntityReference", "description": "Optional. The entities to initiate the search from. Entities can be specified by FQN only, or by FQN and field. To search by FQN and all available fields for that FQN, use the wildcard `*` as the field value." } } }, "GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRuleIntegrationSelector": { "description": "Integration selector of the rule. The rule is only applied to the Integration selected by the selector.", "type": "object", "id": "GoogleCloudDatacatalogLineageConfigmanagementV1ConfigIngestionIngestionRuleIntegrationSelector", "properties": { "integration": { "enumDescriptions": [ "Integration is Unspecified", "Dataproc", "Looker Core" ], "description": "Required. Integration to which the rule applies. This field can be used to specify the integration against which the ingestion rule should be applied.", "type": "string", "enum": [ "INTEGRATION_UNSPECIFIED", "DATAPROC", "LOOKER_CORE" ] } } }, "GoogleCloudDatacatalogLineageV1ListLineageEventsResponse": { "id": "GoogleCloudDatacatalogLineageV1ListLineageEventsResponse", "properties": { "nextPageToken": { "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.", "type": "string" }, "lineageEvents": { "description": "Lineage events from the specified project and location.", "type": "array", "items": { "$ref": "GoogleCloudDatacatalogLineageV1LineageEvent" } } }, "description": "Response message for ListLineageEvents.", "type": "object" }, "GoogleCloudDatacatalogLineageV1LineageLinkLineageProcess": { "description": "Process metadata for the link.", "type": "object", "properties": { "process": { "description": "Process that created the link.", "$ref": "GoogleCloudDatacatalogLineageV1Process" } }, "id": "GoogleCloudDatacatalogLineageV1LineageLinkLineageProcess" }, "GoogleCloudDatacatalogLineageV1EventLink": { "description": "A lineage between source and target entities.", "type": "object", "properties": { "source": { "description": "Required. Reference to the source entity", "$ref": "GoogleCloudDatacatalogLineageV1EntityReference" }, "target": { "$ref": "GoogleCloudDatacatalogLineageV1EntityReference", "description": "Required. Reference to the target entity" }, "dependencyInfo": { "description": "Optional. Describes how the target depends on the source.", "$ref": "GoogleCloudDatacatalogLineageV1DependencyInfo" } }, "id": "GoogleCloudDatacatalogLineageV1EventLink" }, "GoogleCloudDatacatalogLineageV1ProcessLinkInfo": { "description": "Link details.", "type": "object", "properties": { "endTime": { "description": "The end of the last event establishing this link-process tuple.", "type": "string", "format": "google-datetime" }, "startTime": { "description": "The start of the first event establishing this link-process tuple.", "type": "string", "format": "google-datetime" }, "link": { "description": "The name of the link in the format of `projects/{project}/locations/{location}/links/{link}`.", "type": "string" } }, "id": "GoogleCloudDatacatalogLineageV1ProcessLinkInfo" }, "GoogleCloudDatacatalogLineageV1DependencyInfo": { "id": "GoogleCloudDatacatalogLineageV1DependencyInfo", "properties": { "dependencyType": { "enumDescriptions": [ "Dependency type unspecified.", "Exact data copy without any change.", "Other types of dependencies like filtering or grouping." ], "description": "Required. Type of dependency.", "type": "string", "enum": [ "DEPENDENCY_TYPE_UNSPECIFIED", "EXACT_COPY", "OTHER" ] } }, "description": "Dependency info describes how one entity depends on another.", "type": "object" } }, "version": "v1", "basePath": "", "description": "", "documentationLink": "https://cloud.google.com/data-catalog", "id": "datalineage:v1", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/datalineage.read-write": { "description": "See, edit, configure, and delete your Google Cloud Data Lineage data and see the email address for your Google Account" }, "https://www.googleapis.com/auth/datalineage.readonly": { "description": "See your Google Cloud Data Lineage data and the email address of your Google Account" }, "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "servicePath": "", "ownerName": "Google", "mtlsRootUrl": "https://datalineage.mtls.googleapis.com/", "resources": { "projects": { "resources": { "locations": { "methods": { "processOpenLineageRunEvent": { "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:processOpenLineageRunEvent", "response": { "$ref": "GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The name of the project and its location that should own the process, run, and lineage event.", "location": "path", "type": "string" }, "requestId": { "description": "Optional. 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.", "location": "query", "type": "string" } }, "description": "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.", "id": "datalineage.projects.locations.processOpenLineageRunEvent", "path": "v1/{+parent}:processOpenLineageRunEvent", "request": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "batchSearchLinkProcesses": { "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.", "id": "datalineage.projects.locations.batchSearchLinkProcesses", "path": "v1/{+parent}:batchSearchLinkProcesses", "request": { "$ref": "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest" }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:batchSearchLinkProcesses", "response": { "$ref": "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The project and location where you want to search.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } } }, "searchLineageStreaming": { "response": { "$ref": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/datalineage.read-write", "https://www.googleapis.com/auth/datalineage.readonly" ], "httpMethod": "POST", "parameters": { "parent": { "required": true, "description": "Required. The project and location to initiate the search from.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:searchLineageStreaming", "id": "datalineage.projects.locations.searchLineageStreaming", "path": "v1/{+parent}:searchLineageStreaming", "request": { "$ref": "GoogleCloudDatacatalogLineageV1SearchLineageStreamingRequest" }, "description": "Retrieves a streaming response of lineage links connected to the requested assets by performing a breadth-first search in the given direction. 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. This method retrieves links from all valid locations provided in the request. This method supports Column-Level Lineage (CLL) along with wildcard support to retrieve all CLL for an Entity FQN. Following permissions are required to retrieve links: * `datalineage.events.get` permission for the project where the link is stored for entity-level lineage. * `datalineage.events.getFields` permission for the project where the link is stored for column-level lineage. This method also returns processes that created the links if explicitly requested by setting [max_process_per_link](google.cloud.datacatalog.lineage.v1.SearchLineageStreamingRequest.limits.max_process_per_link) is non-zero and full process details are requested via `links.processes.process` in the [FieldMask](https://developers.google.com/workspace/docs/api/how-tos/field-masks#read_with_a_field_mask). Permission required to retrieve processes: * `datalineage.processes.get` permission for the project where the process is stored." }, "searchLinks": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:searchLinks", "parameterOrder": [ "parent" ], "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The project and location you want search in.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "response": { "$ref": "GoogleCloudDatacatalogLineageV1SearchLinksResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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.", "request": { "$ref": "GoogleCloudDatacatalogLineageV1SearchLinksRequest" }, "id": "datalineage.projects.locations.searchLinks", "path": "v1/{+parent}:searchLinks" } }, "resources": { "processes": { "methods": { "create": { "description": "Creates a new process.", "id": "datalineage.projects.locations.processes.create", "path": "v1/{+parent}/processes", "request": { "$ref": "GoogleCloudDatacatalogLineageV1Process" }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes", "response": { "$ref": "GoogleCloudDatacatalogLineageV1Process" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The name of the project and its location that should own the process.", "location": "path", "type": "string" }, "requestId": { "description": "Optional. 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.", "location": "query", "type": "string" } } }, "patch": { "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}", "response": { "$ref": "GoogleCloudDatacatalogLineageV1Process" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "parameters": { "allowMissing": { "description": "Optional. If set to true and the process is not found, the request inserts it.", "location": "query", "type": "boolean" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+$", "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_-:.`", "location": "path", "type": "string", "required": true }, "updateMask": { "description": "Optional. The list of fields to update. Currently not used. The whole message is updated.", "location": "query", "type": "string", "format": "google-fieldmask" }, "requestId": { "description": "Optional. 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.", "location": "query", "type": "string" } }, "description": "Updates a process.", "id": "datalineage.projects.locations.processes.patch", "path": "v1/{+name}", "request": { "$ref": "GoogleCloudDatacatalogLineageV1Process" } }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+$", "required": true, "description": "Required. The name of the process to get.", "location": "path", "type": "string" } }, "response": { "$ref": "GoogleCloudDatacatalogLineageV1Process" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the details of the specified process.", "id": "datalineage.projects.locations.processes.get", "path": "v1/{+name}" }, "delete": { "httpMethod": "DELETE", "parameters": { "allowMissing": { "description": "Optional. If set to true and the process is not found, the request succeeds but the server doesn't perform any actions.", "location": "query", "type": "boolean" }, "name": { "required": true, "description": "Required. The name of the process to delete.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+$" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}", "parameterOrder": [ "name" ], "id": "datalineage.projects.locations.processes.delete", "path": "v1/{+name}", "description": "Deletes the process with the specified name." }, "list": { "id": "datalineage.projects.locations.processes.list", "path": "v1/{+parent}/processes", "description": "List processes in the given project and location. List order is descending by insertion time.", "response": { "$ref": "GoogleCloudDatacatalogLineageV1ListProcessesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "pageToken": { "description": "Optional. 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.", "location": "query", "type": "string" }, "parent": { "description": "Required. The name of the project and its location that owns this collection of processes.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageSize": { "description": "Optional. 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.", "location": "query", "type": "integer", "format": "int32" } }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes" } }, "resources": { "runs": { "methods": { "list": { "description": "Lists runs in the given project and location. List order is descending by `start_time`.", "id": "datalineage.projects.locations.processes.runs.list", "path": "v1/{+parent}/runs", "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs", "response": { "$ref": "GoogleCloudDatacatalogLineageV1ListRunsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "pageToken": { "description": "Optional. 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.", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+$", "description": "Required. The name of process that owns this collection of runs.", "location": "path", "type": "string", "required": true }, "pageSize": { "format": "int32", "description": "Optional. 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.", "location": "query", "type": "integer" } } }, "create": { "httpMethod": "POST", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+$", "required": true, "description": "Required. The name of the process that should own the run.", "location": "path", "type": "string" }, "requestId": { "description": "Optional. 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.", "location": "query", "type": "string" } }, "response": { "$ref": "GoogleCloudDatacatalogLineageV1Run" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudDatacatalogLineageV1Run" }, "id": "datalineage.projects.locations.processes.runs.create", "path": "v1/{+parent}/runs", "description": "Creates a new run." }, "patch": { "request": { "$ref": "GoogleCloudDatacatalogLineageV1Run" }, "id": "datalineage.projects.locations.processes.runs.patch", "path": "v1/{+name}", "description": "Updates a run.", "httpMethod": "PATCH", "parameters": { "updateMask": { "format": "google-fieldmask", "description": "Optional. The list of fields to update. Currently not used. The whole message is updated.", "location": "query", "type": "string" }, "allowMissing": { "description": "Optional. If set to true and the run is not found, the request creates it.", "location": "query", "type": "boolean" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+$", "required": true, "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_-:.`", "location": "path", "type": "string" } }, "response": { "$ref": "GoogleCloudDatacatalogLineageV1Run" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}", "parameterOrder": [ "name" ] }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+$", "required": true, "description": "Required. The name of the run to get.", "location": "path", "type": "string" } }, "response": { "$ref": "GoogleCloudDatacatalogLineageV1Run" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the details of the specified run.", "id": "datalineage.projects.locations.processes.runs.get", "path": "v1/{+name}" }, "delete": { "id": "datalineage.projects.locations.processes.runs.delete", "path": "v1/{+name}", "description": "Deletes the run with the specified name.", "httpMethod": "DELETE", "parameters": { "allowMissing": { "description": "Optional. If set to true and the run is not found, the request succeeds but the server doesn't perform any actions.", "location": "query", "type": "boolean" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+$", "required": true, "description": "Required. The name of the run to delete.", "location": "path", "type": "string" } }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}", "parameterOrder": [ "name" ] } }, "resources": { "lineageEvents": { "methods": { "create": { "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents", "response": { "$ref": "GoogleCloudDatacatalogLineageV1LineageEvent" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The name of the run that should own the lineage event.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+$" }, "requestId": { "description": "Optional. 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.", "location": "query", "type": "string" } }, "description": "Creates a new lineage event.", "id": "datalineage.projects.locations.processes.runs.lineageEvents.create", "path": "v1/{+parent}/lineageEvents", "request": { "$ref": "GoogleCloudDatacatalogLineageV1LineageEvent" } }, "get": { "id": "datalineage.projects.locations.processes.runs.lineageEvents.get", "path": "v1/{+name}", "description": "Gets details of a specified lineage event.", "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+/lineageEvents/[^/]+$", "required": true, "description": "Required. The name of the lineage event to get.", "location": "path", "type": "string" } }, "response": { "$ref": "GoogleCloudDatacatalogLineageV1LineageEvent" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents/{lineageEventsId}", "parameterOrder": [ "name" ] }, "delete": { "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+/lineageEvents/[^/]+$", "required": true, "description": "Required. The name of the lineage event to delete.", "location": "path", "type": "string" }, "allowMissing": { "description": "Optional. If set to true and the lineage event is not found, the request succeeds but the server doesn't perform any actions.", "location": "query", "type": "boolean" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents/{lineageEventsId}", "parameterOrder": [ "name" ], "id": "datalineage.projects.locations.processes.runs.lineageEvents.delete", "path": "v1/{+name}", "description": "Deletes the lineage event with the specified name." }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents", "parameterOrder": [ "parent" ], "httpMethod": "GET", "parameters": { "pageToken": { "description": "Optional. 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.", "location": "query", "type": "string" }, "parent": { "description": "Required. The name of the run that owns the collection of lineage events to get.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+$" }, "pageSize": { "description": "Optional. 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.", "location": "query", "type": "integer", "format": "int32" } }, "response": { "$ref": "GoogleCloudDatacatalogLineageV1ListLineageEventsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists lineage events in the given project and location. The list order is not defined.", "id": "datalineage.projects.locations.processes.runs.lineageEvents.list", "path": "v1/{+parent}/lineageEvents" } } } } } } }, "operations": { "methods": { "get": { "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.", "id": "datalineage.projects.locations.operations.get", "path": "v1/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource.", "location": "path", "type": "string" } } }, "delete": { "id": "datalineage.projects.locations.operations.delete", "path": "v1/{+name}", "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`.", "httpMethod": "DELETE", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameterOrder": [ "name" ] }, "cancel": { "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`.", "id": "datalineage.projects.locations.operations.cancel", "path": "v1/{+name}:cancel", "request": { "$ref": "GoogleLongrunningCancelOperationRequest" }, "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } } }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "id": "datalineage.projects.locations.operations.list", "path": "v1/{+name}/operations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "name": { "description": "The name of the operation's parent resource.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "config": { "methods": { "get": { "id": "datalineage.projects.locations.config.get", "path": "v1/{+name}", "description": "Get the Config for a given resource.", "response": { "$ref": "GoogleCloudDatacatalogLineageConfigmanagementV1Config" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "Required. REQUIRED: The resource name of the config to be fetched. Format: `organizations/{organization_id}/locations/global/config` `folders/{folder_id}/locations/global/config` `projects/{project_id}/locations/global/config` `projects/{project_number}/locations/global/config`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/config$" } }, "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/config" }, "patch": { "id": "datalineage.projects.locations.config.patch", "path": "v1/{+name}", "request": { "$ref": "GoogleCloudDatacatalogLineageConfigmanagementV1Config" }, "description": "Update the Config for a given resource.", "response": { "$ref": "GoogleCloudDatacatalogLineageConfigmanagementV1Config" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "parameters": { "name": { "required": true, "description": "Identifier. The resource name of the config. Format: `organizations/{organization_id}/locations/global/config` `folders/{folder_id}/locations/global/config` `projects/{project_id}/locations/global/config` `projects/{project_number}/locations/global/config`", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/config$" } }, "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/config" } } } } } } }, "folders": { "resources": { "locations": { "resources": { "config": { "methods": { "get": { "response": { "$ref": "GoogleCloudDatacatalogLineageConfigmanagementV1Config" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameters": { "name": { "description": "Required. REQUIRED: The resource name of the config to be fetched. Format: `organizations/{organization_id}/locations/global/config` `folders/{folder_id}/locations/global/config` `projects/{project_id}/locations/global/config` `projects/{project_number}/locations/global/config`", "location": "path", "type": "string", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/config$" } }, "parameterOrder": [ "name" ], "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/config", "id": "datalineage.folders.locations.config.get", "path": "v1/{+name}", "description": "Get the Config for a given resource." }, "patch": { "id": "datalineage.folders.locations.config.patch", "path": "v1/{+name}", "request": { "$ref": "GoogleCloudDatacatalogLineageConfigmanagementV1Config" }, "description": "Update the Config for a given resource.", "response": { "$ref": "GoogleCloudDatacatalogLineageConfigmanagementV1Config" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. The resource name of the config. Format: `organizations/{organization_id}/locations/global/config` `folders/{folder_id}/locations/global/config` `projects/{project_id}/locations/global/config` `projects/{project_number}/locations/global/config`", "location": "path", "type": "string", "required": true, "pattern": "^folders/[^/]+/locations/[^/]+/config$" } }, "parameterOrder": [ "name" ], "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/config" } } } } } } }, "organizations": { "resources": { "locations": { "resources": { "config": { "methods": { "get": { "description": "Get the Config for a given resource.", "id": "datalineage.organizations.locations.config.get", "path": "v1/{+name}", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/config", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "pattern": "^organizations/[^/]+/locations/[^/]+/config$", "description": "Required. REQUIRED: The resource name of the config to be fetched. Format: `organizations/{organization_id}/locations/global/config` `folders/{folder_id}/locations/global/config` `projects/{project_id}/locations/global/config` `projects/{project_number}/locations/global/config`", "location": "path", "type": "string", "required": true } }, "response": { "$ref": "GoogleCloudDatacatalogLineageConfigmanagementV1Config" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "response": { "$ref": "GoogleCloudDatacatalogLineageConfigmanagementV1Config" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^organizations/[^/]+/locations/[^/]+/config$", "description": "Identifier. The resource name of the config. Format: `organizations/{organization_id}/locations/global/config` `folders/{folder_id}/locations/global/config` `projects/{project_id}/locations/global/config` `projects/{project_number}/locations/global/config`", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "name" ], "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/config", "id": "datalineage.organizations.locations.config.patch", "path": "v1/{+name}", "request": { "$ref": "GoogleCloudDatacatalogLineageConfigmanagementV1Config" }, "description": "Update the Config for a given resource." } } } } } } } }, "revision": "20260606", "ownerDomain": "google.com", "fullyEncodeReservedExpansion": true, "rootUrl": "https://datalineage.googleapis.com/", "discoveryVersion": "v1", "batchPath": "batch", "name": "datalineage", "canonicalName": "Datalineage" }