org.eclipse.tractusx.irs.component.JobStatusResult Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of irs-models Show documentation

Data Transfer Object definitions shared between controllers and clients. Part of OpenAPI definition.

The newest version!

/********************************************************************************
 * Copyright (c) 2022,2024
 *       2022: ZF Friedrichshafen AG
 *       2022: ISTOS GmbH
 *       2022,2024: Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
 *       2022,2023: BOSCH AG
 * Copyright (c) 2021,2024 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Apache License, Version 2.0 which is available at
 * https://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.
 *
 * SPDX-License-Identifier: Apache-2.0
 ********************************************************************************/
package org.eclipse.tractusx.irs.component;

import java.time.ZonedDateTime;
import java.util.UUID;

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Builder;
import lombok.Value;
import lombok.extern.jackson.Jacksonized;
import org.eclipse.tractusx.irs.component.enums.JobState;

/**
 * Response for job status request
 */
@Value
@Jacksonized
@Builder(toBuilder = true)
@SuppressWarnings("PMD.ShortVariable")
public class JobStatusResult {

    /**
     * Job identifier
     */
    private UUID id;

    /**
     * Current state of the job
     */
    private JobState state;

    /**
     * Timestamp when the job was started
     */
    @Schema(implementation = ZonedDateTime.class)
    private ZonedDateTime startedOn;

    /**
     * Timestamp when the job was completed
     */
    @Schema(implementation = ZonedDateTime.class)
    private ZonedDateTime completedOn;

}