runs

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

Overview

Name	runs
Type	Resource
Id	google.datalineage.runs

Fields

Name	Datatype	Description
name	string	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_-:.
attributes	object	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.
displayName	string	Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like _-:&.
endTime	string	Optional. The timestamp of the end of the run.
startTime	string	Required. The timestamp of the start of the run.
state	string	Required. The state of the run.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, processesId, projectsId, runsId	Gets the details of the specified run.
list	SELECT	locationsId, processesId, projectsId	Lists runs in the given project and location. List order is descending by start_time.
create	INSERT	locationsId, processesId, projectsId	Creates a new run.
delete	DELETE	locationsId, processesId, projectsId, runsId	Deletes the run with the specified name.
patch	UPDATE	locationsId, processesId, projectsId, runsId	Updates a run.

SELECT examples

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

SELECT
name,
attributes,
displayName,
endTime,
startTime,
state
FROM google.datalineage.runs
WHERE locationsId = '{{ locationsId }}'
AND processesId = '{{ processesId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new runs resource.

All Properties

/*+ create */
INSERT INTO google.datalineage.runs (
locationsId,
processesId,
projectsId,
displayName,
startTime,
name,
attributes,
state,
endTime
)
SELECT 
'{{ locationsId }}',
'{{ processesId }}',
'{{ projectsId }}',
'{{ displayName }}',
'{{ startTime }}',
'{{ name }}',
'{{ attributes }}',
'{{ state }}',
'{{ endTime }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: displayName
      value: string
    - name: startTime
      value: string
    - name: name
      value: string
    - name: attributes
      value: object
    - name: state
      value: string
    - name: endTime
      value: string

UPDATE example

Updates a runs resource.

/*+ update */
UPDATE google.datalineage.runs
SET 
displayName = '{{ displayName }}',
startTime = '{{ startTime }}',
name = '{{ name }}',
attributes = '{{ attributes }}',
state = '{{ state }}',
endTime = '{{ endTime }}'
WHERE 
locationsId = '{{ locationsId }}'
AND processesId = '{{ processesId }}'
AND projectsId = '{{ projectsId }}'
AND runsId = '{{ runsId }}';

DELETE example

Deletes the specified runs resource.

/*+ delete */
DELETE FROM google.datalineage.runs
WHERE locationsId = '{{ locationsId }}'
AND processesId = '{{ processesId }}'
AND projectsId = '{{ projectsId }}'
AND runsId = '{{ runsId }}';