Package com.gooddata.sdk.service

Class GoodData

java.lang.Object
com.gooddata.sdk.service.GoodData
public class GoodData
extends java.lang.Object
Entry point for GoodData SDK usage.

Configure connection to GoodData using one of constructors. One can then get initialized service he needs from the newly constructed instance. This instance can be also used later for logout from GoodData Platform.

Usage example: 


     GoodData gd = new GoodData("roman@gooddata.com", "Roman1");
     // do something useful like: gd.getSomeService().doSomething()
     gd.logout();

  • Constructor Details

    • GoodData

      public GoodData​(java.lang.String login, java.lang.String password)
      Create instance configured to communicate with GoodData Platform under user with given credentials.
      Parameters:
      login - GoodData user's login
      password - GoodData user's password

    • GoodData

      public GoodData​(java.lang.String login, java.lang.String password, GoodDataSettings settings)
      Create instance configured to communicate with GoodData Platform under user with given credentials.
      Parameters:
      login - GoodData user's login
      password - GoodData user's password
      settings - additional settings

    • GoodData

      public GoodData​(java.lang.String hostname, java.lang.String login, java.lang.String password)
      Create instance configured to communicate with GoodData Platform running on given host using given user's credentials.
      Parameters:
      hostname - GoodData Platform's host name (e.g. secure.gooddata.com)
      login - GoodData user's login
      password - GoodData user's password

    • GoodData

      public GoodData​(java.lang.String hostname, java.lang.String login, java.lang.String password, GoodDataSettings settings)
      Create instance configured to communicate with GoodData Platform running on given host using given user's credentials.
      Parameters:
      hostname - GoodData Platform's host name (e.g. secure.gooddata.com)
      login - GoodData user's login
      password - GoodData user's password
      settings - additional settings

    • GoodData

      public GoodData​(java.lang.String hostname, java.lang.String login, java.lang.String password, int port)
      Create instance configured to communicate with GoodData Platform running on given host and port using given user's credentials.
      Parameters:
      hostname - GoodData Platform's host name (e.g. secure.gooddata.com)
      login - GoodData user's login
      password - GoodData user's password
      port - GoodData Platform's API port (e.g. 443)

    • GoodData

      public GoodData​(java.lang.String hostname, java.lang.String login, java.lang.String password, int port, GoodDataSettings settings)
      Create instance configured to communicate with GoodData Platform running on given host and port using given user's credentials.
      Parameters:
      hostname - GoodData Platform's host name (e.g. secure.gooddata.com)
      login - GoodData user's login
      password - GoodData user's password
      port - GoodData Platform's API port (e.g. 443)
      settings - additional settings

    • GoodData

      public GoodData​(java.lang.String hostname, java.lang.String login, java.lang.String password, int port, java.lang.String protocol, GoodDataSettings settings)
      Create instance configured to communicate with GoodData Platform running on given host, port and protocol using given user's credentials.
      Parameters:
      hostname - GoodData Platform's host name (e.g. secure.gooddata.com)
      login - GoodData user's login
      password - GoodData user's password
      port - GoodData Platform's API port (e.g. 443)
      protocol - GoodData Platform's API protocol (e.g. https)
      settings - additional settings

    • GoodData

      protected GoodData​(GoodDataRestProvider goodDataRestProvider)
      Create instance based on given GoodDataRestProvider.
      Parameters:
      goodDataRestProvider - configured provider

  • Method Details

    • getRestTemplate

      protected org.springframework.web.client.RestTemplate getRestTemplate()
      Returns:
      underlying RestTemplate

    • logout

      public void logout()
      Logout from GoodData Platform

    • getProjectService

      @Bean("goodDataProjectService") public ProjectService getProjectService()
      Get initialized service for project management (to list projects, create a project, ...)
      Returns:
      initialized service for project management

    • getAccountService

      @Bean("goodDataAccountService") public AccountService getAccountService()
      Get initialized service for account management (to get current account information, logout, ...)
      Returns:
      initialized service for account management

    • getMetadataService

      @Bean("goodDataMetadataService") public MetadataService getMetadataService()
      Get initialized service for metadata management (to query, create and update project metadata like attributes, facts, metrics, reports, ...)
      Returns:
      initialized service for metadata management

    • getModelService

      @Bean("goodDataModelService") public ModelService getModelService()
      Get initialized service for model management (to get model diff, update model, ...)
      Returns:
      initialized service for model management

    • getGdcService

      @Bean("goodDataGdcService") public GdcService getGdcService()
      Get initialized service for API root management (to get API root links, ...)
      Returns:
      initialized service for API root management

    • getDataStoreService

      @Bean("goodDataDataStoreService") public DataStoreService getDataStoreService()
      Get initialized service for data store (user staging/WebDAV) management (to upload, download, delete, ...)
      Returns:
      initialized service for data store management

    • getDatasetService

      @Bean("goodDataDatasetService") public DatasetService getDatasetService()
      Get initialized service for dataset management (to list manifest, get datasets, load dataset, ...)
      Returns:
      initialized service for dataset management

    • getExportService

      @Bean("goodDataExportService") public ExportService getExportService()
      Get initialized service for exports management (export report,...)
      Returns:
      initialized service for exports

    • getProcessService

      @Bean("goodDataProcessService") public ProcessService getProcessService()
      Get initialized service for dataload processes management and process executions.
      Returns:
      initialized service for dataload processes management and process executions

    • getWarehouseService

      @Bean("goodDataWarehouseService") public WarehouseService getWarehouseService()
      Get initialized service for ADS management (create, access and delete ads instances).
      Returns:
      initialized service for ADS management

    • getConnectorService

      @Bean("goodDataConnectorService") public ConnectorService getConnectorService()
      Get initialized service for connector integration management (create, update, start process, ...).
      Returns:
      initialized service for connector integration management

    • getNotificationService

      @Bean("goodDataNotificationService") public NotificationService getNotificationService()
      Get initialized service for project notifications management.
      Returns:
      initialized service for project notifications management

    • getExportImportService

      @Bean("goodDataExportImportService") public ExportImportService getExportImportService()
      Get initialized service for metadata export/import.
      Returns:
      initialized service for metadata export/import

    • getFeatureFlagService

      @Deprecated @Bean("goodDataFeatureFlagService") public FeatureFlagService getFeatureFlagService()
      Deprecated.
      Use HierarchicalConfigService instead.
      Get initialized service for feature flag management.
      Returns:
      initialized service for feature flag management

    • getOutputStageService

      @Bean("goodDataOutputStageService") public OutputStageService getOutputStageService()
      Get initialized service for output stage management.
      Returns:
      initialized service for output stage management

    • getProjectTemplateService

      @Deprecated @Bean("goodDataProjectTemplateService") public ProjectTemplateService getProjectTemplateService()
      Deprecated.
      The project templates are deprecated and stopped working on May 15, 2019. See https://support.gooddata.com/hc/en-us/articles/360016126334-April-4-2019 Deprecated since version 3.0.1. Will be removed in one of future versions.
      Get initialized service for project templates
      Returns:
      initialized service for project templates

    • getAuditEventService

      @Bean("goodDataAuditEventService") public AuditEventService getAuditEventService()
      Get initialized service for audit events
      Returns:
      initialized service for audit events

    • getExecuteAfmService

      @Bean("goodDataExecuteAfmService") public ExecuteAfmService getExecuteAfmService()
      Get initialized service for afm execution
      Returns:
      initialized service for afm execution

    • getLcmService

      @Bean("goodDataLcmService") public LcmService getLcmService()
      Get initialized service for Life Cycle Management
      Returns:
      initialized service for Life Cycle Management

    • getHierarchicalConfigService

      @Bean("goodDataHierarchicalConfigService") public HierarchicalConfigService getHierarchicalConfigService()
      Get initialized service for hierarchical config management
      Returns:
      hierarchical config service