agones-python-sdk

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

• API version: version not set
• Package version: 1.0.0
• Generator version: 7.12.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import agones_python_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import agones_python_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import agones_python_sdk
from agones_python_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = agones_python_sdk.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with agones_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = agones_python_sdk.SDKApi(api_client)
    body = None # object | 

    try:
        # Call to self Allocation the GameServer
        api_response = api_instance.allocate(body)
        print("The response of SDKApi->allocate:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SDKApi->allocate: %s\n" % e)

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	get_game_server	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	set_annotation	PUT /metadata/annotation	Apply a Annotation to the backing GameServer metadata
SDKApi	set_label	PUT /metadata/label	Apply a Label to the backing GameServer metadata
SDKApi	shutdown	POST /shutdown	Call when the GameServer is shutting down
SDKApi	watch_game_server	GET /watch/gameserver	Send GameServer details whenever the GameServer is updated

Documentation For Models

• GameServerObjectMeta
• GameServerSpec
• GameServerSpecHealth
• GooglerpcStatus
• ProtobufAny
• SdkDuration
• SdkGameServer
• SdkGameServerStatus
• SdkKeyValue
• StatusAddress
• StatusCounterStatus
• StatusListStatus
• StatusPlayerStatus
• StatusPort
• StreamResultOfSdkGameServer

Documentation For Authorization

Endpoints do not require authorization.

Author