Data Lineage API . projects . locations

batchSearchLinkProcesses(parent, body=None, x__xgafv=None)

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.

Args:
  parent: string, Required. The project and location where you want to search. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for BatchSearchLinkProcesses.
  "links": [ # 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}`.
    "A String",
  ],
  "pageSize": 42, # The maximum number of processes to return in a single page of the response. A page may contain fewer results than this value.
  "pageToken": "A String", # 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.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for BatchSearchLinkProcesses.
  "nextPageToken": "A String", # 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.
  "processLinks": [ # An array of processes associated with the specified links.
    { # Links associated with a specific process.
      "links": [ # 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.
        { # Link details.
          "endTime": "A String", # The end of the last event establishing this link-process tuple.
          "link": "A String", # The name of the link in the format of `projects/{project}/locations/{location}/links/{link}`.
          "startTime": "A String", # The start of the first event establishing this link-process tuple.
        },
      ],
      "process": "A String", # The process name in the format of `projects/{project}/locations/{location}/processes/{process}`.
    },
  ],
}

batchSearchLinkProcesses_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

close()

Close httplib2 connections.

processOpenLineageRunEvent(parent, body=None, requestId=None, x__xgafv=None)

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.

Args:
  parent: string, Required. The name of the project and its location that should own the process, run, and lineage event. (required)
  body: object, The request body.
  requestId: string, 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ProcessOpenLineageRunEvent.
  "lineageEvents": [ # Created lineage event names. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`.
    "A String",
  ],
  "process": "A String", # Created process name. Format: `projects/{project}/locations/{location}/processes/{process}`.
  "run": "A String", # Created run name. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}`.
}

searchLinks(parent, body=None, x__xgafv=None)

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.

Args:
  parent: string, Required. The project and location you want search in. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for SearchLinks.
  "pageSize": 42, # 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": "A 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.
  "source": { # The soft reference to everything you can attach a lineage event to. # Optional. Send asset information in the **source** field to retrieve all links that lead from the specified asset to downstream assets.
    "fullyQualifiedName": "A String", # Required. [Fully Qualified Name (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) of the entity.
  },
  "target": { # The soft reference to everything you can attach a lineage event to. # Optional. Send asset information in the **target** field to retrieve all links that lead from upstream assets to the specified asset.
    "fullyQualifiedName": "A String", # Required. [Fully Qualified Name (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) of the entity.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for SearchLinks.
  "links": [ # The list of links for a given asset. Can be empty if the asset has no relations of requested type (source or target).
    { # 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.
      "endTime": "A String", # The end of the last event establishing this link.
      "name": "A String", # Output only. Immutable. The name of the link. Format: `projects/{project}/locations/{location}/links/{link}`.
      "source": { # The soft reference to everything you can attach a lineage event to. # The pointer to the entity that is the **source** of this link.
        "fullyQualifiedName": "A String", # Required. [Fully Qualified Name (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) of the entity.
      },
      "startTime": "A String", # The start of the first event establishing this link.
      "target": { # The soft reference to everything you can attach a lineage event to. # The pointer to the entity that is the **target** of this link.
        "fullyQualifiedName": "A String", # Required. [Fully Qualified Name (FQN)](https://cloud.google.com/data-catalog/docs/fully-qualified-names) of the entity.
      },
    },
  ],
  "nextPageToken": "A String", # 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.
}

searchLinks_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.