Documentation

UpdateJobStatus extends Message
in package

Generated from protobuf message <code>livekit.UpdateJobStatus</code>

Table of Contents

Properties

$error  : mixed
metadata shown on the dashboard, useful for debugging
$job_id  : mixed
Generated from protobuf field <code>string job_id = 1;</code>
$status  : mixed
The worker can indicate the job end by either specifying SUCCESS or FAILED

Methods

__construct()  : mixed
Constructor.
getError()  : string
metadata shown on the dashboard, useful for debugging
getJobId()  : string
Generated from protobuf field <code>string job_id = 1;</code>
getStatus()  : int
The worker can indicate the job end by either specifying SUCCESS or FAILED
setError()  : $this
metadata shown on the dashboard, useful for debugging
setJobId()  : $this
Generated from protobuf field <code>string job_id = 1;</code>
setStatus()  : $this
The worker can indicate the job end by either specifying SUCCESS or FAILED

Properties

$error

metadata shown on the dashboard, useful for debugging

protected mixed $error = ''

Generated from protobuf field string error = 3;

$job_id

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

protected mixed $job_id = ''

$status

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

protected mixed $status = 0

Generated from protobuf field .livekit.JobStatus status = 2;

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 $job_id
@type int $status
      The worker can indicate the job end by either specifying SUCCESS or FAILED
@type string $error
      metadata shown on the dashboard, useful for debugging

}

getError()

metadata shown on the dashboard, useful for debugging

public getError() : string

Generated from protobuf field string error = 3;

Return values
string

getJobId()

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

public getJobId() : string
Return values
string

getStatus()

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

public getStatus() : int

Generated from protobuf field .livekit.JobStatus status = 2;

Return values
int

setError()

metadata shown on the dashboard, useful for debugging

public setError(string $var) : $this

Generated from protobuf field string error = 3;

Parameters
$var : string
Return values
$this

setJobId()

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

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

setStatus()

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

public setStatus(int $var) : $this

Generated from protobuf field .livekit.JobStatus status = 2;

Parameters
$var : int
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results