io.onetapbeyond.opencpu.r.executor

Interface OCPUResult

All Superinterfaces:

java.io.Serializable

public interface OCPUResult
extends java.io.Serializable

Executable R task result data.

All OCPUTask are serializable making them compatible with Java cluster computing solutions, such as Apache Spark.

Method Summary

Modifier and Type	Method and Description
java.lang.Exception	cause() Retrieve cause of error if task execution failed.
java.util.Map	data() Return result data generated by successful task execution.
java.lang.String	error() Retrieve error message if task execution failed.
boolean	success() Determine if task execution was successful.
long	timeTaken() Returns approximate time taken (ms) by task execution.

Method Detail

success

boolean success()

Determine if task execution was successful.

Returns:

indication of task execution success or failure.

error

java.lang.String error()

Retrieve error message if task execution failed.

Returns:

an error message if task execution failed, otherwise null.

cause

java.lang.Exception cause()

Retrieve cause of error if task execution failed.

Returns:

an Exception indicating cause of failure.

timeTaken

long timeTaken()

Returns approximate time taken (ms) by task execution.

Returns:

time taken (ms) on task execution success, otherwise zero

data

java.util.Map data()

Return result data generated by successful task execution.

Returns:

Map representation of JSON data returned following analysis by your OCPUTask.