Class EndpointObservation

Namespace

Openshell.V1

Assembly

OpenShell.Sdk.dll

One redacted endpoint result in a supervisor's complete status report.

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

Inheritance

object

EndpointObservation

Implements

IMessage<EndpointObservation>

IEquatable<EndpointObservation>

IDeepCloneable<EndpointObservation>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

EndpointObservation()

public EndpointObservation()

EndpointObservation(EndpointObservation)

public EndpointObservation(EndpointObservation other)

Parameters

other EndpointObservation

Fields

EndpointIdFieldNumber

Field number for the "endpoint_id" field.

public const int EndpointIdFieldNumber = 1

Field Value

int

FailureFieldNumber

Field number for the "failure" field.

public const int FailureFieldNumber = 3

Field Value

int

ResultFieldNumber

Field number for the "result" field.

public const int ResultFieldNumber = 2

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

EndpointId

Stable identifier derived from the configured host, ports, and path.

public string EndpointId { get; set; }

Property Value

string

Failure

Bounded cause of result, when the supervisor classified it. Each failure domain names the results it can explain.

public EndpointFailure Failure { get; set; }

Property Value

EndpointFailure

Parser

public static MessageParser<EndpointObservation> Parser { get; }

Property Value

MessageParser<EndpointObservation>

Result

Latest result under the reported configuration and supervisor session.

public EndpointResult Result { get; set; }

Property Value

EndpointResult

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

Returns

EndpointObservation

A deep clone of this object.

Equals(EndpointObservation)

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

public bool Equals(EndpointObservation other)

Parameters

other EndpointObservation

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

Merges the given message into this one.

public void MergeFrom(EndpointObservation other)

Parameters

other EndpointObservation

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.