Package com.heroiclabs.nakama.api

Class StorageObject

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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, Serializable

public final class StorageObject
extends com.google.protobuf.GeneratedMessageV3
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	Description
static final class	StorageObject.Builder	An object within the storage engine.

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

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

Fields inherited from class com.google.protobuf.GeneratedMessageV3

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	Description
boolean	equals(Object obj)
String	getCollection()	The collection which stores the object.
com.google.protobuf.ByteString	getCollectionBytes()	The collection which stores the object.
Timestamp	getCreateTime()	The UNIX time when the object was created.
TimestampOrBuilder	getCreateTimeOrBuilder()	The UNIX time when the object was created.
static StorageObject	getDefaultInstance()
StorageObject	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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()
final com.google.protobuf.UnknownFieldSet	getUnknownFields()
Timestamp	getUpdateTime()	The UNIX time when the object was last updated.
TimestampOrBuilder	getUpdateTimeOrBuilder()	The UNIX time when the object was last updated.
String	getUserId()	The user owner of the object.
com.google.protobuf.ByteString	getUserIdBytes()	The user owner of the object.
String	getValue()	The value of the object.
com.google.protobuf.ByteString	getValueBytes()	The value of the object.
String	getVersion()	The version hash of the object.
com.google.protobuf.ByteString	getVersionBytes()	The version hash of the object.
boolean	hasCreateTime()	The UNIX time when the object was created.
int	hashCode()
boolean	hasUpdateTime()	The UNIX time when the object was last updated.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static StorageObject.Builder	newBuilder()
static StorageObject.Builder	newBuilder(StorageObject prototype)
StorageObject.Builder	newBuilderForType()
protected StorageObject.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static StorageObject	parseDelimitedFrom(InputStream input)
static StorageObject	parseDelimitedFrom(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(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(InputStream input)
static StorageObject	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StorageObject	parseFrom(ByteBuffer data)
static StorageObject	parseFrom(ByteBuffer data, 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.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

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 Details

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getCollection

public String getCollection()

 The collection which stores the object.
 

string collection = 1;

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;

Specified by:

getCollectionBytes in interface StorageObjectOrBuilder

Returns:

The bytes for collection.

getKey

public String getKey()

 The key of the object within the collection.
 

string key = 2;

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;

Specified by:

getKeyBytes in interface StorageObjectOrBuilder

Returns:

The bytes for key.

getUserId

public String getUserId()

 The user owner of the object.
 

string user_id = 3;

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;

Specified by:

getUserIdBytes in interface StorageObjectOrBuilder

Returns:

The bytes for userId.

getValue

public String getValue()

 The value of the object.
 

string value = 4;

Specified by:

getValue in interface StorageObjectOrBuilder

Returns:

The value.

getValueBytes

public com.google.protobuf.ByteString getValueBytes()

 The value of the object.
 

string value = 4;

Specified by:

getValueBytes in interface StorageObjectOrBuilder

Returns:

The bytes for value.

getVersion

public String getVersion()

 The version hash of the object.
 

string version = 5;

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;

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;

Specified by:

getPermissionRead in interface StorageObjectOrBuilder

Returns:

The permissionRead.

getPermissionWrite

public int getPermissionWrite()

 The write access permissions for the object.
 

int32 permission_write = 7;

Specified by:

getPermissionWrite in interface StorageObjectOrBuilder

Returns:

The permissionWrite.

hasCreateTime

public boolean hasCreateTime()

 The UNIX time when the object was created.
 

.google.protobuf.Timestamp create_time = 8;

Specified by:

hasCreateTime in interface StorageObjectOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

public Timestamp getCreateTime()

 The UNIX time when the object was created.
 

.google.protobuf.Timestamp create_time = 8;

Specified by:

getCreateTime in interface StorageObjectOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public TimestampOrBuilder getCreateTimeOrBuilder()

 The UNIX time when the object was created.
 

.google.protobuf.Timestamp create_time = 8;

Specified by:

getCreateTimeOrBuilder in interface StorageObjectOrBuilder

hasUpdateTime

public boolean hasUpdateTime()

 The UNIX time when the object was last updated.
 

.google.protobuf.Timestamp update_time = 9;

Specified by:

hasUpdateTime in interface StorageObjectOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime

public Timestamp getUpdateTime()

 The UNIX time when the object was last updated.
 

.google.protobuf.Timestamp update_time = 9;

Specified by:

getUpdateTime in interface StorageObjectOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder

public TimestampOrBuilder getUpdateTimeOrBuilder()

 The UNIX time when the object was last updated.
 

.google.protobuf.Timestamp update_time = 9;

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.GeneratedMessageV3

writeTo

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

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(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(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StorageObject parseFrom(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(InputStream input)
                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static StorageObject parseDelimitedFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

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.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

getDefaultInstanceForType

public StorageObject getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder