Class SchemasAdminApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

SchemasAdminApi

Implements

ISchemasAdminApi

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 SchemasAdminApi : ISchemasAdminApi, IApiAccessor

Constructors

SchemasAdminApi(IApiClient)

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

Declaration

public SchemasAdminApi(IApiClient apiClient)

Parameters

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

SchemasAdminApi(IApiClient, IApiConfiguration)

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

Declaration

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

CreateSchemaByConfigId(string, string, object, CancellationToken)

Create Schema Create new schema for a specific configId

Declaration

public ApiOperation CreateSchemaByConfigId(string projectId, string configId, object body, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	Unity Project Id
string	configId	Configuration Id
object	body
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

DeleteSchemaByConfigIdAndId(string, string, string, CancellationToken)

Delete Schema Delete a schema

Declaration

public ApiOperation DeleteSchemaByConfigIdAndId(string projectId, string configId, string id, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	Unity Project Id
string	configId	Configuration Id
string	id	Schema 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

GetSchemaByConfigIdAndId(string, string, string, CancellationToken)

Get Schema Get a schema

Declaration

public ApiOperation<object> GetSchemaByConfigIdAndId(string projectId, string configId, string id, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	Unity Project Id
string	configId	Configuration Id
string	id	Schema Id
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<object>	The operation

GetSchemasByConfigId(string, string, CancellationToken)

Get All Schemas Return all schemas for a specific configId

Declaration

public ApiOperation<GetAllSchemasResponse> GetSchemasByConfigId(string projectId, string configId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	Unity Project Id
string	configId	Configuration Id
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<GetAllSchemasResponse>	The operation

Implements

ISchemasAdminApi

IApiAccessor