Package com.kaltura.client.services

Class BaseEntryService

java.lang.Object

com.kaltura.client.services.BaseEntryService

public class BaseEntryService
extends Object

Base Entry Service

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseEntryService.AddBaseEntryBuilder
static class	BaseEntryService.AddContentBaseEntryBuilder
static class	BaseEntryService.AddFromUploadedFileBaseEntryBuilder
static class	BaseEntryService.AnonymousRankBaseEntryBuilder
static class	BaseEntryService.ApproveBaseEntryBuilder
static class	BaseEntryService.CloneBaseEntryBuilder
static class	BaseEntryService.CountBaseEntryBuilder
static class	BaseEntryService.DeleteBaseEntryBuilder
static class	BaseEntryService.ExportBaseEntryBuilder
static class	BaseEntryService.ExportToCsvBaseEntryBuilder
static class	BaseEntryService.FlagBaseEntryBuilder
static class	BaseEntryService.GetBaseEntryBuilder
static class	BaseEntryService.GetByIdsBaseEntryBuilder
static class	BaseEntryService.GetContextDataBaseEntryBuilder
static class	BaseEntryService.GetPlaybackContextBaseEntryBuilder
static class	BaseEntryService.GetRemotePathsBaseEntryBuilder
static class	BaseEntryService.IndexBaseEntryBuilder
static class	BaseEntryService.ListBaseEntryBuilder
static class	BaseEntryService.ListByReferenceIdBaseEntryBuilder
static class	BaseEntryService.ListFlagsBaseEntryBuilder
static class	BaseEntryService.RejectBaseEntryBuilder
static class	BaseEntryService.ServePlaybackKeyBaseEntryBuilder
static class	BaseEntryService.UpdateBaseEntryBuilder
static class	BaseEntryService.UpdateContentBaseEntryBuilder
static class	BaseEntryService.UpdateThumbnailFromSourceEntryBaseEntryBuilder
static class	BaseEntryService.UpdateThumbnailFromUrlBaseEntryBuilder
static class	BaseEntryService.UpdateThumbnailJpegBaseEntryBuilder
static class	BaseEntryService.UploadBaseEntryBuilder

Constructor Summary

Constructors

Constructor	Description
BaseEntryService()

Method Summary

