Class Runs

Hierarchy

APIResource
- Runs

Index

Constructors

constructor

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

Properties

`Protected`_client

_client: Runloop

Methods

retrieve

retrieve(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<ScenarioRunView>
Get a ScenarioRun given ID.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ScenarioRunView>
- Defined in src/resources/scenarios/runs.ts:17

list

list(
query?: Scenarios.RunListParams,
options?: RequestOptions<unknown>,
): PagePromise<ScenarioRunViewsBenchmarkRunsCursorIDPage, ScenarioRunView>
List all ScenarioRuns matching filter.
Parameters
- Optionalquery: Scenarios.RunListParams
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<ScenarioRunViewsBenchmarkRunsCursorIDPage, ScenarioRunView>
- Defined in src/resources/scenarios/runs.ts:24
list(
options?: RequestOptions<unknown>,
): PagePromise<ScenarioRunViewsBenchmarkRunsCursorIDPage, ScenarioRunView>
List all ScenarioRuns matching filter.
Parameters
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<ScenarioRunViewsBenchmarkRunsCursorIDPage, ScenarioRunView>
- Defined in src/resources/scenarios/runs.ts:28

cancel

cancel(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<ScenarioRunView>
Cancel a currently running Scenario run. This will shutdown the underlying Devbox resource.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ScenarioRunView>
- Defined in src/resources/scenarios/runs.ts:48

complete

complete(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<ScenarioRunView>
Complete a currently running ScenarioRun. Calling complete will shutdown underlying Devbox resource.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ScenarioRunView>
- Defined in src/resources/scenarios/runs.ts:56

downloadLogs

downloadLogs(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<Response>
Download a zip file containing all logs for a Scenario run from the associated devbox.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Response>
- Defined in src/resources/scenarios/runs.ts:64

score

score(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<ScenarioRunView>
Score a currently running ScenarioRun.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ScenarioRunView>
- Defined in src/resources/scenarios/runs.ts:75

awaitScored

awaitScored(
    id: string,
    options?: RequestOptions<unknown> & {
        polling?: Partial<PollingOptions<ScenarioRunView>>;
    },
): Promise<ScenarioRunView>
Wait for a scenario run to finish scoring. Polls the scenario run status until it reaches a terminal state.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown> & { polling?: Partial<PollingOptions<ScenarioRunView>> }
Returns Promise<ScenarioRunView>
- Defined in src/resources/scenarios/runs.ts:83

scoreAndAwait

scoreAndAwait(
    id: string,
    options?: RequestOptions<unknown> & {
        polling?: Partial<PollingOptions<ScenarioRunView>>;
    },
): Promise<ScenarioRunView>
Score a scenario run and wait for it to finish scoring. This is a convenience method that combines score() and awaitScoring().
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown> & { polling?: Partial<PollingOptions<ScenarioRunView>> }
Returns Promise<ScenarioRunView>
- Defined in src/resources/scenarios/runs.ts:112

scoreAndComplete

scoreAndComplete(
    id: string,
    options?: RequestOptions<unknown> & {
        polling?: Partial<PollingOptions<ScenarioRunView>>;
    },
): Promise<ScenarioRunView>
Score a scenario run, wait for scoring to complete, and then complete the run. This is a convenience method that combines scoreAndAwait() and complete().
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown> & { polling?: Partial<PollingOptions<ScenarioRunView>> }
Returns Promise<ScenarioRunView>
- Defined in src/resources/scenarios/runs.ts:124

Class Runs

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Scenarios.Runs

Properties

Protected_client

Methods

retrieve

Parameters

Returns APIPromise<ScenarioRunView>

list

Parameters

Returns PagePromise<ScenarioRunViewsBenchmarkRunsCursorIDPage, ScenarioRunView>

Parameters

Returns PagePromise<ScenarioRunViewsBenchmarkRunsCursorIDPage, ScenarioRunView>

cancel

Parameters

Returns APIPromise<ScenarioRunView>

complete

Parameters

Returns APIPromise<ScenarioRunView>

downloadLogs

Parameters

Returns APIPromise<Response>

score

Parameters

Returns APIPromise<ScenarioRunView>

awaitScored

Parameters

Returns Promise<ScenarioRunView>

scoreAndAwait

Parameters

Returns Promise<ScenarioRunView>

scoreAndComplete

Parameters

Returns Promise<ScenarioRunView>

Settings

On This Page

`Protected`_client