OpenAPI definition

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for gooddata from gravatar.com gooddata

Unverified details

These details have not been verified by PyPI
Meta

License: MIT

Author: GoodData (generated by OpenAPI Generator)

Tags OpenAPI, OpenAPI-Generator, OpenAPI definition

Requires: Python >=3.6

Project description

gooddata-metadata-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: v0
  • Package version: 1.0.1a2
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >=3.6

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import gooddata_metadata_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import gooddata_metadata_client

Getting Started

Please follow the installation procedure and then run the following:

import time
import gooddata_metadata_client
from pprint import pprint
from gooddata_metadata_client.api import actions_api
from gooddata_metadata_client.model.declarative_model import DeclarativeModel
from gooddata_metadata_client.model.generate_ldm_request import GenerateLdmRequest
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_metadata_client.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with gooddata_metadata_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = actions_api.ActionsApi(api_client)
    data_source_id = "dataSourceId_example" # str | 
    generate_ldm_request = GenerateLdmRequest(
        date_granularities="all",
        denorm_prefix="dr",
        fact_prefix="f",
        generate_long_ids=True,
        grain_prefix="g",
        grain_reference_prefix="gr",
        primary_label_prefix="pl",
        reference_prefix="r",
        secondary_label_prefix="sl",
        separator="__",
        table_prefix="out_table",
        view_prefix="out_view",
        wdf_prefix="wdf",
    ) # GenerateLdmRequest | 

    try:
        # Generate logical data model (LDM) from physical data model (PDM)
        api_response = api_instance.generate_logical_model(data_source_id, generate_ldm_request)
        pprint(api_response)
    except gooddata_metadata_client.ApiException as e:
        print("Exception when calling ActionsApi->generate_logical_model: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
ActionsApi generate_logical_model POST /api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel Generate logical data model (LDM) from physical data model (PDM)
ActionsApi register_upload_notification POST /api/v1/actions/dataSources/{dataSourceId}/uploadNotification Register an upload notification
EntitiesApi create_entity_analytical_dashboards POST /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards
EntitiesApi create_entity_api_tokens POST /api/v1/entities/users/{userId}/apiTokens
EntitiesApi create_entity_dashboard_plugins POST /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins
EntitiesApi create_entity_data_sources POST /api/v1/entities/dataSources
EntitiesApi create_entity_filter_contexts POST /api/v1/entities/workspaces/{workspaceId}/filterContexts
EntitiesApi create_entity_metrics POST /api/v1/entities/workspaces/{workspaceId}/metrics
EntitiesApi create_entity_user_groups POST /api/v1/entities/userGroups
EntitiesApi create_entity_users POST /api/v1/entities/users
EntitiesApi create_entity_visualization_objects POST /api/v1/entities/workspaces/{workspaceId}/visualizationObjects
EntitiesApi create_entity_workspace_data_filters POST /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters
EntitiesApi create_entity_workspaces POST /api/v1/entities/workspaces
EntitiesApi delete_entity_analytical_dashboards DELETE /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}
EntitiesApi delete_entity_api_tokens DELETE /api/v1/entities/users/{userId}/apiTokens/{id}
EntitiesApi delete_entity_dashboard_plugins DELETE /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}
EntitiesApi delete_entity_data_sources DELETE /api/v1/entities/dataSources/{id}
EntitiesApi delete_entity_filter_contexts DELETE /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}
EntitiesApi delete_entity_metrics DELETE /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}
EntitiesApi delete_entity_user_groups DELETE /api/v1/entities/userGroups/{id}
EntitiesApi delete_entity_users DELETE /api/v1/entities/users/{id}
EntitiesApi delete_entity_visualization_objects DELETE /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}
EntitiesApi delete_entity_workspace_data_filters DELETE /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}
EntitiesApi delete_entity_workspaces DELETE /api/v1/entities/workspaces/{id}
EntitiesApi get_all_entities_analytical_dashboards GET /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards
EntitiesApi get_all_entities_api_tokens GET /api/v1/entities/users/{userId}/apiTokens
EntitiesApi get_all_entities_attributes GET /api/v1/entities/workspaces/{workspaceId}/attributes
EntitiesApi get_all_entities_dashboard_plugins GET /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins
EntitiesApi get_all_entities_data_source_identifiers GET /api/v1/entities/dataSourceIdentifiers
EntitiesApi get_all_entities_data_source_tables GET /api/v1/entities/dataSources/{dataSourceId}/dataSourceTables
EntitiesApi get_all_entities_data_sources GET /api/v1/entities/dataSources
EntitiesApi get_all_entities_datasets GET /api/v1/entities/workspaces/{workspaceId}/datasets
EntitiesApi get_all_entities_entitlements GET /api/v1/entities/entitlements
EntitiesApi get_all_entities_facts GET /api/v1/entities/workspaces/{workspaceId}/facts
EntitiesApi get_all_entities_filter_contexts GET /api/v1/entities/workspaces/{workspaceId}/filterContexts
EntitiesApi get_all_entities_labels GET /api/v1/entities/workspaces/{workspaceId}/labels
EntitiesApi get_all_entities_metrics GET /api/v1/entities/workspaces/{workspaceId}/metrics
EntitiesApi get_all_entities_user_groups GET /api/v1/entities/userGroups
EntitiesApi get_all_entities_users GET /api/v1/entities/users
EntitiesApi get_all_entities_visualization_objects GET /api/v1/entities/workspaces/{workspaceId}/visualizationObjects
EntitiesApi get_all_entities_workspace_data_filter_settings GET /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings
EntitiesApi get_all_entities_workspace_data_filters GET /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters
EntitiesApi get_all_entities_workspaces GET /api/v1/entities/workspaces
EntitiesApi get_all_options GET /api/v1/options Links for all configuration options
EntitiesApi get_data_source_drivers GET /api/v1/options/availableDrivers Get all available data source drivers
EntitiesApi get_entity_analytical_dashboards GET /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}
EntitiesApi get_entity_api_tokens GET /api/v1/entities/users/{userId}/apiTokens/{id}
EntitiesApi get_entity_attributes GET /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}
EntitiesApi get_entity_cookie_security_configurations GET /api/v1/entities/admin/cookieSecurityConfigurations/{id}
EntitiesApi get_entity_dashboard_plugins GET /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}
EntitiesApi get_entity_data_source_identifiers GET /api/v1/entities/dataSourceIdentifiers/{id}
EntitiesApi get_entity_data_source_tables GET /api/v1/entities/dataSources/{dataSourceId}/dataSourceTables/{id}
EntitiesApi get_entity_data_sources GET /api/v1/entities/dataSources/{id}
EntitiesApi get_entity_datasets GET /api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}
EntitiesApi get_entity_entitlements GET /api/v1/entities/entitlements/{id}
EntitiesApi get_entity_facts GET /api/v1/entities/workspaces/{workspaceId}/facts/{objectId}
EntitiesApi get_entity_filter_contexts GET /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}
EntitiesApi get_entity_labels GET /api/v1/entities/workspaces/{workspaceId}/labels/{objectId}
EntitiesApi get_entity_metrics GET /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}
EntitiesApi get_entity_organizations GET /api/v1/entities/admin/organizations/{id}
EntitiesApi get_entity_user_groups GET /api/v1/entities/userGroups/{id}
EntitiesApi get_entity_users GET /api/v1/entities/users/{id}
EntitiesApi get_entity_visualization_objects GET /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}
EntitiesApi get_entity_workspace_data_filter_settings GET /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}
EntitiesApi get_entity_workspace_data_filters GET /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}
EntitiesApi get_entity_workspaces GET /api/v1/entities/workspaces/{id}
EntitiesApi get_organization GET /api/v1/entities/organization Get current organization info
EntitiesApi patch_entity_analytical_dashboards PATCH /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}
EntitiesApi patch_entity_cookie_security_configurations PATCH /api/v1/entities/admin/cookieSecurityConfigurations/{id}
EntitiesApi patch_entity_dashboard_plugins PATCH /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}
EntitiesApi patch_entity_data_sources PATCH /api/v1/entities/dataSources/{id}
EntitiesApi patch_entity_filter_contexts PATCH /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}
EntitiesApi patch_entity_metrics PATCH /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}
EntitiesApi patch_entity_organizations PATCH /api/v1/entities/admin/organizations/{id}
EntitiesApi patch_entity_user_groups PATCH /api/v1/entities/userGroups/{id}
EntitiesApi patch_entity_users PATCH /api/v1/entities/users/{id}
EntitiesApi patch_entity_visualization_objects PATCH /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}
EntitiesApi patch_entity_workspace_data_filters PATCH /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}
EntitiesApi patch_entity_workspaces PATCH /api/v1/entities/workspaces/{id}
EntitiesApi update_entity_analytical_dashboards PUT /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}
EntitiesApi update_entity_cookie_security_configurations PUT /api/v1/entities/admin/cookieSecurityConfigurations/{id}
EntitiesApi update_entity_dashboard_plugins PUT /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}
EntitiesApi update_entity_data_sources PUT /api/v1/entities/dataSources/{id}
EntitiesApi update_entity_filter_contexts PUT /api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}
EntitiesApi update_entity_metrics PUT /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}
EntitiesApi update_entity_organizations PUT /api/v1/entities/admin/organizations/{id}
EntitiesApi update_entity_user_groups PUT /api/v1/entities/userGroups/{id}
EntitiesApi update_entity_users PUT /api/v1/entities/users/{id}
EntitiesApi update_entity_visualization_objects PUT /api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}
EntitiesApi update_entity_workspace_data_filters PUT /api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}
EntitiesApi update_entity_workspaces PUT /api/v1/entities/workspaces/{id}
LayoutApi get_analytics_model GET /api/v1/layout/workspaces/{workspaceId}/analyticsModel Get analytics model
LayoutApi get_data_sources_layout GET /api/v1/layout/dataSources Get all data sources
LayoutApi get_logical_model GET /api/v1/layout/workspaces/{workspaceId}/logicalModel Get logical model
LayoutApi get_organization_layout GET /api/v1/layout/organization Get organization layout
LayoutApi get_pdm_layout GET /api/v1/layout/dataSources/{dataSourceId}/physicalModel Get data source physical model layout
LayoutApi get_user_groups_layout GET /api/v1/layout/userGroups Get all user groups
LayoutApi get_users_layout GET /api/v1/layout/users Get all users
LayoutApi get_users_user_groups_layout GET /api/v1/layout/usersAndUserGroups Get all users and user groups
LayoutApi get_workspace_data_filters_layout GET /api/v1/layout/workspaceDataFilters Get workspace data filters for all workspaces
LayoutApi get_workspace_layout GET /api/v1/layout/workspaces/{workspaceId} Get workspace layout
LayoutApi get_workspace_permissions GET /api/v1/layout/workspaces/{workspaceId}/permissions Get permissions for the workspace
LayoutApi get_workspaces_layout GET /api/v1/layout/workspaces Get all workspaces layout
LayoutApi put_data_sources_layout PUT /api/v1/layout/dataSources Put all data sources
LayoutApi put_user_groups_layout PUT /api/v1/layout/userGroups Put all user groups
LayoutApi put_users_layout PUT /api/v1/layout/users Put all users
LayoutApi put_users_user_groups_layout PUT /api/v1/layout/usersAndUserGroups Put all users and user groups
LayoutApi put_workspace_layout PUT /api/v1/layout/workspaces/{workspaceId} Set workspace layout
LayoutApi set_analytics_model PUT /api/v1/layout/workspaces/{workspaceId}/analyticsModel Set analytics model
LayoutApi set_logical_model PUT /api/v1/layout/workspaces/{workspaceId}/logicalModel Set logical model
LayoutApi set_organization_layout PUT /api/v1/layout/organization Set organization layout
LayoutApi set_pdm_layout PUT /api/v1/layout/dataSources/{dataSourceId}/physicalModel Set data source physical model layout
LayoutApi set_workspace_data_filters_layout PUT /api/v1/layout/workspaceDataFilters Set all workspace data filters
LayoutApi set_workspace_permissions PUT /api/v1/layout/workspaces/{workspaceId}/permissions Set permissions for the workspace
LayoutApi set_workspaces_layout PUT /api/v1/layout/workspaces Set all workspaces layout

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

