Message.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<Message.Builder>
    - - com.heroiclabs.satori.api.Message.Builder

All Implemented Interfaces:

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

Enclosing class:

Message
```
public static final class Message.Builder
extends com.google.protobuf.GeneratedMessage.Builder<Message.Builder>
implements MessageOrBuilder
```
```
 A scheduled message.
 
```
Protobuf type satori.api.Message

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Message`	`build()`
`Message`	`buildPartial()`
`Message.Builder`	`clear()`
`Message.Builder`	`clearConsumeTime()` The time the message was consumed by the identity.
`Message.Builder`	`clearCreateTime()` The time the message was created.
`Message.Builder`	`clearId()` The message's unique identifier.
`Message.Builder`	`clearImageUrl()` The message's image url.
`Message.Builder`	`clearMetadata()`
`Message.Builder`	`clearReadTime()` The time the message was read by the client.
`Message.Builder`	`clearScheduleId()` The identifier of the schedule.
`Message.Builder`	`clearSendTime()` The send time for the message.
`Message.Builder`	`clearText()` The message's text.
`Message.Builder`	`clearTitle()` The message's title.
`Message.Builder`	`clearUpdateTime()` The time the message was updated.
`boolean`	`containsMetadata(java.lang.String key)` A key-value pairs of metadata.
`long`	`getConsumeTime()` The time the message was consumed by the identity.
`long`	`getCreateTime()` The time the message was created.
`Message`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`java.lang.String`	`getId()` The message's unique identifier.
`com.google.protobuf.ByteString`	`getIdBytes()` The message's unique identifier.
`java.lang.String`	`getImageUrl()` The message's image url.
`com.google.protobuf.ByteString`	`getImageUrlBytes()` The message's image url.
`java.util.Map<java.lang.String,java.lang.String>`	`getMetadata()` Deprecated.
`int`	`getMetadataCount()` A key-value pairs of metadata.
`java.util.Map<java.lang.String,java.lang.String>`	`getMetadataMap()` A key-value pairs of metadata.
`java.lang.String`	`getMetadataOrDefault(java.lang.String key, java.lang.String defaultValue)` A key-value pairs of metadata.
`java.lang.String`	`getMetadataOrThrow(java.lang.String key)` A key-value pairs of metadata.
`java.util.Map<java.lang.String,java.lang.String>`	`getMutableMetadata()` Deprecated.
`long`	`getReadTime()` The time the message was read by the client.
`java.lang.String`	`getScheduleId()` The identifier of the schedule.
`com.google.protobuf.ByteString`	`getScheduleIdBytes()` The identifier of the schedule.
`long`	`getSendTime()` The send time for the message.
`java.lang.String`	`getText()` The message's text.
`com.google.protobuf.ByteString`	`getTextBytes()` The message's text.
`java.lang.String`	`getTitle()` The message's title.
`com.google.protobuf.ByteString`	`getTitleBytes()` The message's title.
`long`	`getUpdateTime()` The time the message was updated.
`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()`
`Message.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Message.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Message.Builder`	`mergeFrom(Message other)`
`Message.Builder`	`putAllMetadata(java.util.Map<java.lang.String,java.lang.String> values)` A key-value pairs of metadata.
`Message.Builder`	`putMetadata(java.lang.String key, java.lang.String value)` A key-value pairs of metadata.
`Message.Builder`	`removeMetadata(java.lang.String key)` A key-value pairs of metadata.
`Message.Builder`	`setConsumeTime(long value)` The time the message was consumed by the identity.
`Message.Builder`	`setCreateTime(long value)` The time the message was created.
`Message.Builder`	`setId(java.lang.String value)` The message's unique identifier.
`Message.Builder`	`setIdBytes(com.google.protobuf.ByteString value)` The message's unique identifier.
`Message.Builder`	`setImageUrl(java.lang.String value)` The message's image url.
`Message.Builder`	`setImageUrlBytes(com.google.protobuf.ByteString value)` The message's image url.
`Message.Builder`	`setReadTime(long value)` The time the message was read by the client.
`Message.Builder`	`setScheduleId(java.lang.String value)` The identifier of the schedule.
`Message.Builder`	`setScheduleIdBytes(com.google.protobuf.ByteString value)` The identifier of the schedule.
`Message.Builder`	`setSendTime(long value)` The send time for the message.
`Message.Builder`	`setText(java.lang.String value)` The message's text.
`Message.Builder`	`setTextBytes(com.google.protobuf.ByteString value)` The message's text.
`Message.Builder`	`setTitle(java.lang.String value)` The message's title.
`Message.Builder`	`setTitleBytes(com.google.protobuf.ByteString value)` The message's title.
`Message.Builder`	`setUpdateTime(long value)` The time the message was updated.

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<Message.Builder>
  - internalGetMutableMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
```
    Overrides:
    
    internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Message.Builder>
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Message.Builder>
  - clear
