Data Lineage API (datalineage:v1)

2023-03-07

20 new methods | New API

Additions

    Methods
  • datalineage.projects.locations.batchSearchLinkProcesses

      HTTP Method: POST

      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.

      Path: v1/{+parent}:batchSearchLinkProcesses

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

      Parameters:

        parent

          Description: Required. The project and location where you want to search.

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}:batchSearchLinkProcesses

      Parameter Order: parent

  • datalineage.projects.locations.searchLinks

      Parameters:

        parent

          Required: Yes

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Description: Required. The project and location you want search in.

          Type: string

      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.

      Parameter Order: parent

      Path: v1/{+parent}:searchLinks

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

      HTTP Method: POST

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}:searchLinks

  • datalineage.projects.locations.operations.delete

      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`.

      HTTP Method: DELETE

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      Path: v1/{+name}

      Parameters:

        name

          Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Location: path

          Description: The name of the operation resource to be deleted.

          Type: string

          Required: Yes

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

      Parameter Order: name

  • datalineage.projects.locations.operations.list

      Path: v1/{+name}/operations

      Parameters:

        name

          Required: Yes

          Description: The name of the operation's parent resource.

          Location: path

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+$

        pageToken

          Description: The standard list page token.

          Type: string

          Location: query

        pageSize

          Location: query

          Type: integer

          Format: int32

          Description: The standard list page size.

        filter

          Type: string

          Description: The standard list filter.

          Location: query

      Parameter Order: name

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

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations

      Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

      HTTP Method: GET

  • datalineage.projects.locations.operations.cancel

      Parameters:

        name

          Required: Yes

          Description: The name of the operation resource to be cancelled.

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Location: path

      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`.

      Parameter Order: name

      HTTP Method: POST

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel

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

      Path: v1/{+name}:cancel

  • datalineage.projects.locations.operations.get

      Path: v1/{+name}

      Parameter Order: name

      Parameters:

        name

          Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Location: path

          Required: Yes

          Type: string

          Description: The name of the operation resource.

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

      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.

      HTTP Method: GET

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

  • datalineage.projects.locations.processes.list

      Parameters:

        pageSize

          Type: integer

          Description: 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.

          Format: int32

          Location: query

        parent

          Required: Yes

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Description: Required. The name of the project and its location that owns this collection of processes.

          Type: string

        pageToken

          Type: string

          Description: 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

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

      Description: List processes in the given project and location. List order is descending by insertion time.

      Path: v1/{+parent}/processes

      Parameter Order: parent

      HTTP Method: GET

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/processes

  • datalineage.projects.locations.processes.delete

      Path: v1/{+name}

      Parameter Order: name

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}

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

      Parameters:

        name

          Required: Yes

          Type: string

          Location: path

          Description: Required. The name of the process to delete.

          Pattern: ^projects/[^/]+/locations/[^/]+/processes/[^/]+$

        allowMissing

          Type: boolean

          Description: If set to true and the process is not found, the request succeeds but the server doesn't perform any actions.

          Location: query

      Description: Deletes the process with the specified name.

      HTTP Method: DELETE

  • datalineage.projects.locations.processes.get

      HTTP Method: GET

      Parameter Order: name

      Parameters:

        name

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/processes/[^/]+$

          Description: Required. The name of the process to get.

          Location: path

          Type: string

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}

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

      Description: Gets the details of the specified process.

      Path: v1/{+name}

  • datalineage.projects.locations.processes.create

      Parameter Order: parent

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/processes

      Parameters:

        requestId

          Location: query

          Type: string

          Description: 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.

        parent

          Description: Required. The name of the project and its location that should own the process.

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Type: string

          Location: path

          Required: Yes

      Path: v1/{+parent}/processes

      HTTP Method: POST

      Description: Creates a new process.

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

  • datalineage.projects.locations.processes.patch

      Path: v1/{+name}

      HTTP Method: PATCH

      Description: Updates a process.

      Parameter Order: name

      Parameters:

        allowMissing

          Type: boolean

          Location: query

          Description: If set to true and the process is not found, the request inserts it.

        updateMask

          Format: google-fieldmask

          Location: query

          Description: The list of fields to update. Currently not used. The whole message is updated.

          Type: string

        name

          Pattern: ^projects/[^/]+/locations/[^/]+/processes/[^/]+$

          Type: string

          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_-:.`

          Required: Yes

          Location: path

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

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}

  • datalineage.projects.locations.processes.runs.lineageEvents.create

      Description: Creates a new lineage event.

      Path: v1/{+parent}/lineageEvents

      HTTP Method: POST

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

      Parameters:

        parent

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+$

          Type: string

          Description: Required. The name of the run that should own the lineage event.

          Required: Yes

        requestId

          Location: query

          Description: 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.

          Type: string

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents

      Parameter Order: parent

  • datalineage.projects.locations.processes.runs.lineageEvents.delete

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents/{lineageEventsId}

      Parameters:

        name

          Description: Required. The name of the lineage event to delete.

          Pattern: ^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+/lineageEvents/[^/]+$

          Location: path

          Required: Yes

          Type: string

        allowMissing

          Type: boolean

          Location: query

          Description: If set to true and the lineage event is not found, the request succeeds but the server doesn't perform any actions.

      Parameter Order: name

      HTTP Method: DELETE

      Description: Deletes the lineage event with the specified name.

      Path: v1/{+name}

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

  • datalineage.projects.locations.processes.runs.lineageEvents.list

      Description: Lists lineage events in the given project and location. The list order is not defined.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents

      Parameters:

        pageSize

          Location: query

          Format: int32

          Description: 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.

          Type: integer

        pageToken

          Type: string

          Location: query

          Description: 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.

        parent

          Location: path

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+$

          Type: string

          Description: Required. The name of the run that owns the collection of lineage events to get.

      HTTP Method: GET

      Parameter Order: parent

      Path: v1/{+parent}/lineageEvents

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

  • datalineage.projects.locations.processes.runs.lineageEvents.get

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

      Path: v1/{+name}

      Parameter Order: name

      Description: Gets details of a specified lineage event.

      HTTP Method: GET

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}/lineageEvents/{lineageEventsId}

      Parameters:

        name

          Required: Yes

          Location: path

          Description: Required. The name of the lineage event to get.

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+/lineageEvents/[^/]+$

  • datalineage.projects.locations.processes.runs.get

      Path: v1/{+name}

      HTTP Method: GET

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}

      Parameter Order: name

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

      Description: Gets the details of the specified run.

      Parameters:

        name

          Location: path

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+$

          Description: Required. The name of the run to get.

          Required: Yes

  • datalineage.projects.locations.processes.runs.list

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

      Parameters:

        pageToken

          Description: 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.

          Type: string

          Location: query

        pageSize

          Format: int32

          Description: 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.

          Type: integer

          Location: query

        parent

          Type: string

          Description: Required. The name of process that owns this collection of runs.

          Pattern: ^projects/[^/]+/locations/[^/]+/processes/[^/]+$

          Location: path

          Required: Yes

      Parameter Order: parent

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs

      Path: v1/{+parent}/runs

      Description: Lists runs in the given project and location. List order is descending by `start_time`.

      HTTP Method: GET

  • datalineage.projects.locations.processes.runs.delete

      Parameter Order: name

      Description: Deletes the run with the specified name.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}

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

      Path: v1/{+name}

      HTTP Method: DELETE

      Parameters:

        allowMissing

          Type: boolean

          Description: If set to true and the run is not found, the request succeeds but the server doesn't perform any actions.

          Location: query

        name

          Required: Yes

          Description: Required. The name of the run to delete.

          Pattern: ^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+$

          Type: string

          Location: path

  • datalineage.projects.locations.processes.runs.create

      Parameters:

        requestId

          Description: 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.

          Type: string

          Location: query

        parent

          Description: Required. The name of the process that should own the run.

          Type: string

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/processes/[^/]+$

          Location: path

      Path: v1/{+parent}/runs

      Description: Creates a new run.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs

      HTTP Method: POST

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

      Parameter Order: parent

  • datalineage.projects.locations.processes.runs.patch

      HTTP Method: PATCH

      Path: v1/{+name}

      Parameter Order: name

      Parameters:

        updateMask

          Description: The list of fields to update. Currently not used. The whole message is updated.

          Location: query

          Type: string

          Format: google-fieldmask

        allowMissing

          Type: boolean

          Description: If set to true and the run is not found, the request creates it.

          Location: query

        name

          Required: Yes

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/processes/[^/]+/runs/[^/]+$

          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

      Description: Updates a run.

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

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/processes/{processesId}/runs/{runsId}