com.bitmovin.api.sdk.encoding.inputs.sftp

Class SftpApi

java.lang.Object

com.bitmovin.api.sdk.encoding.inputs.sftp.SftpApi

public class SftpApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
CustomdataApi	customdata

Constructor Summary

Constructors

Constructor and Description
SftpApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<SftpApi>	builder() Fluent builder for creating an instance of SftpApi
SftpInput	create(SftpInput sftpInput) Create SFTP Input
SftpInput	delete(String inputId) Delete SFTP Input
SftpInput	get(String inputId) SFTP Input Details
PaginationResponse<SftpInput>	list() List SFTP Inputs
PaginationResponse<SftpInput>	list(SftpInputListQueryParams queryParams) List SFTP Inputs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

customdata

public final CustomdataApi customdata

Constructor Detail

SftpApi

public SftpApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<SftpApi> builder()

Fluent builder for creating an instance of SftpApi

create

public SftpInput create(SftpInput sftpInput)
                 throws BitmovinException

Create SFTP Input

Parameters:

sftpInput - The SFTP input to be created (required)

Returns:

SftpInput

Throws:

BitmovinException - if fails to make API call

delete

public SftpInput delete(String inputId)
                 throws BitmovinException

Delete SFTP Input

Parameters:

inputId - Id of the input (required)

Returns:

SftpInput

Throws:

BitmovinException - if fails to make API call

get

public SftpInput get(String inputId)
              throws BitmovinException

SFTP Input Details

Parameters:

inputId - Id of the input (required)

Returns:

SftpInput

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<SftpInput> list()
                                   throws BitmovinException

List SFTP Inputs

Returns:

List<SftpInput>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<SftpInput> list(SftpInputListQueryParams queryParams)
                                   throws BitmovinException

List SFTP Inputs

Parameters:

queryParams - The query parameters for sorting, filtering and paging options (optional)

Returns:

List<SftpInput>

Throws:

BitmovinException - if fails to make API call