Class EndpointStatus
- Namespace
- Openshell.V1
- Assembly
- OpenShell.Sdk.dll
A configured endpoint and its last accepted network result in one record. Address fields contain policy selectors, never request URLs or credentials.
public sealed class EndpointStatus : IMessage<EndpointStatus>, IEquatable<EndpointStatus>, IDeepCloneable<EndpointStatus>, IBufferMessage, IMessage
- Inheritance
-
EndpointStatus
- Implements
-
IMessage<EndpointStatus>IDeepCloneable<EndpointStatus>IBufferMessageIMessage
- Inherited Members
Constructors
EndpointStatus()
public EndpointStatus()
EndpointStatus(EndpointStatus)
public EndpointStatus(EndpointStatus other)
Parameters
otherEndpointStatus
Fields
EndpointIdFieldNumber
Field number for the "endpoint_id" field.
public const int EndpointIdFieldNumber = 1
Field Value
HostFieldNumber
Field number for the "host" field.
public const int HostFieldNumber = 2
Field Value
LastFailureFieldNumber
Field number for the "last_failure" field.
public const int LastFailureFieldNumber = 7
Field Value
LastReportedTimeFieldNumber
Field number for the "last_reported_time" field.
public const int LastReportedTimeFieldNumber = 106
Field Value
LastResultFieldNumber
Field number for the "last_result" field.
public const int LastResultFieldNumber = 5
Field Value
PathFieldNumber
Field number for the "path" field.
public const int PathFieldNumber = 4
Field Value
PortsFieldNumber
Field number for the "ports" field.
public const int PortsFieldNumber = 3
Field Value
Properties
Descriptor
public static MessageDescriptor Descriptor { get; }
Property Value
- MessageDescriptor
EndpointId
Stable identifier for selecting this endpoint without parsing display text.
public string EndpointId { get; set; }
Property Value
Host
Lowercase configured endpoint host.
public string Host { get; set; }
Property Value
LastFailure
Bounded cause of last_result, when the supervisor classified it. Each failure domain names the results it can explain. Replaced or cleared by every later observation, and cleared by the same resets that clear last_result.
public EndpointFailure LastFailure { get; set; }
Property Value
LastReportedTime
Time when the gateway accepted the observation. This is not the request time: still-valid evidence can be reaccepted after a reset. Identical same-sequence retries do not advance it. Absent until a result is reported.
public Timestamp LastReportedTime { get; set; }
Property Value
- Timestamp
LastResult
Last accepted result, aggregated across configured callers and ports. NoObservedExchange retains the address and has no report timestamp.
public EndpointResult LastResult { get; set; }
Property Value
Parser
public static MessageParser<EndpointStatus> Parser { get; }
Property Value
- MessageParser<EndpointStatus>
Path
Canonical configured path selector; an unrestricted path is /**.
public string Path { get; set; }
Property Value
Ports
Sorted, deduplicated effective endpoint ports. Validated endpoints have at least one port.
public RepeatedField<uint> Ports { get; }
Property Value
- RepeatedField<uint>
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 EndpointStatus Clone()
Returns
- EndpointStatus
A deep clone of this object.
Equals(EndpointStatus)
Indicates whether the current object is equal to another object of the same type.
public bool Equals(EndpointStatus other)
Parameters
otherEndpointStatusAn object to compare with this object.
Returns
Equals(object)
Determines whether the specified object is equal to the current object.
public override bool Equals(object other)
Parameters
otherobject
Returns
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
inputCodedInputStream
Remarks
See the user guide for precise merge semantics.
MergeFrom(EndpointStatus)
Merges the given message into this one.
public void MergeFrom(EndpointStatus other)
Parameters
otherEndpointStatus
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
outputCodedOutputStreamCoded output stream to write the data to. Must not be null.