Documentation

Job extends Message
in package

Generated from protobuf message <code>livekit.SimulationRun.Job</code>

Table of Contents

Properties

$agent_expectations  : mixed
Generated from protobuf field <code>string agent_expectations = 5;</code>
$ended_at  : mixed
Generated from protobuf field <code>.google.protobuf.Timestamp ended_at = 11;</code>
$error  : mixed
Generated from protobuf field <code>string error = 4;</code>
$id  : mixed
Generated from protobuf field <code>string id = 1;</code>
$instructions  : mixed
Generated from protobuf field <code>string instructions = 3;</code>
$label  : mixed
Generated from protobuf field <code>string label = 6;</code>
$room_name  : mixed
Generated from protobuf field <code>string room_name = 8;</code>
$scenario_id  : mixed
Generated from protobuf field <code>string scenario_id = 9;</code>
$started_at  : mixed
Generated from protobuf field <code>.google.protobuf.Timestamp started_at = 10;</code>
$status  : mixed
Generated from protobuf field <code>.livekit.SimulationRun.Job.Status status = 2;</code>
$tags  : mixed
Generated from protobuf field <code>repeated string tags = 7;</code>

Methods

__construct()  : mixed
Constructor.
clearEndedAt()  : mixed
clearStartedAt()  : mixed
getAgentExpectations()  : string
Generated from protobuf field <code>string agent_expectations = 5;</code>
getEndedAt()  : Timestamp|null
Generated from protobuf field <code>.google.protobuf.Timestamp ended_at = 11;</code>
getError()  : string
Generated from protobuf field <code>string error = 4;</code>
getId()  : string
Generated from protobuf field <code>string id = 1;</code>
getInstructions()  : string
Generated from protobuf field <code>string instructions = 3;</code>
getLabel()  : string
Generated from protobuf field <code>string label = 6;</code>
getRoomName()  : string
Generated from protobuf field <code>string room_name = 8;</code>
getScenarioId()  : string
Generated from protobuf field <code>string scenario_id = 9;</code>
getStartedAt()  : Timestamp|null
Generated from protobuf field <code>.google.protobuf.Timestamp started_at = 10;</code>
getStatus()  : int
Generated from protobuf field <code>.livekit.SimulationRun.Job.Status status = 2;</code>
getTags()  : RepeatedField<string|int, string>
Generated from protobuf field <code>repeated string tags = 7;</code>
hasEndedAt()  : mixed
hasStartedAt()  : mixed
setAgentExpectations()  : $this
Generated from protobuf field <code>string agent_expectations = 5;</code>
setEndedAt()  : $this
Generated from protobuf field <code>.google.protobuf.Timestamp ended_at = 11;</code>
setError()  : $this
Generated from protobuf field <code>string error = 4;</code>
setId()  : $this
Generated from protobuf field <code>string id = 1;</code>
setInstructions()  : $this
Generated from protobuf field <code>string instructions = 3;</code>
setLabel()  : $this
Generated from protobuf field <code>string label = 6;</code>
setRoomName()  : $this
Generated from protobuf field <code>string room_name = 8;</code>
setScenarioId()  : $this
Generated from protobuf field <code>string scenario_id = 9;</code>
setStartedAt()  : $this
Generated from protobuf field <code>.google.protobuf.Timestamp started_at = 10;</code>
setStatus()  : $this
Generated from protobuf field <code>.livekit.SimulationRun.Job.Status status = 2;</code>
setTags()  : $this
Generated from protobuf field <code>repeated string tags = 7;</code>

Properties

$agent_expectations

Generated from protobuf field <code>string agent_expectations = 5;</code>

protected mixed $agent_expectations = ''

$ended_at

Generated from protobuf field <code>.google.protobuf.Timestamp ended_at = 11;</code>

protected mixed $ended_at = null

$error

Generated from protobuf field <code>string error = 4;</code>

protected mixed $error = ''

$id

Generated from protobuf field <code>string id = 1;</code>

protected mixed $id = ''

$instructions

Generated from protobuf field <code>string instructions = 3;</code>

protected mixed $instructions = ''

$label

Generated from protobuf field <code>string label = 6;</code>

protected mixed $label = ''

$room_name

Generated from protobuf field <code>string room_name = 8;</code>

protected mixed $room_name = ''

$scenario_id

Generated from protobuf field <code>string scenario_id = 9;</code>

