class Kaltura::KalturaScheduledTaskProfileService

Schedule task service lets you create and manage scheduled task profiles

Public Class Methods

new(client) click to toggle source
Calls superclass method Kaltura::KalturaServiceBase::new
# File lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb, line 566
def initialize(client)
        super(client)
end

Public Instance Methods

add(scheduled_task_profile) click to toggle source

Add a new scheduled task profile @return [KalturaScheduledTaskProfile]

# File lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb, line 572
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) click to toggle source

Delete a scheduled task profile @return []

# File lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb, line 584
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) click to toggle source

Retrieve a scheduled task profile by id @return [KalturaScheduledTaskProfile]

# File lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb, line 596
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) click to toggle source

@return [KalturaObjectListResponse]

# File lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb, line 607
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) click to toggle source

List scheduled task profiles @return [KalturaScheduledTaskProfileListResponse]

# File lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb, line 619
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) click to toggle source

@return [int]

# File lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb, line 631
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) click to toggle source

Serves dry run results by its request id @return [file]

# File lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb, line 644
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) click to toggle source

Update an existing scheduled task profile @return [KalturaScheduledTaskProfile]

# File lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb, line 653
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