Class MultiplayServersAdminApi
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: Unity.Services.Apis.Admin.Multiplay
Assembly: Unity.Services.Apis.dll
Syntax
public class MultiplayServersAdminApi : IMultiplayServersAdminApi, IApiAccessor
Constructors
MultiplayServersAdminApi(IApiClient)
Initializes a new instance of the Multiplay
Declaration
public MultiplayServersAdminApi(IApiClient apiClient)
Parameters
Type | Name | Description |
---|---|---|
IApi |
apiClient | The client interface for synchronous API access. |
MultiplayServersAdminApi(IApiClient, IApiConfiguration)
Initializes a new instance of the Multiplay
Declaration
public MultiplayServersAdminApi(IApiClient apiClient, IApiConfiguration apiConfiguration)
Parameters
Type | Name | Description |
---|---|---|
IApi |
apiClient | The client interface for synchronous API access. |
IApi |
apiConfiguration | The configuration object. |
Properties
Client
The client for accessing this underlying API asynchronously.
Declaration
public IApiClient Client { get; }
Property Value
Type | Description |
---|---|
IApi |
Configuration
Gets the configuration object
Declaration
public IApiConfiguration Configuration { get; }
Property Value
Type | Description |
---|---|
IApi |
An instance of the Configuration |
Methods
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
string | The base path |
GetServer(string, string, long, CancellationToken)
View a server View the details of a single server with the given ID.
Declaration
public ApiOperation<MultiplayServersServer1> GetServer(string projectId, string environmentId, long serverId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
long | serverId | A Multiplay server ID |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetServerActions(string, string, long, DateTime?, CancellationToken)
List action logs List the action logs for a server.
Declaration
public ApiOperation<List<MultiplayServersActionLog>> GetServerActions(string projectId, string environmentId, long serverId, DateTime? date = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
long | serverId | A Multiplay server ID |
Date |
date | Date (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetServerLogsLink(string, string, long, string, CancellationToken)
Get Log File Link Get a link to download a log file.
Declaration
public ApiOperation<MultiplayServersLogFileLink> GetServerLogsLink(string projectId, string environmentId, long serverId, string file, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
long | serverId | A Multiplay server ID |
string | file | Log file name |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetServerLogsPreview(string, string, long, string, CancellationToken)
Get Preview of Log File Get a preview of the server log file.
Declaration
public ApiOperation<string> GetServerLogsPreview(string projectId, string environmentId, long serverId, string file, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
long | serverId | A Multiplay server ID |
string | file | Log file name |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
ListServerLocations(string, string, CancellationToken)
List server locations List all server locations in this project environment.
Declaration
public ApiOperation<List<MultiplayServersLocation>> ListServerLocations(string projectId, string environmentId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
ListServerLogs(string, string, long, CancellationToken)
List log files List the log files for a server.
Declaration
public ApiOperation<List<MultiplayServersLogFile>> ListServerLogs(string projectId, string environmentId, long serverId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
long | serverId | A Multiplay server ID |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
ListServers(string, string, string, string, string, string, string, string, string, string, string, string, string, string, CancellationToken)
List servers List all servers in this project environment.
Declaration
public ApiOperation<List<MultiplayServersServer1>> ListServers(string projectId, string environmentId, string limit = null, string lastId = null, string lastVal = null, string sortBy = null, string sortDir = null, string fleetId = null, string machineId = null, string locationId = null, string buildConfigurationId = null, string hardwareType = null, string partial = null, string status = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | limit | Results limit (optional) |
string | lastId | Last ID (optional) |
string | lastVal | Last value (optional) |
string | sortBy | Sort column (optional) |
string | sortDir | Sort direction (optional, default to ASC) |
string | fleetId | Fleet ID (optional) |
string | machineId | Machine ID (optional) |
string | locationId | Location ID (optional) |
string | buildConfigurationId | Build Configuration ID (optional) |
string | hardwareType | HardwareType (optional) |
string | partial | Partial Filter (optional) |
string | status | Status (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
TriggerServerAction(string, string, long, MultiplayServersActionsRequest, CancellationToken)
Trigger action Trigger an action against the server with the given id.
Declaration
public ApiOperation<MultiplayServersActionsResponse> TriggerServerAction(string projectId, string environmentId, long serverId, MultiplayServersActionsRequest multiplayServersActionsRequest = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
long | serverId | A Multiplay server ID |
Multiplay |
multiplayServersActionsRequest | (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |