Class ConfigsAdminApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

ConfigsAdminApi

Implements

IConfigsAdminApi

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.RemoteConfig

Assembly: Unity.Services.Apis.dll

Syntax

public class ConfigsAdminApi : IConfigsAdminApi, IApiAccessor

Constructors

ConfigsAdminApi(IApiClient)

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

Declaration

public ConfigsAdminApi(IApiClient apiClient)

Parameters

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

ConfigsAdminApi(IApiClient, IApiConfiguration)

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

Declaration

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

CopyConfigByProjectId(string, ConfigCopyRequest, CancellationToken)

Copy Config Settings Copies specified settings from a source Config to a destination Config

Declaration

public 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 Create Config.

Declaration

public 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 Deletes an existing Config

Declaration

public 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

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

GetConfigByEnvironmentId(string, string, CancellationToken)

Get Configs by Environment ID Returns the list of all configs for a Environment. Currently, the only supported config type is "settings"

Declaration

public 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 Returns Config for a given ID

Declaration

public 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 Obtain the configs with the default environment 'production' or specified environment id

Declaration

public 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 Updates the value of an existing Config

Declaration

public 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

Implements

IConfigsAdminApi

IApiAccessor