com.bitmovin.api.sdk.analytics.exports

Class ExportsApi

java.lang.Object

com.bitmovin.api.sdk.analytics.exports.ExportsApi

public class ExportsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ExportsApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<ExportsApi>	builder() Fluent builder for creating an instance of ExportsApi
AnalyticsExportTask	create(AnalyticsExportTask analyticsExportTask) Create Export Task
AnalyticsExportTask	get(String exportTaskId) Get export task
PaginationResponse<AnalyticsExportTask>	list() List Export Tasks
PaginationResponse<AnalyticsExportTask>	list(AnalyticsExportTaskListQueryParams queryParams) List Export Tasks

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportsApi

public ExportsApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<ExportsApi> builder()

Fluent builder for creating an instance of ExportsApi

create

public AnalyticsExportTask create(AnalyticsExportTask analyticsExportTask)
                           throws BitmovinException

Create Export Task

Parameters:

analyticsExportTask - The export task to be created (required)

Returns:

AnalyticsExportTask

Throws:

BitmovinException - if fails to make API call

get

public AnalyticsExportTask get(String exportTaskId)
                        throws BitmovinException

Get export task

Parameters:

exportTaskId - Export task id (required)

Returns:

AnalyticsExportTask

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<AnalyticsExportTask> list()
                                             throws BitmovinException

List Export Tasks

Returns:

List<AnalyticsExportTask>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<AnalyticsExportTask> list(AnalyticsExportTaskListQueryParams queryParams)
                                             throws BitmovinException

List Export Tasks

Parameters:

queryParams - The query parameters for sorting, filtering and paging options (optional)

Returns:

List<AnalyticsExportTask>

Throws:

BitmovinException - if fails to make API call