io.github.jakob.AgonesClient - Kotlin client library for sdk.proto
Requires
- Kotlin 1.3.41
- Gradle 4.9
Build
First, create the gradle wrapper script:
gradle wrapper
Then, run:
./gradlew check assemble
This runs all tests and packages the library.
Features/Implementation Notes
- Supports JSON inputs/outputs, File inputs, and Form inputs.
- Supports collection formats for query parameters: csv, tsv, ssv, pipes.
- Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.
- Implementation of ApiClient is intended to reduce method counts, specifically to benefit Android targets.
Documentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
SDKApi | allocate | POST /allocate | Call to self Allocation the GameServer |
SDKApi | getGameServer | GET /gameserver | Retrieve the current GameServer data |
SDKApi | health | POST /health | Send a Empty every d Duration to declare that this GameSever is healthy |
SDKApi | ready | POST /ready | Call when the GameServer is ready |
SDKApi | reserve | POST /reserve | Marks the GameServer as the Reserved state for Duration |
SDKApi | setAnnotation | PUT /metadata/annotation | Apply a Annotation to the backing GameServer metadata |
SDKApi | setLabel | PUT /metadata/label | Apply a Label to the backing GameServer metadata |
SDKApi | shutdown | POST /shutdown | Call when the GameServer is shutting down |
SDKApi | watchGameServer | GET /watch/gameserver | Send GameServer details whenever the GameServer is updated |
Documentation for Models
- io.github.jakob.AgonesClient.models.GameServerObjectMeta
- io.github.jakob.AgonesClient.models.GameServerSpec
- io.github.jakob.AgonesClient.models.GameServerStatus
- io.github.jakob.AgonesClient.models.ProtobufAny
- io.github.jakob.AgonesClient.models.RuntimeStreamError
- io.github.jakob.AgonesClient.models.SdkDuration
- io.github.jakob.AgonesClient.models.SdkGameServer
- io.github.jakob.AgonesClient.models.SdkKeyValue
- io.github.jakob.AgonesClient.models.SpecHealth
- io.github.jakob.AgonesClient.models.StatusPlayerStatus
- io.github.jakob.AgonesClient.models.StatusPort
Documentation for Authorization
All endpoints do not require authorization.