Package com.heroiclabs.nakama.api

Class LeaderboardRecord

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
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, Serializable
public final class LeaderboardRecord extends com.google.protobuf.GeneratedMessageV3 implements LeaderboardRecordOrBuilder
 Represents a complete leaderboard record with all scores and associated metadata.
Protobuf type nakama.api.LeaderboardRecord
See Also:

  • Field Details

  • 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

    • getLeaderboardId

      public String getLeaderboardId()
       The ID of the leaderboard this score belongs to.
      string leaderboard_id = 1;
      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;
      Specified by:
      getLeaderboardIdBytes in interface LeaderboardRecordOrBuilder
      Returns:
      The bytes for leaderboardId.

    • getOwnerId

      public String getOwnerId()
       The ID of the score owner, usually a user or group.
      string owner_id = 2;
      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;
      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;
      Specified by:
      hasUsername in interface LeaderboardRecordOrBuilder
      Returns:
      Whether the username field is set.

    • getUsername

      public StringValue getUsername()
       The username of the score owner, if the owner is a user.
      .google.protobuf.StringValue username = 3;
      Specified by:
      getUsername in interface LeaderboardRecordOrBuilder
      Returns:
      The username.

    • getUsernameOrBuilder

      public StringValueOrBuilder getUsernameOrBuilder()
       The username of the score owner, if the owner is a user.
      .google.protobuf.StringValue username = 3;
      Specified by:
      getUsernameOrBuilder in interface LeaderboardRecordOrBuilder

    • getScore

      public long getScore()
       The score value.
      int64 score = 4;
      Specified by:
      getScore in interface LeaderboardRecordOrBuilder
      Returns:
      The score.

    • getSubscore

      public long getSubscore()
       An optional subscore value.
      int64 subscore = 5;
      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;
      Specified by:
      getNumScore in interface LeaderboardRecordOrBuilder
      Returns:
      The numScore.

    • getMetadata

      public String getMetadata()
       Metadata.
      string metadata = 7;
      Specified by:
      getMetadata in interface LeaderboardRecordOrBuilder
      Returns:
      The metadata.

    • getMetadataBytes

      public com.google.protobuf.ByteString getMetadataBytes()
       Metadata.
      string metadata = 7;
      Specified by:
      getMetadataBytes in interface LeaderboardRecordOrBuilder
      Returns:
      The bytes for metadata.

    • hasCreateTime

      public boolean hasCreateTime()
       The UNIX time when the leaderboard record was created.
      .google.protobuf.Timestamp create_time = 8;
      Specified by:
      hasCreateTime in interface LeaderboardRecordOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public Timestamp getCreateTime()
       The UNIX time when the leaderboard record was created.
      .google.protobuf.Timestamp create_time = 8;
      Specified by:
      getCreateTime in interface LeaderboardRecordOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public TimestampOrBuilder getCreateTimeOrBuilder()
       The UNIX time when the leaderboard record was created.
      .google.protobuf.Timestamp create_time = 8;
      Specified by:
      getCreateTimeOrBuilder in interface LeaderboardRecordOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       The UNIX time when the leaderboard record was updated.
      .google.protobuf.Timestamp update_time = 9;
      Specified by:
      hasUpdateTime in interface LeaderboardRecordOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public Timestamp getUpdateTime()
       The UNIX time when the leaderboard record was updated.
      .google.protobuf.Timestamp update_time = 9;
      Specified by:
      getUpdateTime in interface LeaderboardRecordOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public TimestampOrBuilder getUpdateTimeOrBuilder()
       The UNIX time when the leaderboard record was updated.
      .google.protobuf.Timestamp update_time = 9;
      Specified by:
      getUpdateTimeOrBuilder in interface LeaderboardRecordOrBuilder

    • hasExpiryTime

      public boolean hasExpiryTime()
       The UNIX time when the leaderboard record expires.
      .google.protobuf.Timestamp expiry_time = 10;
      Specified by:
      hasExpiryTime in interface LeaderboardRecordOrBuilder
      Returns:
      Whether the expiryTime field is set.

    • getExpiryTime

      public Timestamp getExpiryTime()
       The UNIX time when the leaderboard record expires.
      .google.protobuf.Timestamp expiry_time = 10;
      Specified by:
      getExpiryTime in interface LeaderboardRecordOrBuilder
      Returns:
      The expiryTime.

    • getExpiryTimeOrBuilder

      public TimestampOrBuilder getExpiryTimeOrBuilder()
       The UNIX time when the leaderboard record expires.
      .google.protobuf.Timestamp expiry_time = 10;
      Specified by:
      getExpiryTimeOrBuilder in interface LeaderboardRecordOrBuilder

    • getRank

      public long getRank()
       The rank of this record.
      int64 rank = 11;
      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;
      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.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 LeaderboardRecord parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

      public static LeaderboardRecord parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static LeaderboardRecord parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static LeaderboardRecord parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      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.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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

    • getDefaultInstanceForType

      public LeaderboardRecord getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder