Class ScheduledTasksApi

ScheduledTasksApi - object-oriented interface

Export

ScheduledTasksApi

Hierarchy

BaseAPI
- ScheduledTasksApi

Index

Constructors

Properties

axios basePath configuration

Methods

getTask getTasks startTask stopTask updateTask

Constructors

constructor

new ScheduledTasksApi(configuration?, basePath?, axios?): ScheduledTasksApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ScheduledTasksApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

getTask

getTask(requestParameters, options?): Promise<AxiosResponse<TaskInfo, any>>
Parameters
- requestParameters: ScheduledTasksApiGetTaskRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TaskInfo, any>>
Summary
Get task by id.

Throws
Memberof
ScheduledTasksApi
- Defined in generated-client/api/scheduled-tasks-api.ts:471

getTasks

getTasks(requestParameters?, options?): Promise<AxiosResponse<TaskInfo[], any>>
Parameters
- requestParameters: ScheduledTasksApiGetTasksRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<TaskInfo[], any>>
Summary
Get tasks.

Throws
Memberof
ScheduledTasksApi
- Defined in generated-client/api/scheduled-tasks-api.ts:483

startTask

startTask(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: ScheduledTasksApiStartTaskRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Start specified task.

Throws
Memberof
ScheduledTasksApi
- Defined in generated-client/api/scheduled-tasks-api.ts:495

stopTask

stopTask(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: ScheduledTasksApiStopTaskRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Stop specified task.

Throws
Memberof
ScheduledTasksApi
- Defined in generated-client/api/scheduled-tasks-api.ts:507

updateTask

updateTask(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: ScheduledTasksApiUpdateTaskRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Update specified task triggers.

Throws
Memberof
ScheduledTasksApi
- Defined in generated-client/api/scheduled-tasks-api.ts:519