Package com.gooddata.sdk.service.hierarchicalconfig

Class HierarchicalConfigService

  • public class HierarchicalConfigService
extends AbstractService
    Provides hierarchical configuration management a.k.a. platform settings a.k.a. feature flags. For more detailed description, see this documentation https://help.gooddata.com/api#/reference/hierarchical-configuration

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.gooddata.sdk.model.hierarchicalconfig.ConfigItem getProjectConfigItem​(com.gooddata.sdk.model.project.Project project, java.lang.String configName)
      Returns config item for given project (even if it's inherited from its hierarchy).
      com.gooddata.sdk.model.hierarchicalconfig.ConfigItems listProjectConfigItems​(com.gooddata.sdk.model.project.Project project)
      Returns all config items for given project (including inherited ones from its hierarchy).
      void removeProjectConfigItem​(com.gooddata.sdk.model.hierarchicalconfig.ConfigItem configItem)
      Removes existing project config item.
      com.gooddata.sdk.model.hierarchicalconfig.ConfigItem setProjectConfigItem​(com.gooddata.sdk.model.project.Project project, com.gooddata.sdk.model.hierarchicalconfig.ConfigItem configItem)
      Creates or updates config item for given project.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • PROJECT_CONFIG_ITEMS_TEMPLATE

        public static final org.springframework.web.util.UriTemplate PROJECT_CONFIG_ITEMS_TEMPLATE

      • PROJECT_CONFIG_ITEM_TEMPLATE

        public static final org.springframework.web.util.UriTemplate PROJECT_CONFIG_ITEM_TEMPLATE

    • Constructor Detail

      • HierarchicalConfigService

        public HierarchicalConfigService​(org.springframework.web.client.RestTemplate restTemplate,
                                 GoodDataSettings settings)

    • Method Detail

      • listProjectConfigItems

        public com.gooddata.sdk.model.hierarchicalconfig.ConfigItems listProjectConfigItems​(com.gooddata.sdk.model.project.Project project)
        Returns all config items for given project (including inherited ones from its hierarchy).
        Parameters:
        project - project, cannot be null
        Returns:
        config item for given project

      • getProjectConfigItem

        public com.gooddata.sdk.model.hierarchicalconfig.ConfigItem getProjectConfigItem​(com.gooddata.sdk.model.project.Project project,
                                                                                 java.lang.String configName)
        Returns config item for given project (even if it's inherited from its hierarchy).
        Parameters:
        project - project, cannot be null
        configName - unique name (key) of config item, cannot be empty
        Returns:
        config item for given project with given name (key)

      • setProjectConfigItem

        public com.gooddata.sdk.model.hierarchicalconfig.ConfigItem setProjectConfigItem​(com.gooddata.sdk.model.project.Project project,
                                                                                 com.gooddata.sdk.model.hierarchicalconfig.ConfigItem configItem)
        Creates or updates config item for given project.
        Parameters:
        project - project for which the config item should be created/updated, cannot be null
        configItem - config item to be created/updated, cannot be null
        Returns:
        created/updated project config item

      • removeProjectConfigItem

        public void removeProjectConfigItem​(com.gooddata.sdk.model.hierarchicalconfig.ConfigItem configItem)
        Removes existing project config item.
        Parameters:
        configItem - existing project config item with links set properly, cannot be null