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.Inputs.Sftp
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class SftpApiConstructors
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(SftpInput)
Create SFTP Input
Declaration
public Task<SftpInput> CreateAsync(SftpInput sftpInput)Parameters
| Type | Name | Description |
|---|---|---|
| SftpInput | sftpInput | The SFTP input to be created |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<SftpInput> |
DeleteAsync(String)
Delete SFTP Input
Declaration
public Task<SftpInput> DeleteAsync(string inputId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | inputId | Id of the input (required) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<SftpInput> |
GetAsync(String)
SFTP Input Details
Declaration
public Task<SftpInput> GetAsync(string inputId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | inputId | Id of the input (required) |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<SftpInput> |
ListAsync(Func<SftpApi.ListQueryParams, SftpApi.ListQueryParams>[])
List SFTP Inputs
Declaration
public Task<PaginationResponse<SftpInput>> 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<SftpInput>> |