Interface IMultiplayBuildConfigurationsAdminApi

Represents a collection of functions to interact with the API endpoints

Inherited Members

IApiAccessor.Configuration

IApiAccessor.GetBasePath()

Namespace: Unity.Services.Apis.Admin.Multiplay

Assembly: Unity.Services.Apis.dll

Syntax

public interface IMultiplayBuildConfigurationsAdminApi : IApiAccessor

Methods

CreateBuildConfiguration(string, string, MultiplayBuildConfigurationCreateRequest, CancellationToken)

Create a build configuration

Declaration

ApiOperation<MultiplayBuildConfiguration> CreateBuildConfiguration(string projectId, string environmentId, MultiplayBuildConfigurationCreateRequest multiplayBuildConfigurationCreateRequest = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project's Project ID
string	environmentId	The Environment ID of a project
MultiplayBuildConfigurationCreateRequest	multiplayBuildConfigurationCreateRequest	Contains the properties for the build configuration. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<MultiplayBuildConfiguration>	The operation

DeleteBuildConfiguration(string, string, long, bool?, CancellationToken)

Delete a build configuration

Declaration

ApiOperation DeleteBuildConfiguration(string projectId, string environmentId, long buildConfigurationId, 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
long	buildConfigurationId	Build Configuration ID
bool?	dryRun	Dry run the request. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

GetBuildConfiguration(string, string, long, CancellationToken)

View a build configuration

Declaration

ApiOperation<MultiplayBuildConfiguration> GetBuildConfiguration(string projectId, string environmentId, long buildConfigurationId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project's Project ID
string	environmentId	The Environment ID of a project
long	buildConfigurationId	Build Configuration ID
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<MultiplayBuildConfiguration>	The operation

ListBuildConfigurations(string, string, string, string, CancellationToken)

List build configurations

Declaration

ApiOperation<List<MultiplayBuildConfigurationListItem>> ListBuildConfigurations(string projectId, string environmentId, string fleetId = null, string partialFilter = 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 (optional)
string	partialFilter	Partial Filter (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<List<MultiplayBuildConfigurationListItem>>	The operation

UpdateBuildConfiguration(string, string, long, MultiplayBuildConfigurationUpdateRequest, CancellationToken)

Update a build configuration.

Declaration

ApiOperation<MultiplayBuildConfiguration> UpdateBuildConfiguration(string projectId, string environmentId, long buildConfigurationId, MultiplayBuildConfigurationUpdateRequest multiplayBuildConfigurationUpdateRequest = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project's Project ID
string	environmentId	The Environment ID of a project
long	buildConfigurationId	Build Configuration ID
MultiplayBuildConfigurationUpdateRequest	multiplayBuildConfigurationUpdateRequest	Contains the properties for the build configuration. (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<MultiplayBuildConfiguration>	The operation