Documentation

RoomAgentDispatch extends Message
in package

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

Table of Contents

Properties

$agent_name  : mixed
Generated from protobuf field <code>string agent_name = 1;</code>
$deployment  : mixed
Generated from protobuf field <code>string deployment = 4;</code>
$metadata  : mixed
Generated from protobuf field <code>string metadata = 2 [(.logger.sensitivity) = SENSITIVITY_PII];</code>
$restart_policy  : mixed
cloud only
$attributes  : mixed
Generated from protobuf field <code>map<string, string> attributes = 5 [(.logger.sensitivity) = SENSITIVITY_PII];</code>

Methods

__construct()  : mixed
Constructor.
getAgentName()  : string
Generated from protobuf field <code>string agent_name = 1;</code>
getAttributes()  : MapField
Generated from protobuf field <code>map<string, string> attributes = 5 [(.logger.sensitivity) = SENSITIVITY_PII];</code>
getDeployment()  : string
Generated from protobuf field <code>string deployment = 4;</code>
getMetadata()  : string
Generated from protobuf field <code>string metadata = 2 [(.logger.sensitivity) = SENSITIVITY_PII];</code>
getRestartPolicy()  : int
cloud only
setAgentName()  : $this
Generated from protobuf field <code>string agent_name = 1;</code>
setAttributes()  : $this
Generated from protobuf field <code>map<string, string> attributes = 5 [(.logger.sensitivity) = SENSITIVITY_PII];</code>
setDeployment()  : $this
Generated from protobuf field <code>string deployment = 4;</code>
setMetadata()  : $this
Generated from protobuf field <code>string metadata = 2 [(.logger.sensitivity) = SENSITIVITY_PII];</code>
setRestartPolicy()  : $this
cloud only

Properties

$agent_name

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

protected mixed $agent_name = ''

$deployment

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

protected mixed $deployment = ''

$metadata

Generated from protobuf field <code>string metadata = 2 [(.logger.sensitivity) = SENSITIVITY_PII];</code>

protected mixed $metadata = ''

$restart_policy

cloud only

protected mixed $restart_policy = 0

Generated from protobuf field .livekit.JobRestartPolicy restart_policy = 3;

$attributes

Generated from protobuf field <code>map<string, string> attributes = 5 [(.logger.sensitivity) = SENSITIVITY_PII];</code>

private mixed $attributes

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 $agent_name
@type string $metadata
@type int $restart_policy
      cloud only
@type string $deployment
@type array|\Google\Protobuf\Internal\MapField $attributes

}

getAgentName()

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

public getAgentName() : string
Return values
string

getAttributes()

Generated from protobuf field <code>map<string, string> attributes = 5 [(.logger.sensitivity) = SENSITIVITY_PII];</code>

public getAttributes() : MapField
Return values
MapField

getDeployment()

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

public getDeployment() : string
Return values
string

getMetadata()

Generated from protobuf field <code>string metadata = 2 [(.logger.sensitivity) = SENSITIVITY_PII];</code>

public getMetadata() : string
Return values
string

getRestartPolicy()

cloud only

public getRestartPolicy() : int

Generated from protobuf field .livekit.JobRestartPolicy restart_policy = 3;

Return values
int

setAgentName()

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

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

setAttributes()

Generated from protobuf field <code>map<string, string> attributes = 5 [(.logger.sensitivity) = SENSITIVITY_PII];</code>

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

setDeployment()

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

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

setMetadata()

Generated from protobuf field <code>string metadata = 2 [(.logger.sensitivity) = SENSITIVITY_PII];</code>

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

setRestartPolicy()

cloud only

public setRestartPolicy(int $var) : $this

Generated from protobuf field .livekit.JobRestartPolicy restart_policy = 3;

Parameters
$var : int
Return values
$this
On this page

Search results