com.bitmovin.api.sdk.encoding.infrastructure.prewarmedEncoderPools.schedules

Class SchedulesApi

java.lang.Object

com.bitmovin.api.sdk.encoding.infrastructure.prewarmedEncoderPools.schedules.SchedulesApi

public class SchedulesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SchedulesApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<SchedulesApi>	builder() Fluent builder for creating an instance of SchedulesApi
PrewarmedEncoderPoolSchedule	create(String poolId, PrewarmedEncoderPoolSchedule prewarmedEncoderPoolSchedule) Create prewarmed encoder pool schedule
BitmovinResponse	delete(String poolId, String scheduleId) Delete prewarmed encoder pool schedule
PrewarmedEncoderPoolSchedule	get(String poolId, String scheduleId) Prewarmed encoder pool schedule details
PaginationResponse<PrewarmedEncoderPool>	list(String poolId) List prewarmed encoder pool schedules
PaginationResponse<PrewarmedEncoderPool>	list(String poolId, PrewarmedEncoderPoolListQueryParams queryParams) List prewarmed encoder pool schedules

Methods inherited from class java.lang.Object

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

Constructor Detail

SchedulesApi

public SchedulesApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<SchedulesApi> builder()

Fluent builder for creating an instance of SchedulesApi

create

public PrewarmedEncoderPoolSchedule create(String poolId,
                                           PrewarmedEncoderPoolSchedule prewarmedEncoderPoolSchedule)
                                    throws BitmovinException

Create prewarmed encoder pool schedule

Parameters:

poolId - Id of the scheduled encoder pool (required)

prewarmedEncoderPoolSchedule - The prewarmed encoder pool schedule to be created (required)

Returns:

PrewarmedEncoderPoolSchedule

Throws:

BitmovinException - if fails to make API call

delete

public BitmovinResponse delete(String poolId,
                               String scheduleId)
                        throws BitmovinException

Delete prewarmed encoder pool schedule

Parameters:

poolId - Id of the scheduled encoder pool (required)

scheduleId - Id of the prewarmed encoder pool schedule (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public PrewarmedEncoderPoolSchedule get(String poolId,
                                        String scheduleId)
                                 throws BitmovinException

Prewarmed encoder pool schedule details

Parameters:

poolId - Id of the scheduled encoder pool (required)

scheduleId - Id of the prewarmed encoder pool schedule (required)

Returns:

PrewarmedEncoderPoolSchedule

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<PrewarmedEncoderPool> list(String poolId)
                                              throws BitmovinException

List prewarmed encoder pool schedules

Parameters:

poolId - Id of the scheduled encoder pool (required)

Returns:

List<PrewarmedEncoderPool>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<PrewarmedEncoderPool> list(String poolId,
                                                     PrewarmedEncoderPoolListQueryParams queryParams)
                                              throws BitmovinException

List prewarmed encoder pool schedules

Parameters:

poolId - Id of the scheduled encoder pool (required)

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

Returns:

List<PrewarmedEncoderPool>

Throws:

BitmovinException - if fails to make API call