com.bitmovin.api.sdk.encoding.inputs.s3

Class S3Api

java.lang.Object

com.bitmovin.api.sdk.encoding.inputs.s3.S3Api

public class S3Api
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
CustomdataApi	customdata

Constructor Summary

Constructors

Constructor and Description
S3Api(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<S3Api>	builder() Fluent builder for creating an instance of S3Api
S3Input	create(S3Input s3Input) Create S3 Input
BitmovinResponse	delete(String inputId) Delete S3 Input
S3Input	get(String inputId) S3 Input Details
PaginationResponse<S3Input>	list() List S3 Inputs
PaginationResponse<S3Input>	list(S3InputListQueryParams queryParams) List S3 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

S3Api

public S3Api(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<S3Api> builder()

Fluent builder for creating an instance of S3Api

create

public S3Input create(S3Input s3Input)
               throws BitmovinException

Create S3 Input

Parameters:

s3Input - The S3 input to be created The following permissions are required for S3 input: * s3:GetObject * s3:GetBucketLocation, (required)

Returns:

S3Input

Throws:

BitmovinException - if fails to make API call

delete

public BitmovinResponse delete(String inputId)
                        throws BitmovinException

Delete S3 Input

Parameters:

inputId - Id of the input (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

get

public S3Input get(String inputId)
            throws BitmovinException

S3 Input Details

Parameters:

inputId - Id of the input (required)

Returns:

S3Input

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<S3Input> list()
                                 throws BitmovinException

List S3 Inputs

Returns:

List<S3Input>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<S3Input> list(S3InputListQueryParams queryParams)
                                 throws BitmovinException

List S3 Inputs

Parameters:

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

Returns:

List<S3Input>

Throws:

BitmovinException - if fails to make API call