Class SftpApi

Inheritance

System.Object

SftpApi

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.Outputs.Sftp

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class SftpApi

Constructors

SftpApi(IBitmovinApiClientFactory)

Declaration

public SftpApi(IBitmovinApiClientFactory apiClientFactory)

Parameters

Type	Name	Description
IBitmovinApiClientFactory	apiClientFactory

Properties

Builder

Fluent builder for creating an instance of SftpApi

Declaration

public static BitmovinApiBuilder<SftpApi> Builder { get; }

Property Value

Type	Description
BitmovinApiBuilder<SftpApi>

Customdata

Declaration

public CustomdataApi Customdata { get; }

Property Value

Type	Description
CustomdataApi

Methods

CreateAsync(SftpOutput)

Create SFTP Output

Declaration

public Task<SftpOutput> CreateAsync(SftpOutput sftpOutput)

Parameters

Type	Name	Description
SftpOutput	sftpOutput	The SFTP output to be created.

Returns

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

DeleteAsync(String)

Delete SFTP Output

Declaration

public Task<SftpOutput> DeleteAsync(string outputId)

Parameters

Type	Name	Description
System.String	outputId	Id of the output (required)

Returns

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

GetAsync(String)

SFTP Output Details

Declaration

public Task<SftpOutput> GetAsync(string outputId)

Parameters

Type	Name	Description
System.String	outputId	Id of the output (required)

Returns

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

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

List SFTP Outputs

Declaration

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

Parameters

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

Returns

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