Package com.cloudconvert.resource.sync

Class WebhookResource

java.lang.Object

com.cloudconvert.resource.AbstractResource

com.cloudconvert.resource.AbstractWebhooksResource<Result<WebhookResponse>,Result<Pageable<WebhookResponse>>,Result<Void>>

com.cloudconvert.resource.sync.WebhookResource

All Implemented Interfaces:

Closeable, AutoCloseable

public class WebhookResource
extends AbstractWebhooksResource<Result<WebhookResponse>,Result<Pageable<WebhookResponse>>,Result<Void>>

Field Summary

Fields inherited from class com.cloudconvert.resource.AbstractWebhooksResource

HMAC_SHA256, PATH_SEGMENT_WEBHOOKS

Fields inherited from class com.cloudconvert.resource.AbstractResource

BEARER, HEADER_AUTHORIZATION, HEADER_USER_AGENT, INPUT_STREAM_TYPE_REFERENCE, JOB_RESPONSE_PAGEABLE_TYPE_REFERENCE, JOB_RESPONSE_TYPE_REFERENCE, MAP_STRING_TO_OBJECT_TYPE_REFERENCE, OPERATION_RESPONSE_PAGEABLE_TYPE_REFERENCE, TASK_RESPONSE_PAGEABLE_TYPE_REFERENCE, TASK_RESPONSE_TYPE_REFERENCE, USER_RESPONSE_TYPE_REFERENCE, V2, VALUE_USER_AGENT, VOID_TYPE_REFERENCE, WEBHOOKS_RESPONSE_PAGEABLE_TYPE_REFERENCE, WEBHOOKS_RESPONSE_TYPE_REFERENCE

Constructor Summary

Constructors

Constructor	Description
WebhookResource(SettingsProvider settingsProvider, ObjectMapperProvider objectMapperProvider, RequestExecutor requestExecutor)

Method Summary

Modifier and Type	Method	Description
void	close()
Result<WebhookResponse>	create(@NotNull WebhookRequest webhookRequest)	Create a webhook.
Result<Void>	delete(@NotNull String webhookId)	Delete a webhook.
Result<Pageable<WebhookResponse>>	list()	List all webhooks.
Result<Pageable<WebhookResponse>>	list(@NotNull Map<Filter,String> filters)	List all webhooks.
Result<Pageable<WebhookResponse>>	list(@NotNull Map<Filter,String> filters, @Nullable Pagination pagination)	List all webhooks.

Methods inherited from class com.cloudconvert.resource.AbstractWebhooksResource

getCreateHttpUriRequest, getDeleteHttpUriRequest, getListHttpUriRequest, verify

Methods inherited from class com.cloudconvert.resource.AbstractResource

getHttpEntity, getHttpEntity, getHttpUriRequest, getHttpUriRequest, getJson, getSyncUri, getSyncUri, getUri, getUri, requestToMap

Methods inherited from class java.lang.Object

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

Constructor Details

WebhookResource

public WebhookResource(SettingsProvider settingsProvider,
 ObjectMapperProvider objectMapperProvider,
 RequestExecutor requestExecutor)

Method Details

create

public Result<WebhookResponse> create(@NotNull
 @NotNull WebhookRequest webhookRequest)
                               throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Description copied from class: AbstractWebhooksResource

Create a webhook. Requires the webhook.write scope.

Specified by:

create in class AbstractWebhooksResource<Result<WebhookResponse>,Result<Pageable<WebhookResponse>>,Result<Void>>

Parameters:

webhookRequest - WebhookRequest

Returns:

AbstractWebhooksResource

Throws:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

list

public Result<Pageable<WebhookResponse>> list()
                                       throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Description copied from class: AbstractWebhooksResource

List all webhooks. Requires the webhook.read scope.

Specified by:

list in class AbstractWebhooksResource<Result<WebhookResponse>,Result<Pageable<WebhookResponse>>,Result<Void>>

Returns:

AbstractWebhooksResource

Throws:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

list

public Result<Pageable<WebhookResponse>> list(@NotNull
 @NotNull Map<Filter,String> filters)
                                       throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Description copied from class: AbstractWebhooksResource

List all webhooks. Requires the webhook.read scope.

Specified by:

list in class AbstractWebhooksResource<Result<WebhookResponse>,Result<Pageable<WebhookResponse>>,Result<Void>>

Parameters:

filters - (optional) Filters: - url - The result will be filtered to include only webhooks with a specific URL.

Returns:

AbstractWebhooksResource

Throws:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

list

public Result<Pageable<WebhookResponse>> list(@NotNull
 @NotNull Map<Filter,String> filters,
 @Nullable
 @Nullable Pagination pagination)
                                       throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Description copied from class: AbstractWebhooksResource

List all webhooks. Requires the webhook.read scope.

Specified by:

list in class AbstractWebhooksResource<Result<WebhookResponse>,Result<Pageable<WebhookResponse>>,Result<Void>>

Parameters:

filters - (optional) Filters: - url - The result will be filtered to include only webhooks with a specific URL.

pagination - (optional) Pagination: - per_page - Number of tasks per page, defaults to 100. - page - The result page to show.

Returns:

AbstractWebhooksResource

Throws:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

delete

public Result<Void> delete(@NotNull
 @NotNull String webhookId)
                    throws IOException,
URISyntaxException,
CloudConvertClientException,
CloudConvertServerException

Description copied from class: AbstractWebhooksResource

Delete a webhook. Requires the webhook.write scope.

Specified by:

delete in class AbstractWebhooksResource<Result<WebhookResponse>,Result<Pageable<WebhookResponse>>,Result<Void>>

Parameters:

webhookId - webhook id

Returns:

VR

Throws:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

close

public void close()
           throws IOException

Throws:

IOException