IExecutionDefinition

Home > @gooddata/sdk-model > IExecutionDefinition

IExecutionDefinition interface

Execution definition contains 100% complete description of what will the execution compute and how will the resulting data look like.

Signature:

export interface IExecutionDefinition 

Remarks

While the execution definition is part of the public API, it is a low-level structure and as such SHOULD NOT be used in the typical application code. The UI.SDK offers several convenience layers to construct the execution definition. The typical flows start in the Analytical Workspace.

Properties

Property	Modifiers	Type	Description
attributes	readonly	IAttribute[]	Attributes to slice the results by. MAY be empty. If not specified, then measures MUST be specified.
buckets	readonly	IBucket[]	Buckets describe logical grouping within attributes and measures - they serve as a metadata about the execution. They ARE NOT used during the execution itself. MAY be empty.
dimensions	readonly	IDimension[]	Dimensionality and contents of dimensions. MUST be specified. The dimensions specify how the result should be organized. For instance which attributes should be used to slice the row dimension, in which dimension should the measures be located.
executionConfig?	readonly	IExecutionConfig	(Optional) additional configuration of the execution
filters	readonly	IFilter[]	Filters to apply during the execution. MAY be empty.
measures	readonly	IMeasure[]	Measures to calculate. MAY be empty. If not specified, then attributes MUST be specified.
postProcessing?	readonly	IPostProcessing	(Optional) Contains any configuration that should be done with the data after they are obtained from the server and before they are passed to the user.
sortBy	readonly	ISortItem[]	Sorting to apply on the results. MAY be empty.
workspace	readonly	string	Analytical Workspace against which the execution should be run.