Package com.heroiclabs.nakama.api

Class Event.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

com.heroiclabs.nakama.api.Event.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, EventOrBuilder, Cloneable

Enclosing class:

Event

public static final class Event.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>
implements EventOrBuilder

 Represents an event to be passed through the server to registered event handlers.
 

Protobuf type nakama.api.Event

Method Summary

Modifier and Type	Method	Description
Event.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Event	build()
Event	buildPartial()
Event.Builder	clear()
Event.Builder	clearExternal()	True if the event came directly from a client call, false otherwise.
Event.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Event.Builder	clearName()	An event name, type, category, or identifier.
Event.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Event.Builder	clearProperties()
Event.Builder	clearTimestamp()	The time when the event was triggered.
Event.Builder	clone()
boolean	containsProperties(String key)	Arbitrary event property values.
Event	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getExternal()	True if the event came directly from a client call, false otherwise.
Map<String,String>	getMutableProperties()	Deprecated.
String	getName()	An event name, type, category, or identifier.
com.google.protobuf.ByteString	getNameBytes()	An event name, type, category, or identifier.
Map<String,String>	getProperties()	Deprecated.
int	getPropertiesCount()	Arbitrary event property values.
Map<String,String>	getPropertiesMap()	Arbitrary event property values.
String	getPropertiesOrDefault(String key, String defaultValue)	Arbitrary event property values.
String	getPropertiesOrThrow(String key)	Arbitrary event property values.
Timestamp	getTimestamp()	The time when the event was triggered.
Timestamp.Builder	getTimestampBuilder()	The time when the event was triggered.
TimestampOrBuilder	getTimestampOrBuilder()	The time when the event was triggered.
boolean	hasTimestamp()	The time when the event was triggered.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
protected com.google.protobuf.MapField	internalGetMutableMapField(int number)
final boolean	isInitialized()
Event.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Event.Builder	mergeFrom(com.google.protobuf.Message other)
Event.Builder	mergeFrom(Event other)
Event.Builder	mergeTimestamp(Timestamp value)	The time when the event was triggered.
final Event.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Event.Builder	putAllProperties(Map<String,String> values)	Arbitrary event property values.
Event.Builder	putProperties(String key, String value)	Arbitrary event property values.
Event.Builder	removeProperties(String key)	Arbitrary event property values.
Event.Builder	setExternal(boolean value)	True if the event came directly from a client call, false otherwise.
Event.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Event.Builder	setName(String value)	An event name, type, category, or identifier.
Event.Builder	setNameBytes(com.google.protobuf.ByteString value)	An event name, type, category, or identifier.
Event.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Event.Builder	setTimestamp(Timestamp value)	The time when the event was triggered.
Event.Builder	setTimestamp(Timestamp.Builder builderForValue)	The time when the event was triggered.
final Event.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

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

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

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

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

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

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

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

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

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Details

getDescriptor

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

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

internalGetMutableMapField

protected com.google.protobuf.MapField internalGetMutableMapField(int number)

Overrides:

internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

clear

public Event.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.GeneratedMessageV3.Builder<Event.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.GeneratedMessageV3.Builder<Event.Builder>

getDefaultInstanceForType

public Event getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Event build()

Specified by:

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

Specified by:

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

buildPartial

public Event buildPartial()

Specified by:

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

Specified by:

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

clone

public Event.Builder clone()

Specified by:

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

Specified by:

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

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

setField

public Event.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
 Object value)

Specified by:

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

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

clearField

public Event.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

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

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

clearOneof

public Event.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

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

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

setRepeatedField

public Event.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
 int index,
 Object value)

Specified by:

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

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

addRepeatedField

public Event.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
 Object value)

Specified by:

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

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

mergeFrom

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

mergeFrom

