Package org.jenkinsci.plugins.octoperf.result

Interface BenchResultService

public interface BenchResultService

Provides common operations on BenchResult.

Author:

jerome

Field Summary

Fields

Modifier and Type	Field	Description
static final BenchResultService	BENCH_RESULTS	BenchResultService singleton instance.

Method Summary

Modifier and Type	Method	Description
BenchResult	find(RestApiFactory apiFactory, String benchResultId)	Finds a bench result by its id.
Double	getProgress(RestApiFactory apiFactory, String benchResultId)
BenchResultState	getState(RestApiFactory apiFactory, String benchResultId)	Refreshed the state of the given benchresult.
boolean	isFinished(BenchResult benchResult)	Returns true when the bench result is finished.
void	stopTest(RestApiFactory apiFactory, String benchResultId)	Stops the test.

Field Details

BENCH_RESULTS

static final BenchResultService BENCH_RESULTS

BenchResultService singleton instance.

Method Details

find

BenchResult find(RestApiFactory apiFactory,
 String benchResultId)
          throws IOException

Finds a bench result by its id.

Parameters:

benchResultId - bench result id

Returns:

bench result, when found

Throws:

IOException

getState

BenchResultState getState(RestApiFactory apiFactory,
 String benchResultId)
                   throws IOException

Refreshed the state of the given benchresult.

Parameters:

benchResultId - bench result id

Returns:

Throws:

IOException

getProgress

Double getProgress(RestApiFactory apiFactory,
 String benchResultId)
            throws IOException

Throws:

IOException

isFinished

boolean isFinished(BenchResult benchResult)

Returns true when the bench result is finished.

Parameters:

benchResult - bench result

Returns:

true if the result execution is finished

stopTest

void stopTest(RestApiFactory apiFactory,
 String benchResultId)
       throws IOException

Stops the test.

Parameters:

benchResultId - bench result id

Throws:

IOException