gooddata_sdk.catalog.workspace.service.CatalogWorkspaceContentService

class gooddata_sdk.catalog.workspace.service.CatalogWorkspaceContentService(api_client: gooddata_sdk.client.GoodDataApiClient)

Bases: gooddata_sdk.catalog.catalog_service_base.CatalogServiceBase

__init__(api_client: gooddata_sdk.client.GoodDataApiClient) None

Methods

__init__(api_client)

compute_valid_objects(workspace_id, ctx)

Returns attributes, facts, and metrics which are valid to add to a context that already contains some entities from the semantic model.

get_attributes_catalog(workspace_id)

get_declarative_analytics_model(workspace_id)

get_declarative_ldm(workspace_id)

get_facts_catalog(workspace_id)

get_full_catalog(workspace_id)

Retrieves catalog for a workspace.

get_labels_catalog(workspace_id)

get_metrics_catalog(workspace_id)

get_organization()

layout_organization_folder(layout_root_path)

layout_workspace_folder(workspace_id, ...)

load_and_put_declarative_analytics_model(...)

load_and_put_declarative_ldm(workspace_id[, ...])

load_declarative_analytics_model(workspace_id)

load_declarative_ldm(workspace_id[, ...])

put_declarative_analytics_model(...)

put_declarative_ldm(workspace_id, ldm[, ...])

store_declarative_analytics_model(workspace_id)

store_declarative_ldm(workspace_id[, ...])

Attributes

organization_id

compute_valid_objects(workspace_id: str, ctx: Union[gooddata_sdk.compute.model.attribute.Attribute, gooddata_sdk.compute.model.metric.Metric, gooddata_sdk.compute.model.base.Filter, gooddata_sdk.catalog.workspace.entity_model.content_objects.dataset.CatalogLabel, gooddata_sdk.catalog.workspace.entity_model.content_objects.dataset.CatalogFact, gooddata_sdk.catalog.workspace.entity_model.content_objects.metric.CatalogMetric, List[Union[gooddata_sdk.compute.model.attribute.Attribute, gooddata_sdk.compute.model.metric.Metric, gooddata_sdk.compute.model.base.Filter, gooddata_sdk.catalog.workspace.entity_model.content_objects.dataset.CatalogLabel, gooddata_sdk.catalog.workspace.entity_model.content_objects.dataset.CatalogFact, gooddata_sdk.catalog.workspace.entity_model.content_objects.metric.CatalogMetric]], gooddata_sdk.compute.model.execution.ExecutionDefinition]) Dict[str, Set[str]]

Returns attributes, facts, and metrics which are valid to add to a context that already contains some entities from the semantic model. The entities are typically used to compute analytics and come from the execution definition. You may, however, specify the entities through different layers of convenience.

Parameters
  • workspace_id – workspace identifier

  • ctx – items already in context. you can specify context in one of the following ways: - single item or list of items from the execution model - single item or list of items from catalog model; catalog fact, label or metric may be added - the entire execution definition that is used to compute analytics

Returns

a dict of sets; type of available object is used as key in the dict, the value is a set containing id’s of available items

get_full_catalog(workspace_id: str) gooddata_sdk.catalog.workspace.model_container.CatalogWorkspaceContent

Retrieves catalog for a workspace. Catalog contains all data sets and metrics defined in that workspace.

Parameters

workspace_id – workspace identifier

Returns