Class MultiplayAllocationsAdminApi
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 MultiplayAllocationsAdminApi : IMultiplayAllocationsAdminApi, IApiAccessor
Constructors
MultiplayAllocationsAdminApi(IApiClient)
Initializes a new instance of the Multiplay
Declaration
public MultiplayAllocationsAdminApi(IApiClient apiClient)
Parameters
Type | Name | Description |
---|---|---|
IApi |
apiClient | The client interface for synchronous API access. |
MultiplayAllocationsAdminApi(IApiClient, IApiConfiguration)
Initializes a new instance of the Multiplay
Declaration
public MultiplayAllocationsAdminApi(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 |
GetTestAllocation(string, string, string, string, CancellationToken)
View a test allocation Get the details of a single allocation with the given ID.
Declaration
public ApiOperation<MultiplayAllocationsTestAllocation> GetTestAllocation(string projectId, string environmentId, string fleetId, string allocationId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | fleetId | Fleet ID |
string | allocationId | Allocation ID |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
ListTestAllocations(string, string, CancellationToken)
List a project's test allocations Lists the test allocations for a given project.
Declaration
public ApiOperation<MultiplayAllocationsListTestAllocationsResponse> ListTestAllocations(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 |
ProcessTestAllocation(string, string, string, MultiplayAllocationsTestAllocateRequest, CancellationToken)
Queue a test allocation Queues a request to create a test allocation for a server in a fleet.
Declaration
public ApiOperation<MultiplayAllocationsTestAllocateResponse> ProcessTestAllocation(string projectId, string environmentId, string fleetId, MultiplayAllocationsTestAllocateRequest multiplayAllocationsTestAllocateRequest = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | fleetId | Fleet ID |
Multiplay |
multiplayAllocationsTestAllocateRequest | Test allocation request. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
ProcessTestDeallocation(string, string, string, string, CancellationToken)
Remove a test allocation Queues a request to remove a test allocation for a server in an environment.
Declaration
public ApiOperation ProcessTestDeallocation(string projectId, string environmentId, string fleetId, string allocationId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | fleetId | Fleet ID |
string | allocationId | Allocation ID |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |