Class SchedulerAdminApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

SchedulerAdminApi

Implements

ISchedulerAdminApi

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

Assembly: Unity.Services.Apis.dll

Syntax

public class SchedulerAdminApi : ISchedulerAdminApi, IApiAccessor

Constructors

SchedulerAdminApi(IApiClient)

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

Declaration

public SchedulerAdminApi(IApiClient apiClient)

Parameters

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

SchedulerAdminApi(IApiClient, IApiConfiguration)

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

Declaration

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

CreateScheduleConfig(string, string, ScheduleConfigBody, CancellationToken)

Create Schedule Config Add schedule to project environment

Declaration

public ApiOperation<ScheduleConfigId> CreateScheduleConfig(string projectId, string environmentId, ScheduleConfigBody scheduleConfigBody = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project's Project ID
string	environmentId	The Environment ID of a project
ScheduleConfigBody	scheduleConfigBody	(optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<ScheduleConfigId>	The operation

DeleteScheduleConfig(string, string, string, CancellationToken)

Delete Schedule Config Deletes the configuration for a specific schedule

Declaration

public ApiOperation DeleteScheduleConfig(string projectId, string environmentId, string configId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project's Project ID
string	environmentId	The Environment ID of a project
string	configId	ID of the scheduler config. List the scheduler configurations to retrieve IDs.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	The operation

DeleteScheduleConfigs(string, string, List<string>, CancellationToken)

Delete Schedule Configs Deletes multiple schedule configurations

Declaration

public ApiOperation<BatchDeleteFailedResponse> DeleteScheduleConfigs(string projectId, string environmentId, List<string> requestBody = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project's Project ID
string	environmentId	The Environment ID of a project
List<string>	requestBody	(optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<BatchDeleteFailedResponse>	The operation

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

GetScheduleConfig(string, string, string, CancellationToken)

Get Schedule Config Retrieves the configuration for a specific schedule

Declaration

public ApiOperation<ScheduleConfig> GetScheduleConfig(string projectId, string environmentId, string configId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project's Project ID
string	environmentId	The Environment ID of a project
string	configId	ID of the scheduler config. List the scheduler configurations to retrieve IDs.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<ScheduleConfig>	The operation

ListSchedulerConfigs(string, string, int?, string, CancellationToken)

List Scheduler Configs Get list of schedules for the given project and environment

Declaration

public ApiOperation<SchedulerConfigPage> ListSchedulerConfigs(string projectId, string environmentId, int? limit = null, string after = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project's Project ID
string	environmentId	The Environment ID of a project
int?	limit	The number of schedules to display per page (optional, default to 1000)
string	after	A token to get the next page (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<SchedulerConfigPage>	The operation

Implements

ISchedulerAdminApi

IApiAccessor