Class: Kaltura::KalturaScheduledTaskProfileService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb

Overview

Schedule task service lets you create and manage scheduled task profiles

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaScheduledTaskProfileService

Returns a new instance of KalturaScheduledTaskProfileService.



561
562
563
 
# File 'lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb', line 561

def initialize(client)
  super(client)
end

Instance Method Details

#add(scheduled_task_profile) ⇒ KalturaScheduledTaskProfile

Add a new scheduled task profile

Returns:



567
568
569
570
571
572
573
574
575
 
# File 'lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb', line 567

def add(scheduled_task_profile)
  kparams = {}
  client.add_param(kparams, 'scheduledTaskProfile', scheduled_task_profile)
  client.queue_service_action_call('scheduledtask_scheduledtaskprofile', 'add', 'KalturaScheduledTaskProfile', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#delete(id) ⇒ Object

Delete a scheduled task profile

Returns:



579
580
581
582
583
584
585
586
587
 
# File 'lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb', line 579

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

#get(id) ⇒ KalturaScheduledTaskProfile

Retrieve a scheduled task profile by id

Returns:



591
592
593
594
595
596
597
598
599
 
# File 'lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb', line 591

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

#get_dry_run_results(request_id) ⇒ KalturaObjectListResponse

Returns:



602
603
604
605
606
607
608
609
610
 
# File 'lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb', line 602

def get_dry_run_results(request_id)
  kparams = {}
  client.add_param(kparams, 'requestId', request_id)
  client.queue_service_action_call('scheduledtask_scheduledtaskprofile', 'getDryRunResults', 'KalturaObjectListResponse', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaScheduledTaskProfileListResponse

List scheduled task profiles

Returns:



614
615
616
617
618
619
620
621
622
623
 
# File 'lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb', line 614

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

#request_dry_run(scheduled_task_profile_id, max_results = 500) ⇒ int

Returns:

  • (int) 


626
627
628
629
630
631
632
633
634
635
 
# File 'lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb', line 626

def request_dry_run(scheduled_task_profile_id, max_results=500)
  kparams = {}
  client.add_param(kparams, 'scheduledTaskProfileId', scheduled_task_profile_id)
  client.add_param(kparams, 'maxResults', max_results)
  client.queue_service_action_call('scheduledtask_scheduledtaskprofile', 'requestDryRun', 'int', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#serve_dry_run_results(request_id) ⇒ file

Serves dry run results by its request id

Returns:

  • (file) 


639
640
641
642
643
644
 
# File 'lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb', line 639

def serve_dry_run_results(request_id)
  kparams = {}
  client.add_param(kparams, 'requestId', request_id)
  client.queue_service_action_call('scheduledtask_scheduledtaskprofile', 'serveDryRunResults', 'file', kparams)
  return client.get_serve_url()
end

#update(id, scheduled_task_profile) ⇒ KalturaScheduledTaskProfile

Update an existing scheduled task profile

Returns:



648
649
650
651
652
653
654
655
656
657
 
# File 'lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb', line 648

def update(id, scheduled_task_profile)
  kparams = {}
  client.add_param(kparams, 'id', id)
  client.add_param(kparams, 'scheduledTaskProfile', scheduled_task_profile)
  client.queue_service_action_call('scheduledtask_scheduledtaskprofile', 'update', 'KalturaScheduledTaskProfile', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end