Package com.gooddata.sdk.service.warehouse

Class WarehouseService

java.lang.Object
com.gooddata.sdk.service.AbstractService
com.gooddata.sdk.service.warehouse.WarehouseService
public class WarehouseService
extends AbstractService
Provide access to warehouse API - create, update, list and delete warehouses.

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.gooddata.sdk.service.AbstractService

    AbstractService.OutputStreamResponseExtractor

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static org.springframework.web.util.UriTemplate SCHEMA_TEMPLATE  
    static org.springframework.web.util.UriTemplate SCHEMAS_TEMPLATE  
    static org.springframework.web.util.UriTemplate USERS_TEMPLATE  
    static org.springframework.web.util.UriTemplate WAREHOUSE_TEMPLATE  

    Fields inherited from class com.gooddata.sdk.service.AbstractService

    mapper, restTemplate

  • Constructor Summary

    Constructors 
    Constructor Description
    WarehouseService​(org.springframework.web.client.RestTemplate restTemplate, GoodDataSettings settings)
    Sets RESTful HTTP Spring template.

  • Method Summary

    Modifier and Type Method Description
    FutureResult<com.gooddata.sdk.model.warehouse.WarehouseUser> addUserToWarehouse​(com.gooddata.sdk.model.warehouse.Warehouse warehouse, com.gooddata.sdk.model.warehouse.WarehouseUser user)
    Add given user to given warehouse.
    FutureResult<com.gooddata.sdk.model.warehouse.Warehouse> createWarehouse​(com.gooddata.sdk.model.warehouse.Warehouse warehouse)
    Create new warehouse.
    com.gooddata.sdk.model.warehouse.WarehouseSchema getDefaultWarehouseSchema​(com.gooddata.sdk.model.warehouse.Warehouse warehouse)
    get default warehouse schema
    com.gooddata.sdk.model.warehouse.Warehouse getWarehouseById​(java.lang.String id)
    Get Warehouse identified by given id.
    com.gooddata.sdk.model.warehouse.Warehouse getWarehouseByUri​(java.lang.String uri)
    Get Warehouse identified by given uri.
    com.gooddata.sdk.model.warehouse.WarehouseSchema getWarehouseSchemaByName​(com.gooddata.sdk.model.warehouse.Warehouse warehouse, java.lang.String name)
    get warehouse schema by name
    com.gooddata.sdk.model.warehouse.WarehouseSchema getWarehouseSchemaByUri​(java.lang.String uri)
    get warehouse schema by uri
    com.gooddata.sdk.common.collections.PageBrowser<com.gooddata.sdk.model.warehouse.Warehouse> listWarehouses()
    Lists Warehouses.
    com.gooddata.sdk.common.collections.PageBrowser<com.gooddata.sdk.model.warehouse.Warehouse> listWarehouses​(com.gooddata.sdk.common.collections.PageRequest startPage)
    Lists Warehouses.
    com.gooddata.sdk.common.collections.PageBrowser<com.gooddata.sdk.model.warehouse.WarehouseSchema> listWarehouseSchemas​(com.gooddata.sdk.model.warehouse.Warehouse warehouse)
    list schemas for Warehouse
    com.gooddata.sdk.common.collections.PageBrowser<com.gooddata.sdk.model.warehouse.WarehouseSchema> listWarehouseSchemas​(com.gooddata.sdk.model.warehouse.Warehouse warehouse, com.gooddata.sdk.common.collections.PageRequest startPage)
    list schemas for Warehouse
    com.gooddata.sdk.common.collections.PageBrowser<com.gooddata.sdk.model.warehouse.WarehouseUser> listWarehouseUsers​(com.gooddata.sdk.model.warehouse.Warehouse warehouse)
    Lists warehouse users.
    com.gooddata.sdk.common.collections.PageBrowser<com.gooddata.sdk.model.warehouse.WarehouseUser> listWarehouseUsers​(com.gooddata.sdk.model.warehouse.Warehouse warehouse, com.gooddata.sdk.common.collections.PageRequest startPage)
    Lists warehouse users, starting with specified page.
    FutureResult<java.lang.Void> removeUserFromWarehouse​(com.gooddata.sdk.model.warehouse.WarehouseUser user)
    Remove given user from warehouse instance
    void removeWarehouse​(com.gooddata.sdk.model.warehouse.Warehouse warehouse)
    Delete Warehouse.
    com.gooddata.sdk.model.warehouse.Warehouse updateWarehouse​(com.gooddata.sdk.model.warehouse.Warehouse toUpdate)
    Updates given Warehouse.

    Methods inherited from class com.gooddata.sdk.service.AbstractService

    extractData

    Methods inherited from class java.lang.Object

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

  • Field Details

    • SCHEMAS_TEMPLATE

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

    • SCHEMA_TEMPLATE

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

    • WAREHOUSE_TEMPLATE

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

    • USERS_TEMPLATE

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

  • Constructor Details

    • WarehouseService

      public WarehouseService​(org.springframework.web.client.RestTemplate restTemplate, GoodDataSettings settings)
      Sets RESTful HTTP Spring template. Should be called from constructor of concrete service extending this abstract one.
      Parameters:
      restTemplate - RESTful HTTP Spring template
      settings - settings

  • Method Details

    • createWarehouse

      public FutureResult<com.gooddata.sdk.model.warehouse.Warehouse> createWarehouse​(com.gooddata.sdk.model.warehouse.Warehouse warehouse)
      Create new warehouse.
      Parameters:
      warehouse - warehouse to create
      Returns:
      created warehouse

    • removeWarehouse

      public void removeWarehouse​(com.gooddata.sdk.model.warehouse.Warehouse warehouse)
      Delete Warehouse.
      Parameters:
      warehouse - to delete

    • getWarehouseByUri

      public com.gooddata.sdk.model.warehouse.Warehouse getWarehouseByUri​(java.lang.String uri)
      Get Warehouse identified by given uri.
      Parameters:
      uri - warehouse uri
      Returns:
      Warehouse
      Throws:
      com.gooddata.sdk.common.GoodDataException - when Warehouse can't be accessed

    • getWarehouseById

      public com.gooddata.sdk.model.warehouse.Warehouse getWarehouseById​(java.lang.String id)
      Get Warehouse identified by given id.
      Parameters:
      id - warehouse id
      Returns:
      Warehouse
      Throws:
      com.gooddata.sdk.common.GoodDataException - when Warehouse can't be accessed

    • listWarehouses

      public com.gooddata.sdk.common.collections.PageBrowser<com.gooddata.sdk.model.warehouse.Warehouse> listWarehouses()
      Lists Warehouses. Returns empty list in case there are no warehouses. Returns only first page if there's more instances than page limit. Use PageBrowser.allItemsStream() ()} to iterate over all pages, or PageBrowser.getAllItems() ()} to load the entire list.
      Returns:
      PageBrowser first page of list of warehouse instances or empty list

    • listWarehouses

      public com.gooddata.sdk.common.collections.PageBrowser<com.gooddata.sdk.model.warehouse.Warehouse> listWarehouses​(com.gooddata.sdk.common.collections.PageRequest startPage)
      Lists Warehouses. Returns empty list in case there are no warehouses. Returns requested page (by page limit and offset). Use listWarehouses() to get first page with default setting.
      Parameters:
      startPage - page to be listed
      Returns:
      PageBrowser requested page of list of instances or empty list

    • listWarehouseUsers

      public com.gooddata.sdk.common.collections.PageBrowser<com.gooddata.sdk.model.warehouse.WarehouseUser> listWarehouseUsers​(com.gooddata.sdk.model.warehouse.Warehouse warehouse)
      Lists warehouse users. Returns empty list in case there are no users. Use PageBrowser.allItemsStream() ()} to iterate over all pages, or PageBrowser.getAllItems() ()} to load the entire list.
      Parameters:
      warehouse - warehouse
      Returns:
      PageBrowser requested page of list of instances or empty list

    • listWarehouseUsers

      public com.gooddata.sdk.common.collections.PageBrowser<com.gooddata.sdk.model.warehouse.WarehouseUser> listWarehouseUsers​(com.gooddata.sdk.model.warehouse.Warehouse warehouse, com.gooddata.sdk.common.collections.PageRequest startPage)
      Lists warehouse users, starting with specified page. Returns empty list in case there are no users. Use PageBrowser.allItemsStream() ()} to iterate over all pages, or PageBrowser.getAllItems() ()} to load the entire list.
      Parameters:
      warehouse - warehouse
      startPage - page to start with
      Returns:
      PageBrowser requested page of list of instances starting with startPage or empty list

    • addUserToWarehouse

      public FutureResult<com.gooddata.sdk.model.warehouse.WarehouseUser> addUserToWarehouse​(com.gooddata.sdk.model.warehouse.Warehouse warehouse, com.gooddata.sdk.model.warehouse.WarehouseUser user)
      Add given user to given warehouse.
      Parameters:
      warehouse - warehouse the user should be added to
      user - user to be added
      Returns:
      added user in warehouse

    • removeUserFromWarehouse

      public FutureResult<java.lang.Void> removeUserFromWarehouse​(com.gooddata.sdk.model.warehouse.WarehouseUser user)
      Remove given user from warehouse instance
      Parameters:
      user - to remove from warehouse
      Returns:
      empty future result
      Throws:
      WarehouseUserNotFoundException - when user for removal can't be found
      com.gooddata.sdk.common.GoodDataException - any other reason

    • updateWarehouse

      public com.gooddata.sdk.model.warehouse.Warehouse updateWarehouse​(com.gooddata.sdk.model.warehouse.Warehouse toUpdate)
      Updates given Warehouse.
      Parameters:
      toUpdate - warehouse to be updated
      Returns:
      updated warehouse
      Throws:
      com.gooddata.sdk.common.GoodDataException - when update fails

    • listWarehouseSchemas

      public com.gooddata.sdk.common.collections.PageBrowser<com.gooddata.sdk.model.warehouse.WarehouseSchema> listWarehouseSchemas​(com.gooddata.sdk.model.warehouse.Warehouse warehouse)
      list schemas for Warehouse
      Parameters:
      warehouse - to list schemas for
      Returns:
      PageBrowser pageable list of warehouse schemas

    • listWarehouseSchemas

      public com.gooddata.sdk.common.collections.PageBrowser<com.gooddata.sdk.model.warehouse.WarehouseSchema> listWarehouseSchemas​(com.gooddata.sdk.model.warehouse.Warehouse warehouse, com.gooddata.sdk.common.collections.PageRequest startPage)
      list schemas for Warehouse
      Parameters:
      warehouse - to list schemas for
      startPage - page to be listed
      Returns:
      PageBrowser pageable list of warehouse schemas

    • getWarehouseSchemaByName

      public com.gooddata.sdk.model.warehouse.WarehouseSchema getWarehouseSchemaByName​(com.gooddata.sdk.model.warehouse.Warehouse warehouse, java.lang.String name)
      get warehouse schema by name
      Parameters:
      warehouse - to get schema for
      name - of schema
      Returns:
      warehouse schema

    • getWarehouseSchemaByUri

      public com.gooddata.sdk.model.warehouse.WarehouseSchema getWarehouseSchemaByUri​(java.lang.String uri)
      get warehouse schema by uri
      Parameters:
      uri - of schema
      Returns:
      warehouse schema

    • getDefaultWarehouseSchema

      public com.gooddata.sdk.model.warehouse.WarehouseSchema getDefaultWarehouseSchema​(com.gooddata.sdk.model.warehouse.Warehouse warehouse)
      get default warehouse schema
      Parameters:
      warehouse - to get default schema for
      Returns:
      default warehouse schema