org.kie.kogito.jobs.service.api.Job Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jobs-service-api Show documentation
The common events API for Kogito Jobs Service
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.kie.kogito.jobs.service.api;

import org.eclipse.microprofile.openapi.annotations.media.Schema;

import com.fasterxml.jackson.annotation.JsonPropertyOrder;

import static org.kie.kogito.jobs.service.api.Job.CORRELATION_ID_PROPERTY;
import static org.kie.kogito.jobs.service.api.Job.EXECUTION_TIMEOUT_PROPERTY;
import static org.kie.kogito.jobs.service.api.Job.EXECUTION_TIMEOUT_UNIT_PROPERTY;
import static org.kie.kogito.jobs.service.api.Job.ID_PROPERTY;
import static org.kie.kogito.jobs.service.api.Job.RECIPIENT_PROPERTY;
import static org.kie.kogito.jobs.service.api.Job.RETRY_PROPERTY;
import static org.kie.kogito.jobs.service.api.Job.SCHEDULE_PROPERTY;
import static org.kie.kogito.jobs.service.api.Job.STATE_PROPERTY;

@Schema(name = "JobV2", description = "Defines a job that can be managed by the jobs service.",
        requiredProperties = { SCHEDULE_PROPERTY, RETRY_PROPERTY, RECIPIENT_PROPERTY })
@JsonPropertyOrder({ ID_PROPERTY, CORRELATION_ID_PROPERTY, STATE_PROPERTY, SCHEDULE_PROPERTY, RETRY_PROPERTY,
        RECIPIENT_PROPERTY, EXECUTION_TIMEOUT_PROPERTY, EXECUTION_TIMEOUT_UNIT_PROPERTY })
public class Job {

    static final String ID_PROPERTY = "id";
    static final String CORRELATION_ID_PROPERTY = "correlationId";
    static final String STATE_PROPERTY = "state";
    static final String SCHEDULE_PROPERTY = "schedule";
    static final String RETRY_PROPERTY = "retry";
    static final String RECIPIENT_PROPERTY = "recipient";
    static final String EXECUTION_TIMEOUT_PROPERTY = "executionTimeout";
    static final String EXECUTION_TIMEOUT_UNIT_PROPERTY = "executionTimeoutUnit";

    @Schema(description = "Available states for a Job.")
    public enum State {
        /**
         * Active job state.
         */
        SCHEDULED,
        /**
         * Active job state.
         */
        RETRY,
        /**
         * Final job state.
         */
        EXECUTED,
        /**
         * Final job state.
         */
        ERROR,
        /**
         * Final job state.
         */
        CANCELED
    }

    @Schema(description = "The unique identifier of the job in the system, this value is set by the jobs service.")
    private String id;
    @Schema(description = "Logical user provided identifier of the job in the system.")
    private String correlationId;
    private State state;
    private Schedule schedule;
    private Retry retry;
    private Recipient recipient;
    @Schema(description = "Optional configuration that establishes the time limit for the current Job execution attempt to finish." +
            " When this timeout is exceeded the execution attempt is considered as failed, and depending on the Job retry " +
            " configuration, the execution can be retried or the Job will be marked as ERROR." +
            " Every Recipient type has a default timeout configuration that will apply automatically if this value is not set," +
            " and a maximum timeout configuration that can not be exceeded by current value.")
    private Long executionTimeout;
    @Schema(description = "The unit for the executionTimeout. If the executionTimeout is set and the unit is left empty MILLISECONDS are assumed." +
            " If the unit is set and the executionTimeout is left empty this value is ignored.")
    private TemporalUnit executionTimeoutUnit;

    public Job() {
        // Marshalling constructor.
    }

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getCorrelationId() {
        return correlationId;
    }

    public void setCorrelationId(String correlationId) {
        this.correlationId = correlationId;
    }

    public State getState() {
        return state;
    }

    public void setState(State state) {
        this.state = state;
    }

    public Schedule getSchedule() {
        return schedule;
    }

    public void setSchedule(Schedule schedule) {
        this.schedule = schedule;
    }

    public Retry getRetry() {
        return retry;
    }

    public void setRetry(Retry retry) {
        this.retry = retry;
    }

    public Recipient getRecipient() {
        return recipient;
    }

    public void setRecipient(Recipient recipient) {
        this.recipient = recipient;
    }

    public Long getExecutionTimeout() {
        return executionTimeout;
    }

    public void setExecutionTimeout(Long executionTimeout) {
        this.executionTimeout = executionTimeout;
    }

    public TemporalUnit getExecutionTimeoutUnit() {
        return executionTimeoutUnit;
    }

    public void setExecutionTimeoutUnit(TemporalUnit executionTimeoutUnit) {
        this.executionTimeoutUnit = executionTimeoutUnit;
    }

    @Override
    public String toString() {
        return "Job{" +
                "id='" + id + '\'' +
                ", correlationId='" + correlationId + '\'' +
                ", state=" + state +
                ", schedule=" + schedule +
                ", retry=" + retry +
                ", recipient=" + recipient +
                ", executionTimeout=" + executionTimeout +
                ", executionTimeoutUnit=" + executionTimeoutUnit +
                '}';
    }

    public static Builder builder() {
        return new Builder(new Job());
    }

    public static class Builder {

        private final Job job;

        private Builder(Job job) {
            this.job = job;
        }

        public Builder id(String id) {
            job.setId(id);
            return this;
        }

        public Builder correlationId(String correlationId) {
            job.setCorrelationId(correlationId);
            return this;
        }

        public Builder state(State state) {
            job.setState(state);
            return this;
        }

        public Builder schedule(Schedule schedule) {
            job.setSchedule(schedule);
            return this;
        }

        public Builder retry(Retry retry) {
            job.setRetry(retry);
            return this;
        }

        public Builder recipient(Recipient recipient) {
            job.setRecipient(recipient);
            return this;
        }

        public Builder executionTimeout(Long executionTimeout) {
            job.setExecutionTimeout(executionTimeout);
            return this;
        }

        public Builder executionTimeoutUnit(TemporalUnit timeoutUnit) {
            job.setExecutionTimeoutUnit(timeoutUnit);
            return this;
        }

        public Job build() {
            return job;
        }
    }
}