Table of Contents

Class SimulationRun

Namespace
LiveKit.Proto
Assembly
LiveKit.AspNetCore.ServerSdk.Abstractions.dll
public sealed class SimulationRun : IMessage<SimulationRun>, IEquatable<SimulationRun>, IDeepCloneable<SimulationRun>, IBufferMessage, IMessage
Inheritance
SimulationRun
Implements
IMessage<SimulationRun>
IDeepCloneable<SimulationRun>
IBufferMessage
IMessage
Inherited Members

Constructors

SimulationRun()

public SimulationRun()

SimulationRun(SimulationRun)

public SimulationRun(SimulationRun other)

Parameters

other SimulationRun

Fields

AgentDescriptionFieldNumber

Field number for the "agent_description" field.

public const int AgentDescriptionFieldNumber = 4

Field Value

int

AgentNameFieldNumber

Field number for the "agent_name" field.

public const int AgentNameFieldNumber = 9

Field Value

int

CiFieldNumber

Field number for the "ci" field.

public const int CiFieldNumber = 22

Field Value

int

ConcurrencyFieldNumber

Field number for the "concurrency" field.

public const int ConcurrencyFieldNumber = 17

Field Value

int

CreatedAtFieldNumber

Field number for the "created_at" field.

public const int CreatedAtFieldNumber = 6

Field Value

int

EndedAtFieldNumber

Field number for the "ended_at" field.

public const int EndedAtFieldNumber = 11

Field Value

int

ErrorFieldNumber

Field number for the "error" field.

public const int ErrorFieldNumber = 5

Field Value

int

FailedCountFieldNumber

Field number for the "failed_count" field.

public const int FailedCountFieldNumber = 14

Field Value

int

IdFieldNumber

Field number for the "id" field.

public const int IdFieldNumber = 1

Field Value

int

IssueCountFieldNumber

Field number for the "issue_count" field.

public const int IssueCountFieldNumber = 21

Field Value

int

JobCountFieldNumber

Field number for the "job_count" field.

public const int JobCountFieldNumber = 12

Field Value

int

JobsFieldNumber

Field number for the "jobs" field.

public const int JobsFieldNumber = 7

Field Value

int

MetricsFieldNumber

Field number for the "metrics" field.

public const int MetricsFieldNumber = 19

Field Value

int

ModeFieldNumber

Field number for the "mode" field.

public const int ModeFieldNumber = 18

Field Value

int

NumSimulationsFieldNumber

Field number for the "num_simulations" field.

public const int NumSimulationsFieldNumber = 15

Field Value

int

PassedCountFieldNumber

Field number for the "passed_count" field.

public const int PassedCountFieldNumber = 13

Field Value

int

ProjectIdFieldNumber

Field number for the "project_id" field.

public const int ProjectIdFieldNumber = 2

Field Value

int

SamplingFieldNumber

Field number for the "sampling" field.

public const int SamplingFieldNumber = 23

Field Value

int

ScenarioGroupFieldNumber

Field number for the "scenario_group" field.

public const int ScenarioGroupFieldNumber = 10

Field Value

int

StatusFieldNumber

Field number for the "status" field.

public const int StatusFieldNumber = 3

Field Value

int

SummaryZstdFieldNumber

Field number for the "summary_zstd" field.

public const int SummaryZstdFieldNumber = 20

Field Value

int

UsageFieldNumber

Field number for the "usage" field.

public const int UsageFieldNumber = 16

Field Value

int

Properties

AgentDescription

public string AgentDescription { get; set; }

Property Value

string

AgentName

public string AgentName { get; set; }

Property Value

string

Ci

The pipeline this run came from; unset when it did not come from one.

public SimulationRun.Types.CI Ci { get; set; }

Property Value

SimulationRun.Types.CI

Concurrency

Maximum simulate jobs running in parallel for this run (0 = server default).

public int Concurrency { get; set; }

Property Value

int

CreatedAt

public Timestamp CreatedAt { get; set; }

Property Value

Timestamp

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

EndedAt

public Timestamp EndedAt { get; set; }

Property Value

Timestamp

Error

public string Error { get; set; }

Property Value

string

FailedCount

public int FailedCount { get; set; }

Property Value

int

HasIssueCount

Gets whether the "issue_count" field is set

public bool HasIssueCount { get; }

Property Value

bool

Id

public string Id { get; set; }

Property Value

string

IssueCount

How many issues the stored summary flagged. Present only once a summary landed — absent and 0 differ ("never summarized" vs "no issues") — and List responses carry it without the summary blob itself.

public int IssueCount { get; set; }

Property Value

int

JobCount

public int JobCount { get; set; }

Property Value

int

Jobs

public RepeatedField<SimulationRun.Types.Job> Jobs { get; }

Property Value

RepeatedField<SimulationRun.Types.Job>

Metrics

Run-level aggregates over this run's jobs.

public SimulationRun.Types.RunMetrics Metrics { get; set; }

Property Value

SimulationRun.Types.RunMetrics

Mode

Conversation mode for every job in this run; unspecified = TEXT.

public SimulationMode Mode { get; set; }

Property Value

SimulationMode

NumSimulations

public int NumSimulations { get; set; }

Property Value

int

Parser

public static MessageParser<SimulationRun> Parser { get; }

Property Value

MessageParser<SimulationRun>

PassedCount

public int PassedCount { get; set; }

Property Value

int

ProjectId

public string ProjectId { get; set; }

Property Value

string

Sampling

Absent when the run ran each scenario once and required it to pass.

public SimulationRun.Types.Sampling Sampling { get; set; }

Property Value

SimulationRun.Types.Sampling

ScenarioGroup

public ScenarioGroup ScenarioGroup { get; set; }

Property Value

ScenarioGroup

Status

public SimulationRun.Types.Status Status { get; set; }

Property Value

SimulationRun.Types.Status

SummaryZstd

zstd-compressed SimulationRunSummary: decompress, then proto.Unmarshal. Compressed by default so the blob ships as-is on every hop.

public ByteString SummaryZstd { get; set; }

Property Value

ByteString

Usage

Aggregate usage across all jobs in this run (sum of Job.usage).

public SimulationRun.Types.Usage Usage { get; set; }

Property Value

SimulationRun.Types.Usage

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

ClearIssueCount()

Clears the value of the "issue_count" field

public void ClearIssueCount()

Clone()

Creates a deep clone of this object.

public SimulationRun Clone()

Returns

SimulationRun

A deep clone of this object.

Equals(SimulationRun)

public bool Equals(SimulationRun other)

Parameters

other SimulationRun

Returns

bool

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(SimulationRun)

Merges the given message into this one.

public void MergeFrom(SimulationRun other)

Parameters

other SimulationRun

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.