com.bitmovin.api.sdk.notifications.webhooks.encoding.encodings.error

Class ErrorApi

java.lang.Object

com.bitmovin.api.sdk.notifications.webhooks.encoding.encodings.error.ErrorApi

public class ErrorApi
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
CustomdataApi	customdata

Constructor Summary

Constructors

Constructor and Description
ErrorApi(BitmovinApiClientFactory clientFactory)

Method Summary

Modifier and Type	Method and Description
static BitmovinApiBuilder<ErrorApi>	builder() Fluent builder for creating an instance of ErrorApi
Webhook	create(Webhook webhook) Add Encoding Error Webhook
Webhook	createByEncodingId(String encodingId, Webhook webhook) Add Encoding Error Webhook for specific Encoding Resource.
BitmovinResponse	deleteByEncodingIdAndWebhookId(String encodingId, String webhookId) Delete Encoding Error Webhook for specific Encoding Resource
BitmovinResponse	deleteByWebhookId(String webhookId) Delete Encoding Error Webhook
Webhook	getByEncodingIdAndWebhookId(String encodingId, String webhookId) Encoding Error Webhook Details for specific Encoding Resource
Webhook	getByWebhookId(String webhookId) Encoding Error Webhook Details
PaginationResponse<Webhook>	list() List Encoding Error Webhooks
PaginationResponse<Webhook>	list(WebhookListQueryParams queryParams) List Encoding Error Webhooks
PaginationResponse<Webhook>	listByEncodingId(String encodingId) List Encoding Error Webhooks for specific Encoding Resource
PaginationResponse<Webhook>	listByEncodingId(String encodingId, WebhookListByEncodingIdQueryParams queryParams) List Encoding Error Webhooks for specific Encoding Resource

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

ErrorApi

public ErrorApi(BitmovinApiClientFactory clientFactory)

Method Detail

builder

public static BitmovinApiBuilder<ErrorApi> builder()

Fluent builder for creating an instance of ErrorApi

create

public Webhook create(Webhook webhook)
               throws BitmovinException

Add Encoding Error Webhook

Parameters:

webhook - The Encoding Error Webhook to be added. **Note:** A maximum number of 5 webhooks is allowed (required)

Returns:

Webhook

Throws:

BitmovinException - if fails to make API call

createByEncodingId

public Webhook createByEncodingId(String encodingId,
                                  Webhook webhook)
                           throws BitmovinException

Add Encoding Error Webhook for specific Encoding Resource. **Note:** A maximum number of 5 webhooks is allowed

Parameters:

encodingId - Id of the encoding (required)

webhook - The Encoding Error Webhook to be added (required)

Returns:

Webhook

Throws:

BitmovinException - if fails to make API call

deleteByEncodingIdAndWebhookId

public BitmovinResponse deleteByEncodingIdAndWebhookId(String encodingId,
                                                       String webhookId)
                                                throws BitmovinException

Delete Encoding Error Webhook for specific Encoding Resource

Parameters:

encodingId - Id of the encoding (required)

webhookId - Id of the webhook (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

deleteByWebhookId

public BitmovinResponse deleteByWebhookId(String webhookId)
                                   throws BitmovinException

Delete Encoding Error Webhook

Parameters:

webhookId - Id of the webhook (required)

Returns:

BitmovinResponse

Throws:

BitmovinException - if fails to make API call

getByEncodingIdAndWebhookId

public Webhook getByEncodingIdAndWebhookId(String encodingId,
                                           String webhookId)
                                    throws BitmovinException

Encoding Error Webhook Details for specific Encoding Resource

Parameters:

encodingId - Id of the encoding (required)

webhookId - Id of the webhook (required)

Returns:

Webhook

Throws:

BitmovinException - if fails to make API call

getByWebhookId

public Webhook getByWebhookId(String webhookId)
                       throws BitmovinException

Encoding Error Webhook Details

Parameters:

webhookId - Id of the webhook (required)

Returns:

Webhook

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<Webhook> list()
                                 throws BitmovinException

List Encoding Error Webhooks

Returns:

List<Webhook>

Throws:

BitmovinException - if fails to make API call

list

public PaginationResponse<Webhook> list(WebhookListQueryParams queryParams)
                                 throws BitmovinException

List Encoding Error Webhooks

Parameters:

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

Returns:

List<Webhook>

Throws:

BitmovinException - if fails to make API call

listByEncodingId

public PaginationResponse<Webhook> listByEncodingId(String encodingId)
                                             throws BitmovinException

List Encoding Error Webhooks for specific Encoding Resource

Parameters:

encodingId - Id of the encoding (required)

Returns:

List<Webhook>

Throws:

BitmovinException - if fails to make API call

listByEncodingId

public PaginationResponse<Webhook> listByEncodingId(String encodingId,
                                                    WebhookListByEncodingIdQueryParams queryParams)
                                             throws BitmovinException

List Encoding Error Webhooks for specific Encoding Resource

Parameters:

encodingId - Id of the encoding (required)

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

Returns:

List<Webhook>

Throws:

BitmovinException - if fails to make API call