Interface IMultiplayAllocationsApi
Represents a collection of functions to interact with the API endpoints
Namespace: Unity.Services.Apis.Multiplay
Assembly: Unity.Services.Apis.dll
Syntax
public interface IMultiplayAllocationsApi : IApiAccessor
Methods
GetAllocation(string, string, string, string, CancellationToken)
Get an allocation by its UUID
Declaration
ApiOperation<MultiplayAllocationsAllocation> GetAllocation(string projectId, string environmentId, string fleetId, string allocationId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | ID of the project |
string | environmentId | 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 |
ListAllocations(string, string, string, string, int?, int?, string, CancellationToken)
List fleet allocations
Declaration
ApiOperation<MultiplayAllocationsListAllocationsResponse> ListAllocations(string projectId, string environmentId, string fleetId, string age = null, int? limit = null, int? offset = null, string ids = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | ID of the project |
string | environmentId | Environment Id of a project |
string | fleetId | Fleet ID |
string | age | Optional parameter representing the minimum time each allocation has been active. For example, providing a value of '24h' would return all allocations that have been active for longer than 24 hours. Not providing this parameter would return all allocations regardless of age (but taking into account other filters). (optional) |
int? | limit | Optional parameter used for pagination. Represents the max number of allocations to include in the response. This must be a value between 1 and 50. Anything above will be hard limited to 50 results. (optional) |
int? | offset | Optional parameter used for pagination. Represents the offset at which to start pagination. (optional) |
string | ids | Optional parameter containing a comma-separated list of allocationIds to limit the response list to. Note that if one or more ids are specified, the other filters of age and pagination are ignored. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
ProcessAllocation(string, string, string, MultiplayAllocationsAllocateRequest, CancellationToken)
Queue an allocation request
Declaration
ApiOperation<MultiplayAllocationsAllocateResponse> ProcessAllocation(string projectId, string environmentId, string fleetId, MultiplayAllocationsAllocateRequest multiplayAllocationsAllocateRequest = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | ID of the project |
string | environmentId | Environment Id of a project |
string | fleetId | Fleet ID |
Multiplay |
multiplayAllocationsAllocateRequest | The request body of the allocate endpoint. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
ProcessDeallocation(string, string, string, string, CancellationToken)
Remove an allocation
Declaration
ApiOperation ProcessDeallocation(string projectId, string environmentId, string fleetId, string allocationId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | ID of the project |
string | environmentId | 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 |