Class MultiplayFleetsAdminApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

MultiplayFleetsAdminApi

Implements

IMultiplayFleetsAdminApi

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

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 MultiplayFleetsAdminApi class using a Configuration object and client instance.

Declaration

public MultiplayFleetsAdminApi(IApiClient apiClient)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.

MultiplayFleetsAdminApi(IApiClient, IApiConfiguration)

Initializes a new instance of the MultiplayFleetsAdminApi class using a Configuration object and client instance.

Declaration

public MultiplayFleetsAdminApi(IApiClient apiClient, IApiConfiguration apiConfiguration)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.
IApiConfiguration	apiConfiguration	The configuration object.

Properties

Client

The client for accessing this underlying API asynchronously.

Declaration

public IApiClient Client { get; }

Property Value

Type	Description
IApiClient

Configuration

Gets the configuration object

Declaration

public IApiConfiguration Configuration { get; }

Property Value

Type	Description
IApiConfiguration	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
MultiplayFleetAddRegionRequest	multiplayFleetAddRegionRequest	(optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<MultiplayAddedRegion>	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
MultiplayFleetCreateRequest	multiplayFleetCreateRequest	(optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<MultiplayFleet>	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)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	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
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<List<MultiplayFleetRegionTemplateListItem>>	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
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<MultiplayFleet>	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
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<MultiplayFleetBuildConfigurationSwitchStatus>	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
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<List<MultiplayFleetListItem>>	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
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<List<MultiplayFleetRegionTemplateListItem>>	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
MultiplayFleetBuildConfigurationSwitchRequest	multiplayFleetBuildConfigurationSwitchRequest	(optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<MultiplayFleetBuildConfigurationSwitchStatus>	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
MultiplayFleetUpdateRequest	multiplayFleetUpdateRequest	(optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<MultiplayFleet>	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
MultiplayFleetUpdateRegionRequest	multiplayFleetUpdateRegionRequest	(optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<MultiplayUpdatedRegion>	The operation

Implements

IMultiplayFleetsAdminApi

IApiAccessor