Klasse WebhookResource

java.lang.Object

com.cloudconvert.resource.AbstractResource

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

com.cloudconvert.resource.sync.WebhookResource

Alle implementierten Schnittstellen:

Closeable, AutoCloseable

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

Feldübersicht

Von Klasse geerbte Felder com.cloudconvert.resource.AbstractWebhooksResource

HMAC_SHA256, PATH_SEGMENT_WEBHOOKS

Von Klasse geerbte Felder 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

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
WebhookResource(SettingsProvider settingsProvider, ObjectMapperProvider objectMapperProvider, RequestExecutor requestExecutor)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
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.

Von Klasse geerbte Methoden com.cloudconvert.resource.AbstractWebhooksResource

getCreateHttpUriRequest, getDeleteHttpUriRequest, getListHttpUriRequest, verify

Von Klasse geerbte Methoden com.cloudconvert.resource.AbstractResource

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

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

WebhookResource

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

Methodendetails

create

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

Beschreibung aus Klasse kopiert: AbstractWebhooksResource

Create a webhook. Requires the webhook.write scope.

Angegeben von:

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

Parameter:

webhookRequest - WebhookRequest

Gibt zurück:

AbstractWebhooksResource

Löst aus:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

list

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

Beschreibung aus Klasse kopiert: AbstractWebhooksResource

List all webhooks. Requires the webhook.read scope.

Angegeben von:

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

Gibt zurück:

AbstractWebhooksResource

Löst aus:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

list

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

Beschreibung aus Klasse kopiert: AbstractWebhooksResource

List all webhooks. Requires the webhook.read scope.

Angegeben von:

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

Parameter:

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

Gibt zurück:

AbstractWebhooksResource

Löst aus:

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

Beschreibung aus Klasse kopiert: AbstractWebhooksResource

List all webhooks. Requires the webhook.read scope.

Angegeben von:

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

Parameter:

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.

Gibt zurück:

AbstractWebhooksResource

Löst aus:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

delete

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

Beschreibung aus Klasse kopiert: AbstractWebhooksResource

Delete a webhook. Requires the webhook.write scope.

Angegeben von:

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

Parameter:

webhookId - webhook id

Gibt zurück:

VR

Löst aus:

IOException

URISyntaxException

CloudConvertClientException

CloudConvertServerException

close

public void close()
           throws IOException

Löst aus:

IOException