io.kurrent.rpc

Class ErrorMetadata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

io.kurrent.rpc.ErrorMetadata

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ErrorMetadataOrBuilder, java.io.Serializable

public final class ErrorMetadata
extends com.google.protobuf.GeneratedMessage
implements ErrorMetadataOrBuilder

 ErrorMetadata provides actionable information for error enum values to enable automated
 code generation, documentation, and consistent error handling across the Kurrent platform.

 It was modeled to support a single details type per error code to simplify code generation and
 validation. If multiple detail types are needed for a single error code, consider defining
 separate error codes for each detail type. Or, use a union type (oneof) in the detail message
 to encapsulate multiple detail variants within a single detail message.

 More however DebugInfo and RetryInfo can and should be added to any error regardless of
 this setting, when applicable.

 This annotation is applied to enum values using the google.protobuf.EnumValueOptions
 extension mechanism. It enables:
 - Automatic gRPC status code mapping
 - Code generation for error handling utilities
 - Documentation generation
 - Type-safe error detail validation

 Usage Example:
 enum StreamErrorCode {
 REVISION_CONFLICT = 5 [(kurrent.rpc.error) = {
 status_code: FAILED_PRECONDITION,
 has_details: true
 }];
 }

 See individual field documentation for conventions and defaults.
 

Protobuf type kurrent.rpc.ErrorMetadata

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ErrorMetadata.Builder ErrorMetadata provides actionable information for error enum values to enable automated code generation, documentation, and consistent error handling across the Kurrent platform.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	HAS_DETAILS_FIELD_NUMBER
static int	STATUS_CODE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static ErrorMetadata	getDefaultInstance()
ErrorMetadata	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getHasDetails() Indicates whether this error supports rich, typed detail messages.
com.google.protobuf.Parser<ErrorMetadata>	getParserForType()
int	getSerializedSize()
Code	getStatusCode() Maps the error to a standard gRPC status code for transport-level compatibility.
int	getStatusCodeValue() Maps the error to a standard gRPC status code for transport-level compatibility.
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ErrorMetadata.Builder	newBuilder()
static ErrorMetadata.Builder	newBuilder(ErrorMetadata prototype)
ErrorMetadata.Builder	newBuilderForType()
protected ErrorMetadata.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static ErrorMetadata	parseDelimitedFrom(java.io.InputStream input)
static ErrorMetadata	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ErrorMetadata	parseFrom(byte[] data)
static ErrorMetadata	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ErrorMetadata	parseFrom(java.nio.ByteBuffer data)
static ErrorMetadata	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ErrorMetadata	parseFrom(com.google.protobuf.ByteString data)
static ErrorMetadata	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ErrorMetadata	parseFrom(com.google.protobuf.CodedInputStream input)
static ErrorMetadata	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ErrorMetadata	parseFrom(java.io.InputStream input)
static ErrorMetadata	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ErrorMetadata>	parser()
ErrorMetadata.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

STATUS_CODE_FIELD_NUMBER

public static final int STATUS_CODE_FIELD_NUMBER

See Also:

Constant Field Values

HAS_DETAILS_FIELD_NUMBER

public static final int HAS_DETAILS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getStatusCodeValue

public int getStatusCodeValue()

 Maps the error to a standard gRPC status code for transport-level compatibility.
 This field is REQUIRED for every error annotation.

 Use standard gRPC status codes from `google.rpc.code`.

 Code generators use this to:
 - Map errors to gRPC status codes automatically
 - Generate HTTP status code mappings
 - Create transport-agnostic error handling
 

.google.rpc.Code status_code = 1;

Specified by:

getStatusCodeValue in interface ErrorMetadataOrBuilder

Returns:

The enum numeric value on the wire for statusCode.

getStatusCode

public Code getStatusCode()

 Maps the error to a standard gRPC status code for transport-level compatibility.
 This field is REQUIRED for every error annotation.

 Use standard gRPC status codes from `google.rpc.code`.

 Code generators use this to:
 - Map errors to gRPC status codes automatically
 - Generate HTTP status code mappings
 - Create transport-agnostic error handling
 

.google.rpc.Code status_code = 1;

Specified by:

getStatusCode in interface ErrorMetadataOrBuilder

Returns:

The statusCode.

getHasDetails

public boolean getHasDetails()

 Indicates whether this error supports rich, typed detail messages.
 Defaults to false (simple message string only).
 The message type name must be derived from the enum name by convention.
 Mask: {EnumValue}ErrorDetails, {EnumValue}Error, {EnumValue}

 Examples:
 ACCESS_DENIED    -> "AccessDeniedErrorDetails", "AccessDeniedError" or "AccessDenied"
 SERVER_NOT_READY -> "ServerNotReadyErrorDetails", "ServerNotReadyError" or "ServerNotReady"

 Code generators use the message type name to:
 - Validate that the detail message matches the expected type
 - Generate type-safe error handling code
 - Create accurate documentation
 

bool has_details = 2;

Specified by:

getHasDetails in interface ErrorMetadataOrBuilder

Returns:

The hasDetails.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ErrorMetadata parseFrom(java.nio.ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ErrorMetadata parseFrom(java.nio.ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ErrorMetadata parseFrom(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ErrorMetadata parseFrom(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ErrorMetadata parseFrom(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ErrorMetadata parseFrom(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ErrorMetadata parseFrom(java.io.InputStream input)
                               throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static ErrorMetadata parseFrom(java.io.InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static ErrorMetadata parseDelimitedFrom(java.io.InputStream input)
                                        throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static ErrorMetadata parseDelimitedFrom(java.io.InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static ErrorMetadata parseFrom(com.google.protobuf.CodedInputStream input)
                               throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static ErrorMetadata parseFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public ErrorMetadata.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ErrorMetadata.Builder newBuilder()

newBuilder

public static ErrorMetadata.Builder newBuilder(ErrorMetadata prototype)

toBuilder

public ErrorMetadata.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ErrorMetadata.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static ErrorMetadata getDefaultInstance()

parser

public static com.google.protobuf.Parser<ErrorMetadata> parser()

getParserForType

public com.google.protobuf.Parser<ErrorMetadata> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public ErrorMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder