Class FtpApi
Inheritance
System.Object
FtpApi
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.Ftp
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class FtpApiConstructors
FtpApi(IBitmovinApiClientFactory)
Declaration
public FtpApi(IBitmovinApiClientFactory apiClientFactory)Parameters
| Type | Name | Description |
|---|---|---|
| IBitmovinApiClientFactory | apiClientFactory |
Properties
Builder
Fluent builder for creating an instance of FtpApi
Declaration
public static BitmovinApiBuilder<FtpApi> Builder { get; }Property Value
| Type | Description |
|---|---|
| BitmovinApiBuilder<FtpApi> |
Customdata
Declaration
public CustomdataApi Customdata { get; }Property Value
| Type | Description |
|---|---|
| CustomdataApi |
Methods
CreateAsync(FtpInput)
Create FTP Input
Declaration
public Task<FtpInput> CreateAsync(FtpInput ftpInput)Parameters
| Type | Name | Description |
|---|---|---|
| FtpInput | ftpInput | The FTP input to be created |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<FtpInput> |
DeleteAsync(String)
Delete FTP Input
Declaration
public Task<FtpInput> DeleteAsync(string inputId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | inputId | Id of the input (required) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<FtpInput> |
GetAsync(String)
FTP Input Details
Declaration
public Task<FtpInput> GetAsync(string inputId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | inputId | Id of the input (required) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<FtpInput> |
ListAsync(Func<FtpApi.ListQueryParams, FtpApi.ListQueryParams>[])
List FTP Inputs
Declaration
public Task<PaginationResponse<FtpInput>> ListAsync(params Func<FtpApi.ListQueryParams, FtpApi.ListQueryParams>[] queryParams)Parameters
| Type | Name | Description |
|---|---|---|
| System.Func<FtpApi.ListQueryParams, FtpApi.ListQueryParams>[] | queryParams | The query parameters for sorting, filtering and paging options (optional) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<PaginationResponse<FtpInput>> |