Class BenchmarkRuns

Hierarchy

APIResource
- BenchmarkRuns

Index

Constructors

Properties

Methods

retrieve list cancel complete listScenarioRuns

Constructors

constructor

new BenchmarkRuns(client: Runloop): Runloop.BenchmarkRuns
Parameters
- client: Runloop
Returns Runloop.BenchmarkRuns
Inherited from APIResource.constructor
- Defined in src/resource.ts:8

Properties

`Protected`_client

_client: Runloop

Methods

retrieve

retrieve(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<Runloop.BenchmarkRunView>
Get a BenchmarkRun given ID.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.BenchmarkRunView>
- Defined in src/resources/benchmark-runs.ts:14

list

list(
    query?: Runloop.BenchmarkRunListParams,
    options?: RequestOptions<unknown>,
): PagePromise<
    Runloop.BenchmarkRunViewsBenchmarkRunsCursorIDPage,
    Runloop.BenchmarkRunView,
>
List all BenchmarkRuns matching filter.
Parameters
- Optionalquery: Runloop.BenchmarkRunListParams
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<
Runloop.BenchmarkRunViewsBenchmarkRunsCursorIDPage,
Runloop.BenchmarkRunView,
>
- Defined in src/resources/benchmark-runs.ts:21
list(
    options?: RequestOptions<unknown>,
): PagePromise<
    Runloop.BenchmarkRunViewsBenchmarkRunsCursorIDPage,
    Runloop.BenchmarkRunView,
>
List all BenchmarkRuns matching filter.
Parameters
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<
Runloop.BenchmarkRunViewsBenchmarkRunsCursorIDPage,
Runloop.BenchmarkRunView,
>
- Defined in src/resources/benchmark-runs.ts:25

cancel

cancel(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<Runloop.BenchmarkRunView>
Cancel a Benchmark run. This will do the following: 1. Cancel all running scenarios and shutdown the underlying Devbox resources 2. Update the benchmark state to CANCELED 3. Calculate final score from completed scenarios
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.BenchmarkRunView>
- Defined in src/resources/benchmark-runs.ts:46

complete

complete(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<Runloop.BenchmarkRunView>
Complete a currently running BenchmarkRun.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.BenchmarkRunView>
- Defined in src/resources/benchmark-runs.ts:53

listScenarioRuns

listScenarioRuns(
    id: string,
    query?: Runloop.BenchmarkRunListScenarioRunsParams,
    options?: RequestOptions<unknown>,
): PagePromise<ScenarioRunViewsBenchmarkRunsCursorIDPage, ScenarioRunView>
List started scenario runs for a benchmark run.
Parameters
- id: string
- Optionalquery: Runloop.BenchmarkRunListScenarioRunsParams
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<ScenarioRunViewsBenchmarkRunsCursorIDPage, ScenarioRunView>
- Defined in src/resources/benchmark-runs.ts:60
listScenarioRuns(
id: string,
options?: RequestOptions<unknown>,
): PagePromise<ScenarioRunViewsBenchmarkRunsCursorIDPage, ScenarioRunView>
List started scenario runs for a benchmark run.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<ScenarioRunViewsBenchmarkRunsCursorIDPage, ScenarioRunView>
- Defined in src/resources/benchmark-runs.ts:65