Class PlatformEvent

Namespace

Openshell.V1

Assembly

OpenShell.Sdk.dll

Public platform event exposed on the sandbox watch stream.

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

Inheritance

object

PlatformEvent

Implements

IMessage<PlatformEvent>

IEquatable<PlatformEvent>

IDeepCloneable<PlatformEvent>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PlatformEvent()

public PlatformEvent()

PlatformEvent(PlatformEvent)

public PlatformEvent(PlatformEvent other)

Parameters

other PlatformEvent

Fields

EventTimeFieldNumber

Field number for the "event_time" field.

public const int EventTimeFieldNumber = 101

Field Value

int

MessageFieldNumber

Field number for the "message" field.

public const int MessageFieldNumber = 5

Field Value

int

MetadataFieldNumber

Field number for the "metadata" field.

public const int MetadataFieldNumber = 6

Field Value

int

ReasonFieldNumber

Field number for the "reason" field.

public const int ReasonFieldNumber = 4

Field Value

int

SourceFieldNumber

Field number for the "source" field.

public const int SourceFieldNumber = 2

Field Value

int

TypeFieldNumber

Field number for the "type" field.

public const int TypeFieldNumber = 3

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

EventTime

Time when the event occurred.

public Timestamp EventTime { get; set; }

Property Value

Timestamp

Message

Human-readable event message.

public string Message { get; set; }

Property Value

string

Metadata

Optional metadata as key-value pairs.

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

Property Value

MapField<string, string>

Parser

public static MessageParser<PlatformEvent> Parser { get; }

Property Value

MessageParser<PlatformEvent>

Reason

Short reason code (e.g. "Started", "Pulled", "Failed").

public string Reason { get; set; }

Property Value

string

Source

Event source (e.g. "kubernetes", "docker", "process").

public string Source { get; set; }

Property Value

string

Type

Event type/severity (e.g. "Normal", "Warning").

public string Type { 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 PlatformEvent Clone()

Returns

PlatformEvent

A deep clone of this object.

Equals(PlatformEvent)

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

public bool Equals(PlatformEvent other)

Parameters

other PlatformEvent

An object to compare with this object.

Returns

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.

public override bool Equals(object other)

Parameters

other object

Returns

bool

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

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

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

Merges the given message into this one.

public void MergeFrom(PlatformEvent other)

Parameters

other PlatformEvent

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

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.