grpc.leaderboard

Class LeaderboardGrpc.LeaderboardStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractAsyncStub<LeaderboardGrpc.LeaderboardStub>

grpc.leaderboard.LeaderboardGrpc.LeaderboardStub

Enclosing class:

LeaderboardGrpc

public static final class LeaderboardGrpc.LeaderboardStub
extends io.grpc.stub.AbstractAsyncStub<LeaderboardGrpc.LeaderboardStub>

 Like a sorted set, but for leaderboards!
 Elements in a leaderboard are keyed by an ID, which is an unsigned 64 bit integer.
 Scores are single-precision floating point numbers.
 Each ID can have only 1 score.
 For batchy, multi-element apis, limits are 8192 elements per api call.
 Scores are IEEE 754 single-precision floating point numbers. This has a few
 implications you should be aware of, but the one most likely to affect you is that
 below -16777216 and above 16777216, not all integers are able to be represented.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected LeaderboardGrpc.LeaderboardStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
void	deleteLeaderboard(_DeleteLeaderboardRequest request, io.grpc.stub.StreamObserver<_Empty> responseObserver) Deletes a leaderboard.
void	getByRank(_GetByRankRequest request, io.grpc.stub.StreamObserver<_GetByRankResponse> responseObserver) Get a range of elements.
void	getByScore(_GetByScoreRequest request, io.grpc.stub.StreamObserver<_GetByScoreResponse> responseObserver) Get a range of elements by a score range.
void	getLeaderboardLength(_GetLeaderboardLengthRequest request, io.grpc.stub.StreamObserver<_GetLeaderboardLengthResponse> responseObserver) Returns the length of a leaderboard in terms of ID count.
void	getRank(_GetRankRequest request, io.grpc.stub.StreamObserver<_GetRankResponse> responseObserver) Get the rank of a list of particular ids in the leaderboard.
void	removeElements(_RemoveElementsRequest request, io.grpc.stub.StreamObserver<_Empty> responseObserver) Remove up to 8192 elements at a time from a leaderboard.
void	upsertElements(_UpsertElementsRequest request, io.grpc.stub.StreamObserver<_Empty> responseObserver) Insert or update elements in a leaderboard.

Methods inherited from class io.grpc.stub.AbstractAsyncStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected LeaderboardGrpc.LeaderboardStub build(io.grpc.Channel channel,
                                                io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<LeaderboardGrpc.LeaderboardStub>

deleteLeaderboard

public void deleteLeaderboard(_DeleteLeaderboardRequest request,
                              io.grpc.stub.StreamObserver<_Empty> responseObserver)

 Deletes a leaderboard. After this call, you're not incurring storage cost for this leaderboard anymore.
 

upsertElements

public void upsertElements(_UpsertElementsRequest request,
                           io.grpc.stub.StreamObserver<_Empty> responseObserver)

 Insert or update elements in a leaderboard. You can do up to 8192 elements per call.
 There is no partial failure: Upsert succeeds or fails.
 

removeElements

public void removeElements(_RemoveElementsRequest request,
                           io.grpc.stub.StreamObserver<_Empty> responseObserver)

 Remove up to 8192 elements at a time from a leaderboard. Elements are removed by id.
 

getLeaderboardLength

public void getLeaderboardLength(_GetLeaderboardLengthRequest request,
                                 io.grpc.stub.StreamObserver<_GetLeaderboardLengthResponse> responseObserver)

 Returns the length of a leaderboard in terms of ID count. 
 

getByRank

public void getByRank(_GetByRankRequest request,
                      io.grpc.stub.StreamObserver<_GetByRankResponse> responseObserver)

 Get a range of elements.
 * Ordinal, 0-based rank.
 * Range can span up to 8192 elements.
 See RankRange for details about permissible ranges.
 

getRank

public void getRank(_GetRankRequest request,
                    io.grpc.stub.StreamObserver<_GetRankResponse> responseObserver)

 Get the rank of a list of particular ids in the leaderboard.
 * Ordinal, 0-based rank.
 

getByScore

public void getByScore(_GetByScoreRequest request,
                       io.grpc.stub.StreamObserver<_GetByScoreResponse> responseObserver)

 Get a range of elements by a score range.
 * Ordinal, 0-based rank.
 You can request up to 8192 elements at a time. To page through many elements that all
 fall into a score range you can repeatedly invoke this api with the offset parameter.