com.kaltura.client.services.KalturaScheduledTaskProfileService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kalturaClient Show documentation
KalturaClient is a library of Java classes that can be used to interact with the Kaltura REST API. More information about the REST API can be found at http://corp.kaltura.com/Products/Kaltura-API Many of the Java classes in this library are auto-generated from a schema that defines the objects that are used to interect with the API. The current schema can be found at http://www.kaltura.com/api_v3/api_schema.php
The newest version!
// ===================================================================================================
//                           _  __     _ _
//                          | |/ /__ _| | |_ _  _ _ _ __ _
//                          | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client.services;

import com.kaltura.client.KalturaClient;
import com.kaltura.client.KalturaServiceBase;
import com.kaltura.client.types.*;
import org.w3c.dom.Element;
import com.kaltura.client.utils.ParseUtils;
import com.kaltura.client.KalturaParams;
import com.kaltura.client.KalturaApiException;

/**
 * This class was generated using generate.php
 * against an XML schema provided by Kaltura.
 * 
 * MANUAL CHANGES TO THIS CLASS WILL BE OVERWRITTEN.
 */

/**  Schedule task service lets you create and manage scheduled task profiles    */
@SuppressWarnings("serial")
public class KalturaScheduledTaskProfileService extends KalturaServiceBase {
    public KalturaScheduledTaskProfileService(KalturaClient client) {
        this.kalturaClient = client;
    }

	/**  Add a new scheduled task profile     */
    public KalturaScheduledTaskProfile add(KalturaScheduledTaskProfile scheduledTaskProfile) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("scheduledTaskProfile", scheduledTaskProfile);
        this.kalturaClient.queueServiceCall("scheduledtask_scheduledtaskprofile", "add", kparams, KalturaScheduledTaskProfile.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaScheduledTaskProfile.class, resultXmlElement);
    }

	/**  Retrieve a scheduled task profile by id     */
    public KalturaScheduledTaskProfile get(int id) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        this.kalturaClient.queueServiceCall("scheduledtask_scheduledtaskprofile", "get", kparams, KalturaScheduledTaskProfile.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaScheduledTaskProfile.class, resultXmlElement);
    }

	/**  Update an existing scheduled task profile     */
    public KalturaScheduledTaskProfile update(int id, KalturaScheduledTaskProfile scheduledTaskProfile) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        kparams.add("scheduledTaskProfile", scheduledTaskProfile);
        this.kalturaClient.queueServiceCall("scheduledtask_scheduledtaskprofile", "update", kparams, KalturaScheduledTaskProfile.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaScheduledTaskProfile.class, resultXmlElement);
    }

	/**  Delete a scheduled task profile     */
    public void delete(int id) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        this.kalturaClient.queueServiceCall("scheduledtask_scheduledtaskprofile", "delete", kparams);
        if (this.kalturaClient.isMultiRequest())
            return ;
        this.kalturaClient.doQueue();
    }

    public KalturaScheduledTaskProfileListResponse list() throws KalturaApiException {
        return this.list(null);
    }

    public KalturaScheduledTaskProfileListResponse list(KalturaScheduledTaskProfileFilter filter) throws KalturaApiException {
        return this.list(filter, null);
    }

	/**  List scheduled task profiles     */
    public KalturaScheduledTaskProfileListResponse list(KalturaScheduledTaskProfileFilter filter, KalturaFilterPager pager) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("filter", filter);
        kparams.add("pager", pager);
        this.kalturaClient.queueServiceCall("scheduledtask_scheduledtaskprofile", "list", kparams, KalturaScheduledTaskProfileListResponse.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaScheduledTaskProfileListResponse.class, resultXmlElement);
    }

    public int requestDryRun(int scheduledTaskProfileId) throws KalturaApiException {
        return this.requestDryRun(scheduledTaskProfileId, 500);
    }

    public int requestDryRun(int scheduledTaskProfileId, int maxResults) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("scheduledTaskProfileId", scheduledTaskProfileId);
        kparams.add("maxResults", maxResults);
        this.kalturaClient.queueServiceCall("scheduledtask_scheduledtaskprofile", "requestDryRun", kparams);
        if (this.kalturaClient.isMultiRequest())
            return 0;
        Element resultXmlElement = this.kalturaClient.doQueue();
        String resultText = resultXmlElement.getTextContent();
        return ParseUtils.parseInt(resultText);
    }

    public KalturaObjectListResponse getDryRunResults(int requestId) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("requestId", requestId);
        this.kalturaClient.queueServiceCall("scheduledtask_scheduledtaskprofile", "getDryRunResults", kparams, KalturaObjectListResponse.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaObjectListResponse.class, resultXmlElement);
    }
}