Class S3Upload

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

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

Inheritance

object

S3Upload

Implements

IMessage<S3Upload>

IEquatable<S3Upload>

IDeepCloneable<S3Upload>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

S3Upload()

public S3Upload()

S3Upload(S3Upload)

public S3Upload(S3Upload other)

Parameters

other S3Upload

Fields

AccessKeyFieldNumber

Field number for the "access_key" field.

public const int AccessKeyFieldNumber = 1

Field Value

int

AssumeRoleArnFieldNumber

Field number for the "assume_role_arn" field.

public const int AssumeRoleArnFieldNumber = 12

Field Value

int

AssumeRoleExternalIdFieldNumber

Field number for the "assume_role_external_id" field.

public const int AssumeRoleExternalIdFieldNumber = 13

Field Value

int

BucketFieldNumber

Field number for the "bucket" field.

public const int BucketFieldNumber = 5

Field Value

int

ContentDispositionFieldNumber

Field number for the "content_disposition" field.

public const int ContentDispositionFieldNumber = 9

Field Value

int

EndpointFieldNumber

Field number for the "endpoint" field.

public const int EndpointFieldNumber = 4

Field Value

int

ForcePathStyleFieldNumber

Field number for the "force_path_style" field.

public const int ForcePathStyleFieldNumber = 6

Field Value

int

MetadataFieldNumber

Field number for the "metadata" field.

public const int MetadataFieldNumber = 7

Field Value

int

ProxyFieldNumber

Field number for the "proxy" field.

public const int ProxyFieldNumber = 10

Field Value

int

RegionFieldNumber

Field number for the "region" field.

public const int RegionFieldNumber = 3

Field Value

int

SecretFieldNumber

Field number for the "secret" field.

public const int SecretFieldNumber = 2

Field Value

int

SessionTokenFieldNumber

Field number for the "session_token" field.

public const int SessionTokenFieldNumber = 11

Field Value

int

TaggingFieldNumber

Field number for the "tagging" field.

public const int TaggingFieldNumber = 8

Field Value

int

Properties

AccessKey

public string AccessKey { get; set; }

Property Value

string

AssumeRoleArn

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

public string AssumeRoleArn { get; set; }

Property Value

string

AssumeRoleExternalId

ExternalID to use when assuming role for upload

public string AssumeRoleExternalId { get; set; }

Property Value

string

Bucket

public string Bucket { get; set; }

Property Value

string

ContentDisposition

Content-Disposition header

public string ContentDisposition { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Endpoint

public string Endpoint { get; set; }

Property Value

string

ForcePathStyle

public bool ForcePathStyle { get; set; }

Property Value

bool

Metadata

public MapField<string, string> Metadata { get; }

Property Value

MapField<string, string>

Parser

public static MessageParser<S3Upload> Parser { get; }

Property Value

MessageParser<S3Upload>

Proxy

public ProxyConfig Proxy { get; set; }

Property Value

ProxyConfig

Region

public string Region { get; set; }

Property Value

string

Secret

public string Secret { get; set; }

Property Value

string

SessionToken

public string SessionToken { get; set; }

Property Value

string

Tagging

public string Tagging { get; set; }

Property Value

string

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 S3Upload Clone()

Returns

S3Upload

A deep clone of this object.

Equals(S3Upload)

public bool Equals(S3Upload other)

Parameters

other S3Upload

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

Merges the given message into this one.

public void MergeFrom(S3Upload other)

Parameters

other S3Upload

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.