Package com.gooddata.sdk.service.executeafm

Class ExecuteAfmService

java.lang.Object

com.gooddata.sdk.service.AbstractService

com.gooddata.sdk.service.executeafm.ExecuteAfmService

public class ExecuteAfmService
extends AbstractService

Service for executing reports with new visualization structures like AFM or Visualization Object. This includes GD API endpoints:

• /executeAfm
• /executeVisualization

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 final String	AFM_EXECUTION_URI	URI string containing template link to the /executeAfm resource.
static final String	RESULT_LIMIT	Query param representing limit of result data returned by AFM execution.
static final String	RESULT_OFFSET	Query param representing offset of result data returned by AFM execution.
static final String	VISUALIZATION_EXECUTION_URI	URI string containing template link to the /executeVisualization resource.

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

mapper, restTemplate

Constructor Summary

Constructors

Constructor	Description
ExecuteAfmService(org.springframework.web.client.RestTemplate restTemplate, GoodDataSettings settings)	Constructor.

Method Summary

Modifier and Type	Method	Description
ExecutionResponse	executeAfm(Project project, Execution execution)	Executes the given AFM execution returning the execution response
ExecutionResponse	executeVisualization(Project project, VisualizationExecution execution)	Executes the given execution returning the execution response
FutureResult<ExecutionResult>	getResult(ExecutionResponse executionResponse)	Get for result of given response.
FutureResult<ExecutionResult>	getResult(ExecutionResponse executionResponse, ResultPage page)	Get for page of result of given response.

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

AFM_EXECUTION_URI

public static final String AFM_EXECUTION_URI

URI string containing template link to the /executeAfm resource.

See Also:

• Constant Field Values

VISUALIZATION_EXECUTION_URI

public static final String VISUALIZATION_EXECUTION_URI

URI string containing template link to the /executeVisualization resource.

See Also:

• Constant Field Values

RESULT_OFFSET

public static final String RESULT_OFFSET

Query param representing offset of result data returned by AFM execution. Can be used for offset query param value replacement in ExecutionResponse.getExecutionResultUri() link.

See Also:

• Constant Field Values

RESULT_LIMIT

public static final String RESULT_LIMIT

Query param representing limit of result data returned by AFM execution. Can be used for limit query param value replacement in ExecutionResponse.getExecutionResultUri() link.

See Also:

• Constant Field Values

Constructor Details

ExecuteAfmService

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

Constructor.

Parameters:

restTemplate - rest template

settings - settings

Method Details

executeAfm

public ExecutionResponse executeAfm(Project project,
 Execution execution)

Executes the given AFM execution returning the execution response

Parameters:

project - project of the execution

execution - execution

Returns:

response of the submitted execution

executeVisualization

public ExecutionResponse executeVisualization(Project project,
 VisualizationExecution execution)

Executes the given execution returning the execution response

Parameters:

project - project of the execution

execution - execution

Returns:

response of the submitted execution

getResult

public FutureResult<ExecutionResult> getResult(ExecutionResponse executionResponse)

Get for result of given response.

Parameters:

executionResponse - response to get the result

Returns:

future of execution result

getResult

public FutureResult<ExecutionResult> getResult(ExecutionResponse executionResponse,
 ResultPage page)

Get for page of result of given response.

Parameters:

executionResponse - response to get the result

page - desired result page specification

Returns:

future of execution result