com.heroiclabs.nakama.api

Class StorageObject

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.heroiclabs.nakama.api.StorageObject

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StorageObjectOrBuilder, java.io.Serializable

public final class StorageObject
extends com.google.protobuf.GeneratedMessage
implements StorageObjectOrBuilder

 An object within the storage engine.
 

Protobuf type nakama.api.StorageObject

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StorageObject.Builder An object within the storage engine.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	COLLECTION_FIELD_NUMBER
static int	CREATE_TIME_FIELD_NUMBER
static int	KEY_FIELD_NUMBER
static int	PERMISSION_READ_FIELD_NUMBER
static int	PERMISSION_WRITE_FIELD_NUMBER
static int	UPDATE_TIME_FIELD_NUMBER
static int	USER_ID_FIELD_NUMBER
static int	VALUE_FIELD_NUMBER
static int	VERSION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getCollection() The collection which stores the object.
com.google.protobuf.ByteString	getCollectionBytes() The collection which stores the object.
com.google.protobuf.Timestamp	getCreateTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was created.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was created.
static StorageObject	getDefaultInstance()
StorageObject	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
java.lang.String	getKey() The key of the object within the collection.
com.google.protobuf.ByteString	getKeyBytes() The key of the object within the collection.
com.google.protobuf.Parser<StorageObject>	getParserForType()
int	getPermissionRead() The read access permissions for the object.
int	getPermissionWrite() The write access permissions for the object.
int	getSerializedSize()
com.google.protobuf.Timestamp	getUpdateTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was last updated.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was last updated.
java.lang.String	getUserId() The user owner of the object.
com.google.protobuf.ByteString	getUserIdBytes() The user owner of the object.
java.lang.String	getValue() The value of the object.
com.google.protobuf.ByteString	getValueBytes() The value of the object.
java.lang.String	getVersion() The version hash of the object.
com.google.protobuf.ByteString	getVersionBytes() The version hash of the object.
boolean	hasCreateTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was created.
int	hashCode()
boolean	hasUpdateTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was last updated.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static StorageObject.Builder	newBuilder()
static StorageObject.Builder	newBuilder(StorageObject prototype)
StorageObject.Builder	newBuilderForType()
protected StorageObject.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static StorageObject	parseDelimitedFrom(java.io.InputStream input)
static StorageObject	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StorageObject	parseFrom(byte[] data)
static StorageObject	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StorageObject	parseFrom(java.nio.ByteBuffer data)
static StorageObject	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StorageObject	parseFrom(com.google.protobuf.ByteString data)
static StorageObject	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StorageObject	parseFrom(com.google.protobuf.CodedInputStream input)
static StorageObject	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StorageObject	parseFrom(java.io.InputStream input)
static StorageObject	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<StorageObject>	parser()
StorageObject.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

COLLECTION_FIELD_NUMBER

public static final int COLLECTION_FIELD_NUMBER

See Also:

Constant Field Values

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER

See Also:

Constant Field Values

USER_ID_FIELD_NUMBER

public static final int USER_ID_FIELD_NUMBER

See Also:

Constant Field Values

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER

See Also:

Constant Field Values

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER

See Also:

Constant Field Values

PERMISSION_READ_FIELD_NUMBER

public static final int PERMISSION_READ_FIELD_NUMBER

See Also:

Constant Field Values

PERMISSION_WRITE_FIELD_NUMBER

public static final int PERMISSION_WRITE_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

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

getCollection

public java.lang.String getCollection()

 The collection which stores the object.
 

string collection = 1 [json_name = "collection"];

Specified by:

getCollection in interface StorageObjectOrBuilder

Returns:

The collection.

getCollectionBytes

public com.google.protobuf.ByteString getCollectionBytes()

 The collection which stores the object.
 

string collection = 1 [json_name = "collection"];

Specified by:

getCollectionBytes in interface StorageObjectOrBuilder

Returns:

The bytes for collection.

getKey

public java.lang.String getKey()

 The key of the object within the collection.
 

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

Specified by:

getKey in interface StorageObjectOrBuilder

Returns:

The key.

getKeyBytes

public com.google.protobuf.ByteString getKeyBytes()

 The key of the object within the collection.
 

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

Specified by:

