com.heroiclabs.nakama.api

Class LeaderboardRecord

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.heroiclabs.nakama.api.LeaderboardRecord

All Implemented Interfaces:

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

public final class LeaderboardRecord
extends com.google.protobuf.GeneratedMessage
implements LeaderboardRecordOrBuilder

 Represents a complete leaderboard record with all scores and associated metadata.
 

Protobuf type nakama.api.LeaderboardRecord

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LeaderboardRecord.Builder Represents a complete leaderboard record with all scores and associated metadata.

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	CREATE_TIME_FIELD_NUMBER
static int	EXPIRY_TIME_FIELD_NUMBER
static int	LEADERBOARD_ID_FIELD_NUMBER
static int	MAX_NUM_SCORE_FIELD_NUMBER
static int	METADATA_FIELD_NUMBER
static int	NUM_SCORE_FIELD_NUMBER
static int	OWNER_ID_FIELD_NUMBER
static int	RANK_FIELD_NUMBER
static int	SCORE_FIELD_NUMBER
static int	SUBSCORE_FIELD_NUMBER
static int	UPDATE_TIME_FIELD_NUMBER
static int	USERNAME_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)
com.google.protobuf.Timestamp	getCreateTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was created.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was created.
static LeaderboardRecord	getDefaultInstance()
LeaderboardRecord	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Timestamp	getExpiryTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record expires.
com.google.protobuf.TimestampOrBuilder	getExpiryTimeOrBuilder() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record expires.
java.lang.String	getLeaderboardId() The ID of the leaderboard this score belongs to.
com.google.protobuf.ByteString	getLeaderboardIdBytes() The ID of the leaderboard this score belongs to.
int	getMaxNumScore() The maximum number of score updates allowed by the owner.
java.lang.String	getMetadata() Metadata.
com.google.protobuf.ByteString	getMetadataBytes() Metadata.
int	getNumScore() The number of submissions to this score record.
java.lang.String	getOwnerId() The ID of the score owner, usually a user or group.
com.google.protobuf.ByteString	getOwnerIdBytes() The ID of the score owner, usually a user or group.
com.google.protobuf.Parser<LeaderboardRecord>	getParserForType()
long	getRank() The rank of this record.
long	getScore() The score value.
int	getSerializedSize()
long	getSubscore() An optional subscore value.
com.google.protobuf.Timestamp	getUpdateTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was updated.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was updated.
com.google.protobuf.StringValue	getUsername() The username of the score owner, if the owner is a user.
com.google.protobuf.StringValueOrBuilder	getUsernameOrBuilder() The username of the score owner, if the owner is a user.
boolean	hasCreateTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was created.
boolean	hasExpiryTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record expires.
int	hashCode()
boolean	hasUpdateTime() The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record was updated.
boolean	hasUsername() The username of the score owner, if the owner is a user.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static LeaderboardRecord.Builder	newBuilder()
static LeaderboardRecord.Builder	newBuilder(LeaderboardRecord prototype)
LeaderboardRecord.Builder	newBuilderForType()
protected LeaderboardRecord.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static LeaderboardRecord	parseDelimitedFrom(java.io.InputStream input)
static LeaderboardRecord	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LeaderboardRecord	parseFrom(byte[] data)
static LeaderboardRecord	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LeaderboardRecord	parseFrom(java.nio.ByteBuffer data)
static LeaderboardRecord	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LeaderboardRecord	parseFrom(com.google.protobuf.ByteString data)
static LeaderboardRecord	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LeaderboardRecord	parseFrom(com.google.protobuf.CodedInputStream input)
static LeaderboardRecord	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LeaderboardRecord	parseFrom(java.io.InputStream input)
static LeaderboardRecord	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<LeaderboardRecord>	parser()
LeaderboardRecord.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

LEADERBOARD_ID_FIELD_NUMBER

public static final int LEADERBOARD_ID_FIELD_NUMBER

See Also:

Constant Field Values

OWNER_ID_FIELD_NUMBER

public static final int OWNER_ID_FIELD_NUMBER

See Also:

Constant Field Values

USERNAME_FIELD_NUMBER

public static final int USERNAME_FIELD_NUMBER

See Also:

Constant Field Values

SCORE_FIELD_NUMBER

public static final int SCORE_FIELD_NUMBER

See Also:

Constant Field Values

SUBSCORE_FIELD_NUMBER

public static final int SUBSCORE_FIELD_NUMBER

See Also:

Constant Field Values

NUM_SCORE_FIELD_NUMBER

public static final int NUM_SCORE_FIELD_NUMBER

See Also:

Constant Field Values

METADATA_FIELD_NUMBER

public static final int METADATA_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

EXPIRY_TIME_FIELD_NUMBER

public static final int EXPIRY_TIME_FIELD_NUMBER

See Also:

Constant Field Values

RANK_FIELD_NUMBER

public static final int RANK_FIELD_NUMBER

See Also:

Constant Field Values

MAX_NUM_SCORE_FIELD_NUMBER

public static final int MAX_NUM_SCORE_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

getLeaderboardId

public java.lang.String getLeaderboardId()

 The ID of the leaderboard this score belongs to.
 

string leaderboard_id = 1 [json_name = "leaderboardId"];

Specified by:

getLeaderboardId in interface LeaderboardRecordOrBuilder

Returns:

The leaderboardId.

getLeaderboardIdBytes

public com.google.protobuf.ByteString getLeaderboardIdBytes()

 The ID of the leaderboard this score belongs to.
 

