executions

Creates, updates, deletes, gets or lists an executions resource.

Overview

Name	executions
Type	Resource
Id	google.workloadmanager.executions

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}
endTime	string (google-datetime)	Output only. [Output only] End time stamp
engine	string	Optional. Engine
evaluationId	string	Output only. [Output only] Evaluation ID
externalDataSources	array	Optional. External data sources
inventoryTime	string (google-datetime)	Output only. [Output only] Inventory time stamp
labels	object	Labels as key value pairs
notices	array	Output only. Additional information generated by the execution
resultSummary	object	Output only. [Output only] Result summary for the execution (id: Summary)
ruleResults	array	Output only. execution result summary per rule
runType	string	type represent whether the execution executed directly by user or scheduled according evaluation.schedule field.
startTime	string (google-datetime)	Output only. [Output only] Start time stamp
state	string	Output only. [Output only] State

list

Successful response

Name	Datatype	Description
name	string	The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}
endTime	string (google-datetime)	Output only. [Output only] End time stamp
engine	string	Optional. Engine
evaluationId	string	Output only. [Output only] Evaluation ID
externalDataSources	array	Optional. External data sources
inventoryTime	string (google-datetime)	Output only. [Output only] Inventory time stamp
labels	object	Labels as key value pairs
notices	array	Output only. Additional information generated by the execution
resultSummary	object	Output only. [Output only] Result summary for the execution (id: Summary)
ruleResults	array	Output only. execution result summary per rule
runType	string	type represent whether the execution executed directly by user or scheduled according evaluation.schedule field.
startTime	string (google-datetime)	Output only. [Output only] Start time stamp
state	string	Output only. [Output only] State

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, evaluationsId, executionsId		Gets details of a single Execution.
list	select	projectsId, locationsId, evaluationsId	pageSize, pageToken, filter, orderBy	Lists Executions in a given project and location.
delete	delete	projectsId, locationsId, evaluationsId, executionsId	requestId	Deletes a single Execution.
run	exec	projectsId, locationsId, evaluationsId		Creates a new Execution in a given project and location.

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
evaluationsId	string
executionsId	string
locationsId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string

SELECT examples

get

Gets details of a single Execution.

SELECT
name,
endTime,
engine,
evaluationId,
externalDataSources,
inventoryTime,
labels,
notices,
resultSummary,
ruleResults,
runType,
startTime,
state
FROM google.workloadmanager.executions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND evaluationsId = '{{ evaluationsId }}' -- required
AND executionsId = '{{ executionsId }}' -- required;

list

Lists Executions in a given project and location.

SELECT
name,
endTime,
engine,
evaluationId,
externalDataSources,
inventoryTime,
labels,
notices,
resultSummary,
ruleResults,
runType,
startTime,
state
FROM google.workloadmanager.executions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND evaluationsId = '{{ evaluationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

DELETE examples

delete

Deletes a single Execution.

DELETE FROM google.workloadmanager.executions
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND evaluationsId = '{{ evaluationsId }}' --required
AND executionsId = '{{ executionsId }}' --required
AND requestId = '{{ requestId }}';

Lifecycle Methods

run

Creates a new Execution in a given project and location.

EXEC google.workloadmanager.executions.run 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@evaluationsId='{{ evaluationsId }}' --required 
@@json=
'{
"executionId": "{{ executionId }}", 
"execution": "{{ execution }}", 
"requestId": "{{ requestId }}"
}';