io.github.primelib.jira4j.restv3.model.WebhookDetails Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jira4j-rest-v3 Show documentation
A Java Wrapper for the Jira REST API
The newest version!
package io.github.primelib.jira4j.restv3.model;

import java.util.function.Consumer;
import org.jetbrains.annotations.ApiStatus;
import javax.annotation.processing.Generated;
import lombok.AccessLevel;
import lombok.Builder;
import lombok.Getter;
import lombok.Setter;
import lombok.EqualsAndHashCode;
import lombok.ToString;
import lombok.NoArgsConstructor;
import lombok.AllArgsConstructor;
import lombok.experimental.Accessors;

import java.util.List;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;

/**
 * WebhookDetails
 *
 */
@Getter
@Setter
@EqualsAndHashCode
@ToString
@Accessors(fluent = true, chain = true)
@NoArgsConstructor(access = AccessLevel.PROTECTED, force = true)
@Builder
@JsonPropertyOrder({
    "events",
    "fieldIdsFilter",
    "issuePropertyKeysFilter",
    "jqlFilter"
})
@JsonTypeName("WebhookDetails")
@Generated(value = "io.github.primelib.primecodegen.javafeign.JavaFeignGenerator")
public class WebhookDetails {

    /**
     * The Jira events that trigger the webhook.
     */
    @JsonProperty("events")
    protected List events;

    /**
     * A list of field IDs. When the issue changelog contains any of the fields, the webhook {@code jira:issue_updated} is sent. If this parameter is not present, the app is notified about all field updates.
     */
    @JsonProperty("fieldIdsFilter")
    protected List fieldIdsFilter;

    /**
     * A list of issue property keys. A change of those issue properties triggers the {@code issue_property_set} or {@code issue_property_deleted} webhooks. If this parameter is not present, the app is notified about all issue property updates.
     */
    @JsonProperty("issuePropertyKeysFilter")
    protected List issuePropertyKeysFilter;

    /**
     * The JQL filter that specifies which issues the webhook is sent for. Only a subset of JQL can be used. The supported elements are:
     *  *
     * Fields: {@code issueKey}, {@code project}, {@code issuetype}, {@code status}, {@code assignee}, {@code reporter}, {@code issue.property}, and {@code cf[id]}. For custom fields ({@code cf[id]}), only the epic label custom field is supported.".
     * *
     * Operators: {@code =}, {@code !=}, {@code IN}, and {@code NOT IN}.
     */
    @JsonProperty("jqlFilter")
    protected String jqlFilter;

    /**
     * Constructs a validated instance of {@link WebhookDetails}.
     *
     * @param spec the specification to process
     */
    public WebhookDetails(Consumer spec) {
        spec.accept(this);
    }

    /**
     * Constructs a validated instance of {@link WebhookDetails}.
     * 
     * NOTE: This constructor is not considered stable and may change if the model is updated. Consider using {@link #WebhookDetails(Consumer)} instead.
     * @param events The Jira events that trigger the webhook.
     * @param fieldIdsFilter A list of field IDs. When the issue changelog contains any of the fields, the webhook {@code jira:issue_updated} is sent. If this parameter is not present, the app is notified about all field updates.
     * @param issuePropertyKeysFilter A list of issue property keys. A change of those issue properties triggers the {@code issue_property_set} or {@code issue_property_deleted} webhooks. If this parameter is not present, the app is notified about all issue property updates.
     * @param jqlFilter The JQL filter that specifies which issues the webhook is sent for. Only a subset of JQL can be used. The supported elements are:   *  Fields: {@code issueKey}, {@code project}, {@code issuetype}, {@code status}, {@code assignee}, {@code reporter}, {@code issue.property}, and {@code cf[id]}. For custom fields ({@code cf[id]}), only the epic label custom field is supported.".  *  Operators: {@code =}, {@code !=}, {@code IN}, and {@code NOT IN}.
     */
    @ApiStatus.Internal
    public WebhookDetails(List events, List fieldIdsFilter, List issuePropertyKeysFilter, String jqlFilter) {
        this.events = events;
        this.fieldIdsFilter = fieldIdsFilter;
        this.issuePropertyKeysFilter = issuePropertyKeysFilter;
        this.jqlFilter = jqlFilter;
    }

    /**
     * The Jira events that trigger the webhook.
     */
    @AllArgsConstructor
    public enum EventsEnum {
        JIRA_ISSUE_CREATED("jira:issue_created"),
        JIRA_ISSUE_UPDATED("jira:issue_updated"),
        JIRA_ISSUE_DELETED("jira:issue_deleted"),
        COMMENT_CREATED("comment_created"),
        COMMENT_UPDATED("comment_updated"),
        COMMENT_DELETED("comment_deleted"),
        ISSUE_PROPERTY_SET("issue_property_set"),
        ISSUE_PROPERTY_DELETED("issue_property_deleted");

        private static final EventsEnum[] VALUES = values(); // prevent allocating a new array for every call to values()
        private final String value;

        @JsonCreator
        public static EventsEnum of(String input) {
            if (input != null) {
                for (EventsEnum v : VALUES) {
                    if (input.equalsIgnoreCase(v.value)) 
                        return v;
                }
            }

            return null;
        }

        @JsonValue
        public String getValue() {
            return value;
        }
    }

}