string leaderboard_id = 1 [json_name = "leaderboardId"];

Specified by:

getLeaderboardIdBytes in interface LeaderboardRecordOrBuilder

Returns:

The bytes for leaderboardId.

getOwnerId

public java.lang.String getOwnerId()

 The ID of the score owner, usually a user or group.
 

string owner_id = 2 [json_name = "ownerId"];

Specified by:

getOwnerId in interface LeaderboardRecordOrBuilder

Returns:

The ownerId.

getOwnerIdBytes

public com.google.protobuf.ByteString getOwnerIdBytes()

 The ID of the score owner, usually a user or group.
 

string owner_id = 2 [json_name = "ownerId"];

Specified by:

getOwnerIdBytes in interface LeaderboardRecordOrBuilder

Returns:

The bytes for ownerId.

hasUsername

public boolean hasUsername()

 The username of the score owner, if the owner is a user.
 

.google.protobuf.StringValue username = 3 [json_name = "username"];

Specified by:

hasUsername in interface LeaderboardRecordOrBuilder

Returns:

Whether the username field is set.

getUsername

public com.google.protobuf.StringValue getUsername()

 The username of the score owner, if the owner is a user.
 

.google.protobuf.StringValue username = 3 [json_name = "username"];

Specified by:

getUsername in interface LeaderboardRecordOrBuilder

Returns:

The username.

getUsernameOrBuilder

public com.google.protobuf.StringValueOrBuilder getUsernameOrBuilder()

 The username of the score owner, if the owner is a user.
 

.google.protobuf.StringValue username = 3 [json_name = "username"];

Specified by:

getUsernameOrBuilder in interface LeaderboardRecordOrBuilder

getScore

public long getScore()

 The score value.
 

int64 score = 4 [json_name = "score"];

Specified by:

getScore in interface LeaderboardRecordOrBuilder

Returns:

The score.

getSubscore

public long getSubscore()

 An optional subscore value.
 

int64 subscore = 5 [json_name = "subscore"];

Specified by:

getSubscore in interface LeaderboardRecordOrBuilder

Returns:

The subscore.

getNumScore

public int getNumScore()

 The number of submissions to this score record.
 

int32 num_score = 6 [json_name = "numScore"];

Specified by:

getNumScore in interface LeaderboardRecordOrBuilder

Returns:

The numScore.

getMetadata

public java.lang.String getMetadata()

 Metadata.
 

string metadata = 7 [json_name = "metadata"];

Specified by:

getMetadata in interface LeaderboardRecordOrBuilder

Returns:

The metadata.

getMetadataBytes

public com.google.protobuf.ByteString getMetadataBytes()

 Metadata.
 

string metadata = 7 [json_name = "metadata"];

Specified by:

getMetadataBytes in interface LeaderboardRecordOrBuilder

Returns:

The bytes for metadata.

hasCreateTime

public boolean hasCreateTime()

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

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

Specified by:

hasCreateTime in interface LeaderboardRecordOrBuilder

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 leaderboard record was created.
 

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

Specified by:

getCreateTime in interface LeaderboardRecordOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

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

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

Specified by:

getCreateTimeOrBuilder in interface LeaderboardRecordOrBuilder

hasUpdateTime

public boolean hasUpdateTime()

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

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

Specified by:

hasUpdateTime in interface LeaderboardRecordOrBuilder

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 leaderboard record was updated.
 

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

Specified by:

getUpdateTime in interface LeaderboardRecordOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

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

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

Specified by:

getUpdateTimeOrBuilder in interface LeaderboardRecordOrBuilder

hasExpiryTime

public boolean hasExpiryTime()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record expires.
 

.google.protobuf.Timestamp expiry_time = 10 [json_name = "expiryTime"];

Specified by:

hasExpiryTime in interface LeaderboardRecordOrBuilder

Returns:

Whether the expiryTime field is set.

getExpiryTime

public com.google.protobuf.Timestamp getExpiryTime()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record expires.
 

.google.protobuf.Timestamp expiry_time = 10 [json_name = "expiryTime"];

Specified by:

getExpiryTime in interface LeaderboardRecordOrBuilder

Returns:

The expiryTime.

getExpiryTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getExpiryTimeOrBuilder()

 The UNIX time (for gRPC clients) or ISO string (for REST clients) when the leaderboard record expires.
 

.google.protobuf.Timestamp expiry_time = 10 [json_name = "expiryTime"];

Specified by:

getExpiryTimeOrBuilder in interface LeaderboardRecordOrBuilder

getRank

public long getRank()

 The rank of this record.
 

int64 rank = 11 [json_name = "rank"];

Specified by:

getRank in interface LeaderboardRecordOrBuilder

Returns:

The rank.

getMaxNumScore

public int getMaxNumScore()

 The maximum number of score updates allowed by the owner.
 

uint32 max_num_score = 12 [json_name = "maxNumScore"];

Specified by:

getMaxNumScore in interface LeaderboardRecordOrBuilder

Returns:

The maxNumScore.

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 LeaderboardRecord parseFrom(java.nio.ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

newBuilderForType

public LeaderboardRecord.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static LeaderboardRecord.Builder newBuilder()

newBuilder

public static LeaderboardRecord.Builder newBuilder(LeaderboardRecord prototype)

toBuilder

public LeaderboardRecord.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static LeaderboardRecord getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<LeaderboardRecord> 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 LeaderboardRecord getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder