@runloop/api-client - v1.4.0
    Preparing search index...

    Interface BenchmarkUpdateParameters

    BenchmarkUpdateParameters contain the set of parameters to update a Benchmark. All fields are optional - null fields preserve existing values, provided fields replace entirely.

    interface BenchmarkUpdateParameters {
        attribution?: string | null;
        description?: string | null;
        metadata?: { [key: string]: string } | null;
        name?: string | null;
        required_environment_variables?: string[] | null;
        required_secret_names?: string[] | null;
        scenario_ids?: string[] | null;
    }
    Index

    Properties

    attribution? description? metadata? name? required_environment_variables? required_secret_names? scenario_ids?

    Properties

    attribution?: string | null

    Attribution information for the benchmark. Pass in empty string to clear.

    description?: string | null

    Detailed description of the benchmark. Pass in empty string to clear.

    metadata?: { [key: string]: string } | null

    User defined metadata to attach to the benchmark. Pass in empty map to clear.

    name?: string | null

    The unique name of the Benchmark. Cannot be blank.

    required_environment_variables?: string[] | null

    Environment variables required to run the benchmark. If any required variables are not supplied, the benchmark will fail to start. Pass in empty list to clear.

    required_secret_names?: string[] | null

    Secrets required to run the benchmark with (environment variable name will be mapped to the your user secret by name). If any of these secrets are not provided or the mapping is incorrect, the benchmark will fail to start. Pass in empty list to clear.

    scenario_ids?: string[] | null

    The Scenario IDs that make up the Benchmark. Pass in empty list to clear.

    Settings

    Member Visibility

    On This Page

    Properties