Event.Builder (nakama-java 2.5.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessage.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, java.lang.Cloneable

Enclosing class:

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

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Event`	`build()`
`Event`	`buildPartial()`
`Event.Builder`	`clear()`
`Event.Builder`	`clearExternal()` True if the event came directly from a client call, false otherwise.
`Event.Builder`	`clearName()` An event name, type, category, or identifier.
`Event.Builder`	`clearProperties()`
`Event.Builder`	`clearTimestamp()` The time when the event was triggered.
`boolean`	`containsProperties(java.lang.String key)` Arbitrary event property values.
`Event`	`getDefaultInstanceForType()`
`static 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.
`java.util.Map<java.lang.String,java.lang.String>`	`getMutableProperties()` Deprecated.
`java.lang.String`	`getName()` An event name, type, category, or identifier.
`com.google.protobuf.ByteString`	`getNameBytes()` An event name, type, category, or identifier.
`java.util.Map<java.lang.String,java.lang.String>`	`getProperties()` Deprecated.
`int`	`getPropertiesCount()` Arbitrary event property values.
`java.util.Map<java.lang.String,java.lang.String>`	`getPropertiesMap()` Arbitrary event property values.
`java.lang.String`	`getPropertiesOrDefault(java.lang.String key, java.lang.String defaultValue)` Arbitrary event property values.
`java.lang.String`	`getPropertiesOrThrow(java.lang.String key)` Arbitrary event property values.
`com.google.protobuf.Timestamp`	`getTimestamp()` The time when the event was triggered.
`com.google.protobuf.Timestamp.Builder`	`getTimestampBuilder()` The time when the event was triggered.
`com.google.protobuf.TimestampOrBuilder`	`getTimestampOrBuilder()` The time when the event was triggered.
`boolean`	`hasTimestamp()` The time when the event was triggered.
`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()`
`Event.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Event.Builder`	`mergeFrom(Event other)`
`Event.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Event.Builder`	`mergeTimestamp(com.google.protobuf.Timestamp value)` The time when the event was triggered.
`Event.Builder`	`putAllProperties(java.util.Map<java.lang.String,java.lang.String> values)` Arbitrary event property values.
`Event.Builder`	`putProperties(java.lang.String key, java.lang.String value)` Arbitrary event property values.
`Event.Builder`	`removeProperties(java.lang.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`	`setName(java.lang.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`	`setTimestamp(com.google.protobuf.Timestamp.Builder builderForValue)` The time when the event was triggered.
`Event.Builder`	`setTimestamp(com.google.protobuf.Timestamp value)` The time when the event was triggered.

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<Event.Builder>
  - internalGetMutableMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
```
    Overrides:
    
    internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Event.Builder>
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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
  - 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.GeneratedMessage.Builder<Event.Builder>
  - mergeFrom
```
public Event.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<Event.Builder>
    
    Throws:
    
    java.io.IOException
  - getName
```
public java.lang.String getName()
```
```
 An event name, type, category, or identifier.
 
```
    string name = 1 [json_name = "name"];
    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 [json_name = "name"];
    Specified by:
    
    getNameBytes in interface EventOrBuilder
    
    Returns:
    
    The bytes for name.
  - setName
```
public Event.Builder setName(java.lang.String value)
```
```
 An event name, type, category, or identifier.
 
```
    string name = 1 [json_name = "name"];
    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 [json_name = "name"];
    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 [json_name = "name"];
    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 [json_name = "properties"];
    Specified by:
    
    getPropertiesCount in interface EventOrBuilder
  - containsProperties
```
public boolean containsProperties(java.lang.String key)
```
```
 Arbitrary event property values.
 
```
    map<string, string> properties = 2 [json_name = "properties"];
    Specified by:
    
    containsProperties in interface EventOrBuilder
  - getProperties
```
@Deprecated
public java.util.Map<java.lang.String,java.lang.String> getProperties()
```
    Deprecated.
    
    Use getPropertiesMap() instead.
    
    Specified by:
    
    getProperties in interface EventOrBuilder
  - getPropertiesMap
```
public java.util.Map<java.lang.String,java.lang.String> getPropertiesMap()
```
```
 Arbitrary event property values.
 
```
    map<string, string> properties = 2 [json_name = "properties"];
    Specified by:
    
    getPropertiesMap in interface EventOrBuilder
  - getPropertiesOrDefault
```
public java.lang.String getPropertiesOrDefault(java.lang.String key,
                                               java.lang.String defaultValue)
```
```
 Arbitrary event property values.
 
```
    map<string, string> properties = 2 [json_name = "properties"];
    Specified by:
    
    getPropertiesOrDefault in interface EventOrBuilder
  - getPropertiesOrThrow
```
public java.lang.String getPropertiesOrThrow(java.lang.String key)
```
```
 Arbitrary event property values.
 
```
    map<string, string> properties = 2 [json_name = "properties"];
    Specified by:
    
    getPropertiesOrThrow in interface EventOrBuilder
  - clearProperties
```
public Event.Builder clearProperties()
```
  - removeProperties
```
public Event.Builder removeProperties(java.lang.String key)
```
```
 Arbitrary event property values.
 
```
    map<string, string> properties = 2 [json_name = "properties"];
  - getMutableProperties
```
@Deprecated
public java.util.Map<java.lang.String,java.lang.String> getMutableProperties()
```
    Deprecated.
    
    Use alternate mutation accessors instead.
  - putProperties
```
public Event.Builder putProperties(java.lang.String key,
                                   java.lang.String value)
```
```
 Arbitrary event property values.
 
```
    map<string, string> properties = 2 [json_name = "properties"];
  - putAllProperties
```
public Event.Builder putAllProperties(java.util.Map<java.lang.String,java.lang.String> values)
```
```
 Arbitrary event property values.
 
```
    map<string, string> properties = 2 [json_name = "properties"];
  - hasTimestamp
```
public boolean hasTimestamp()
```
```
 The time when the event was triggered.
 
```
    .google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];
    Specified by:
    
    hasTimestamp in interface EventOrBuilder
    
    Returns:
    
    Whether the timestamp field is set.
  - getTimestamp
```
public com.google.protobuf.Timestamp getTimestamp()
```
```
 The time when the event was triggered.
 
```
    .google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];
    Specified by:
    
    getTimestamp in interface EventOrBuilder
    
    Returns:
    
    The timestamp.
  - setTimestamp
```
public Event.Builder setTimestamp(com.google.protobuf.Timestamp value)
```
```
 The time when the event was triggered.
 
```
    .google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];
  - setTimestamp
```
public Event.Builder setTimestamp(com.google.protobuf.Timestamp.Builder builderForValue)
```
```
 The time when the event was triggered.
 
```
    .google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];
  - mergeTimestamp
```
public Event.Builder mergeTimestamp(com.google.protobuf.Timestamp value)
```
```
 The time when the event was triggered.
 
```
    .google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];
  - clearTimestamp
```
public Event.Builder clearTimestamp()
```
```
 The time when the event was triggered.
 
```
    .google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];
  - getTimestampBuilder
```
public com.google.protobuf.Timestamp.Builder getTimestampBuilder()
```
```
 The time when the event was triggered.
 
```
    .google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];
  - getTimestampOrBuilder
```
public com.google.protobuf.TimestampOrBuilder getTimestampOrBuilder()
```
```
 The time when the event was triggered.
 
```
    .google.protobuf.Timestamp timestamp = 3 [json_name = "timestamp"];
    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 [json_name = "external"];
    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 [json_name = "external"];
    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 [json_name = "external"];
    Returns:
    
    This builder for chaining.

Class Event.Builder

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

getDescriptor

internalGetMapFieldReflection

internalGetMutableMapFieldReflection

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

mergeFrom

mergeFrom

isInitialized

mergeFrom

getName

getNameBytes

setName

clearName

setNameBytes

getPropertiesCount

containsProperties

getProperties

getPropertiesMap

getPropertiesOrDefault

getPropertiesOrThrow

clearProperties

removeProperties

getMutableProperties

putProperties

putAllProperties

hasTimestamp

getTimestamp

setTimestamp

setTimestamp

mergeTimestamp

clearTimestamp

getTimestampBuilder

getTimestampOrBuilder

getExternal

setExternal

clearExternal