Class BenchmarkJobs

Hierarchy

APIResource
- BenchmarkJobs

Index

Constructors

Properties

Methods

create retrieve list

Constructors

constructor

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

Properties

`Protected`_client

_client: Runloop

Methods

create

create(
body?: Runloop.BenchmarkJobCreateParams,
options?: RequestOptions<unknown>,
): APIPromise<Runloop.BenchmarkJobView>
[Beta] Create a BenchmarkJob that runs a set of scenarios entirely on runloop.
Parameters
- Optionalbody: Runloop.BenchmarkJobCreateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.BenchmarkJobView>
- Defined in src/resources/benchmark-jobs.ts:11
create(options?: RequestOptions<unknown>): APIPromise<Runloop.BenchmarkJobView>
[Beta] Create a BenchmarkJob that runs a set of scenarios entirely on runloop.
Parameters
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.BenchmarkJobView>
- Defined in src/resources/benchmark-jobs.ts:12

retrieve

retrieve(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<Runloop.BenchmarkJobView>
[Beta] Get a BenchmarkJob given ID.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.BenchmarkJobView>
- Defined in src/resources/benchmark-jobs.ts:26

list

list(
query?: Runloop.BenchmarkJobListParams,
options?: RequestOptions<unknown>,
): APIPromise<Runloop.BenchmarkJobListView>
[Beta] List all BenchmarkJobs matching filter.
Parameters
- Optionalquery: Runloop.BenchmarkJobListParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.BenchmarkJobListView>
- Defined in src/resources/benchmark-jobs.ts:33
list(
options?: RequestOptions<unknown>,
): APIPromise<Runloop.BenchmarkJobListView>
[Beta] List all BenchmarkJobs matching filter.
Parameters
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.BenchmarkJobListView>
- Defined in src/resources/benchmark-jobs.ts:34