Package com.heroiclabs.nakama.api

Class ListLeaderboardRecordsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.heroiclabs.nakama.api.ListLeaderboardRecordsRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ListLeaderboardRecordsRequestOrBuilder, Serializable
public final class ListLeaderboardRecordsRequest extends com.google.protobuf.GeneratedMessageV3 implements ListLeaderboardRecordsRequestOrBuilder
 List leaderboard records from a given leaderboard.
Protobuf type nakama.api.ListLeaderboardRecordsRequest
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 to list for.
      string leaderboard_id = 1;
      Specified by:
      getLeaderboardId in interface ListLeaderboardRecordsRequestOrBuilder
      Returns:
      The leaderboardId.

    • getLeaderboardIdBytes

      public com.google.protobuf.ByteString getLeaderboardIdBytes()
       The ID of the leaderboard to list for.
      string leaderboard_id = 1;
      Specified by:
      getLeaderboardIdBytes in interface ListLeaderboardRecordsRequestOrBuilder
      Returns:
      The bytes for leaderboardId.

    • getOwnerIdsList

      public com.google.protobuf.ProtocolStringList getOwnerIdsList()
       One or more owners to retrieve records for.
      repeated string owner_ids = 2;
      Specified by:
      getOwnerIdsList in interface ListLeaderboardRecordsRequestOrBuilder
      Returns:
      A list containing the ownerIds.

    • getOwnerIdsCount

      public int getOwnerIdsCount()
       One or more owners to retrieve records for.
      repeated string owner_ids = 2;
      Specified by:
      getOwnerIdsCount in interface ListLeaderboardRecordsRequestOrBuilder
      Returns:
      The count of ownerIds.

    • getOwnerIds

      public String getOwnerIds(int index)
       One or more owners to retrieve records for.
      repeated string owner_ids = 2;
      Specified by:
      getOwnerIds in interface ListLeaderboardRecordsRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The ownerIds at the given index.

    • getOwnerIdsBytes

      public com.google.protobuf.ByteString getOwnerIdsBytes(int index)
       One or more owners to retrieve records for.
      repeated string owner_ids = 2;
      Specified by:
      getOwnerIdsBytes in interface ListLeaderboardRecordsRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the ownerIds at the given index.

    • hasLimit

      public boolean hasLimit()
       Max number of records to return. Between 1 and 100.
      .google.protobuf.Int32Value limit = 3;
      Specified by:
      hasLimit in interface ListLeaderboardRecordsRequestOrBuilder
      Returns:
      Whether the limit field is set.

    • getLimit

      public Int32Value getLimit()
       Max number of records to return. Between 1 and 100.
      .google.protobuf.Int32Value limit = 3;
      Specified by:
      getLimit in interface ListLeaderboardRecordsRequestOrBuilder
      Returns:
      The limit.

    • getLimitOrBuilder

      public Int32ValueOrBuilder getLimitOrBuilder()
       Max number of records to return. Between 1 and 100.
      .google.protobuf.Int32Value limit = 3;
      Specified by:
      getLimitOrBuilder in interface ListLeaderboardRecordsRequestOrBuilder

    • getCursor

      public String getCursor()
       A next or previous page cursor.
      string cursor = 4;
      Specified by:
      getCursor in interface ListLeaderboardRecordsRequestOrBuilder
      Returns:
      The cursor.

    • getCursorBytes

      public com.google.protobuf.ByteString getCursorBytes()
       A next or previous page cursor.
      string cursor = 4;
      Specified by:
      getCursorBytes in interface ListLeaderboardRecordsRequestOrBuilder
      Returns:
      The bytes for cursor.

    • hasExpiry

      public boolean hasExpiry()
       Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.
      .google.protobuf.Int64Value expiry = 5;
      Specified by:
      hasExpiry in interface ListLeaderboardRecordsRequestOrBuilder
      Returns:
      Whether the expiry field is set.

    • getExpiry

      public Int64Value getExpiry()
       Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.
      .google.protobuf.Int64Value expiry = 5;
      Specified by:
      getExpiry in interface ListLeaderboardRecordsRequestOrBuilder
      Returns:
      The expiry.

    • getExpiryOrBuilder

      public Int64ValueOrBuilder getExpiryOrBuilder()
       Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.
      .google.protobuf.Int64Value expiry = 5;
      Specified by:
      getExpiryOrBuilder in interface ListLeaderboardRecordsRequestOrBuilder

    • 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 ListLeaderboardRecordsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListLeaderboardRecordsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListLeaderboardRecordsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static ListLeaderboardRecordsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static ListLeaderboardRecordsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

      public ListLeaderboardRecordsRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ListLeaderboardRecordsRequest.Builder newBuilder()

    • newBuilder

      public static ListLeaderboardRecordsRequest.Builder newBuilder(ListLeaderboardRecordsRequest prototype)

    • toBuilder

      public ListLeaderboardRecordsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ListLeaderboardRecordsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ListLeaderboardRecordsRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ListLeaderboardRecordsRequest> 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 ListLeaderboardRecordsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder