Class MultiplayFleetsAdminApi
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 MultiplayFleetsAdminApi : IMultiplayFleetsAdminApi, IApiAccessor
Constructors
MultiplayFleetsAdminApi(IApiClient)
Initializes a new instance of the Multiplay
Declaration
public MultiplayFleetsAdminApi(IApiClient apiClient)
Parameters
Type | Name | Description |
---|---|---|
IApi |
apiClient | The client interface for synchronous API access. |
MultiplayFleetsAdminApi(IApiClient, IApiConfiguration)
Initializes a new instance of the Multiplay
Declaration
public MultiplayFleetsAdminApi(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
AddFleetRegion(string, string, string, MultiplayFleetAddRegionRequest, CancellationToken)
Add fleet region Add region to the fleet with given ID.
Declaration
public 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 Create a fleet with the provided configuration.
Declaration
public 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 Delete a single fleet with the given ID.
Declaration
public 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 List the fleet regions available to be added from the template fleet.
Declaration
public 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 |
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
string | The base path |
GetFleet(string, string, string, CancellationToken)
View a fleet View the details of a single fleet with the given ID.
Declaration
public 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 View the status of the active build configuration switch taking place.
Declaration
public 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 List all fleets in this project environment.
Declaration
public 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 List the fleet regions from the template fleet.
Declaration
public 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 Start the switch of the active build configuration for a given reservations fleet.
Declaration
public 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 Update the details of a single fleet with the given ID.
Declaration
public 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 Update the settings for a fleet region
Declaration
public 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 |