Skip to content

Latest commit

 

History

History
67 lines (42 loc) · 2.08 KB

index.rst

File metadata and controls

67 lines (42 loc) · 2.08 KB
Raw

Services

All services are accessible by class gooddata_sdk.GoodDataSdk. The class forms an entry-point to the SDK.

To create an instance of GoodDataSdk:

from gooddata_sdk import GoodDataSdk

# GoodData.CN host in the form of uri eg. "http://localhost:3000"
host = "http://localhost:3000"
# GoodData.CN user token
token = "some_user_token"
sdk = GoodDataSdk.create(host, token)

# Now you can start calling services.
# For example, get a list of all workspaces from my GoodData.CN project
workspaces = sdk.catalog_workspace.list_workspaces()

Supported services:

  • Catalog Workspace <catalog-workspace>: Read, update, create and delete workspaces.

    • w entity methods
    • w declarative methods

  • Catalog Workspace Content <catalog-workspace-content>: Read catalog objects (datasets and metrics) from a workspace.

    • wc entity methods
    • wc declarative methods

  • Catalog Data Source <catalog-data-source>: Read, update, create and delete data sources and read their tables.

    • ds entity methods
    • ds declarative methods
    • ds action methods

  • Catalog User <catalog-user>: Read, update, create and delete user and user groups.

    • u entity methods
    • ug entity methods
    • u declarative methods
    • ug declarative methods
    • uug declarative methods

  • Catalog Permission <catalog-permission>: Read, update workspace permissions.

    • p declarative methods

  • Catalog Organization <catalog-organization>: Update organization name, OIDC parameters.

    • o entity methods

  • Insights <insight>: Read insights stored in a workspace.

    • i entity methods

  • Compute <compute>: Drives computation of analytics for GoodData.CN workspaces. Used by higher level services such as the Table service.

    • c entity methods

  • Table <table>: Compute and read analytics in typical tabular format.

    • t entity methods