Interface IMultiplayDeployer
Responsible to make available deployment functionality
Assembly: Unity.Services.Multiplayer.Multiplay.Authoring.Core.dll
Syntax
public interface IMultiplayDeployer
Methods
BuildBinaries(IReadOnlyList<BuildItem>, CancellationToken)
Build the binaries associated with the build items
Declaration
Task<(List<BuildItem>, List<BuildItem>)> BuildBinaries(IReadOnlyList<BuildItem> buildItems, CancellationToken token = default)
Parameters
Returns
CreateAndSyncTestAllocationAsync(FleetName, BuildConfigurationName, CancellationToken)
Creates a test allocation for the associated Fleet
Declaration
Task<AllocationInformation> CreateAndSyncTestAllocationAsync(FleetName fleetName, BuildConfigurationName buildConfigurationName, CancellationToken cancellationToken = default)
Parameters
Returns
DeleteBuild(BuildId, CancellationToken)
Deletes the specified build
Declaration
Task DeleteBuild(BuildId buildId, CancellationToken cancellationToken = default)
Parameters
Returns
DeleteBuildConfig(BuildConfigurationId, CancellationToken)
Deletes the Build Configuration
Declaration
Task DeleteBuildConfig(BuildConfigurationId buildConfigurationId, CancellationToken cancellationToken = default)
Parameters
Returns
DeleteFleet(FleetId)
Deletes the associated Fleet
Declaration
Task DeleteFleet(FleetId fleetName)
Parameters
| Type |
Name |
Description |
| FleetId |
fleetName |
|
Returns
Deploy(IReadOnlyList<DeploymentItem>, CancellationToken)
Deploy the associated Multiplay Config items.
Builds will be built and uploaded, Build Configurations and fleets will
be created or updated according to the item.
The item status and progress will be updated along the way.
Declaration
Task Deploy(IReadOnlyList<DeploymentItem> items, CancellationToken token = default)
Parameters
Returns
DeployBuildConfigs(IReadOnlyList<BuildConfigurationItem>, Dictionary<BuildName, BuildId>, CancellationToken)
Creates or Updates the associated build configurations
Declaration
Task<(Dictionary<BuildConfigurationName, BuildConfigurationId>, List<BuildConfigurationItem>)> DeployBuildConfigs(IReadOnlyList<BuildConfigurationItem> items, Dictionary<BuildName, BuildId> successfulUploads, CancellationToken token)
Parameters
Returns
DeployFleets(IReadOnlyList<FleetItem>, Dictionary<BuildConfigurationName, BuildConfigurationId>, CancellationToken)
Creates or Updates the associated fleets
Declaration
Task DeployFleets(IReadOnlyList<FleetItem> items, Dictionary<BuildConfigurationName, BuildConfigurationId> buildConfigIds = null, CancellationToken token = default)
Parameters
Returns
GetAvailableRegions()
Gets regions that are available for fleet scaling options
Declaration
Task<Dictionary<string, Guid>> GetAvailableRegions()
Returns
GetBuildConfigs(CancellationToken)
Gets the information of the build configurations for the current environment
Declaration
Task<IReadOnlyList<BuildConfigInfo>> GetBuildConfigs(CancellationToken cancellationToken = default)
Parameters
Returns
GetBuilds(CancellationToken)
Gets the information of the builds for the current environment
Declaration
Task<IReadOnlyList<BuildInfo>> GetBuilds(CancellationToken cancellationToken = default)
Parameters
Returns
GetFleets()
Gets the information of the fleets
Declaration
Task<IReadOnlyList<FleetInfo>> GetFleets()
Returns
InitAsync()
Initialize the MultiplayDeployer with an authenticated client
Declaration
Returns
ListTestAllocations(FleetId, CancellationToken)
Lists existing test allocations for the associated fleet
Declaration
Task<List<AllocationInformation>> ListTestAllocations(FleetId fleetId, CancellationToken cancellationToken = default)
Parameters
Returns
RemoveTestAllocation(FleetId, Guid, CancellationToken)
Removes a test allocation
Declaration
Task RemoveTestAllocation(FleetId fleetId, Guid allocationId, CancellationToken cancellationToken = default)
Parameters
Returns
UploadAndSyncBuilds(List<BuildItem>, CancellationToken)
Uploads the associated builds, and waits for them to be available.
Declaration
Task<IMultiplayDeployer.UploadResult> UploadAndSyncBuilds(List<BuildItem> successfulBuilds, CancellationToken token = default)
Parameters
Returns
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.