public interface

InvocationHistoryService

com.atlassian.bitbucket.webhook.history.InvocationHistoryService

Class Overview

Provides various historical information about com.atlassian.webhooks.WebhookInvocation invocations for Webhook webhooks.

Summary

Public Methods
@Nonnull InvocationHistory get(InvocationHistoryRequest request)
@Nonnull Map<WebhookEvent, InvocationHistory> getByEvent(InvocationHistoryByEventRequest request)
@Nonnull Map<Integer, InvocationHistory> getByWebhook(Collection<Integer> webhookIds)
@Nonnull Optional<DetailedInvocation> getLatestInvocation(HistoricalInvocationRequest request)

Public Methods

@Nonnull public InvocationHistory get (InvocationHistoryRequest request)

Returns
  • a historical summary of invocations for the supplied Webhook webhook restricted to only those invoked for the supplied WebhookEvent event if non-null
Throws
NoSuchWebhookException if history is requested for a webhook that does not exist

@Nonnull public Map<WebhookEvent, InvocationHistory> getByEvent (InvocationHistoryByEventRequest request)

Returns
  • historical summaries of invocations for all WebhookEvent events for the supplied Webhook webhook
Throws
NoSuchWebhookException if history is requested for a webhook that does not exist

@Nonnull public Map<Integer, InvocationHistory> getByWebhook (Collection<Integer> webhookIds)

Parameters
webhookIds the IDs of the webhooks for which the invocation history is requested
Returns

@Nonnull public Optional<DetailedInvocation> getLatestInvocation (HistoricalInvocationRequest request)

Returns
Throws
NoSuchWebhookException if invocationd data is requested for a webhook that does not exist