Package com.heroiclabs.nakama.api

Class LeaderboardRecord.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderType>
com.google.protobuf.GeneratedMessageV3.Builder<LeaderboardRecord.Builder>
com.heroiclabs.nakama.api.LeaderboardRecord.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LeaderboardRecordOrBuilder, Cloneable
Enclosing class:
LeaderboardRecord
public static final class LeaderboardRecord.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<LeaderboardRecord.Builder> implements LeaderboardRecordOrBuilder
 Represents a complete leaderboard record with all scores and associated metadata.
Protobuf type nakama.api.LeaderboardRecord

  • Method Details

    • 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.Builder<LeaderboardRecord.Builder>

    • clear

      public LeaderboardRecord.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.GeneratedMessageV3.Builder<LeaderboardRecord.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.GeneratedMessageV3.Builder<LeaderboardRecord.Builder>

    • getDefaultInstanceForType

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

    • build

      public LeaderboardRecord build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public LeaderboardRecord buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public LeaderboardRecord.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<LeaderboardRecord.Builder>

    • setField

      public LeaderboardRecord.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<LeaderboardRecord.Builder>

    • clearField

      public LeaderboardRecord.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<LeaderboardRecord.Builder>

    • clearOneof

      public LeaderboardRecord.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<LeaderboardRecord.Builder>

    • setRepeatedField

      public LeaderboardRecord.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<LeaderboardRecord.Builder>

    • addRepeatedField

      public LeaderboardRecord.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<LeaderboardRecord.Builder>

    • mergeFrom

      public LeaderboardRecord.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<LeaderboardRecord.Builder>

    • mergeFrom

      public LeaderboardRecord.Builder mergeFrom(LeaderboardRecord other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<LeaderboardRecord.Builder>

    • mergeFrom

      public LeaderboardRecord.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws 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<LeaderboardRecord.Builder>
      Throws:
      IOException

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

    • setLeaderboardId

      public LeaderboardRecord.Builder setLeaderboardId(String value)
       The ID of the leaderboard this score belongs to.
      string leaderboard_id = 1;
      Parameters:
      value - The leaderboardId to set.
      Returns:
      This builder for chaining.

    • clearLeaderboardId

      public LeaderboardRecord.Builder clearLeaderboardId()
       The ID of the leaderboard this score belongs to.
      string leaderboard_id = 1;
      Returns:
      This builder for chaining.

    • setLeaderboardIdBytes

      public LeaderboardRecord.Builder setLeaderboardIdBytes(com.google.protobuf.ByteString value)
       The ID of the leaderboard this score belongs to.
      string leaderboard_id = 1;
      Parameters:
      value - The bytes for leaderboardId to set.
      Returns:
      This builder for chaining.

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

    • setOwnerId

      public LeaderboardRecord.Builder setOwnerId(String value)
       The ID of the score owner, usually a user or group.
      string owner_id = 2;
      Parameters:
      value - The ownerId to set.
      Returns:
      This builder for chaining.

    • clearOwnerId

      public LeaderboardRecord.Builder clearOwnerId()
       The ID of the score owner, usually a user or group.
      string owner_id = 2;
      Returns:
      This builder for chaining.

    • setOwnerIdBytes

      public LeaderboardRecord.Builder setOwnerIdBytes(com.google.protobuf.ByteString value)
       The ID of the score owner, usually a user or group.
      string owner_id = 2;
      Parameters:
      value - The bytes for ownerId to set.
      Returns:
      This builder for chaining.

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

    • setUsername

      public LeaderboardRecord.Builder setUsername(StringValue value)
       The username of the score owner, if the owner is a user.
      .google.protobuf.StringValue username = 3;

    • setUsername

      public LeaderboardRecord.Builder setUsername(StringValue.Builder builderForValue)
       The username of the score owner, if the owner is a user.
      .google.protobuf.StringValue username = 3;

    • mergeUsername

      public LeaderboardRecord.Builder mergeUsername(StringValue value)
       The username of the score owner, if the owner is a user.
      .google.protobuf.StringValue username = 3;

    • clearUsername

      public LeaderboardRecord.Builder clearUsername()
       The username of the score owner, if the owner is a user.
      .google.protobuf.StringValue username = 3;

    • getUsernameBuilder

      public StringValue.Builder getUsernameBuilder()
       The username of the score owner, if the owner is a user.
      .google.protobuf.StringValue username = 3;

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

    • setScore

      public LeaderboardRecord.Builder setScore(long value)
       The score value.
      int64 score = 4;
      Parameters:
      value - The score to set.
      Returns:
      This builder for chaining.

    • clearScore

      public LeaderboardRecord.Builder clearScore()
       The score value.
      int64 score = 4;
      Returns:
      This builder for chaining.

    • getSubscore

      public long getSubscore()
       An optional subscore value.
      int64 subscore = 5;
      Specified by:
      getSubscore in interface LeaderboardRecordOrBuilder
      Returns:
      The subscore.

    • setSubscore

      public LeaderboardRecord.Builder setSubscore(long value)
       An optional subscore value.
      int64 subscore = 5;
      Parameters:
      value - The subscore to set.
      Returns:
      This builder for chaining.

    • clearSubscore

      public LeaderboardRecord.Builder clearSubscore()
       An optional subscore value.
      int64 subscore = 5;
      Returns:
      This builder for chaining.

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

    • setNumScore

      public LeaderboardRecord.Builder setNumScore(int value)
       The number of submissions to this score record.
      int32 num_score = 6;
      Parameters:
      value - The numScore to set.
      Returns:
      This builder for chaining.

    • clearNumScore

      public LeaderboardRecord.Builder clearNumScore()
       The number of submissions to this score record.
      int32 num_score = 6;
      Returns:
      This builder for chaining.

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

    • setMetadata

      public LeaderboardRecord.Builder setMetadata(String value)
       Metadata.
      string metadata = 7;
      Parameters:
      value - The metadata to set.
      Returns:
      This builder for chaining.

    • clearMetadata

      public LeaderboardRecord.Builder clearMetadata()
       Metadata.
      string metadata = 7;
      Returns:
      This builder for chaining.

    • setMetadataBytes

      public LeaderboardRecord.Builder setMetadataBytes(com.google.protobuf.ByteString value)
       Metadata.
      string metadata = 7;
      Parameters:
      value - The bytes for metadata to set.
      Returns:
      This builder for chaining.

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

    • setCreateTime

      public LeaderboardRecord.Builder setCreateTime(Timestamp value)
       The UNIX time when the leaderboard record was created.
      .google.protobuf.Timestamp create_time = 8;

    • setCreateTime

      public LeaderboardRecord.Builder setCreateTime(Timestamp.Builder builderForValue)
       The UNIX time when the leaderboard record was created.
      .google.protobuf.Timestamp create_time = 8;

    • mergeCreateTime

      public LeaderboardRecord.Builder mergeCreateTime(Timestamp value)
       The UNIX time when the leaderboard record was created.
      .google.protobuf.Timestamp create_time = 8;

    • clearCreateTime

      public LeaderboardRecord.Builder clearCreateTime()
       The UNIX time when the leaderboard record was created.
      .google.protobuf.Timestamp create_time = 8;

    • getCreateTimeBuilder

      public Timestamp.Builder getCreateTimeBuilder()
       The UNIX time when the leaderboard record was created.
      .google.protobuf.Timestamp create_time = 8;

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

    • setUpdateTime

      public LeaderboardRecord.Builder setUpdateTime(Timestamp value)
       The UNIX time when the leaderboard record was updated.
      .google.protobuf.Timestamp update_time = 9;

    • setUpdateTime

      public LeaderboardRecord.Builder setUpdateTime(Timestamp.Builder builderForValue)
       The UNIX time when the leaderboard record was updated.
      .google.protobuf.Timestamp update_time = 9;

    • mergeUpdateTime

      public LeaderboardRecord.Builder mergeUpdateTime(Timestamp value)
       The UNIX time when the leaderboard record was updated.
      .google.protobuf.Timestamp update_time = 9;

    • clearUpdateTime

      public LeaderboardRecord.Builder clearUpdateTime()
       The UNIX time when the leaderboard record was updated.
      .google.protobuf.Timestamp update_time = 9;

    • getUpdateTimeBuilder

      public Timestamp.Builder getUpdateTimeBuilder()
       The UNIX time when the leaderboard record was updated.
      .google.protobuf.Timestamp update_time = 9;

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

    • setExpiryTime

      public LeaderboardRecord.Builder setExpiryTime(Timestamp value)
       The UNIX time when the leaderboard record expires.
      .google.protobuf.Timestamp expiry_time = 10;

    • setExpiryTime

      public LeaderboardRecord.Builder setExpiryTime(Timestamp.Builder builderForValue)
       The UNIX time when the leaderboard record expires.
      .google.protobuf.Timestamp expiry_time = 10;

    • mergeExpiryTime

      public LeaderboardRecord.Builder mergeExpiryTime(Timestamp value)
       The UNIX time when the leaderboard record expires.
      .google.protobuf.Timestamp expiry_time = 10;

    • clearExpiryTime

      public LeaderboardRecord.Builder clearExpiryTime()
       The UNIX time when the leaderboard record expires.
      .google.protobuf.Timestamp expiry_time = 10;

    • getExpiryTimeBuilder

      public Timestamp.Builder getExpiryTimeBuilder()
       The UNIX time when the leaderboard record expires.
      .google.protobuf.Timestamp expiry_time = 10;

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

    • setRank

      public LeaderboardRecord.Builder setRank(long value)
       The rank of this record.
      int64 rank = 11;
      Parameters:
      value - The rank to set.
      Returns:
      This builder for chaining.

    • clearRank

      public LeaderboardRecord.Builder clearRank()
       The rank of this record.
      int64 rank = 11;
      Returns:
      This builder for chaining.

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

    • setMaxNumScore

      public LeaderboardRecord.Builder setMaxNumScore(int value)
       The maximum number of score updates allowed by the owner.
      uint32 max_num_score = 12;
      Parameters:
      value - The maxNumScore to set.
      Returns:
      This builder for chaining.

    • clearMaxNumScore

      public LeaderboardRecord.Builder clearMaxNumScore()
       The maximum number of score updates allowed by the owner.
      uint32 max_num_score = 12;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final LeaderboardRecord.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<LeaderboardRecord.Builder>

    • mergeUnknownFields

      public final LeaderboardRecord.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<LeaderboardRecord.Builder>