Interface IMultiplayBuildConfigurationsAdminApi
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 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 |
Multiplay |
multiplayBuildConfigurationCreateRequest | Contains the properties for the build configuration. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
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) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
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 |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
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) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
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 |
Multiplay |
multiplayBuildConfigurationUpdateRequest | Contains the properties for the build configuration. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |