Interface IMultiplayFleetsAdminApi
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 IMultiplayFleetsAdminApi : IApiAccessor
Methods
AddFleetRegion(string, string, string, MultiplayFleetAddRegionRequest, CancellationToken)
Add fleet region
Declaration
ApiOperation<MultiplayAddedRegion> AddFleetRegion(string projectId, string environmentId, string fleetId, MultiplayFleetAddRegionRequest multiplayFleetAddRegionRequest = 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 |
multiplayFleetAddRegionRequest | (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
CreateFleet(string, string, MultiplayFleetCreateRequest, CancellationToken)
Create a fleet
Declaration
ApiOperation<MultiplayFleet> CreateFleet(string projectId, string environmentId, MultiplayFleetCreateRequest multiplayFleetCreateRequest = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
Multiplay |
multiplayFleetCreateRequest | (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeleteFleet(string, string, string, bool?, CancellationToken)
Delete a fleet
Declaration
ApiOperation DeleteFleet(string projectId, string environmentId, string fleetId, bool? dryRun = 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 |
bool? | dryRun | Dry run the request. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetAvailableFleetRegions(string, string, string, CancellationToken)
Available fleet regions list
Declaration
ApiOperation<List<MultiplayFleetRegionTemplateListItem>> GetAvailableFleetRegions(string projectId, string environmentId, string fleetId, 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 |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetFleet(string, string, string, CancellationToken)
View a fleet
Declaration
ApiOperation<MultiplayFleet> GetFleet(string projectId, string environmentId, string fleetId, 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 |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetFleetBuildConfigurationSwitchStatus(string, string, string, CancellationToken)
View Active Build Configuration and Switch Status
Declaration
ApiOperation<MultiplayFleetBuildConfigurationSwitchStatus> GetFleetBuildConfigurationSwitchStatus(string projectId, string environmentId, string fleetId, 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 |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
ListFleets(string, string, CancellationToken)
List fleets
Declaration
ApiOperation<List<MultiplayFleetListItem>> ListFleets(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 |
ListTemplateFleetRegions(string, string, CancellationToken)
List template fleet regions
Declaration
ApiOperation<List<MultiplayFleetRegionTemplateListItem>> ListTemplateFleetRegions(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 |
SwitchReservationFleetActiveBuildConfiguration(string, string, string, MultiplayFleetBuildConfigurationSwitchRequest, CancellationToken)
Trigger Build Configuration Switch for Reservation Fleet
Declaration
ApiOperation<MultiplayFleetBuildConfigurationSwitchStatus> SwitchReservationFleetActiveBuildConfiguration(string projectId, string environmentId, string fleetId, MultiplayFleetBuildConfigurationSwitchRequest multiplayFleetBuildConfigurationSwitchRequest = 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 |
multiplayFleetBuildConfigurationSwitchRequest | (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
UpdateFleet(string, string, string, MultiplayFleetUpdateRequest, CancellationToken)
Update a fleet
Declaration
ApiOperation<MultiplayFleet> UpdateFleet(string projectId, string environmentId, string fleetId, MultiplayFleetUpdateRequest multiplayFleetUpdateRequest = 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 |
multiplayFleetUpdateRequest | (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
UpdateFleetRegion(string, string, string, string, MultiplayFleetUpdateRegionRequest, CancellationToken)
Update fleet region settings
Declaration
ApiOperation<MultiplayUpdatedRegion> UpdateFleetRegion(string projectId, string environmentId, string fleetId, string regionId, MultiplayFleetUpdateRegionRequest multiplayFleetUpdateRegionRequest = 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 |
string | regionId | Region ID |
Multiplay |
multiplayFleetUpdateRegionRequest | (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |