Interface IMultiplayAllocationsAdminApi
Represents a collection of functions to interact with the API endpoints
Namespace: Unity.Services.Apis.Admin.Multiplay
Assembly: Unity.Services.Apis.dll
Syntax
public interface IMultiplayAllocationsAdminApi : IApiAccessor
Methods
GetTestAllocation(string, string, string, string, CancellationToken)
View a test allocation
Declaration
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
Declaration
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
Declaration
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
Declaration
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 |