Package com.gooddata.sdk.service.export

Class ExportService

java.lang.Object
com.gooddata.sdk.service.AbstractService
com.gooddata.sdk.service.export.ExportService
public class ExportService
extends AbstractService
Export project data

  • 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 java.lang.String EXPORTING_URI  
    static org.springframework.web.util.UriTemplate OBJ_TEMPLATE  
    static org.springframework.web.util.UriTemplate PROJECT_TEMPLATE  

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

    mapper, restTemplate

  • Constructor Summary

    Constructors 
    Constructor Description
    ExportService​(org.springframework.web.client.RestTemplate restTemplate, GoodDataSettings settings)
    Service for data export

  • Method Summary

    Modifier and Type Method Description
    protected com.fasterxml.jackson.databind.JsonNode executeReport​(java.lang.String executionUri, com.gooddata.sdk.model.export.ReportRequest request)  
    FutureResult<java.lang.Void> export​(com.gooddata.sdk.model.md.report.ReportDefinition reportDefinition, com.gooddata.sdk.model.export.ExportFormat format, java.io.OutputStream output)
    Export the given report definition in the given format to the given output stream
    FutureResult<java.lang.Void> export​(com.gooddata.sdk.model.md.report.Report report, com.gooddata.sdk.model.export.ExportFormat format, java.io.OutputStream output)
    Export the given report in the given format to the given output stream
    FutureResult<java.lang.Void> exportCsv​(com.gooddata.sdk.model.md.report.ReportDefinition definition, java.io.OutputStream output)
    Export the given Report Definition using the raw export (without columns/rows limitations)
    FutureResult<java.lang.Void> exportCsv​(com.gooddata.sdk.model.md.report.Report report, java.io.OutputStream output)
    Export the given Report using the raw export (without columns/rows limitations)
    FutureResult<java.lang.Void> exportPdf​(GoodDataEndpoint endpoint, com.gooddata.sdk.model.md.ProjectDashboard dashboard, com.gooddata.sdk.model.md.ProjectDashboard.Tab tab, java.io.OutputStream output)
    Export the given dashboard tab in PDF format to the given output stream

    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

  • Constructor Details

    • ExportService

      public ExportService​(org.springframework.web.client.RestTemplate restTemplate, GoodDataSettings settings)
      Service for data export
      Parameters:
      restTemplate - REST template
      settings - settings

  • Method Details

    • export

      public FutureResult<java.lang.Void> export​(com.gooddata.sdk.model.md.report.ReportDefinition reportDefinition, com.gooddata.sdk.model.export.ExportFormat format, java.io.OutputStream output)
      Export the given report definition in the given format to the given output stream
      Parameters:
      reportDefinition - report definition
      format - export format
      output - target
      Returns:
      polling result
      Throws:
      NoDataExportException - in case report contains no data
      ExportException - on error

    • export

      public FutureResult<java.lang.Void> export​(com.gooddata.sdk.model.md.report.Report report, com.gooddata.sdk.model.export.ExportFormat format, java.io.OutputStream output)
      Export the given report in the given format to the given output stream
      Parameters:
      report - report
      format - export format
      output - target
      Returns:
      polling result
      Throws:
      NoDataExportException - in case report contains no data
      ExportException - on error

    • executeReport

      protected com.fasterxml.jackson.databind.JsonNode executeReport​(java.lang.String executionUri, com.gooddata.sdk.model.export.ReportRequest request)

    • exportPdf

      public FutureResult<java.lang.Void> exportPdf​(GoodDataEndpoint endpoint, com.gooddata.sdk.model.md.ProjectDashboard dashboard, com.gooddata.sdk.model.md.ProjectDashboard.Tab tab, java.io.OutputStream output)
      Export the given dashboard tab in PDF format to the given output stream
      Parameters:
      endpoint - endpoint for which the export is generated
      dashboard - dashboard
      tab - tab
      output - output
      Returns:
      polling result
      Throws:
      ExportException - if export fails

    • exportCsv

      public FutureResult<java.lang.Void> exportCsv​(com.gooddata.sdk.model.md.report.Report report, java.io.OutputStream output)
      Export the given Report using the raw export (without columns/rows limitations)
      Parameters:
      report - report
      output - output
      Returns:
      polling result
      Throws:
      ExportException - in case export fails

    • exportCsv

      public FutureResult<java.lang.Void> exportCsv​(com.gooddata.sdk.model.md.report.ReportDefinition definition, java.io.OutputStream output)
      Export the given Report Definition using the raw export (without columns/rows limitations)
      Parameters:
      definition - report definition
      output - output
      Returns:
      polling result
      Throws:
      ExportException - in case export fails