Method: projects.locations.searchLinks

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.

HTTP request

POST https://datalineage.googleapis.com/v1/{parent}:searchLinks

Path parameters

Parameters

Parameters
`parent`	`string` Required. The project and location you want search in. It takes the form `projects/{project}/locations/{location}`.

parent

string

Required. The project and location you want search in. It takes the form projects/{project}/locations/{location}.

Request body

The request body contains data with the following structure:

JSON representation

JSON representation
{ "pageSize": integer, "pageToken": string, // Union field `criteria` can be only one of the following: "source": { object (`EntityReference`) }, "target": { object (`EntityReference`) } // End of list of possible types for union field `criteria`. }

{
  "pageSize": integer,
  "pageToken": string,

  // Union field criteria can be only one of the following:
  "source": {
    object (EntityReference)
  },
  "target": {
    object (EntityReference)
  }
  // End of list of possible types for union field criteria.
}

Fields
`pageSize`	`integer` 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.
`pageToken`	`string` 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.
Union field `criteria`. The asset for which you want to retrieve links. `criteria` can be only one of the following:
`source`	`object (EntityReference)` Optional. Send asset information in the source field to retrieve all links that lead from the specified asset to downstream assets.
`target`	`object (EntityReference)` Optional. Send asset information in the target field to retrieve all links that lead from upstream assets to the specified asset.

Response body

Response message for locations.searchLinks.

If successful, the response body contains data with the following structure:

JSON representation
{ "links": [ { object (`Link`) } ], "nextPageToken": string }

Fields

Fields
`links[]`	`object (Link)` The list of links for a given asset. Can be empty if the asset has no relations of requested type (source or target).
`nextPageToken`	`string` The token to specify as `pageToken` in the subsequent call to get the next page. Omitted if there are no more pages in the response.

links[]

object (Link)

The list of links for a given asset. Can be empty if the asset has no relations of requested type (source or target).

nextPageToken

string

The token to specify as pageToken in the subsequent call to get the next page. Omitted if there are no more pages in the response.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

datalineage.locations.searchLinks

For more information, see the IAM documentation.

Link

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.

JSON representation
{ "name": string, "source": { object (`EntityReference`) }, "target": { object (`EntityReference`) }, "startTime": string, "endTime": string }

Fields
`name`	`string` Output only. Immutable. The name of the link. Format: `projects/{project}/locations/{location}/links/{link}`.
`source`	`object (EntityReference)` The pointer to the entity that is the source of this link.
`target`	`object (EntityReference)` The pointer to the entity that is the target of this link.
`startTime`	`string (Timestamp format)` The start of the first event establishing this link. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`endTime`	`string (Timestamp format)` The end of the last event establishing this link. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.