Class MultiplayBuildConfigurationsAdminApi
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 MultiplayBuildConfigurationsAdminApi : IMultiplayBuildConfigurationsAdminApi, IApiAccessor
Constructors
MultiplayBuildConfigurationsAdminApi(IApiClient)
Initializes a new instance of the Multiplay
Declaration
public MultiplayBuildConfigurationsAdminApi(IApiClient apiClient)
Parameters
Type | Name | Description |
---|---|---|
IApi |
apiClient | The client interface for synchronous API access. |
MultiplayBuildConfigurationsAdminApi(IApiClient, IApiConfiguration)
Initializes a new instance of the Multiplay
Declaration
public MultiplayBuildConfigurationsAdminApi(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
CreateBuildConfiguration(string, string, MultiplayBuildConfigurationCreateRequest, CancellationToken)
Create a build configuration Create a build configuration with the provided configuration.
Declaration
public 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 Delete a single build configuration with the given ID.
Declaration
public 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 |
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
string | The base path |
GetBuildConfiguration(string, string, long, CancellationToken)
View a build configuration View the details of a single build configuration with the given ID.
Declaration
public 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 List all build configurations within this project.
Declaration
public 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. Update the details of a single build configuration with the given ID.
Declaration
public 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 |