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

Show more of this group Show more artifacts with this name
Show all versions of kalturaApiClient 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

There is a newer version: 19.3.0

Show newest version

// ===================================================================================================
//                           _  __     _ _
//                          | |/ /__ _| | |_ _  _ _ _ __ _
//                          | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client.services;

import com.kaltura.client.types.BulkUpload;
import com.kaltura.client.types.BulkUploadFilter;
import com.kaltura.client.types.FilterPager;
import com.kaltura.client.utils.request.ListResponseRequestBuilder;
import com.kaltura.client.utils.request.RequestBuilder;
import com.kaltura.client.utils.request.ServeRequestBuilder;

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

/**
 * Bulk upload service is used to upload & manage bulk uploads
 * 
 * @param id job id
 * @param id 
 * @param bulkUploadFilter 
 * @param pager 
 * @param id job id
 * @param id job id
 */
public class BulkService {
	
	public static class AbortBulkBuilder extends RequestBuilder {
		
		public AbortBulkBuilder(int id) {
			super(BulkUpload.class, "bulkupload_bulk", "abort");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Aborts the bulk upload and all its child jobs
	 * 
	 * @param id job id
	 */
    public static AbortBulkBuilder abort(int id)  {
		return new AbortBulkBuilder(id);
	}
	
	public static class GetBulkBuilder extends RequestBuilder {
		
		public GetBulkBuilder(int id) {
			super(BulkUpload.class, "bulkupload_bulk", "get");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Get bulk upload batch job by id
	 * 
	 * @param id 
	 */
    public static GetBulkBuilder get(int id)  {
		return new GetBulkBuilder(id);
	}
	
	public static class ListBulkBuilder extends ListResponseRequestBuilder {
		
		public ListBulkBuilder(BulkUploadFilter bulkUploadFilter, FilterPager pager) {
			super(BulkUpload.class, "bulkupload_bulk", "list");
			params.add("bulkUploadFilter", bulkUploadFilter);
			params.add("pager", pager);
		}
	}

	public static ListBulkBuilder list()  {
		return list(null);
	}

	public static ListBulkBuilder list(BulkUploadFilter bulkUploadFilter)  {
		return list(bulkUploadFilter, null);
	}

	/**
	 * List bulk upload batch jobs
	 * 
	 * @param bulkUploadFilter 
	 * @param pager 
	 */
    public static ListBulkBuilder list(BulkUploadFilter bulkUploadFilter, FilterPager pager)  {
		return new ListBulkBuilder(bulkUploadFilter, pager);
	}
	
	public static class ServeBulkBuilder extends ServeRequestBuilder {
		
		public ServeBulkBuilder(int id) {
			super("bulkupload_bulk", "serve");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * serve action returns the original file.
	 * 
	 * @param id job id
	 */
    public static ServeBulkBuilder serve(int id)  {
		return new ServeBulkBuilder(id);
	}
	
	public static class ServeLogBulkBuilder extends ServeRequestBuilder {
		
		public ServeLogBulkBuilder(int id) {
			super("bulkupload_bulk", "serveLog");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * serveLog action returns the log file for the bulk-upload job.
	 * 
	 * @param id job id
	 */
    public static ServeLogBulkBuilder serveLog(int id)  {
		return new ServeLogBulkBuilder(id);
	}
}