runs

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

Overview

Name	runs
Type	Resource
Id	google.datalineage.runs

Fields

The following fields are returned by SELECT queries:

get

Successful response

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 (google-datetime)	Optional. The timestamp of the end of the run.
startTime	string (google-datetime)	Required. The timestamp of the start of the run.
state	string	Required. The state of the run.

list

Successful response

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 (google-datetime)	Optional. The timestamp of the end of the run.
startTime	string (google-datetime)	Required. The timestamp of the start of the run.
state	string	Required. The state of the run.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, processesId, runsId		Gets the details of the specified run.
list	select	projectsId, locationsId, processesId	pageSize, pageToken	Lists runs in the given project and location. List order is descending by start_time.
create	insert	projectsId, locationsId, processesId	requestId	Creates a new run.
patch	update	projectsId, locationsId, processesId, runsId	updateMask, allowMissing	Updates a run.
delete	delete	projectsId, locationsId, processesId, runsId	allowMissing	Deletes the run 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
runsId	string
allowMissing	boolean
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets the details of the specified run.

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

list

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 projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND processesId = '{{ processesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Creates a new run.

INSERT INTO google.datalineage.runs (
data__name,
data__displayName,
data__attributes,
data__startTime,
data__endTime,
data__state,
projectsId,
locationsId,
processesId,
requestId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ attributes }}',
'{{ startTime }}',
'{{ endTime }}',
'{{ state }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ processesId }}',
'{{ requestId }}'
RETURNING
name,
attributes,
displayName,
endTime,
startTime,
state
;

Manifest

# Description fields are for documentation purposes
- name: runs
  props:
    - name: projectsId
      value: string
      description: Required parameter for the runs resource.
    - name: locationsId
      value: string
      description: Required parameter for the runs resource.
    - name: processesId
      value: string
      description: Required parameter for the runs resource.
    - name: name
      value: string
      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_-:.`
        
    - name: displayName
      value: string
      description: >
        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 `_-:&.`
        
    - name: attributes
      value: object
      description: >
        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.
        
    - name: startTime
      value: string
      description: >
        Required. The timestamp of the start of the run.
        
    - name: endTime
      value: string
      description: >
        Optional. The timestamp of the end of the run.
        
    - name: state
      value: string
      description: >
        Required. The state of the run.
        
      valid_values: ['UNKNOWN', 'STARTED', 'COMPLETED', 'FAILED', 'ABORTED']
    - name: requestId
      value: string

UPDATE examples

patch

Updates a run.

UPDATE google.datalineage.runs
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__attributes = '{{ attributes }}',
data__startTime = '{{ startTime }}',
data__endTime = '{{ endTime }}',
data__state = '{{ state }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND processesId = '{{ processesId }}' --required
AND runsId = '{{ runsId }}' --required
AND updateMask = '{{ updateMask}}'
AND allowMissing = {{ allowMissing}}
RETURNING
name,
attributes,
displayName,
endTime,
startTime,
state;

DELETE examples

delete

Deletes the run with the specified name.

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