com.heroiclabs.nakama.api

Class ListLeaderboardRecordsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

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, java.io.Serializable

public final class ListLeaderboardRecordsRequest
extends com.google.protobuf.GeneratedMessage
implements ListLeaderboardRecordsRequestOrBuilder

 List leaderboard records from a given leaderboard.
 

Protobuf type nakama.api.ListLeaderboardRecordsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListLeaderboardRecordsRequest.Builder List leaderboard records from a given leaderboard.

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	CURSOR_FIELD_NUMBER
static int	EXPIRY_FIELD_NUMBER
static int	LEADERBOARD_ID_FIELD_NUMBER
static int	LIMIT_FIELD_NUMBER
static int	OWNER_IDS_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)
java.lang.String	getCursor() A next or previous page cursor.
com.google.protobuf.ByteString	getCursorBytes() A next or previous page cursor.
static ListLeaderboardRecordsRequest	getDefaultInstance()
ListLeaderboardRecordsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Int64Value	getExpiry() Expiry in seconds (since epoch) to begin fetching records from.
com.google.protobuf.Int64ValueOrBuilder	getExpiryOrBuilder() Expiry in seconds (since epoch) to begin fetching records from.
java.lang.String	getLeaderboardId() The ID of the leaderboard to list for.
com.google.protobuf.ByteString	getLeaderboardIdBytes() The ID of the leaderboard to list for.
com.google.protobuf.Int32Value	getLimit() Max number of records to return.
com.google.protobuf.Int32ValueOrBuilder	getLimitOrBuilder() Max number of records to return.
java.lang.String	getOwnerIds(int index) One or more owners to retrieve records for.
com.google.protobuf.ByteString	getOwnerIdsBytes(int index) One or more owners to retrieve records for.
int	getOwnerIdsCount() One or more owners to retrieve records for.
com.google.protobuf.ProtocolStringList	getOwnerIdsList() One or more owners to retrieve records for.
com.google.protobuf.Parser<ListLeaderboardRecordsRequest>	getParserForType()
int	getSerializedSize()
boolean	hasExpiry() Expiry in seconds (since epoch) to begin fetching records from.
int	hashCode()
boolean	hasLimit() Max number of records to return.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ListLeaderboardRecordsRequest.Builder	newBuilder()
static ListLeaderboardRecordsRequest.Builder	newBuilder(ListLeaderboardRecordsRequest prototype)
ListLeaderboardRecordsRequest.Builder	newBuilderForType()
protected ListLeaderboardRecordsRequest.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static ListLeaderboardRecordsRequest	parseDelimitedFrom(java.io.InputStream input)
static ListLeaderboardRecordsRequest	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListLeaderboardRecordsRequest	parseFrom(byte[] data)
static ListLeaderboardRecordsRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListLeaderboardRecordsRequest	parseFrom(java.nio.ByteBuffer data)
static ListLeaderboardRecordsRequest	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListLeaderboardRecordsRequest	parseFrom(com.google.protobuf.ByteString data)
static ListLeaderboardRecordsRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListLeaderboardRecordsRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static ListLeaderboardRecordsRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListLeaderboardRecordsRequest	parseFrom(java.io.InputStream input)
static ListLeaderboardRecordsRequest	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ListLeaderboardRecordsRequest>	parser()
ListLeaderboardRecordsRequest.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_IDS_FIELD_NUMBER

public static final int OWNER_IDS_FIELD_NUMBER

See Also:

Constant Field Values

LIMIT_FIELD_NUMBER

public static final int LIMIT_FIELD_NUMBER

See Also:

Constant Field Values

CURSOR_FIELD_NUMBER

public static final int CURSOR_FIELD_NUMBER

See Also:

Constant Field Values

EXPIRY_FIELD_NUMBER

public static final int EXPIRY_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 to list for.
 

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

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 [json_name = "leaderboardId"];

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 [json_name = "ownerIds"];

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 [json_name = "ownerIds"];

Specified by:

getOwnerIdsCount in interface ListLeaderboardRecordsRequestOrBuilder

Returns:

The count of ownerIds.

getOwnerIds

public java.lang.String getOwnerIds(int index)

 One or more owners to retrieve records for.
 

repeated string owner_ids = 2 [json_name = "ownerIds"];

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 [json_name = "ownerIds"];

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 [json_name = "limit"];

Specified by:

hasLimit in interface ListLeaderboardRecordsRequestOrBuilder

Returns:

Whether the limit field is set.

getLimit

public com.google.protobuf.Int32Value getLimit()

 Max number of records to return. Between 1 and 100.
 

.google.protobuf.Int32Value limit = 3 [json_name = "limit"];

Specified by:

getLimit in interface ListLeaderboardRecordsRequestOrBuilder

Returns:

The limit.

getLimitOrBuilder

public com.google.protobuf.Int32ValueOrBuilder getLimitOrBuilder()

 Max number of records to return. Between 1 and 100.
 

.google.protobuf.Int32Value limit = 3 [json_name = "limit"];

Specified by:

getLimitOrBuilder in interface ListLeaderboardRecordsRequestOrBuilder

getCursor

public java.lang.String getCursor()

 A next or previous page cursor.
 

string cursor = 4 [json_name = "cursor"];

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 [json_name = "cursor"];

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 [json_name = "expiry"];

Specified by:

hasExpiry in interface ListLeaderboardRecordsRequestOrBuilder

Returns:

Whether the expiry field is set.

getExpiry

public com.google.protobuf.Int64Value getExpiry()

 Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.
 

.google.protobuf.Int64Value expiry = 5 [json_name = "expiry"];

Specified by:

getExpiry in interface ListLeaderboardRecordsRequestOrBuilder

Returns:

The expiry.

getExpiryOrBuilder

public com.google.protobuf.Int64ValueOrBuilder getExpiryOrBuilder()

 Expiry in seconds (since epoch) to begin fetching records from. Optional. 0 means from current time.
 

.google.protobuf.Int64Value expiry = 5 [json_name = "expiry"];

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListLeaderboardRecordsRequest parseFrom(java.nio.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(java.io.InputStream input)
                                               throws java.io.IOException

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.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.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

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

getDefaultInstanceForType

public ListLeaderboardRecordsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder