Class ClassificationError
Error information for failed classification attempts. Provides details about why a classification could not be completed.
public sealed class ClassificationError : IMessage<ClassificationError>, IEquatable<ClassificationError>, IDeepCloneable<ClassificationError>, IBufferMessage, IMessage
- Inheritance
-
ClassificationError
- Implements
-
IMessage<ClassificationError>IDeepCloneable<ClassificationError>IBufferMessageIMessage
- Inherited Members
Constructors
ClassificationError()
public ClassificationError()
ClassificationError(ClassificationError)
public ClassificationError(ClassificationError other)
Parameters
otherClassificationError
Fields
CodeFieldNumber
Field number for the "code" field.
public const int CodeFieldNumber = 1
Field Value
DetailsFieldNumber
Field number for the "details" field.
public const int DetailsFieldNumber = 3
Field Value
MessageFieldNumber
Field number for the "message" field.
public const int MessageFieldNumber = 2
Field Value
Properties
Code
Error code indicating the type of failure
public ErrorCode Code { get; set; }
Property Value
Descriptor
public static MessageDescriptor Descriptor { get; }
Property Value
- MessageDescriptor
Details
Additional context or details about the error (optional)
public string Details { get; set; }
Property Value
Message
Human-readable error message providing details about the failure
public string Message { get; set; }
Property Value
Parser
public static MessageParser<ClassificationError> Parser { get; }
Property Value
- MessageParser<ClassificationError>
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 ClassificationError Clone()
Returns
- ClassificationError
A deep clone of this object.
Equals(ClassificationError)
Indicates whether the current object is equal to another object of the same type.
public bool Equals(ClassificationError other)
Parameters
otherClassificationErrorAn 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(ClassificationError)
Merges the given message into this one.
public void MergeFrom(ClassificationError other)
Parameters
otherClassificationError
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.