com.heroiclabs.nakama.rtapi

Class Error.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

com.heroiclabs.nakama.rtapi.Error.Builder

All Implemented Interfaces:

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

Enclosing class:

Error

public static final class Error.Builder
extends com.google.protobuf.GeneratedMessage.Builder<Error.Builder>
implements ErrorOrBuilder

 A logical error which may occur on the server.
 

Protobuf type nakama.realtime.Error

Method Summary

Modifier and Type	Method and Description
Error	build()
Error	buildPartial()
Error.Builder	clear()
Error.Builder	clearCode() The error code which should be one of "Error.Code" enums.
Error.Builder	clearContext()
Error.Builder	clearMessage() A message in English to help developers debug the response.
boolean	containsContext(java.lang.String key) Additional error details which may be different for each response.
int	getCode() The error code which should be one of "Error.Code" enums.
java.util.Map<java.lang.String,java.lang.String>	getContext() Deprecated.
int	getContextCount() Additional error details which may be different for each response.
java.util.Map<java.lang.String,java.lang.String>	getContextMap() Additional error details which may be different for each response.
java.lang.String	getContextOrDefault(java.lang.String key, java.lang.String defaultValue) Additional error details which may be different for each response.
java.lang.String	getContextOrThrow(java.lang.String key) Additional error details which may be different for each response.
Error	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
java.lang.String	getMessage() A message in English to help developers debug the response.
com.google.protobuf.ByteString	getMessageBytes() A message in English to help developers debug the response.
java.util.Map<java.lang.String,java.lang.String>	getMutableContext() Deprecated.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMutableMapFieldReflection(int number)
boolean	isInitialized()
Error.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Error.Builder	mergeFrom(Error other)
Error.Builder	mergeFrom(com.google.protobuf.Message other)
Error.Builder	putAllContext(java.util.Map<java.lang.String,java.lang.String> values) Additional error details which may be different for each response.
Error.Builder	putContext(java.lang.String key, java.lang.String value) Additional error details which may be different for each response.
Error.Builder	removeContext(java.lang.String key) Additional error details which may be different for each response.
Error.Builder	setCode(int value) The error code which should be one of "Error.Code" enums.
Error.Builder	setMessage(java.lang.String value) A message in English to help developers debug the response.
Error.Builder	setMessageBytes(com.google.protobuf.ByteString value) A message in English to help developers debug the response.

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, internalGetMutableMapField, 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()

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Error.Builder>

internalGetMutableMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Overrides:

internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Error.Builder>

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Error.Builder>

clear

public Error.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<Error.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<Error.Builder>

getDefaultInstanceForType

public Error getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Error build()

Specified by:

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

Specified by:

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

buildPartial

public Error buildPartial()

Specified by:

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

Specified by:

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

mergeFrom

public Error.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<Error.Builder>

mergeFrom

public Error.Builder mergeFrom(Error other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

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

mergeFrom

public Error.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<Error.Builder>

Throws:

java.io.IOException

getCode

public int getCode()

 The error code which should be one of "Error.Code" enums.
 

int32 code = 1 [json_name = "code"];

Specified by:

getCode in interface ErrorOrBuilder

Returns:

The code.

setCode

public Error.Builder setCode(int value)

 The error code which should be one of "Error.Code" enums.
 

int32 code = 1 [json_name = "code"];

Parameters:

value - The code to set.

Returns:

This builder for chaining.

clearCode

public Error.Builder clearCode()

 The error code which should be one of "Error.Code" enums.
 

int32 code = 1 [json_name = "code"];

Returns:

This builder for chaining.

getMessage

public java.lang.String getMessage()

 A message in English to help developers debug the response.
 

string message = 2 [json_name = "message"];

Specified by:

getMessage in interface ErrorOrBuilder

Returns:

The message.

getMessageBytes

public com.google.protobuf.ByteString getMessageBytes()

 A message in English to help developers debug the response.
 

string message = 2 [json_name = "message"];

Specified by:

getMessageBytes in interface ErrorOrBuilder

Returns:

The bytes for message.

setMessage

public Error.Builder setMessage(java.lang.String value)

 A message in English to help developers debug the response.
 

string message = 2 [json_name = "message"];

Parameters:

value - The message to set.

Returns:

This builder for chaining.

clearMessage

public Error.Builder clearMessage()

 A message in English to help developers debug the response.
 

string message = 2 [json_name = "message"];

Returns:

This builder for chaining.

setMessageBytes

public Error.Builder setMessageBytes(com.google.protobuf.ByteString value)

 A message in English to help developers debug the response.
 

string message = 2 [json_name = "message"];

Parameters:

value - The bytes for message to set.

Returns:

This builder for chaining.

getContextCount

public int getContextCount()

Description copied from interface: ErrorOrBuilder

 Additional error details which may be different for each response.
 

map<string, string> context = 3 [json_name = "context"];

Specified by:

getContextCount in interface ErrorOrBuilder

containsContext

public boolean containsContext(java.lang.String key)

 Additional error details which may be different for each response.
 

map<string, string> context = 3 [json_name = "context"];

Specified by:

containsContext in interface ErrorOrBuilder

getContext

@Deprecated
public java.util.Map<java.lang.String,java.lang.String> getContext()

Deprecated.

Use getContextMap() instead.

Specified by:

getContext in interface ErrorOrBuilder

getContextMap

public java.util.Map<java.lang.String,java.lang.String> getContextMap()

 Additional error details which may be different for each response.
 

map<string, string> context = 3 [json_name = "context"];

Specified by:

getContextMap in interface ErrorOrBuilder

getContextOrDefault

public java.lang.String getContextOrDefault(java.lang.String key,
                                            java.lang.String defaultValue)

 Additional error details which may be different for each response.
 

map<string, string> context = 3 [json_name = "context"];

Specified by:

getContextOrDefault in interface ErrorOrBuilder

getContextOrThrow

public java.lang.String getContextOrThrow(java.lang.String key)

 Additional error details which may be different for each response.
 

map<string, string> context = 3 [json_name = "context"];

Specified by:

getContextOrThrow in interface ErrorOrBuilder

clearContext

public Error.Builder clearContext()

removeContext

public Error.Builder removeContext(java.lang.String key)

 Additional error details which may be different for each response.
 

map<string, string> context = 3 [json_name = "context"];

getMutableContext

@Deprecated
public java.util.Map<java.lang.String,java.lang.String> getMutableContext()

Deprecated.

Use alternate mutation accessors instead.

putContext

public Error.Builder putContext(java.lang.String key,
                                java.lang.String value)

 Additional error details which may be different for each response.
 

map<string, string> context = 3 [json_name = "context"];

putAllContext

public Error.Builder putAllContext(java.util.Map<java.lang.String,java.lang.String> values)

 Additional error details which may be different for each response.
 

map<string, string> context = 3 [json_name = "context"];