io.kurrent.rpc

Class ErrorMetadata.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<ErrorMetadata.Builder>

io.kurrent.rpc.ErrorMetadata.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ErrorMetadataOrBuilder, java.lang.Cloneable

Enclosing class:

ErrorMetadata

public static final class ErrorMetadata.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ErrorMetadata.Builder>
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

Method Summary

Modifier and Type	Method and Description
ErrorMetadata	build()
ErrorMetadata	buildPartial()
ErrorMetadata.Builder	clear()
ErrorMetadata.Builder	clearHasDetails() Indicates whether this error supports rich, typed detail messages.
ErrorMetadata.Builder	clearStatusCode() Maps the error to a standard gRPC status code for transport-level compatibility.
ErrorMetadata	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getHasDetails() Indicates whether this error supports rich, typed detail messages.
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.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ErrorMetadata.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ErrorMetadata.Builder	mergeFrom(ErrorMetadata other)
ErrorMetadata.Builder	mergeFrom(com.google.protobuf.Message other)
ErrorMetadata.Builder	setHasDetails(boolean value) Indicates whether this error supports rich, typed detail messages.
ErrorMetadata.Builder	setStatusCode(Code value) Maps the error to a standard gRPC status code for transport-level compatibility.
ErrorMetadata.Builder	setStatusCodeValue(int value) Maps the error to a standard gRPC status code for transport-level compatibility.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

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.Builder<ErrorMetadata.Builder>

clear

public ErrorMetadata.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<ErrorMetadata.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ErrorMetadata.Builder>

getDefaultInstanceForType

public ErrorMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ErrorMetadata build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ErrorMetadata buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public ErrorMetadata.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ErrorMetadata.Builder>

mergeFrom

public ErrorMetadata.Builder mergeFrom(ErrorMetadata other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ErrorMetadata.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ErrorMetadata.Builder>

Throws:

java.io.IOException

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.

setStatusCodeValue

public ErrorMetadata.Builder setStatusCodeValue(int value)

 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;

Parameters:

value - The enum numeric value on the wire for statusCode to set.

Returns:

This builder for chaining.

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.

setStatusCode

public ErrorMetadata.Builder setStatusCode(Code value)

 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;

Parameters:

value - The statusCode to set.

Returns:

This builder for chaining.

clearStatusCode

public ErrorMetadata.Builder clearStatusCode()

 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;

Returns:

This builder for chaining.

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.

setHasDetails

public ErrorMetadata.Builder setHasDetails(boolean value)

 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;

Parameters:

value - The hasDetails to set.

Returns:

This builder for chaining.

clearHasDetails

public ErrorMetadata.Builder clearHasDetails()

 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;

Returns:

This builder for chaining.