com.heroiclabs.nakama.api

Class ListLeaderboardRecordsRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.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, java.lang.Cloneable

Enclosing class:

ListLeaderboardRecordsRequest

public static final class ListLeaderboardRecordsRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ListLeaderboardRecordsRequest.Builder>
implements ListLeaderboardRecordsRequestOrBuilder

 List leaderboard records from a given leaderboard.
 

Protobuf type nakama.api.ListLeaderboardRecordsRequest

Method Summary

Modifier and Type	Method and Description
ListLeaderboardRecordsRequest.Builder	addAllOwnerIds(java.lang.Iterable<java.lang.String> values) One or more owners to retrieve records for.
ListLeaderboardRecordsRequest.Builder	addOwnerIds(java.lang.String value) One or more owners to retrieve records for.
ListLeaderboardRecordsRequest.Builder	addOwnerIdsBytes(com.google.protobuf.ByteString value) One or more owners to retrieve records for.
ListLeaderboardRecordsRequest	build()
ListLeaderboardRecordsRequest	buildPartial()
ListLeaderboardRecordsRequest.Builder	clear()
ListLeaderboardRecordsRequest.Builder	clearCursor() A next or previous page cursor.
ListLeaderboardRecordsRequest.Builder	clearExpiry() Expiry in seconds (since epoch) to begin fetching records from.
ListLeaderboardRecordsRequest.Builder	clearLeaderboardId() The ID of the leaderboard to list for.
ListLeaderboardRecordsRequest.Builder	clearLimit() Max number of records to return.
ListLeaderboardRecordsRequest.Builder	clearOwnerIds() One or more owners to retrieve records for.
java.lang.String	getCursor() A next or previous page cursor.
com.google.protobuf.ByteString	getCursorBytes() A next or previous page cursor.
ListLeaderboardRecordsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
com.google.protobuf.Int64Value	getExpiry() Expiry in seconds (since epoch) to begin fetching records from.
com.google.protobuf.Int64Value.Builder	getExpiryBuilder() 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.Int32Value.Builder	getLimitBuilder() 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.
boolean	hasExpiry() Expiry in seconds (since epoch) to begin fetching records from.
boolean	hasLimit() Max number of records to return.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ListLeaderboardRecordsRequest.Builder	mergeExpiry(com.google.protobuf.Int64Value value) Expiry in seconds (since epoch) to begin fetching records from.
ListLeaderboardRecordsRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ListLeaderboardRecordsRequest.Builder	mergeFrom(ListLeaderboardRecordsRequest other)
ListLeaderboardRecordsRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ListLeaderboardRecordsRequest.Builder	mergeLimit(com.google.protobuf.Int32Value value) Max number of records to return.
ListLeaderboardRecordsRequest.Builder	setCursor(java.lang.String value) A next or previous page cursor.
ListLeaderboardRecordsRequest.Builder	setCursorBytes(com.google.protobuf.ByteString value) A next or previous page cursor.
ListLeaderboardRecordsRequest.Builder	setExpiry(com.google.protobuf.Int64Value.Builder builderForValue) Expiry in seconds (since epoch) to begin fetching records from.
ListLeaderboardRecordsRequest.Builder	setExpiry(com.google.protobuf.Int64Value value) Expiry in seconds (since epoch) to begin fetching records from.
ListLeaderboardRecordsRequest.Builder	setLeaderboardId(java.lang.String value) The ID of the leaderboard to list for.
ListLeaderboardRecordsRequest.Builder	setLeaderboardIdBytes(com.google.protobuf.ByteString value) The ID of the leaderboard to list for.
ListLeaderboardRecordsRequest.Builder	setLimit(com.google.protobuf.Int32Value.Builder builderForValue) Max number of records to return.
ListLeaderboardRecordsRequest.Builder	setLimit(com.google.protobuf.Int32Value value) Max number of records to return.
ListLeaderboardRecordsRequest.Builder	setOwnerIds(int index, java.lang.String value) One or more owners to retrieve records for.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

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

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

mergeFrom

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

java.io.IOException

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.

setLeaderboardId

public ListLeaderboardRecordsRequest.Builder setLeaderboardId(java.lang.String value)

 The ID of the leaderboard to list for.
 

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

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

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

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

setOwnerIds

public ListLeaderboardRecordsRequest.Builder setOwnerIds(int index,
                                                         java.lang.String value)

 One or more owners to retrieve records for.
 

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

Parameters:

index - The index to set the value at.

value - The ownerIds to set.

Returns:

This builder for chaining.

addOwnerIds

public ListLeaderboardRecordsRequest.Builder addOwnerIds(java.lang.String value)

 One or more owners to retrieve records for.
 

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

Parameters:

value - The ownerIds to add.

Returns:

This builder for chaining.

addAllOwnerIds

public ListLeaderboardRecordsRequest.Builder addAllOwnerIds(java.lang.Iterable<java.lang.String> values)

 One or more owners to retrieve records for.
 

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

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

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

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

setLimit

public ListLeaderboardRecordsRequest.Builder setLimit(com.google.protobuf.Int32Value value)

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

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

setLimit

public ListLeaderboardRecordsRequest.Builder setLimit(com.google.protobuf.Int32Value.Builder builderForValue)

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

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

mergeLimit

public ListLeaderboardRecordsRequest.Builder mergeLimit(com.google.protobuf.Int32Value value)

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

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

clearLimit

public ListLeaderboardRecordsRequest.Builder clearLimit()

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

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

getLimitBuilder

public com.google.protobuf.Int32Value.Builder getLimitBuilder()

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

.google.protobuf.Int32Value limit = 3 [json_name = "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.

setCursor

public ListLeaderboardRecordsRequest.Builder setCursor(java.lang.String value)

 A next or previous page cursor.
 

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

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

Returns:

This builder for chaining.

setCursorBytes

public ListLeaderboardRecordsRequest.Builder setCursorBytes(com.google.protobuf.ByteString value)

 A next or previous page cursor.
 

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

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

setExpiry

public ListLeaderboardRecordsRequest.Builder setExpiry(com.google.protobuf.Int64Value value)

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

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

setExpiry

public ListLeaderboardRecordsRequest.Builder setExpiry(com.google.protobuf.Int64Value.Builder builderForValue)

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

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

mergeExpiry

public ListLeaderboardRecordsRequest.Builder mergeExpiry(com.google.protobuf.Int64Value value)

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

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

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

getExpiryBuilder

public com.google.protobuf.Int64Value.Builder getExpiryBuilder()

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

.google.protobuf.Int64Value expiry = 5 [json_name = "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