Interface BenchmarkJobCreateParameters

BenchmarkJobCreateParameters contain the set of parameters to create a BenchmarkJob.

interface BenchmarkJobCreateParameters {
    name?: string | null;
    spec?:
        | Runloop.BenchmarkJobCreateParameters.HarborJobSpec
        | Runloop.BenchmarkJobCreateParameters.BenchmarkDefinitionJobSpec
        | Runloop.BenchmarkJobCreateParameters.ScenarioDefinitionJobSpec
        | null;
}

Index

Properties

Properties

`Optional`name

name?: string | null

The name of the BenchmarkJob. If not provided, name will be generated based on target dataset.

`Optional`spec

spec?:
    | Runloop.BenchmarkJobCreateParameters.HarborJobSpec
    | Runloop.BenchmarkJobCreateParameters.BenchmarkDefinitionJobSpec
    | Runloop.BenchmarkJobCreateParameters.ScenarioDefinitionJobSpec
    | null

The job specification. Exactly one spec type must be set.