gooddata_pandas.data_access.ExecutionDefinitionBuilder

class gooddata_pandas.data_access.ExecutionDefinitionBuilder(columns: Dict[str, Union[Attribute, Metric, ObjId, str]], index_by: Optional[Union[Attribute, ObjId, str, Dict[str, Union[Attribute, ObjId, str]]]] = None)

Bases: object

__init__(columns: Dict[str, Union[Attribute, Metric, ObjId, str]], index_by: Optional[Union[Attribute, ObjId, str, Dict[str, Union[Attribute, ObjId, str]]]] = None) None

Initializes the ExecutionDefinitionBuilder instance with columns and an optional index_by definition. Processes the given columns and index_by definitions to build the internal mappings.

Args:

columns (ColumnsDef): Input columns to process and build internal mappings. index_by (Optional[IndexDef], optional): Index definition to process. Defaults to None.

Methods

__init__(columns[, index_by])

Initializes the ExecutionDefinitionBuilder instance with columns and an optional index_by definition.

build_execution_definition([filter_by])

Builds an ExecutionDefinition instance with the current configuration of metrics, attributes, and filters.

Attributes

col_to_attr_idx

col_to_metric_idx

index_to_attr_idx

build_execution_definition(filter_by: Optional[Union[Filter, list[gooddata_sdk.compute.model.base.Filter]]] = None) ExecutionDefinition

Builds an ExecutionDefinition instance with the current configuration of metrics, attributes, and filters.

Args:

filter_by (Optional[Union[Filter, list[Filter]]]): A filter or a list of filters to be applied to the execution definition. If it’s not provided or None, then the current filter configuration is used.

Returns:

ExecutionDefinition: An ExecutionDefinition instance containing attributes, metrics, filters, and dimensions.