Class: Kaltura::KalturaScheduledTaskProfileService

Inherits:

KalturaServiceBase

• Object
• KalturaServiceBase
• Kaltura::KalturaScheduledTaskProfileService

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

• #add(scheduled_task_profile) ⇒ Object

  Add a new scheduled task profile.

• #delete(id) ⇒ Object

  Delete a scheduled task profile.

• #get(id) ⇒ Object

  Retrieve a scheduled task profile by id.

• #get_dry_run_results(request_id) ⇒ Object
• #initialize(client) ⇒ KalturaScheduledTaskProfileService constructor

  A new instance of KalturaScheduledTaskProfileService.

• #list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ Object

  List scheduled task profiles.

• #request_dry_run(scheduled_task_profile_id, max_results = 500) ⇒ Object
• #update(id, scheduled_task_profile) ⇒ Object

  Update an existing scheduled task profile.

Constructor Details

#initialize(client) ⇒ KalturaScheduledTaskProfileService

Returns a new instance of KalturaScheduledTaskProfileService.

# File 'lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb', line 358

def initialize(client)
	super(client)
end

Instance Method Details

#add(scheduled_task_profile) ⇒ Object

Add a new scheduled task profile

# File 'lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb', line 364

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

# File 'lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb', line 401

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) ⇒ Object

Retrieve a scheduled task profile by id

# File 'lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb', line 376

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) ⇒ Object

# File 'lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb', line 435

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) ⇒ Object

List scheduled task profiles

# File 'lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb', line 413

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) ⇒ Object

# File 'lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb', line 424

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

#update(id, scheduled_task_profile) ⇒ Object

Update an existing scheduled task profile

# File 'lib/kaltura_plugins/kaltura_scheduled_task_client_plugin.rb', line 388

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