Package com.heroiclabs.nakama.api

Class ListLeaderboardRecordsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderType>
com.google.protobuf.GeneratedMessageV3.Builder<ListLeaderboardRecordsRequest.Builder>
com.heroiclabs.nakama.api.ListLeaderboardRecordsRequest.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ListLeaderboardRecordsRequestOrBuilder, Cloneable
Enclosing class:
ListLeaderboardRecordsRequest
public static final class ListLeaderboardRecordsRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ListLeaderboardRecordsRequest.Builder> implements ListLeaderboardRecordsRequestOrBuilder
 List leaderboard records from a given leaderboard.
Protobuf type nakama.api.ListLeaderboardRecordsRequest

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public ListLeaderboardRecordsRequest.Builder mergeFrom(ListLeaderboardRecordsRequest other)

    • isInitialized

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

    • mergeFrom

      public ListLeaderboardRecordsRequest.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<ListLeaderboardRecordsRequest.Builder>
      Throws:
      IOException

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

    • setLeaderboardId

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

    • clearLeaderboardId

      public ListLeaderboardRecordsRequest.Builder clearLeaderboardId()
       The ID of the leaderboard to list for.
      string leaderboard_id = 1;
      Returns:
      This builder for chaining.

    • setLeaderboardIdBytes

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

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

    • setOwnerIds

      public ListLeaderboardRecordsRequest.Builder setOwnerIds(int index, String value)
       One or more owners to retrieve records for.
      repeated string owner_ids = 2;
      Parameters:
      index - The index to set the value at.
      value - The ownerIds to set.
      Returns:
      This builder for chaining.

    • addOwnerIds

      public ListLeaderboardRecordsRequest.Builder addOwnerIds(String value)
       One or more owners to retrieve records for.
      repeated string owner_ids = 2;
      Parameters:
      value - The ownerIds to add.
      Returns:
      This builder for chaining.

    • addAllOwnerIds

      public ListLeaderboardRecordsRequest.Builder addAllOwnerIds(Iterable<String> values)
       One or more owners to retrieve records for.
      repeated string owner_ids = 2;
      Parameters:
      values - The ownerIds to add.
      Returns:
      This builder for chaining.

    • clearOwnerIds

      public ListLeaderboardRecordsRequest.Builder clearOwnerIds()
       One or more owners to retrieve records for.
      repeated string owner_ids = 2;
      Returns:
      This builder for chaining.

    • addOwnerIdsBytes

      public ListLeaderboardRecordsRequest.Builder addOwnerIdsBytes(com.google.protobuf.ByteString value)
       One or more owners to retrieve records for.
      repeated string owner_ids = 2;
      Parameters:
      value - The bytes of the ownerIds to add.
      Returns:
      This builder for chaining.

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

    • setLimit

      public ListLeaderboardRecordsRequest.Builder setLimit(Int32Value value)
       Max number of records to return. Between 1 and 100.
      .google.protobuf.Int32Value limit = 3;

    • setLimit

      public ListLeaderboardRecordsRequest.Builder setLimit(Int32Value.Builder builderForValue)
       Max number of records to return. Between 1 and 100.
      .google.protobuf.Int32Value limit = 3;

    • mergeLimit

      public ListLeaderboardRecordsRequest.Builder mergeLimit(Int32Value value)
       Max number of records to return. Between 1 and 100.
      .google.protobuf.Int32Value limit = 3;

    • clearLimit

      public ListLeaderboardRecordsRequest.Builder clearLimit()
       Max number of records to return. Between 1 and 100.
      .google.protobuf.Int32Value limit = 3;

    • getLimitBuilder

      public Int32Value.Builder getLimitBuilder()
       Max number of records to return. Between 1 and 100.
      .google.protobuf.Int32Value limit = 3;

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

    • setCursor

      public ListLeaderboardRecordsRequest.Builder setCursor(String value)
       A next or previous page cursor.
      string cursor = 4;
      Parameters:
      value - The cursor to set.
      Returns:
      This builder for chaining.

    • clearCursor

      public ListLeaderboardRecordsRequest.Builder clearCursor()
       A next or previous page cursor.
      string cursor = 4;
      Returns:
      This builder for chaining.

    • setCursorBytes

      public ListLeaderboardRecordsRequest.Builder setCursorBytes(com.google.protobuf.ByteString value)
       A next or previous page cursor.
      string cursor = 4;
      Parameters:
      value - The bytes for cursor to set.
      Returns:
      This builder for chaining.

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

    • setExpiry

      public ListLeaderboardRecordsRequest.Builder setExpiry(Int64Value value)
       Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.
      .google.protobuf.Int64Value expiry = 5;

    • setExpiry

      public ListLeaderboardRecordsRequest.Builder setExpiry(Int64Value.Builder builderForValue)
       Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.
      .google.protobuf.Int64Value expiry = 5;

    • mergeExpiry

      public ListLeaderboardRecordsRequest.Builder mergeExpiry(Int64Value value)
       Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.
      .google.protobuf.Int64Value expiry = 5;

    • clearExpiry

      public ListLeaderboardRecordsRequest.Builder clearExpiry()
       Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.
      .google.protobuf.Int64Value expiry = 5;

    • getExpiryBuilder

      public Int64Value.Builder getExpiryBuilder()
       Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.
      .google.protobuf.Int64Value expiry = 5;

    • 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

    • setUnknownFields

      public final ListLeaderboardRecordsRequest.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<ListLeaderboardRecordsRequest.Builder>

    • mergeUnknownFields

      public final ListLeaderboardRecordsRequest.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<ListLeaderboardRecordsRequest.Builder>