```
public Message.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<Message.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<Message.Builder>
  - getDefaultInstanceForType
```
public Message getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public Message build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public Message buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - mergeFrom
```
public Message.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<Message.Builder>
  - mergeFrom
```
public Message.Builder mergeFrom(Message other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Message.Builder>
  - mergeFrom
```
public Message.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<Message.Builder>
    
    Throws:
    
    java.io.IOException
  - getScheduleId
```
public java.lang.String getScheduleId()
```
```
 The identifier of the schedule.
 
```
    string schedule_id = 1 [json_name = "scheduleId"];
    Returns:
    
    The scheduleId.
  - getScheduleIdBytes
```
public com.google.protobuf.ByteString getScheduleIdBytes()
```
```
 The identifier of the schedule.
 
```
    string schedule_id = 1 [json_name = "scheduleId"];
    Returns:
    
    The bytes for scheduleId.
  - setScheduleId
```
public Message.Builder setScheduleId(java.lang.String value)
```
```
 The identifier of the schedule.
 
```
    string schedule_id = 1 [json_name = "scheduleId"];
    Parameters:
    
    value - The scheduleId to set.
    
    Returns:
    
    This builder for chaining.
  - clearScheduleId
```
public Message.Builder clearScheduleId()
```
```
 The identifier of the schedule.
 
```
    string schedule_id = 1 [json_name = "scheduleId"];
    Returns:
    
    This builder for chaining.
  - setScheduleIdBytes
```
public Message.Builder setScheduleIdBytes(com.google.protobuf.ByteString value)
```
```
 The identifier of the schedule.
 
```
    string schedule_id = 1 [json_name = "scheduleId"];
    Parameters:
    
    value - The bytes for scheduleId to set.
    
    Returns:
    
    This builder for chaining.
  - getSendTime
```
public long getSendTime()
```
```
 The send time for the message.
 
```
    int64 send_time = 2 [json_name = "sendTime"];
    Returns:
    
    The sendTime.
  - setSendTime
```
public Message.Builder setSendTime(long value)
```
```
 The send time for the message.
 
```
    int64 send_time = 2 [json_name = "sendTime"];
    Parameters:
    
    value - The sendTime to set.
    
    Returns:
    
    This builder for chaining.
  - clearSendTime
```
public Message.Builder clearSendTime()
```
```
 The send time for the message.
 
```
    int64 send_time = 2 [json_name = "sendTime"];
    Returns:
    
    This builder for chaining.
  - getMetadataCount
```
public int getMetadataCount()
```
    Description copied from interface: MessageOrBuilder
```
 A key-value pairs of metadata.
 
```
    map<string, string> metadata = 3 [json_name = "metadata"];
  - containsMetadata
```
public boolean containsMetadata(java.lang.String key)
```
```
 A key-value pairs of metadata.
 
```
    map<string, string> metadata = 3 [json_name = "metadata"];
  - getMetadata
```
@Deprecated
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
```
    Deprecated.
    
    Use getMetadataMap() instead.
  - getMetadataMap
```
public java.util.Map<java.lang.String,java.lang.String> getMetadataMap()
```
```
 A key-value pairs of metadata.
 
```
    map<string, string> metadata = 3 [json_name = "metadata"];
  - getMetadataOrDefault
```
public java.lang.String getMetadataOrDefault(java.lang.String key,
                                             java.lang.String defaultValue)
```
```
 A key-value pairs of metadata.
 
```
    map<string, string> metadata = 3 [json_name = "metadata"];
  - getMetadataOrThrow
```
public java.lang.String getMetadataOrThrow(java.lang.String key)
```
```
 A key-value pairs of metadata.
 
```
    map<string, string> metadata = 3 [json_name = "metadata"];
  - clearMetadata
```
public Message.Builder clearMetadata()
```
  - removeMetadata
```
public Message.Builder removeMetadata(java.lang.String key)
```
```
 A key-value pairs of metadata.
 
```
    map<string, string> metadata = 3 [json_name = "metadata"];
  - getMutableMetadata
```
@Deprecated
public java.util.Map<java.lang.String,java.lang.String> getMutableMetadata()
```
    Deprecated.
    
    Use alternate mutation accessors instead.
  - putMetadata
```
public Message.Builder putMetadata(java.lang.String key,
                                   java.lang.String value)
```
```
 A key-value pairs of metadata.
 
```
    map<string, string> metadata = 3 [json_name = "metadata"];
  - putAllMetadata
```
public Message.Builder putAllMetadata(java.util.Map<java.lang.String,java.lang.String> values)
```
```
 A key-value pairs of metadata.
 
```
    map<string, string> metadata = 3 [json_name = "metadata"];
  - getCreateTime
```
public long getCreateTime()
```
```
 The time the message was created.
 
```
    int64 create_time = 4 [json_name = "createTime"];
    Returns:
    
    The createTime.
  - setCreateTime
```
public Message.Builder setCreateTime(long value)
```
```
 The time the message was created.
 
```
    int64 create_time = 4 [json_name = "createTime"];
    Parameters:
    
    value - The createTime to set.
    
    Returns:
    
    This builder for chaining.
  - clearCreateTime
```
public Message.Builder clearCreateTime()
```
```
 The time the message was created.
 
```
    int64 create_time = 4 [json_name = "createTime"];
    Returns:
    
    This builder for chaining.
  - getUpdateTime
```
public long getUpdateTime()
```
```
 The time the message was updated.
 
```
    int64 update_time = 5 [json_name = "updateTime"];
    Returns:
    
    The updateTime.
  - setUpdateTime
```
public Message.Builder setUpdateTime(long value)
```
```
 The time the message was updated.
 
```
    int64 update_time = 5 [json_name = "updateTime"];
    Parameters:
    
    value - The updateTime to set.
    
    Returns:
    
    This builder for chaining.
  - clearUpdateTime
```
public Message.Builder clearUpdateTime()
```
```
 The time the message was updated.
 
```
    int64 update_time = 5 [json_name = "updateTime"];
    Returns:
    
    This builder for chaining.
  - getReadTime
```
public long getReadTime()
```
```
 The time the message was read by the client.
 
```
    int64 read_time = 6 [json_name = "readTime"];
    Returns:
    
    The readTime.
  - setReadTime
```
public Message.Builder setReadTime(long value)
```
```
 The time the message was read by the client.
 
```
    int64 read_time = 6 [json_name = "readTime"];
    Parameters:
    
    value - The readTime to set.
    
    Returns:
    
    This builder for chaining.
  - clearReadTime
```
public Message.Builder clearReadTime()
```
```
 The time the message was read by the client.
 
```
    int64 read_time = 6 [json_name = "readTime"];
    Returns:
    
    This builder for chaining.
  - getConsumeTime
```
public long getConsumeTime()
```
```
 The time the message was consumed by the identity.
 
```
    int64 consume_time = 7 [json_name = "consumeTime"];
    Returns:
    
    The consumeTime.
  - setConsumeTime
```
public Message.Builder setConsumeTime(long value)
```
```
 The time the message was consumed by the identity.
 
```
    int64 consume_time = 7 [json_name = "consumeTime"];
    Parameters:
    
    value - The consumeTime to set.
    
    Returns:
    
    This builder for chaining.
  - clearConsumeTime
```
public Message.Builder clearConsumeTime()
```
```
 The time the message was consumed by the identity.
 
```
    int64 consume_time = 7 [json_name = "consumeTime"];
    Returns:
    
    This builder for chaining.
  - getText
```
public java.lang.String getText()
```
```
 The message's text.
 
```
    string text = 8 [json_name = "text"];
    Returns:
    
    The text.
  - getTextBytes
```
public com.google.protobuf.ByteString getTextBytes()
```
```
 The message's text.
 
```
    string text = 8 [json_name = "text"];
    Returns:
    
    The bytes for text.
  - setText
```
public Message.Builder setText(java.lang.String value)
```
```
 The message's text.
 
```
    string text = 8 [json_name = "text"];
    Parameters:
    
    value - The text to set.
    
    Returns:
    
    This builder for chaining.
  - clearText
```
public Message.Builder clearText()
```
```
 The message's text.
 
```
    string text = 8 [json_name = "text"];
    Returns:
    
    This builder for chaining.
  - setTextBytes
```
public Message.Builder setTextBytes(com.google.protobuf.ByteString value)
```
```
 The message's text.
 
```
    string text = 8 [json_name = "text"];
    Parameters:
    
    value - The bytes for text to set.
    
    Returns:
    
    This builder for chaining.
  - getId
```
public java.lang.String getId()
```
```
 The message's unique identifier.
 
```
    string id = 9 [json_name = "id"];
    Returns:
    
    The id.
  - getIdBytes
```
public com.google.protobuf.ByteString getIdBytes()
```
```
 The message's unique identifier.
 
```
    string id = 9 [json_name = "id"];
    Returns:
    
    The bytes for id.
  - setId
```
public Message.Builder setId(java.lang.String value)
```
```
 The message's unique identifier.
 
```
    string id = 9 [json_name = "id"];
    Parameters:
    
    value - The id to set.
    
    Returns:
    
    This builder for chaining.
  - clearId
```
public Message.Builder clearId()
```
```
 The message's unique identifier.
 
```
    string id = 9 [json_name = "id"];
    Returns:
    
    This builder for chaining.
  - setIdBytes
```
public Message.Builder setIdBytes(com.google.protobuf.ByteString value)
```
```
 The message's unique identifier.
 
```
    string id = 9 [json_name = "id"];
    Parameters:
    
    value - The bytes for id to set.
    
    Returns:
    
    This builder for chaining.
  - getTitle
```
public java.lang.String getTitle()
```
```
 The message's title.
 
```
    string title = 10 [json_name = "title"];
    Returns:
    
    The title.
  - getTitleBytes
```
public com.google.protobuf.ByteString getTitleBytes()
```
```
 The message's title.
 
```
    string title = 10 [json_name = "title"];
    Returns:
    
    The bytes for title.
  - setTitle
```
public Message.Builder setTitle(java.lang.String value)
```
```
 The message's title.
 
```
    string title = 10 [json_name = "title"];
    Parameters:
    
    value - The title to set.
    
    Returns:
    
    This builder for chaining.
  - clearTitle
```
public Message.Builder clearTitle()
```
```
 The message's title.
 
```
    string title = 10 [json_name = "title"];
    Returns:
    
    This builder for chaining.
  - setTitleBytes
```
public Message.Builder setTitleBytes(com.google.protobuf.ByteString value)
```
```
 The message's title.
 
```
    string title = 10 [json_name = "title"];
    Parameters:
    
    value - The bytes for title to set.
    
    Returns:
    
    This builder for chaining.
  - getImageUrl
```
public java.lang.String getImageUrl()
```
```
 The message's image url.
 
```
    string image_url = 11 [json_name = "imageUrl"];
    Returns:
    
    The imageUrl.
  - getImageUrlBytes
```
public com.google.protobuf.ByteString getImageUrlBytes()
```
```
 The message's image url.
 
```
    string image_url = 11 [json_name = "imageUrl"];
    Returns:
    
    The bytes for imageUrl.
  - setImageUrl
```
public Message.Builder setImageUrl(java.lang.String value)
```
```
 The message's image url.
 
```
    string image_url = 11 [json_name = "imageUrl"];
    Parameters:
    
    value - The imageUrl to set.
    
    Returns:
    
    This builder for chaining.
  - clearImageUrl
```
public Message.Builder clearImageUrl()
```
```
 The message's image url.
 
```
    string image_url = 11 [json_name = "imageUrl"];
    Returns:
    
    This builder for chaining.
  - setImageUrlBytes
```
public Message.Builder setImageUrlBytes(com.google.protobuf.ByteString value)
```
```
 The message's image url.
 
```
    string image_url = 11 [json_name = "imageUrl"];
    Parameters:
    
    value - The bytes for imageUrl to set.
    
    Returns:
    
    This builder for chaining.

Class Message.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

getScheduleId

getScheduleIdBytes

setScheduleId

clearScheduleId

setScheduleIdBytes

getSendTime

setSendTime

clearSendTime

getMetadataCount

containsMetadata

getMetadata

getMetadataMap

getMetadataOrDefault

getMetadataOrThrow

clearMetadata

removeMetadata

getMutableMetadata

putMetadata

putAllMetadata

getCreateTime

setCreateTime

clearCreateTime

getUpdateTime

setUpdateTime

clearUpdateTime

getReadTime

setReadTime

clearReadTime

getConsumeTime

setConsumeTime

clearConsumeTime

getText

getTextBytes

setText

clearText

setTextBytes

getId

getIdBytes

setId

clearId

setIdBytes

getTitle

getTitleBytes

setTitle

clearTitle

setTitleBytes

getImageUrl

getImageUrlBytes

setImageUrl

clearImageUrl

setImageUrlBytes