Interface ISchedulerAdminApi
Represents a collection of functions to interact with the API endpoints
Namespace: Unity.Services.Apis.Admin.Scheduler
Assembly: Unity.Services.Apis.dll
Syntax
public interface ISchedulerAdminApi : IApiAccessor
Methods
CreateScheduleConfig(string, string, ScheduleConfigBody, CancellationToken)
Create Schedule Config
Declaration
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 |
Schedule |
scheduleConfigBody | (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeleteScheduleConfig(string, string, string, CancellationToken)
Delete Schedule Config
Declaration
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. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeleteScheduleConfigs(string, string, List<string>, CancellationToken)
Delete Schedule Configs
Declaration
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) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetScheduleConfig(string, string, string, CancellationToken)
Get Schedule Config
Declaration
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. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
ListSchedulerConfigs(string, string, int?, string, CancellationToken)
List Scheduler Configs
Declaration
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) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |