agones_python_sdk.SDKApi

All URIs are relative to http://localhost

Method	HTTP request	Description
allocate	POST /allocate	Call to self Allocation the GameServer
get_game_server	GET /gameserver	Retrieve the current GameServer data
health	POST /health	Send a Empty every d Duration to declare that this GameSever is healthy
ready	POST /ready	Call when the GameServer is ready
reserve	POST /reserve	Marks the GameServer as the Reserved state for Duration
set_annotation	PUT /metadata/annotation	Apply a Annotation to the backing GameServer metadata
set_label	PUT /metadata/label	Apply a Label to the backing GameServer metadata
shutdown	POST /shutdown	Call when the GameServer is shutting down
watch_game_server	GET /watch/gameserver	Send GameServer details whenever the GameServer is updated

allocate

object allocate(body)

Call to self Allocation the GameServer

Example

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 Exception as e:
        print("Exception when calling SDKApi->allocate: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	object

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_game_server

SdkGameServer get_game_server()

Retrieve the current GameServer data

Example

import agones_python_sdk
from agones_python_sdk.models.sdk_game_server import SdkGameServer
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)

    try:
        # Retrieve the current GameServer data
        api_response = api_instance.get_game_server()
        print("The response of SDKApi->get_game_server:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SDKApi->get_game_server: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

SdkGameServer

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

health

object health(body)

Send a Empty every d Duration to declare that this GameSever is healthy

Example

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 |  (streaming inputs)

    try:
        # Send a Empty every d Duration to declare that this GameSever is healthy
        api_response = api_instance.health(body)
        print("The response of SDKApi->health:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SDKApi->health: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	object	(streaming inputs)

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ready

object ready(body)

Call when the GameServer is ready

Example

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 when the GameServer is ready
        api_response = api_instance.ready(body)
        print("The response of SDKApi->ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SDKApi->ready: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	object

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reserve

object reserve(body)

Marks the GameServer as the Reserved state for Duration

Example

import agones_python_sdk
from agones_python_sdk.models.sdk_duration import SdkDuration
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 = agones_python_sdk.SdkDuration() # SdkDuration | 

    try:
        # Marks the GameServer as the Reserved state for Duration
        api_response = api_instance.reserve(body)
        print("The response of SDKApi->reserve:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SDKApi->reserve: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	SdkDuration

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_annotation

object set_annotation(body)

Apply a Annotation to the backing GameServer metadata

Example

import agones_python_sdk
from agones_python_sdk.models.sdk_key_value import SdkKeyValue
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 = agones_python_sdk.SdkKeyValue() # SdkKeyValue | 

    try:
        # Apply a Annotation to the backing GameServer metadata
        api_response = api_instance.set_annotation(body)
        print("The response of SDKApi->set_annotation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SDKApi->set_annotation: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	SdkKeyValue

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_label

object set_label(body)

Apply a Label to the backing GameServer metadata

Example

import agones_python_sdk
from agones_python_sdk.models.sdk_key_value import SdkKeyValue
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 = agones_python_sdk.SdkKeyValue() # SdkKeyValue | 

    try:
        # Apply a Label to the backing GameServer metadata
        api_response = api_instance.set_label(body)
        print("The response of SDKApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SDKApi->set_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	SdkKeyValue

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

shutdown

object shutdown(body)

Call when the GameServer is shutting down

Example

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 when the GameServer is shutting down
        api_response = api_instance.shutdown(body)
        print("The response of SDKApi->shutdown:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SDKApi->shutdown: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	object

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

watch_game_server

StreamResultOfSdkGameServer watch_game_server()

Send GameServer details whenever the GameServer is updated

Example

import agones_python_sdk
from agones_python_sdk.models.stream_result_of_sdk_game_server import StreamResultOfSdkGameServer
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)

    try:
        # Send GameServer details whenever the GameServer is updated
        api_response = api_instance.watch_game_server()
        print("The response of SDKApi->watch_game_server:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SDKApi->watch_game_server: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

StreamResultOfSdkGameServer

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.(streaming responses)	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

SDKApi.md

Latest commit

History

SDKApi.md

File metadata and controls

agones_python_sdk.SDKApi

allocate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_game_server

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

health

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ready

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

reserve

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

set_annotation

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

set_label

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

shutdown

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

watch_game_server

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details