Documentation

S3Upload extends Message

in package

• Application

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

Table of Contents

Properties

$access_key  : mixed

Generated from protobuf field <code>string access_key = 1 [(.logger.redact) = true];</code>

$assume_role_arn  : mixed

ARN of the role to assume for file upload. Egress will make an AssumeRole API call using the provided access_key and secret to assume that role. On LiveKit cloud, this is only available on accounts that have the feature enabled

$assume_role_external_id  : mixed

ExternalID to use when assuming role for upload

$bucket  : mixed

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

$content_disposition  : mixed

Content-Disposition header

$endpoint  : mixed

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

$force_path_style  : mixed

Generated from protobuf field <code>bool force_path_style = 6;</code>

$proxy  : mixed

Generated from protobuf field <code>.livekit.ProxyConfig proxy = 10;</code>

$region  : mixed

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

$secret  : mixed

Generated from protobuf field <code>string secret = 2 [(.logger.redact) = true];</code>

$session_token  : mixed

Generated from protobuf field <code>string session_token = 11 [(.logger.redact) = true];</code>

$tagging  : mixed

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

$metadata  : mixed

Generated from protobuf field <code>map<string, string> metadata = 7;</code>

Methods

__construct()  : mixed

Constructor.

clearProxy()  : mixed

getAccessKey()  : string

Generated from protobuf field <code>string access_key = 1 [(.logger.redact) = true];</code>

getAssumeRoleArn()  : string

ARN of the role to assume for file upload. Egress will make an AssumeRole API call using the provided access_key and secret to assume that role. On LiveKit cloud, this is only available on accounts that have the feature enabled

getAssumeRoleExternalId()  : string

ExternalID to use when assuming role for upload

getBucket()  : string

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

getContentDisposition()  : string

Content-Disposition header

getEndpoint()  : string

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

getForcePathStyle()  : bool

Generated from protobuf field <code>bool force_path_style = 6;</code>

getMetadata()  : MapField

Generated from protobuf field <code>map<string, string> metadata = 7;</code>

getProxy()  : ProxyConfig|null

Generated from protobuf field <code>.livekit.ProxyConfig proxy = 10;</code>

getRegion()  : string

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

getSecret()  : string

Generated from protobuf field <code>string secret = 2 [(.logger.redact) = true];</code>

getSessionToken()  : string

Generated from protobuf field <code>string session_token = 11 [(.logger.redact) = true];</code>

getTagging()  : string

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

hasProxy()  : mixed

setAccessKey()  : $this

Generated from protobuf field <code>string access_key = 1 [(.logger.redact) = true];</code>

setAssumeRoleArn()  : $this

ARN of the role to assume for file upload. Egress will make an AssumeRole API call using the provided access_key and secret to assume that role. On LiveKit cloud, this is only available on accounts that have the feature enabled

setAssumeRoleExternalId()  : $this

ExternalID to use when assuming role for upload

setBucket()  : $this

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

setContentDisposition()  : $this

Content-Disposition header

setEndpoint()  : $this

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

setForcePathStyle()  : $this

Generated from protobuf field <code>bool force_path_style = 6;</code>

setMetadata()  : $this

Generated from protobuf field <code>map<string, string> metadata = 7;</code>

setProxy()  : $this

Generated from protobuf field <code>.livekit.ProxyConfig proxy = 10;</code>

setRegion()  : $this

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

setSecret()  : $this

Generated from protobuf field <code>string secret = 2 [(.logger.redact) = true];</code>

setSessionToken()  : $this

Generated from protobuf field <code>string session_token = 11 [(.logger.redact) = true];</code>

setTagging()  : $this

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