Services

General Objects

Kaltura API

Service Name batch
Description batch service lets you handle different batch process from remote machines.
As oppesed to other ojects in the system, locking mechanism is critical in this case.
For this reason the GetExclusiveXX, UpdateExclusiveXX and FreeExclusiveXX actions are important for the system's intergity.
In general - updating batch object should be done only using the UpdateExclusiveXX which in turn can be called only after
acuiring a batch objet properly (using GetExclusiveXX).
If an object was aquired and should be returned to the pool in it's initial state - use the FreeExclusiveXX action
Actions
Name Description
getExclusiveImportJobsbatch getExclusiveImportJob action allows to get a BatchJob of type IMPORT
updateExclusiveImportJobbatch updateExclusiveImportJob action updates a BatchJob of type IMPORT that was claimed using the getExclusiveImportJobs
freeExclusiveImportJobbatch freeExclusiveImportJob action frees a BatchJob of type IMPORT that was claimed using the getExclusiveImportJobs
getExclusiveBulkUploadJobsbatch getExclusiveBulkUploadJob action allows to get a BatchJob of type BULKUPLOAD
getExclusiveAlmostDoneBulkUploadJobsbatch getExclusiveAlmostDoneBulkUploadJobs action allows to get a BatchJob of type BULKUPLOAD that wait for remote closure
updateExclusiveBulkUploadJobbatch updateExclusiveBulkUploadJob action updates a BatchJob of type BULKUPLOAD that was claimed using the getExclusiveBulkUploadJobs
freeExclusiveBulkUploadJobbatch freeExclusiveBulkUploadJob action frees a BatchJob of type BULKUPLOAD that was claimed using the getExclusiveBulkUploadJobs
addBulkUploadResultbatch addBulkUploadResultAction action adds KalturaBulkUploadResult to the DB
getBulkUploadLastResultbatch getBulkUploadLastResultAction action returns the last result of the bulk upload
updateBulkUploadResultsbatch updateBulkUploadResults action adds KalturaBulkUploadResult to the DB
getExclusiveAlmostDoneRemoteConvertJobsbatch getExclusiveAlmostDoneRemoteConvertJobsAction action allows to get a BatchJob of type REMOTE_CONVERT that wait for remote closure
updateExclusiveRemoteConvertJobbatch updateExclusiveRemoteConvertJobAction action updates a BatchJob of type REMOTE_CONVERT that was claimed using the getExclusiveConvertJobs
freeExclusiveRemoteConvertJobbatch freeExclusiveRemoteConvertJobAction action frees a BatchJob of type REMOTE_CONVERT that was claimed using the getExclusiveConvertJobs
getExclusiveAlmostDoneConvertCollectionJobsbatch getExclusiveAlmostDoneConvertCollectionJobs action allows to get a BatchJob of type CONVERT_COLLECTION that wait for remote closure
getExclusiveAlmostDoneConvertProfileJobsbatch getExclusiveAlmostDoneConvertProfileJobs action allows to get a BatchJob of type CONVERT_PROFILE that wait for remote closure
updateExclusiveConvertCollectionJobbatch updateExclusiveConvertCollectionJobAction action updates a BatchJob of type CONVERT_PROFILE that was claimed using the getExclusiveConvertJobs
updateExclusiveConvertProfileJobbatch updateExclusiveConvertProfileJobAction action updates a BatchJob of type CONVERT_PROFILE that was claimed using the getExclusiveConvertJobs
freeExclusiveConvertCollectionJobbatch freeExclusiveConvertCollectionJobAction action frees a BatchJob of type CONVERT_COLLECTION that was claimed using the getExclusiveConvertJobs
freeExclusiveConvertProfileJobbatch freeExclusiveConvertProfileJobAction action frees a BatchJob of type CONVERT_PROFILE that was claimed using the getExclusiveConvertJobs
getExclusiveConvertCollectionJobsbatch getExclusiveConvertCollectionJob action allows to get a BatchJob of type CONVERT_COLLECTION
getExclusiveConvertJobsbatch getExclusiveConvertJob action allows to get a BatchJob of type CONVERT
getExclusiveAlmostDoneConvertJobsbatch getExclusiveAlmostDoneConvertJobsAction action allows to get a BatchJob of type CONVERT that wait for remote closure
updateExclusiveConvertJobbatch updateExclusiveConvertJob action updates a BatchJob of type CONVERT that was claimed using the getExclusiveConvertJobs
updateExclusiveConvertJobSubTypebatch updateExclusiveConvertJobSubType action updates the sub type for a BatchJob of type CONVERT that was claimed using the getExclusiveConvertJobs
freeExclusiveConvertJobbatch freeExclusiveConvertJob action frees a BatchJob of type IMPORT that was claimed using the getExclusiveConvertJobs
getExclusivePostConvertJobsbatch getExclusivePostConvertJob action allows to get a BatchJob of type POSTCONVERT
updateExclusivePostConvertJobbatch updateExclusivePostConvertJob action updates a BatchJob of type POSTCONVERT that was claimed using the getExclusivePostConvertJobs
freeExclusivePostConvertJobbatch freeExclusivePostConvertJob action frees a BatchJob of type IMPORT that was claimed using the getExclusivePostConvertJobs
getExclusivePullJobsbatch getExclusivePullJob action allows to get a BatchJob of type PULL
updateExclusivePullJobbatch updateExclusivePullJob action updates a BatchJob of type PULL that was claimed using the getExclusivePullJobs
freeExclusivePullJobbatch freeExclusivePullJob action frees a BatchJob of type IMPORT that was claimed using the getExclusivePullJobs
getExclusiveExtractMediaJobsbatch getExclusiveExtractMediaJob action allows to get a BatchJob of type EXTRACT_MEDIA
updateExclusiveExtractMediaJobbatch updateExclusiveExtractMediaJob action updates a BatchJob of type EXTRACT_MEDIA that was claimed using the getExclusiveExtractMediaJobs
addMediaInfobatch addMediaInfoAction action saves a media info object
freeExclusiveExtractMediaJobbatch freeExclusiveExtractMediaJob action frees a BatchJob of type IMPORT that was claimed using the getExclusiveExtractMediaJobs
getExclusiveStorageExportJobsbatch getExclusiveStorageExportJob action allows to get a BatchJob of type STORAGE_EXPORT
updateExclusiveStorageExportJobbatch updateExclusiveStorageExportJob action updates a BatchJob of type STORAGE_EXPORT that was claimed using the getExclusiveStorageExportJobs
freeExclusiveStorageExportJobbatch freeExclusiveStorageExportJob action frees a BatchJob of type IMPORT that was claimed using the getExclusiveStorageExportJobs
getExclusiveStorageDeleteJobsbatch getExclusiveStorageDeleteJob action allows to get a BatchJob of type STORAGE_DELETE
updateExclusiveStorageDeleteJobbatch updateExclusiveStorageDeleteJob action updates a BatchJob of type StorageDelete that was claimed using the getExclusiveStorageDeleteJobs
freeExclusiveStorageDeleteJobbatch freeExclusiveStorageDeleteJob action frees a BatchJob of type IMPORT that was claimed using the getExclusiveStorageDeleteJobs
getExclusiveNotificationJobsbatch getExclusiveNotificationJob action allows to get a BatchJob of type NOTIFICATION
updateExclusiveNotificationJobbatch updateExclusiveNotificationJob action updates a BatchJob of type NOTIFICATION that was claimed using the getExclusiveNotificationJobs
freeExclusiveNotificationJobbatch freeExclusiveNotificationJob action frees a BatchJob of type IMPORT that was claimed using the getExclusiveNotificationJobs
getExclusiveMailJobsbatch getExclusiveMailJob action allows to get a BatchJob of type MAIL
updateExclusiveMailJobbatch updateExclusiveMailJob action updates a BatchJob of type MAIL that was claimed using the getExclusiveMailJobs
freeExclusiveMailJobbatch freeExclusiveMailJob action frees a BatchJob of type MAIL that was claimed using the getExclusiveMailJobs
getExclusiveBulkDownloadJobsbatch getExclusiveBulkDownloadJobs action allows to get a BatchJob of type BULKDOWNLOAD
getExclusiveAlmostDoneBulkDownloadJobsbatch getExclusiveAlmostDoneBulkDownloadJobs action allows to get a BatchJob of type BULKDOWNLOAD that wait for remote closure
updateExclusiveBulkDownloadJobbatch updateExclusiveBulkDownloadJob action updates a BatchJob of type BULKDOWNLOAD that was claimed using the getExclusiveBulkDownloadJobs
freeExclusiveBulkDownloadJobbatch freeExclusiveBulkDownloadJob action frees a BatchJob of type BULKDOWNLOAD that was claimed using the getExclusiveBulkDownloadJobs
getExclusiveProvisionProvideJobsbatch getExclusiveProvisionProvideJobs action allows to get a BatchJob of type ProvisionProvide
getExclusiveAlmostDoneProvisionProvideJobsbatch getExclusiveAlmostDoneProvisionProvideJobs action allows to get a BatchJob of type ProvisionProvide that wait for remote closure
updateExclusiveProvisionProvideJobbatch updateExclusiveProvisionProvideJob action updates a BatchJob of type ProvisionProvide that was claimed using the getExclusiveProvisionProvideJobs
freeExclusiveProvisionProvideJobbatch freeExclusiveProvisionProvideJob action frees a BatchJob of type ProvisionProvide that was claimed using the getExclusiveProvisionProvideJobs
getExclusiveProvisionDeleteJobsbatch getExclusiveProvisionDeleteJobs action allows to get a BatchJob of type ProvisionDelete
getExclusiveAlmostDoneProvisionDeleteJobsbatch getExclusiveAlmostDoneProvisionDeleteJobs action allows to get a BatchJob of type ProvisionDelete that wait for remote closure
updateExclusiveProvisionDeleteJobbatch updateExclusiveProvisionDeleteJob action updates a BatchJob of type ProvisionDelete that was claimed using the getExclusiveProvisionDeleteJobs
freeExclusiveProvisionDeleteJobbatch freeExclusiveProvisionDeleteJob action frees a BatchJob of type ProvisionDelete that was claimed using the getExclusiveProvisionDeleteJobs
resetJobExecutionAttemptsbatch resetJobExecutionAttempts action resets the execution attempts of the job
freeExclusiveJobbatch freeExclusiveJobAction action allows to get a generic BatchJob
getQueueSizebatch getQueueSize action get the queue size for job type
getExclusiveJobsbatch getExclusiveJobsAction action allows to get a BatchJob
getExclusiveAlmostDonebatch getExclusiveAlmostDone action allows to get a BatchJob that wait for remote closure
updateExclusiveJobbatch updateExclusiveJobAction action updates a BatchJob of extended type that was claimed using the getExclusiveJobs
cleanExclusiveJobsbatch cleanExclusiveJobs action mark as fatal error all expired jobs
logConversionAdd the data to the flavor asset conversion log, creates it if doesn't exists
checkFileExistsbatch checkFileExists action check if the file exists