Modifier and Type	Method	Description
static BaseEntryService.AddBaseEntryBuilder	add(BaseEntry entry)
static BaseEntryService.AddBaseEntryBuilder	add(BaseEntry entry, EntryType type)	Generic add entry, should be used when the uploaded entry type is not known.
static BaseEntryService.AddContentBaseEntryBuilder	addContent(String entryId, Resource resource)	Attach content resource to entry in status NO_MEDIA
static BaseEntryService.AddFromUploadedFileBaseEntryBuilder	addFromUploadedFile(BaseEntry entry, String uploadTokenId)
static BaseEntryService.AddFromUploadedFileBaseEntryBuilder	addFromUploadedFile(BaseEntry entry, String uploadTokenId, EntryType type)	Generic add entry using an uploaded file, should be used when the uploaded entry type is not known.
static BaseEntryService.AnonymousRankBaseEntryBuilder	anonymousRank(String entryId, int rank)	Anonymously rank an entry, no validation is done on duplicate rankings.
static BaseEntryService.ApproveBaseEntryBuilder	approve(String entryId)	Approve the entry and mark the pending flags (if any) as moderated (this will make the entry playable).
static BaseEntryService.CloneBaseEntryBuilder	clone(String entryId)
static BaseEntryService.CloneBaseEntryBuilder	clone(String entryId, List<BaseEntryCloneOptionItem> cloneOptions)	Clone an entry with optional attributes to apply to the clone
static BaseEntryService.CountBaseEntryBuilder	count()
static BaseEntryService.CountBaseEntryBuilder	count(BaseEntryFilter filter)	Count base entries by filter.
static BaseEntryService.DeleteBaseEntryBuilder	delete(String entryId)	Delete an entry.
static BaseEntryService.ExportBaseEntryBuilder	export(String entryId, int storageProfileId)
static BaseEntryService.ExportToCsvBaseEntryBuilder	exportToCsv()
static BaseEntryService.ExportToCsvBaseEntryBuilder	exportToCsv(BaseEntryFilter filter)
static BaseEntryService.ExportToCsvBaseEntryBuilder	exportToCsv(BaseEntryFilter filter, int metadataProfileId)
static BaseEntryService.ExportToCsvBaseEntryBuilder	exportToCsv(BaseEntryFilter filter, int metadataProfileId, List<CsvAdditionalFieldInfo> additionalFields)
static BaseEntryService.ExportToCsvBaseEntryBuilder	exportToCsv(BaseEntryFilter filter, int metadataProfileId, List<CsvAdditionalFieldInfo> additionalFields, List<KeyValue> mappedFields)
static BaseEntryService.ExportToCsvBaseEntryBuilder	exportToCsv(BaseEntryFilter filter, int metadataProfileId, List<CsvAdditionalFieldInfo> additionalFields, List<KeyValue> mappedFields, ExportToCsvOptions options)	add batch job that sends an email with a link to download an updated CSV that contains list of entries
static BaseEntryService.FlagBaseEntryBuilder	flag(ModerationFlag moderationFlag)	Flag inappropriate entry for moderation.
static BaseEntryService.GetBaseEntryBuilder	get(String entryId)
static BaseEntryService.GetBaseEntryBuilder	get(String entryId, int version)	Get base entry by ID.
static BaseEntryService.GetByIdsBaseEntryBuilder	getByIds(String entryIds)	Get an array of KalturaBaseEntry objects by a comma-separated list of ids.
static BaseEntryService.GetContextDataBaseEntryBuilder	getContextData(String entryId, EntryContextDataParams contextDataParams)	This action delivers entry-related data, based on the user's context: access control, restriction, playback format and storage information.
static BaseEntryService.GetPlaybackContextBaseEntryBuilder	getPlaybackContext(String entryId, PlaybackContextOptions contextDataParams)	This action delivers all data relevant for player
static BaseEntryService.GetRemotePathsBaseEntryBuilder	getRemotePaths(String entryId)	Get remote storage existing paths for the asset.
static BaseEntryService.IndexBaseEntryBuilder	index(String id)
static BaseEntryService.IndexBaseEntryBuilder	index(String id, boolean shouldUpdate)	Index an entry by id.
static BaseEntryService.ListBaseEntryBuilder	list()
static BaseEntryService.ListBaseEntryBuilder	list(BaseEntryFilter filter)
static BaseEntryService.ListBaseEntryBuilder	list(BaseEntryFilter filter, FilterPager pager)	List base entries by filter with paging support.
static BaseEntryService.ListByReferenceIdBaseEntryBuilder	listByReferenceId(String refId)
static BaseEntryService.ListByReferenceIdBaseEntryBuilder	listByReferenceId(String refId, FilterPager pager)	List base entries by filter according to reference id
static BaseEntryService.ListFlagsBaseEntryBuilder	listFlags(String entryId)
static BaseEntryService.ListFlagsBaseEntryBuilder	listFlags(String entryId, FilterPager pager)	List all pending flags for the entry.
static BaseEntryService.RejectBaseEntryBuilder	reject(String entryId)	Reject the entry and mark the pending flags (if any) as moderated (this will make the entry non-playable).
static BaseEntryService.ServePlaybackKeyBaseEntryBuilder	servePlaybackKey(String entryId)	This action serves HLS encrypted key if access control is validated
static BaseEntryService.UpdateBaseEntryBuilder	update(String entryId, BaseEntry baseEntry)	Update base entry.
static BaseEntryService.UpdateContentBaseEntryBuilder	updateContent(String entryId, Resource resource)
static BaseEntryService.UpdateContentBaseEntryBuilder	updateContent(String entryId, Resource resource, int conversionProfileId)
static BaseEntryService.UpdateContentBaseEntryBuilder	updateContent(String entryId, Resource resource, int conversionProfileId, EntryReplacementOptions advancedOptions)	Update the content resource associated with the entry.
static BaseEntryService.UpdateThumbnailFromSourceEntryBaseEntryBuilder	updateThumbnailFromSourceEntry(String entryId, String sourceEntryId, int timeOffset)	Update entry thumbnail from a different entry by a specified time offset (in seconds).
static BaseEntryService.UpdateThumbnailFromUrlBaseEntryBuilder	updateThumbnailFromUrl(String entryId, String url)	Update entry thumbnail using URL.
static BaseEntryService.UpdateThumbnailJpegBaseEntryBuilder	updateThumbnailJpeg(String entryId, FileHolder fileData)	Update entry thumbnail using a raw jpeg file.
static BaseEntryService.UpdateThumbnailJpegBaseEntryBuilder	updateThumbnailJpeg(String entryId, File fileData)
static BaseEntryService.UpdateThumbnailJpegBaseEntryBuilder	updateThumbnailJpeg(String entryId, FileInputStream fileData, String fileDataMimeType, String fileDataName)
static BaseEntryService.UpdateThumbnailJpegBaseEntryBuilder	updateThumbnailJpeg(String entryId, InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize)
static BaseEntryService.UploadBaseEntryBuilder	upload(FileHolder fileData)	Upload a file to Kaltura, that can be used to create an entry.
static BaseEntryService.UploadBaseEntryBuilder	upload(File fileData)
static BaseEntryService.UploadBaseEntryBuilder	upload(FileInputStream fileData, String fileDataMimeType, String fileDataName)
static BaseEntryService.UploadBaseEntryBuilder	upload(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseEntryService

public BaseEntryService()

Method Detail

add

public static BaseEntryService.AddBaseEntryBuilder add(BaseEntry entry)

add

public static BaseEntryService.AddBaseEntryBuilder add(BaseEntry entry,
                                                       EntryType type)

Generic add entry, should be used when the uploaded entry type is not known.

Parameters:

entry -

type -

addContent

public static BaseEntryService.AddContentBaseEntryBuilder addContent(String entryId,
                                                                     Resource resource)

Attach content resource to entry in status NO_MEDIA

Parameters:

entryId -

resource -

addFromUploadedFile

public static BaseEntryService.AddFromUploadedFileBaseEntryBuilder addFromUploadedFile(BaseEntry entry,
                                                                                       String uploadTokenId)

addFromUploadedFile

public static BaseEntryService.AddFromUploadedFileBaseEntryBuilder addFromUploadedFile(BaseEntry entry,
                                                                                       String uploadTokenId,
                                                                                       EntryType type)

Generic add entry using an uploaded file, should be used when the uploaded entry type is not known.

Parameters:

entry -

uploadTokenId -

type -

anonymousRank

public static BaseEntryService.AnonymousRankBaseEntryBuilder anonymousRank(String entryId,
                                                                           int rank)

Anonymously rank an entry, no validation is done on duplicate rankings.

Parameters:

entryId -

rank -

approve

public static BaseEntryService.ApproveBaseEntryBuilder approve(String entryId)

Approve the entry and mark the pending flags (if any) as moderated (this will make the entry playable).

Parameters:

entryId -

clone

public static BaseEntryService.CloneBaseEntryBuilder clone(String entryId)

clone

public static BaseEntryService.CloneBaseEntryBuilder clone(String entryId,
                                                           List<BaseEntryCloneOptionItem> cloneOptions)

Clone an entry with optional attributes to apply to the clone

Parameters:

entryId - Id of entry to clone

cloneOptions -

count

public static BaseEntryService.CountBaseEntryBuilder count()

count

public static BaseEntryService.CountBaseEntryBuilder count(BaseEntryFilter filter)

Count base entries by filter.

Parameters:

filter - Entry filter

delete

public static BaseEntryService.DeleteBaseEntryBuilder delete(String entryId)

Delete an entry.

Parameters:

entryId - Entry id to delete

export

public static BaseEntryService.ExportBaseEntryBuilder export(String entryId,
                                                             int storageProfileId)

exportToCsv

public static BaseEntryService.ExportToCsvBaseEntryBuilder exportToCsv()

exportToCsv

public static BaseEntryService.ExportToCsvBaseEntryBuilder exportToCsv(BaseEntryFilter filter)

exportToCsv

public static BaseEntryService.ExportToCsvBaseEntryBuilder exportToCsv(BaseEntryFilter filter,
                                                                       int metadataProfileId)

exportToCsv

public static BaseEntryService.ExportToCsvBaseEntryBuilder exportToCsv(BaseEntryFilter filter,
                                                                       int metadataProfileId,
                                                                       List<CsvAdditionalFieldInfo> additionalFields)

exportToCsv

public static BaseEntryService.ExportToCsvBaseEntryBuilder exportToCsv(BaseEntryFilter filter,
                                                                       int metadataProfileId,
                                                                       List<CsvAdditionalFieldInfo> additionalFields,
                                                                       List<KeyValue> mappedFields)

exportToCsv

public static BaseEntryService.ExportToCsvBaseEntryBuilder exportToCsv(BaseEntryFilter filter,
                                                                       int metadataProfileId,
                                                                       List<CsvAdditionalFieldInfo> additionalFields,
                                                                       List<KeyValue> mappedFields,
                                                                       ExportToCsvOptions options)

add batch job that sends an email with a link to download an updated CSV that contains list of entries

Parameters:

filter - A filter used to exclude specific entries

metadataProfileId -

additionalFields -

mappedFields - mapping between field headline and its mapped value

options -

flag

public static BaseEntryService.FlagBaseEntryBuilder flag(ModerationFlag moderationFlag)

Flag inappropriate entry for moderation.

Parameters:

moderationFlag -

get

public static BaseEntryService.GetBaseEntryBuilder get(String entryId)

get

public static BaseEntryService.GetBaseEntryBuilder get(String entryId,
                                                       int version)

Get base entry by ID.

Parameters:

entryId - Entry id

version - Desired version of the data

getByIds

public static BaseEntryService.GetByIdsBaseEntryBuilder getByIds(String entryIds)

Get an array of KalturaBaseEntry objects by a comma-separated list of ids.

Parameters:

entryIds - Comma separated string of entry ids

getContextData

public static BaseEntryService.GetContextDataBaseEntryBuilder getContextData(String entryId,
                                                                             EntryContextDataParams contextDataParams)

This action delivers entry-related data, based on the user's context: access control, restriction, playback format and storage information.

Parameters:

entryId -

contextDataParams -

getPlaybackContext

public static BaseEntryService.GetPlaybackContextBaseEntryBuilder getPlaybackContext(String entryId,
                                                                                     PlaybackContextOptions contextDataParams)

This action delivers all data relevant for player

Parameters:

entryId -

contextDataParams -

getRemotePaths

public static BaseEntryService.GetRemotePathsBaseEntryBuilder getRemotePaths(String entryId)

Get remote storage existing paths for the asset.

Parameters:

entryId -

index

public static BaseEntryService.IndexBaseEntryBuilder index(String id)

index

public static BaseEntryService.IndexBaseEntryBuilder index(String id,
                                                           boolean shouldUpdate)

Index an entry by id.

Parameters:

id -

shouldUpdate -

list

public static BaseEntryService.ListBaseEntryBuilder list()

list

public static BaseEntryService.ListBaseEntryBuilder list(BaseEntryFilter filter)

list

public static BaseEntryService.ListBaseEntryBuilder list(BaseEntryFilter filter,
                                                         FilterPager pager)

List base entries by filter with paging support.

Parameters:

filter - Entry filter

pager - Pager

listByReferenceId

public static BaseEntryService.ListByReferenceIdBaseEntryBuilder listByReferenceId(String refId)

listByReferenceId

public static BaseEntryService.ListByReferenceIdBaseEntryBuilder listByReferenceId(String refId,
                                                                                   FilterPager pager)

List base entries by filter according to reference id

Parameters:

refId - Entry Reference ID

pager - Pager

listFlags

public static BaseEntryService.ListFlagsBaseEntryBuilder listFlags(String entryId)

listFlags

public static BaseEntryService.ListFlagsBaseEntryBuilder listFlags(String entryId,
                                                                   FilterPager pager)

List all pending flags for the entry.

Parameters:

entryId -

pager -

reject

public static BaseEntryService.RejectBaseEntryBuilder reject(String entryId)

Reject the entry and mark the pending flags (if any) as moderated (this will make the entry non-playable).

Parameters:

entryId -

servePlaybackKey

public static BaseEntryService.ServePlaybackKeyBaseEntryBuilder servePlaybackKey(String entryId)

This action serves HLS encrypted key if access control is validated

Parameters:

entryId -

update

public static BaseEntryService.UpdateBaseEntryBuilder update(String entryId,
                                                             BaseEntry baseEntry)

Update base entry. Only the properties that were set will be updated.

Parameters:

entryId - Entry id to update

baseEntry - Base entry metadata to update

updateContent

public static BaseEntryService.UpdateContentBaseEntryBuilder updateContent(String entryId,
                                                                           Resource resource)

updateContent

public static BaseEntryService.UpdateContentBaseEntryBuilder updateContent(String entryId,
                                                                           Resource resource,
                                                                           int conversionProfileId)

updateContent

public static BaseEntryService.UpdateContentBaseEntryBuilder updateContent(String entryId,
                                                                           Resource resource,
                                                                           int conversionProfileId,
                                                                           EntryReplacementOptions advancedOptions)

Update the content resource associated with the entry.

Parameters:

entryId - Entry id to update

resource - Resource to be used to replace entry content

conversionProfileId - The conversion profile id to be used on the entry

advancedOptions - Additional update content options

updateThumbnailFromSourceEntry

public static BaseEntryService.UpdateThumbnailFromSourceEntryBaseEntryBuilder updateThumbnailFromSourceEntry(String entryId,
                                                                                                             String sourceEntryId,
                                                                                                             int timeOffset)

Update entry thumbnail from a different entry by a specified time offset (in seconds).

Parameters:

entryId - Media entry id

sourceEntryId - Media entry id

timeOffset - Time offset (in seconds)

updateThumbnailFromUrl

public static BaseEntryService.UpdateThumbnailFromUrlBaseEntryBuilder updateThumbnailFromUrl(String entryId,
                                                                                             String url)

Update entry thumbnail using URL.

Parameters:

entryId - Media entry id

url - file url

updateThumbnailJpeg

public static BaseEntryService.UpdateThumbnailJpegBaseEntryBuilder updateThumbnailJpeg(String entryId,
                                                                                       File fileData)

updateThumbnailJpeg

public static BaseEntryService.UpdateThumbnailJpegBaseEntryBuilder updateThumbnailJpeg(String entryId,
                                                                                       InputStream fileData,
                                                                                       String fileDataMimeType,
                                                                                       String fileDataName,
                                                                                       long fileDataSize)

updateThumbnailJpeg

public static BaseEntryService.UpdateThumbnailJpegBaseEntryBuilder updateThumbnailJpeg(String entryId,
                                                                                       FileInputStream fileData,
                                                                                       String fileDataMimeType,
                                                                                       String fileDataName)

updateThumbnailJpeg

public static BaseEntryService.UpdateThumbnailJpegBaseEntryBuilder updateThumbnailJpeg(String entryId,
                                                                                       FileHolder fileData)

Update entry thumbnail using a raw jpeg file.

Parameters:

entryId - Media entry id

fileData - Jpeg file data

upload

public static BaseEntryService.UploadBaseEntryBuilder upload(File fileData)

upload

public static BaseEntryService.UploadBaseEntryBuilder upload(InputStream fileData,
                                                             String fileDataMimeType,
                                                             String fileDataName,
                                                             long fileDataSize)

upload

public static BaseEntryService.UploadBaseEntryBuilder upload(FileInputStream fileData,
                                                             String fileDataMimeType,
                                                             String fileDataName)

upload

public static BaseEntryService.UploadBaseEntryBuilder upload(FileHolder fileData)

Upload a file to Kaltura, that can be used to create an entry.

Parameters:

fileData - The file data