Class UpdateJobStatus

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

public sealed class UpdateJobStatus : IMessage<UpdateJobStatus>, IEquatable<UpdateJobStatus>, IDeepCloneable<UpdateJobStatus>, IBufferMessage, IMessage

Inheritance

object

UpdateJobStatus

Implements

IMessage<UpdateJobStatus>

IEquatable<UpdateJobStatus>

IDeepCloneable<UpdateJobStatus>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

UpdateJobStatus()

public UpdateJobStatus()

UpdateJobStatus(UpdateJobStatus)

public UpdateJobStatus(UpdateJobStatus other)

Parameters

other UpdateJobStatus

Fields

ErrorFieldNumber

Field number for the "error" field.

public const int ErrorFieldNumber = 3

Field Value

int

JobIdFieldNumber

Field number for the "job_id" field.

public const int JobIdFieldNumber = 1

Field Value

int

StatusFieldNumber

Field number for the "status" field.

public const int StatusFieldNumber = 2

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Error

metadata shown on the dashboard, useful for debugging

public string Error { get; set; }

Property Value

string

JobId

public string JobId { get; set; }

Property Value

string

Parser

public static MessageParser<UpdateJobStatus> Parser { get; }

Property Value

MessageParser<UpdateJobStatus>

Status

The worker can indicate the job end by either specifying SUCCESS or FAILED

public JobStatus Status { get; set; }

Property Value

JobStatus

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.

Clone()

Creates a deep clone of this object.

public UpdateJobStatus Clone()

Returns

UpdateJobStatus

A deep clone of this object.

Equals(UpdateJobStatus)

public bool Equals(UpdateJobStatus other)

Parameters

other UpdateJobStatus

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(UpdateJobStatus)

Merges the given message into this one.

public void MergeFrom(UpdateJobStatus other)

Parameters

other UpdateJobStatus

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.