Class Benchmarks

Hierarchy

APIResource
- Benchmarks

Index

Constructors

constructor

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

Properties

`Protected`_client

_client: Runloop

Methods

create

create(
body: BenchmarkCreateParams,
options?: RequestOptions<unknown>,
): APIPromise<BenchmarkView>
Create a Benchmark with a set of Scenarios.
Parameters
- body: BenchmarkCreateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<BenchmarkView>
- Defined in src/resources/benchmarks.ts:15

retrieve

retrieve(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<BenchmarkView>
Get a previously created Benchmark.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<BenchmarkView>
- Defined in src/resources/benchmarks.ts:22

update

update(
    id: string,
    body?: BenchmarkUpdateParams,
    options?: RequestOptions<unknown>,
): APIPromise<BenchmarkView>
Update a Benchmark. Fields that are null will preserve the existing value. Fields that are provided (including empty values) will replace the existing value entirely.
Parameters
- id: string
- Optionalbody: BenchmarkUpdateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<BenchmarkView>
- Defined in src/resources/benchmarks.ts:31
update(id: string, options?: RequestOptions<unknown>): APIPromise<BenchmarkView>
Update a Benchmark. Fields that are null will preserve the existing value. Fields that are provided (including empty values) will replace the existing value entirely.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<BenchmarkView>
- Defined in src/resources/benchmarks.ts:36

list

list(
query?: BenchmarkListParams,
options?: RequestOptions<unknown>,
): PagePromise<BenchmarkViewsBenchmarksCursorIDPage, BenchmarkView>
List all Benchmarks matching filter.
Parameters
- Optionalquery: BenchmarkListParams
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<BenchmarkViewsBenchmarksCursorIDPage, BenchmarkView>
- Defined in src/resources/benchmarks.ts:51
list(
options?: RequestOptions<unknown>,
): PagePromise<BenchmarkViewsBenchmarksCursorIDPage, BenchmarkView>
List all Benchmarks matching filter.
Parameters
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<BenchmarkViewsBenchmarksCursorIDPage, BenchmarkView>
- Defined in src/resources/benchmarks.ts:55

definitions

definitions(
    id: string,
    query?: BenchmarkDefinitionsParams,
    options?: RequestOptions<unknown>,
): APIPromise<ScenarioDefinitionListView>
Get scenario definitions for a previously created Benchmark.
Parameters
- id: string
- Optionalquery: BenchmarkDefinitionsParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ScenarioDefinitionListView>
- Defined in src/resources/benchmarks.ts:72
definitions(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<ScenarioDefinitionListView>
Get scenario definitions for a previously created Benchmark.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<ScenarioDefinitionListView>
- Defined in src/resources/benchmarks.ts:77

listPublic

listPublic(
query?: BenchmarkListPublicParams,
options?: RequestOptions<unknown>,
): PagePromise<BenchmarkViewsBenchmarksCursorIDPage, BenchmarkView>
List all public benchmarks matching filter.
Parameters
- Optionalquery: BenchmarkListPublicParams
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<BenchmarkViewsBenchmarksCursorIDPage, BenchmarkView>
- Defined in src/resources/benchmarks.ts:92
listPublic(
options?: RequestOptions<unknown>,
): PagePromise<BenchmarkViewsBenchmarksCursorIDPage, BenchmarkView>
List all public benchmarks matching filter.
Parameters
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<BenchmarkViewsBenchmarksCursorIDPage, BenchmarkView>
- Defined in src/resources/benchmarks.ts:96

startRun

startRun(
body: BenchmarkStartRunParams,
options?: RequestOptions<unknown>,
): APIPromise<Runloop.BenchmarkRunView>
Start a new BenchmarkRun based on the provided Benchmark.
Parameters
- body: BenchmarkStartRunParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.BenchmarkRunView>
- Defined in src/resources/benchmarks.ts:115

updateScenarios

updateScenarios(
    id: string,
    body?: BenchmarkUpdateScenariosParams,
    options?: RequestOptions<unknown>,
): APIPromise<BenchmarkView>
Add and/or remove Scenario IDs from an existing Benchmark.
Parameters
- id: string
- Optionalbody: BenchmarkUpdateScenariosParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<BenchmarkView>
- Defined in src/resources/benchmarks.ts:125
updateScenarios(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<BenchmarkView>
Add and/or remove Scenario IDs from an existing Benchmark.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<BenchmarkView>
- Defined in src/resources/benchmarks.ts:130

Class Benchmarks

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Benchmarks

Properties

Protected_client

Methods

create

Parameters

Returns APIPromise<BenchmarkView>

retrieve

Parameters

Returns APIPromise<BenchmarkView>

update

Parameters

Returns APIPromise<BenchmarkView>

Parameters

Returns APIPromise<BenchmarkView>

list

Parameters

Returns PagePromise<BenchmarkViewsBenchmarksCursorIDPage, BenchmarkView>

Parameters

Returns PagePromise<BenchmarkViewsBenchmarksCursorIDPage, BenchmarkView>

definitions

Parameters

Returns APIPromise<ScenarioDefinitionListView>

Parameters

Returns APIPromise<ScenarioDefinitionListView>

listPublic

Parameters

Returns PagePromise<BenchmarkViewsBenchmarksCursorIDPage, BenchmarkView>

Parameters

Returns PagePromise<BenchmarkViewsBenchmarksCursorIDPage, BenchmarkView>

startRun

Parameters

Returns APIPromise<Runloop.BenchmarkRunView>

updateScenarios

Parameters

Returns APIPromise<BenchmarkView>

Parameters

Returns APIPromise<BenchmarkView>

Settings

On This Page

`Protected`_client