Class AsperaApi

Inheritance

System.Object

AsperaApi

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.Inputs.Aspera

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class AsperaApi

Constructors

AsperaApi(IBitmovinApiClientFactory)

Declaration

public AsperaApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of AsperaApi

Declaration

public static BitmovinApiBuilder<AsperaApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<AsperaApi>

Customdata

Declaration

public CustomdataApi Customdata { get; }

Property Value

Type	Description
CustomdataApi

Methods

CreateAsync(AsperaInput)

Create Aspera Input

Declaration

public Task<AsperaInput> CreateAsync(AsperaInput asperaInput)

Parameters

Type	Name	Description
AsperaInput	asperaInput	The Aspera input to be created

Returns

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

DeleteAsync(String)

Delete Aspera Input

Declaration

public Task<AsperaInput> DeleteAsync(string inputId)

Parameters

Type	Name	Description
System.String	inputId	Id of the input (required)

Returns

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

GetAsync(String)

Aspera Input Details

Declaration

public Task<AsperaInput> GetAsync(string inputId)

Parameters

Type	Name	Description
System.String	inputId	Id of the input (required)

Returns

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

ListAsync(Func<AsperaApi.ListQueryParams, AsperaApi.ListQueryParams>[])

List Aspera Inputs

Declaration

public Task<PaginationResponse<AsperaInput>> ListAsync(params Func<AsperaApi.ListQueryParams, AsperaApi.ListQueryParams>[] queryParams)

Parameters

Type	Name	Description
System.Func<AsperaApi.ListQueryParams, AsperaApi.ListQueryParams>[]	queryParams	The query parameters for sorting, filtering and paging options (optional)

Returns

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