getKeyBytes in interface StorageObjectOrBuilder

Returns:

The bytes for key.

getUserId

public java.lang.String getUserId()

 The user owner of the object.
 

string user_id = 3 [json_name = "userId"];

Specified by:

getUserId in interface StorageObjectOrBuilder

Returns:

The userId.

getUserIdBytes

public com.google.protobuf.ByteString getUserIdBytes()

 The user owner of the object.
 

string user_id = 3 [json_name = "userId"];

Specified by:

getUserIdBytes in interface StorageObjectOrBuilder

Returns:

The bytes for userId.

getValue

public java.lang.String getValue()

 The value of the object.
 

string value = 4 [json_name = "value"];

Specified by:

getValue in interface StorageObjectOrBuilder

Returns:

The value.

getValueBytes

public com.google.protobuf.ByteString getValueBytes()

 The value of the object.
 

string value = 4 [json_name = "value"];

Specified by:

getValueBytes in interface StorageObjectOrBuilder

Returns:

The bytes for value.

getVersion

public java.lang.String getVersion()

 The version hash of the object.
 

string version = 5 [json_name = "version"];

Specified by:

getVersion in interface StorageObjectOrBuilder

Returns:

The version.

getVersionBytes

public com.google.protobuf.ByteString getVersionBytes()

 The version hash of the object.
 

string version = 5 [json_name = "version"];

Specified by:

getVersionBytes in interface StorageObjectOrBuilder

Returns:

The bytes for version.

getPermissionRead

public int getPermissionRead()

 The read access permissions for the object.
 

int32 permission_read = 6 [json_name = "permissionRead"];

Specified by:

getPermissionRead in interface StorageObjectOrBuilder

Returns:

The permissionRead.

getPermissionWrite

public int getPermissionWrite()

 The write access permissions for the object.
 

int32 permission_write = 7 [json_name = "permissionWrite"];

Specified by:

getPermissionWrite in interface StorageObjectOrBuilder

Returns:

The permissionWrite.

hasCreateTime

public boolean hasCreateTime()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was created.
 

.google.protobuf.Timestamp create_time = 8 [json_name = "createTime"];

Specified by:

hasCreateTime in interface StorageObjectOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

public com.google.protobuf.Timestamp getCreateTime()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was created.
 

.google.protobuf.Timestamp create_time = 8 [json_name = "createTime"];

Specified by:

getCreateTime in interface StorageObjectOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was created.
 

.google.protobuf.Timestamp create_time = 8 [json_name = "createTime"];

Specified by:

getCreateTimeOrBuilder in interface StorageObjectOrBuilder

hasUpdateTime

public boolean hasUpdateTime()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was last updated.
 

.google.protobuf.Timestamp update_time = 9 [json_name = "updateTime"];

Specified by:

hasUpdateTime in interface StorageObjectOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime

public com.google.protobuf.Timestamp getUpdateTime()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was last updated.
 

.google.protobuf.Timestamp update_time = 9 [json_name = "updateTime"];

Specified by:

getUpdateTime in interface StorageObjectOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the object was last updated.
 

.google.protobuf.Timestamp update_time = 9 [json_name = "updateTime"];

Specified by:

getUpdateTimeOrBuilder in interface StorageObjectOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static StorageObject parseFrom(java.nio.ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StorageObject parseFrom(java.nio.ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StorageObject parseFrom(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StorageObject parseFrom(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StorageObject parseFrom(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StorageObject parseFrom(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StorageObject parseFrom(java.io.InputStream input)
                               throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static StorageObject parseFrom(java.io.InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static StorageObject parseDelimitedFrom(java.io.InputStream input)
                                        throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static StorageObject parseDelimitedFrom(java.io.InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static StorageObject parseFrom(com.google.protobuf.CodedInputStream input)
                               throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static StorageObject parseFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public StorageObject.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static StorageObject.Builder newBuilder()

newBuilder

public static StorageObject.Builder newBuilder(StorageObject prototype)

toBuilder

public StorageObject.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected StorageObject.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static StorageObject getDefaultInstance()

parser

public static com.google.protobuf.Parser<StorageObject> parser()

getParserForType

public com.google.protobuf.Parser<StorageObject> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public StorageObject getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder