Class MultiplayBuildConfigurationsAdminApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

MultiplayBuildConfigurationsAdminApi

Implements

IMultiplayBuildConfigurationsAdminApi

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 MultiplayBuildConfigurationsAdminApi : IMultiplayBuildConfigurationsAdminApi, IApiAccessor

Constructors

MultiplayBuildConfigurationsAdminApi(IApiClient)

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

Declaration

public MultiplayBuildConfigurationsAdminApi(IApiClient apiClient)

Parameters

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

MultiplayBuildConfigurationsAdminApi(IApiClient, IApiConfiguration)

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

Declaration

public MultiplayBuildConfigurationsAdminApi(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

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

Returns

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

Returns

Type	Description
ApiOperation<MultiplayBuildConfiguration>	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)
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. 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
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

Implements

IMultiplayBuildConfigurationsAdminApi

IApiAccessor