Class ServerInstanceService

Class ServerInstanceService#

Inheritance Relationships#

Base Type#

Class Documentation#

class xbe.sdk.Services.ServerInstanceService : xbe.sdk.ServiceBase#

Public Functions

ServerInstanceService ()#
Task<ServerInstance> Assign (AssignServerInstance obj)#

Request a server instance assignment.

Return:

A task whose result is the final assigned server instance.

async Task<List<string>> GetRegions (Dictionary<string, string> query)#

Returns a array of available server regions.

Param query:

A map of property names to values to search for.

async Task<List<string>> GetVersions (Dictionary<string, string> query)#

Returns a array of available server build versions.

Param query:

A map of property names to values to search for.

Task<ServerInstance> Create (ServerInstance obj)#

Creates a new instance of ServerInstance, storing the object on the remote service and returning the final result.

Param obj:

The object to persist with the remote service.

Return:

A task whose result is the final object as it was persisted with the remote service.

async new Task<long> Count (Dictionary<string, string> query = null)#

Retrieves the total number of objects matching the specified search parameters.

Param query:

A map of property names to values to search for.

Return:

A task whose result is the number of objects matching the specified search parameters.

Task<List<ServerInstance>> FindAll (Dictionary<string, string> query = null)#

Retrieves a list of objects matching the specified search parameters.

Param query:

A map of property names to values to search for.

Return:

A task whose result is a list of objects matching the specified search parameters.

Task<ServerInstance> FindById (string id)#

Retrieves an instance of ServerInstance with the specified unique identifier.

Param id:

The id value which uniquely identifies the object.

Return:

A task whose result is the object with the specified identifier if found.

Task<ServerInstance> Update (string id, ServerInstance obj)#

Updates an existing instance of ServerInstance, storing the object on the remote service and returning the final result.

<param name=”id”The id value which uniquely identifies the object.>

Param obj:

The object to update with the remote service.

Return:

A task whose result is the final object as it was persisted with the remote service.

Task<ServerInstance> UpdateHeartbeat (string id)#

Retrieves an instance of ServerInstance with the specified unique identifier and updates heartbeat.

Param id:

The id value which uniquely identifies the object.

Return:

A task whose result is the object with the specified identifier if found.

Task Delete (string id)#

Deletes an instance of T with the specified unique identifier.

Return:

Task