public sealed class DataStream.Types.Header : IMessage<DataStream.Types.Header>, IEquatable<DataStream.Types.Header>, IDeepCloneable<DataStream.Types.Header>, IBufferMessage, IMessage

Constructors

Header()

Declaration

public Header()

Header(Header)

Declaration

public Header(DataStream.Types.Header other)

Parameters

Type	Name	Description
DataStream.Types.Header	other

Fields

AttributesFieldNumber

Field number for the "attributes" field.

Declaration

public const int AttributesFieldNumber = 8

Field Value

Type	Description
int

ByteHeaderFieldNumber

Field number for the "byte_header" field.

Declaration

public const int ByteHeaderFieldNumber = 10

Field Value

Type	Description
int

CompressionFieldNumber

Field number for the "compression" field.

Declaration

public const int CompressionFieldNumber = 12

Field Value

Type	Description
int

EncryptionTypeFieldNumber

Field number for the "encryption_type" field.

Declaration

public const int EncryptionTypeFieldNumber = 7

Field Value

Type	Description
int

InlineContentFieldNumber

Field number for the "inline_content" field.

Declaration

public const int InlineContentFieldNumber = 11

Field Value

Type	Description
int

MimeTypeFieldNumber

Field number for the "mime_type" field.

Declaration

public const int MimeTypeFieldNumber = 4

Field Value

Type	Description
int

StreamIdFieldNumber

Field number for the "stream_id" field.

Declaration

public const int StreamIdFieldNumber = 1

Field Value

Type	Description
int

TextHeaderFieldNumber

Field number for the "text_header" field.

Declaration

public const int TextHeaderFieldNumber = 9

Field Value

Type	Description
int

TimestampFieldNumber

Field number for the "timestamp" field.

Declaration

public const int TimestampFieldNumber = 2

Field Value

Type	Description
int

TopicFieldNumber

Field number for the "topic" field.

Declaration

public const int TopicFieldNumber = 3

Field Value

Type	Description
int

TotalLengthFieldNumber

Field number for the "total_length" field.

Declaration

public const int TotalLengthFieldNumber = 5

Field Value

Type	Description
int

Properties

Attributes

user defined attributes map that can carry additional info

Declaration

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

Property Value

Type	Description
MapField<string, string>

ByteHeader

Declaration

public DataStream.Types.ByteHeader ByteHeader { get; set; }

Property Value

Type	Description
DataStream.Types.ByteHeader

Compression

Declaration

public DataStream.Types.CompressionType Compression { get; set; }

Property Value

Type	Description
DataStream.Types.CompressionType

ContentHeaderCase

Declaration

public DataStream.Types.Header.ContentHeaderOneofCase ContentHeaderCase { get; }

Property Value

Type	Description
DataStream.Types.Header.ContentHeaderOneofCase

Descriptor

Declaration

public static MessageDescriptor Descriptor { get; }

Property Value

Type	Description
MessageDescriptor

EncryptionType

this is set on the DataPacket

Declaration

[Obsolete]
public Encryption.Types.Type EncryptionType { get; set; }

Property Value

Type	Description
Encryption.Types.Type

HasInlineContent

Gets whether the "inline_content" field is set

Declaration

public bool HasInlineContent { get; }

Property Value

Type	Description
bool

HasTotalLength

Gets whether the "total_length" field is set

Declaration

public bool HasTotalLength { get; }

Property Value

Type	Description
bool

InlineContent

Optional inline content so that a data stream can be sent as a single packet for short payloads.

Declaration

public ByteString InlineContent { get; set; }

Property Value

Type	Description
ByteString

MimeType

Declaration

public string MimeType { get; set; }

Property Value

Type	Description
string

Parser

Declaration

public static MessageParser<DataStream.Types.Header> Parser { get; }

Property Value

Type	Description
MessageParser<DataStream.Types.Header>

StreamId

unique identifier for this data stream

Declaration

public string StreamId { get; set; }

Property Value

Type	Description
string

TextHeader

Declaration

public DataStream.Types.TextHeader TextHeader { get; set; }

Property Value

Type	Description
DataStream.Types.TextHeader

Timestamp

using int64 for Unix timestamp

Declaration

public long Timestamp { get; set; }

Property Value

Type	Description
long

Topic

Declaration

public string Topic { get; set; }

Property Value

Type	Description
string

TotalLength

only populated for finite streams, if it's a stream of unknown size this stays empty

Declaration

public ulong TotalLength { get; set; }

Property Value

Type	Description
ulong

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Declaration

public int CalculateSize()

Returns

Type	Description
int	The number of bytes required to write this message to a coded output stream.

ClearContentHeader()

Declaration

public void ClearContentHeader()

ClearInlineContent()

Clears the value of the "inline_content" field

Declaration

public void ClearInlineContent()

ClearTotalLength()

Clears the value of the "total_length" field

Declaration

public void ClearTotalLength()

Clone()

Creates a deep clone of this object.

Declaration

public DataStream.Types.Header Clone()

Returns

Type	Description
DataStream.Types.Header	A deep clone of this object.

Equals(Header)

Indicates whether the current object is equal to another object of the same type.

Declaration

public bool Equals(DataStream.Types.Header other)

Parameters

Type	Name	Description
DataStream.Types.Header	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the `other` parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
object	other

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

object.Equals(object)

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

object.GetHashCode()

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

Declaration

public void MergeFrom(CodedInputStream input)

Parameters

Type	Name	Description
CodedInputStream	input

Remarks

See the user guide for precise merge semantics.

MergeFrom(Header)

Merges the given message into this one.

Declaration

public void MergeFrom(DataStream.Types.Header other)

Parameters

Type	Name	Description
DataStream.Types.Header	other

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

object.ToString()

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

Declaration

public void WriteTo(CodedOutputStream output)

Parameters

Type	Name	Description
CodedOutputStream	output	Coded output stream to write the data to. Must not be null.

Implements

Google.Protobuf.IMessage<T>

IEquatable<T>

Google.Protobuf.IDeepCloneable<T>

Google.Protobuf.IBufferMessage

Google.Protobuf.IMessage