support@gooddata.com

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in gooddata_metadata_client.apis and gooddata_metadata_client.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

  • from gooddata_metadata_client.api.default_api import DefaultApi
  • from gooddata_metadata_client.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import gooddata_metadata_client
from gooddata_metadata_client.apis import *
from gooddata_metadata_client.models import *

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for gooddata from gravatar.com gooddata

Unverified details

These details have not been verified by PyPI
Meta

License: MIT

Author: GoodData (generated by OpenAPI Generator)

Tags OpenAPI, OpenAPI-Generator, OpenAPI definition

Requires: Python >=3.6


Release history Release notifications | RSS feed

1.3.0

1.2.1a3 pre-release

1.2.1a2 pre-release

1.2.1a1 pre-release

1.2.0

1.1.1a5 pre-release

1.1.1a4 pre-release

1.1.1a3 pre-release

1.1.1a2 pre-release

1.1.1a1 pre-release

1.1.0

1.0.1a4 pre-release

1.0.1a3 pre-release

This version

1.0.1a2 pre-release

1.0.1a1 pre-release

1.0.0

0.8.0

0.7.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gooddata-metadata-client-1.0.1a2.tar.gz (187.8 kB view hashes)

Uploaded Source

Built Distribution

gooddata_metadata_client-1.0.1a2-py3-none-any.whl (869.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page