processes

Creates, updates, deletes, gets or lists a processes resource.

Overview

Name	processes
Type	Resource
Id	google.datalineage.processes

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	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_-:.
attributes	object	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.
displayName	string	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 _-:&.
origin	object	Optional. The origin of this process and its runs and lineage events. (id: GoogleCloudDatacatalogLineageV1Origin)

list

Successful response

Name	Datatype	Description
name	string	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_-:.
attributes	object	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.
displayName	string	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 _-:&.
origin	object	Optional. The origin of this process and its runs and lineage events. (id: GoogleCloudDatacatalogLineageV1Origin)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, processesId		Gets the details of the specified process.
list	select	projectsId, locationsId	pageSize, pageToken	List processes in the given project and location. List order is descending by insertion time.
create	insert	projectsId, locationsId	requestId	Creates a new process.
patch	update	projectsId, locationsId, processesId	updateMask, allowMissing, requestId	Updates a process.
delete	delete	projectsId, locationsId, processesId	allowMissing	Deletes the process with the specified name.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
processesId	string
projectsId	string
allowMissing	boolean
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets the details of the specified process.

SELECT
name,
attributes,
displayName,
origin
FROM google.datalineage.processes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND processesId = '{{ processesId }}' -- required;

list

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

SELECT
name,
attributes,
displayName,
origin
FROM google.datalineage.processes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Creates a new process.

INSERT INTO google.datalineage.processes (
data__name,
data__displayName,
data__attributes,
data__origin,
projectsId,
locationsId,
requestId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ attributes }}',
'{{ origin }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ requestId }}'
RETURNING
name,
attributes,
displayName,
origin
;

Manifest

# Description fields are for documentation purposes
- name: processes
  props:
    - name: projectsId
      value: string
      description: Required parameter for the processes resource.
    - name: locationsId
      value: string
      description: Required parameter for the processes resource.
    - name: name
      value: 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_-:.`
        
    - name: displayName
      value: string
      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 `_-:&.`
        
    - name: attributes
      value: object
      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.
        
    - name: origin
      value: object
      description: >
        Optional. The origin of this process and its runs and lineage events.
        
    - name: requestId
      value: string

UPDATE examples

patch

Updates a process.

UPDATE google.datalineage.processes
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__attributes = '{{ attributes }}',
data__origin = '{{ origin }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND processesId = '{{ processesId }}' --required
AND updateMask = '{{ updateMask}}'
AND allowMissing = {{ allowMissing}}
AND requestId = '{{ requestId}}'
RETURNING
name,
attributes,
displayName,
origin;

DELETE examples

delete

Deletes the process with the specified name.

DELETE FROM google.datalineage.processes
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND processesId = '{{ processesId }}' --required
AND allowMissing = '{{ allowMissing }}';