protected mixed $scenario_id = ''

$started_at

Generated from protobuf field <code>.google.protobuf.Timestamp started_at = 10;</code>

protected mixed $started_at = null

$status

Generated from protobuf field <code>.livekit.SimulationRun.Job.Status status = 2;</code>

protected mixed $status = 0

$tags

Generated from protobuf field <code>repeated string tags = 7;</code>

private mixed $tags

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

{ Optional. Data for populating the Message object.

@type string $id
@type int $status
@type string $instructions
@type string $error
@type string $agent_expectations
@type string $label
@type string[] $tags
@type string $room_name
@type string $scenario_id
@type \Google\Protobuf\Timestamp $started_at
@type \Google\Protobuf\Timestamp $ended_at

}

clearEndedAt()

public clearEndedAt() : mixed

clearStartedAt()

public clearStartedAt() : mixed

getAgentExpectations()

Generated from protobuf field <code>string agent_expectations = 5;</code>

public getAgentExpectations() : string
Return values
string

getEndedAt()

Generated from protobuf field <code>.google.protobuf.Timestamp ended_at = 11;</code>

public getEndedAt() : Timestamp|null
Return values
Timestamp|null

getError()

Generated from protobuf field <code>string error = 4;</code>

public getError() : string
Return values
string

getId()

Generated from protobuf field <code>string id = 1;</code>

public getId() : string
Return values
string

getInstructions()

Generated from protobuf field <code>string instructions = 3;</code>

public getInstructions() : string
Return values
string

getLabel()

Generated from protobuf field <code>string label = 6;</code>

public getLabel() : string
Return values
string

getRoomName()

Generated from protobuf field <code>string room_name = 8;</code>

public getRoomName() : string
Return values
string

getScenarioId()

Generated from protobuf field <code>string scenario_id = 9;</code>

public getScenarioId() : string
Return values
string

getStartedAt()

Generated from protobuf field <code>.google.protobuf.Timestamp started_at = 10;</code>

public getStartedAt() : Timestamp|null
Return values
Timestamp|null

getStatus()

Generated from protobuf field <code>.livekit.SimulationRun.Job.Status status = 2;</code>

public getStatus() : int
Return values
int

getTags()

Generated from protobuf field <code>repeated string tags = 7;</code>

public getTags() : RepeatedField<string|int, string>
Return values
RepeatedField<string|int, string>

hasEndedAt()

public hasEndedAt() : mixed

hasStartedAt()

public hasStartedAt() : mixed

setAgentExpectations()

Generated from protobuf field <code>string agent_expectations = 5;</code>

public setAgentExpectations(string $var) : $this
Parameters
$var : string
Return values
$this

setEndedAt()

Generated from protobuf field <code>.google.protobuf.Timestamp ended_at = 11;</code>

public setEndedAt(Timestamp $var) : $this
Parameters
$var : Timestamp
Return values
$this

setError()

Generated from protobuf field <code>string error = 4;</code>

public setError(string $var) : $this
Parameters
$var : string
Return values
$this

setId()

Generated from protobuf field <code>string id = 1;</code>

public setId(string $var) : $this
Parameters
$var : string
Return values
$this

setInstructions()

Generated from protobuf field <code>string instructions = 3;</code>

public setInstructions(string $var) : $this
Parameters
$var : string
Return values
$this

setLabel()

Generated from protobuf field <code>string label = 6;</code>

public setLabel(string $var) : $this
Parameters
$var : string
Return values
$this

setRoomName()

Generated from protobuf field <code>string room_name = 8;</code>

public setRoomName(string $var) : $this
Parameters
$var : string
Return values
$this

setScenarioId()

Generated from protobuf field <code>string scenario_id = 9;</code>

public setScenarioId(string $var) : $this
Parameters
$var : string
Return values
$this

setStartedAt()

Generated from protobuf field <code>.google.protobuf.Timestamp started_at = 10;</code>

public setStartedAt(Timestamp $var) : $this
Parameters
$var : Timestamp
Return values
$this

setStatus()

Generated from protobuf field <code>.livekit.SimulationRun.Job.Status status = 2;</code>

public setStatus(int $var) : $this
Parameters
$var : int
Return values
$this

setTags()

Generated from protobuf field <code>repeated string tags = 7;</code>

public setTags(array<string|int, string> $var) : $this
Parameters
$var : array<string|int, string>
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results