Package io.github.primelib.jira4j.restv2.model

Class Webhook

java.lang.Object
io.github.primelib.jira4j.restv2.model.Webhook
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class Webhook extends Object
Webhook

  • Field Details

    • events

      protected List<Webhook.EventsEnum> events
      The Jira events that trigger the webhook.

    • expirationDate

      protected Long expirationDate
      The date after which the webhook is no longer sent. Use [Extend webhook life](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks/#api-rest-api-3-webhook-refresh-put) to extend the date.

    • fieldIdsFilter

      protected List<String> fieldIdsFilter
      A list of field IDs. When the issue changelog contains any of the fields, the webhook jira:issue_updated is sent. If this parameter is not present, the app is notified about all field updates.

    • id

      protected Long id
      The ID of the webhook.

    • issuePropertyKeysFilter

      protected List<String> issuePropertyKeysFilter
      A list of issue property keys. A change of those issue properties triggers the issue_property_set or issue_property_deleted webhooks. If this parameter is not present, the app is notified about all issue property updates.

    • jqlFilter

      protected String jqlFilter
      The JQL filter that specifies which issues the webhook is sent for.

  • Constructor Details

    • Webhook

      public Webhook(Consumer<Webhook> spec)
      Constructs a validated instance of Webhook.
      Parameters:
      spec - the specification to process

    • Webhook

      @Internal public Webhook(List<Webhook.EventsEnum> events, Long expirationDate, List<String> fieldIdsFilter, Long id, List<String> issuePropertyKeysFilter, String jqlFilter)
      Constructs a validated instance of Webhook.

      NOTE: This constructor is not considered stable and may change if the model is updated. Consider using Webhook(Consumer) instead.

      Parameters:
      events - The Jira events that trigger the webhook.
      expirationDate - The date after which the webhook is no longer sent. Use [Extend webhook life](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks/#api-rest-api-3-webhook-refresh-put) to extend the date.
      fieldIdsFilter - A list of field IDs. When the issue changelog contains any of the fields, the webhook jira:issue_updated is sent. If this parameter is not present, the app is notified about all field updates.
      id - The ID of the webhook.
      issuePropertyKeysFilter - A list of issue property keys. A change of those issue properties triggers the issue_property_set or issue_property_deleted webhooks. If this parameter is not present, the app is notified about all issue property updates.
      jqlFilter - The JQL filter that specifies which issues the webhook is sent for.

    • Webhook

      protected Webhook()

  • Method Details

    • builder

      public static Webhook.WebhookBuilder builder()

    • events

      public List<Webhook.EventsEnum> events()
      The Jira events that trigger the webhook.

    • expirationDate

      public Long expirationDate()
      The date after which the webhook is no longer sent. Use [Extend webhook life](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks/#api-rest-api-3-webhook-refresh-put) to extend the date.

    • fieldIdsFilter

      public List<String> fieldIdsFilter()
      A list of field IDs. When the issue changelog contains any of the fields, the webhook jira:issue_updated is sent. If this parameter is not present, the app is notified about all field updates.

    • id

      public Long id()
      The ID of the webhook.

    • issuePropertyKeysFilter

      public List<String> issuePropertyKeysFilter()
      A list of issue property keys. A change of those issue properties triggers the issue_property_set or issue_property_deleted webhooks. If this parameter is not present, the app is notified about all issue property updates.

    • jqlFilter

      public String jqlFilter()
      The JQL filter that specifies which issues the webhook is sent for.

    • events

      public Webhook events(List<Webhook.EventsEnum> events)
      The Jira events that trigger the webhook.
      Returns:
      this.

    • expirationDate

      public Webhook expirationDate(Long expirationDate)
      The date after which the webhook is no longer sent. Use [Extend webhook life](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks/#api-rest-api-3-webhook-refresh-put) to extend the date.
      Returns:
      this.

    • fieldIdsFilter

      public Webhook fieldIdsFilter(List<String> fieldIdsFilter)
      A list of field IDs. When the issue changelog contains any of the fields, the webhook jira:issue_updated is sent. If this parameter is not present, the app is notified about all field updates.
      Returns:
      this.

    • id

      public Webhook id(Long id)
      The ID of the webhook.
      Returns:
      this.

    • issuePropertyKeysFilter

      public Webhook issuePropertyKeysFilter(List<String> issuePropertyKeysFilter)
      A list of issue property keys. A change of those issue properties triggers the issue_property_set or issue_property_deleted webhooks. If this parameter is not present, the app is notified about all issue property updates.
      Returns:
      this.

    • jqlFilter

      public Webhook jqlFilter(String jqlFilter)
      The JQL filter that specifies which issues the webhook is sent for.
      Returns:
      this.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object