Class SchedulesApi

Inheritance

System.Object

SchedulesApi

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Bitmovin.Api.Sdk.Encoding.Infrastructure.PrewarmedEncoderPools.Schedules

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class SchedulesApi

Constructors

SchedulesApi(IBitmovinApiClientFactory)

Declaration

public SchedulesApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of SchedulesApi

Declaration

public static BitmovinApiBuilder<SchedulesApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<SchedulesApi>

Methods

CreateAsync(String, PrewarmedEncoderPoolSchedule)

Create prewarmed encoder pool schedule

Declaration

public Task<PrewarmedEncoderPoolSchedule> CreateAsync(string poolId, PrewarmedEncoderPoolSchedule prewarmedEncoderPoolSchedule)

Parameters

Type	Name	Description
System.String	poolId	Id of the scheduled encoder pool (required)
PrewarmedEncoderPoolSchedule	prewarmedEncoderPoolSchedule	The prewarmed encoder pool schedule to be created

Returns

Type	Description
System.Threading.Tasks.Task<PrewarmedEncoderPoolSchedule>

DeleteAsync(String, String)

Delete prewarmed encoder pool schedule

Declaration

public Task<BitmovinResponse> DeleteAsync(string poolId, string scheduleId)

Parameters

Type	Name	Description
System.String	poolId	Id of the scheduled encoder pool (required)
System.String	scheduleId	Id of the prewarmed encoder pool schedule (required)

Returns

Type	Description
System.Threading.Tasks.Task<BitmovinResponse>

GetAsync(String, String)

Prewarmed encoder pool schedule details

Declaration

public Task<PrewarmedEncoderPoolSchedule> GetAsync(string poolId, string scheduleId)

Parameters

Type	Name	Description
System.String	poolId	Id of the scheduled encoder pool (required)
System.String	scheduleId	Id of the prewarmed encoder pool schedule (required)

Returns

Type	Description
System.Threading.Tasks.Task<PrewarmedEncoderPoolSchedule>

ListAsync(String, Func<SchedulesApi.ListQueryParams, SchedulesApi.ListQueryParams>[])

List prewarmed encoder pool schedules

Declaration

public Task<PaginationResponse<PrewarmedEncoderPoolSchedule>> ListAsync(string poolId, params Func<SchedulesApi.ListQueryParams, SchedulesApi.ListQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.String	poolId	Id of the scheduled encoder pool (required)
System.Func<SchedulesApi.ListQueryParams, SchedulesApi.ListQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

Type	Description
System.Threading.Tasks.Task<PaginationResponse<PrewarmedEncoderPoolSchedule>>