Class: Kaltura::KalturaBulkUploadService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_client.rb

Overview

Bulk upload service is used to upload & manage bulk uploads using CSV files.

This service manages only entry bulk uploads.

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaBulkUploadService

Returns a new instance of KalturaBulkUploadService.



655
656
657
 
# File 'lib/kaltura_client.rb', line 655

def initialize(client)
	super(client)
end

Instance Method Details

#abort(id) ⇒ Object

Aborts the bulk upload and all its child jobs



722
723
724
725
726
727
728
729
730
 
# File 'lib/kaltura_client.rb', line 722

def abort(id)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.queue_service_action_call('bulkupload', 'abort', 'KalturaBulkUpload', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#add(conversion_profile_id, csv_file_data, bulk_upload_type = KalturaNotImplemented, uploaded_by = KalturaNotImplemented, file_name = KalturaNotImplemented) ⇒ Object

Add new bulk upload batch job Conversion profile id can be specified in the API or in the CSV file, the one in the CSV file will be stronger. If no conversion profile was specified, partner’s default will be used



663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'lib/kaltura_client.rb', line 663

def add(conversion_profile_id, csv_file_data, bulk_upload_type=KalturaNotImplemented, uploaded_by=KalturaNotImplemented, file_name=KalturaNotImplemented)
	kparams = {}
	kfiles = {}
	client.add_param(kparams, 'conversionProfileId', conversion_profile_id)
	client.add_param(kfiles, 'csvFileData', csv_file_data)
	client.add_param(kparams, 'bulkUploadType', bulk_upload_type)
	client.add_param(kparams, 'uploadedBy', uploaded_by)
	client.add_param(kparams, 'fileName', file_name)
	client.queue_service_action_call('bulkupload', 'add', 'KalturaBulkUpload', kparams, kfiles)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#get(id) ⇒ Object

Get bulk upload batch job by id



680
681
682
683
684
685
686
687
688
 
# File 'lib/kaltura_client.rb', line 680

def get(id)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.queue_service_action_call('bulkupload', 'get', 'KalturaBulkUpload', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#list(pager = KalturaNotImplemented) ⇒ Object

List bulk upload batch jobs



692
693
694
695
696
697
698
699
700
 
# File 'lib/kaltura_client.rb', line 692

def list(pager=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'pager', pager)
	client.queue_service_action_call('bulkupload', 'list', 'KalturaBulkUploadListResponse', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#serve(id) ⇒ Object

serve action returan the original file.



704
705
706
707
708
709
 
# File 'lib/kaltura_client.rb', line 704

def serve(id)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.queue_service_action_call('bulkupload', 'serve', 'file', kparams)
	return client.get_serve_url()
end

#serve_log(id) ⇒ Object

serveLog action returan the original file.



713
714
715
716
717
718
 
# File 'lib/kaltura_client.rb', line 713

def serve_log(id)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.queue_service_action_call('bulkupload', 'serveLog', 'file', kparams)
	return client.get_serve_url()
end