Изменить

Поделиться через

ItemScheduleAPI interface

  • Reference
Package:
@ms-fabric/workload-client

Methods

cancelItemJob(ItemJobInstanceBaseParams)
createItemScheduledJobs(CreateItemScheduleParams)
getItemJobHistory(GetItemJobHistoryParams)
getItemScheduledJobs(string)
listItemSchedules(ListItemSchedulesParams)

An item can have multiple job types, each with its own distinct job schedule. This API is used to retrieve schedule list for specific item.
runItemJob(RunItemJobParams)
updateItemScheduledJobs(CreateItemScheduleParams)

Method Details

cancelItemJob(ItemJobInstanceBaseParams) 

function cancelItemJob(jobParams: ItemJobInstanceBaseParams): Promise<CancelItemJobResult>

Parameters

jobParams

ItemJobInstanceBaseParams

Returns

Promise<CancelItemJobResult>

createItemScheduledJobs(CreateItemScheduleParams) 

function createItemScheduledJobs(createItemScheduledJobs: CreateItemScheduleParams): Promise<ItemSchedule>

Parameters

createItemScheduledJobs
CreateItemScheduleParams

Returns

Promise<ItemSchedule>

getItemJobHistory(GetItemJobHistoryParams) 

function getItemJobHistory(getHistoryParams: GetItemJobHistoryParams): Promise<ItemJobHistory>

Parameters

getHistoryParams
GetItemJobHistoryParams

Returns

Promise<ItemJobHistory>

getItemScheduledJobs(string)

Warning

This API is now deprecated.

use listItemSchedules instead.

function getItemScheduledJobs(objectId: string): Promise<ItemSchedule>

Parameters

objectId

string

Returns

Promise<ItemSchedule>

listItemSchedules(ListItemSchedulesParams)

An item can have multiple job types, each with its own distinct job schedule. This API is used to retrieve schedule list for specific item.

function listItemSchedules(listItemSchedulesParams: ListItemSchedulesParams): Promise<ListItemSchedulesResponse>

Parameters

listItemSchedulesParams
ListItemSchedulesParams

Include the object id of the item.

Returns

Promise<ListItemSchedulesResponse>

runItemJob(RunItemJobParams) 

function runItemJob(jobParams: RunItemJobParams): Promise<ItemJobInstance>

Parameters

jobParams
RunItemJobParams

Returns

Promise<ItemJobInstance>

updateItemScheduledJobs(CreateItemScheduleParams) 

function updateItemScheduledJobs(updateItemScheduleParams: CreateItemScheduleParams): Promise<ItemSchedule>

Parameters

updateItemScheduleParams
CreateItemScheduleParams

Returns

Promise<ItemSchedule>