public Event.Builder mergeFrom(Event other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

mergeFrom

public Event.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws 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<Event.Builder>

Throws:

IOException

getName

public String getName()

 An event name, type, category, or identifier.
 

string name = 1;

Specified by:

getName in interface EventOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 An event name, type, category, or identifier.
 

string name = 1;

Specified by:

getNameBytes in interface EventOrBuilder

Returns:

The bytes for name.

setName

public Event.Builder setName(String value)

 An event name, type, category, or identifier.
 

string name = 1;

Parameters:

value - The name to set.

Returns:

This builder for chaining.

clearName

public Event.Builder clearName()

 An event name, type, category, or identifier.
 

string name = 1;

Returns:

This builder for chaining.

setNameBytes

public Event.Builder setNameBytes(com.google.protobuf.ByteString value)

 An event name, type, category, or identifier.
 

string name = 1;

Parameters:

value - The bytes for name to set.

Returns:

This builder for chaining.

getPropertiesCount

public int getPropertiesCount()

Description copied from interface: EventOrBuilder

 Arbitrary event property values.
 

map<string, string> properties = 2;

Specified by:

getPropertiesCount in interface EventOrBuilder

containsProperties

public boolean containsProperties(String key)

 Arbitrary event property values.
 

map<string, string> properties = 2;

Specified by:

containsProperties in interface EventOrBuilder

getProperties

@Deprecated
public Map<String,String> getProperties()

Deprecated.

Use getPropertiesMap() instead.

Specified by:

getProperties in interface EventOrBuilder

getPropertiesMap

public Map<String,String> getPropertiesMap()

 Arbitrary event property values.
 

map<string, string> properties = 2;

Specified by:

getPropertiesMap in interface EventOrBuilder

getPropertiesOrDefault

public String getPropertiesOrDefault(String key,
 String defaultValue)

 Arbitrary event property values.
 

map<string, string> properties = 2;

Specified by:

getPropertiesOrDefault in interface EventOrBuilder

getPropertiesOrThrow

public String getPropertiesOrThrow(String key)

 Arbitrary event property values.
 

map<string, string> properties = 2;

Specified by:

getPropertiesOrThrow in interface EventOrBuilder

clearProperties

public Event.Builder clearProperties()

removeProperties

public Event.Builder removeProperties(String key)

 Arbitrary event property values.
 

map<string, string> properties = 2;

getMutableProperties

@Deprecated
public Map<String,String> getMutableProperties()

Deprecated.

Use alternate mutation accessors instead.

putProperties

public Event.Builder putProperties(String key,
 String value)

 Arbitrary event property values.
 

map<string, string> properties = 2;

putAllProperties

public Event.Builder putAllProperties(Map<String,String> values)

 Arbitrary event property values.
 

map<string, string> properties = 2;

hasTimestamp

public boolean hasTimestamp()

 The time when the event was triggered.
 

.google.protobuf.Timestamp timestamp = 3;

Specified by:

hasTimestamp in interface EventOrBuilder

Returns:

Whether the timestamp field is set.

getTimestamp

public Timestamp getTimestamp()

 The time when the event was triggered.
 

.google.protobuf.Timestamp timestamp = 3;

Specified by:

getTimestamp in interface EventOrBuilder

Returns:

The timestamp.

setTimestamp

public Event.Builder setTimestamp(Timestamp value)

 The time when the event was triggered.
 

.google.protobuf.Timestamp timestamp = 3;

setTimestamp

public Event.Builder setTimestamp(Timestamp.Builder builderForValue)

 The time when the event was triggered.
 

.google.protobuf.Timestamp timestamp = 3;

mergeTimestamp

public Event.Builder mergeTimestamp(Timestamp value)

 The time when the event was triggered.
 

.google.protobuf.Timestamp timestamp = 3;

clearTimestamp

public Event.Builder clearTimestamp()

 The time when the event was triggered.
 

.google.protobuf.Timestamp timestamp = 3;

getTimestampBuilder

public Timestamp.Builder getTimestampBuilder()

 The time when the event was triggered.
 

.google.protobuf.Timestamp timestamp = 3;

getTimestampOrBuilder

public TimestampOrBuilder getTimestampOrBuilder()

 The time when the event was triggered.
 

.google.protobuf.Timestamp timestamp = 3;

Specified by:

getTimestampOrBuilder in interface EventOrBuilder

getExternal

public boolean getExternal()

 True if the event came directly from a client call, false otherwise.
 

bool external = 4;

Specified by:

getExternal in interface EventOrBuilder

Returns:

The external.

setExternal

public Event.Builder setExternal(boolean value)

 True if the event came directly from a client call, false otherwise.
 

bool external = 4;

Parameters:

value - The external to set.

Returns:

This builder for chaining.

clearExternal

public Event.Builder clearExternal()

 True if the event came directly from a client call, false otherwise.
 

bool external = 4;

Returns:

This builder for chaining.

setUnknownFields

public final Event.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

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

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>

mergeUnknownFields

public final Event.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

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

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Event.Builder>