Interface IConfigsAdminApi

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: Unity.Services.Apis.Admin.RemoteConfig
Assembly: Unity.Services.Apis.dll
Syntax
public interface IConfigsAdminApi : IApiAccessor

Methods

CopyConfigByProjectId(string, ConfigCopyRequest, CancellationToken)

Copy Config Settings

Declaration
ApiOperation CopyConfigByProjectId(string projectId, ConfigCopyRequest configCopyRequest, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string projectId

Unity Project Id
ConfigCopyRequest configCopyRequest

IDs for source and destination Config, and Settings keys to be copied
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
ApiOperation

The operation

CreateConfig(string, CreateConfigRequest, CancellationToken)

Create Config

Declaration
ApiOperation<CreateConfigResponse> CreateConfig(string projectId, CreateConfigRequest createConfigRequest, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string projectId

Unity Project Id
CreateConfigRequest createConfigRequest

Config object
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
ApiOperation<CreateConfigResponse>

The operation

DeleteConfigById(string, string, CancellationToken)

Delete Config

Declaration
ApiOperation DeleteConfigById(string configId, string projectId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string configId

Configuration Id
string projectId

Unity Project Id
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
ApiOperation

The operation

GetConfigByEnvironmentId(string, string, CancellationToken)

Get Configs by Environment ID

Declaration
ApiOperation<GetConfigWithDefaultEnvironment200Response> GetConfigByEnvironmentId(string projectId, string environmentId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string projectId

Unity Project Id
string environmentId

Environment Id
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
ApiOperation<GetConfigWithDefaultEnvironment200Response>

The operation

GetConfigById(string, string, CancellationToken)

Get Config

Declaration
ApiOperation<Config> GetConfigById(string configId, string projectId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string configId

Configuration Id
string projectId

Unity Project Id
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
ApiOperation<Config>

The operation

GetConfigWithDefaultEnvironment(string, CancellationToken)

Get config with the default environment

Declaration
ApiOperation<GetConfigWithDefaultEnvironment200Response> GetConfigWithDefaultEnvironment(string projectId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string projectId

Unity Project Id
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
ApiOperation<GetConfigWithDefaultEnvironment200Response>

The operation

UpdateConfigById(string, string, UpdateConfigByIdRequest, CancellationToken)

Update Config

Declaration
ApiOperation UpdateConfigById(string configId, string projectId, UpdateConfigByIdRequest updateConfigByIdRequest, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string configId

Configuration Id
string projectId

Unity Project Id
UpdateConfigByIdRequest updateConfigByIdRequest

Updated Config values
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
ApiOperation

The operation