org.eclipse.tractusx.irs.component.BatchResponse 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.List;
import java.util.UUID;

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

/**
 * Batch model
 */
@Schema(description = "Batch model.", example = BatchResponse.EXAMPLE)
@Value
@Builder
@AllArgsConstructor
@Jacksonized
public class BatchResponse {

    private static final int UUID_LENGTH = 36;
    public static final String EXAMPLE = "{\"batchId\"=\"f253718e-a270-4367-901b-9d50d9bd8462\", \"batchNumber\"=1, \"batchProcessingState\"=\"COMPLETED\", \"batchTotal\"=1, \"completedOn\"=\"2022-02-03T14:48:54.709Z\", \"jobs\"=[{\"completedOn\"=\"2022-02-03T14:48:54.709Z\", \"id\"=\"6c311d29-5753-46d4-b32c-19b918ea93b0\", \"startedOn\"=\"2022-02-03T14:48:54.709Z\", \"state\"=\"COMPLETED\"}], \"jobsInBatchChecksum\"=1, \"orderId\"=\"f253718e-a270-4367-901b-9d50d9bd8462\", \"startedOn\"=\"2022-02-03T14:48:54.709Z\", \"totalJobs\"=1}";

    @Schema(description = "Id of the order.", minLength = UUID_LENGTH,
            maxLength = UUID_LENGTH, implementation = UUID.class,
            pattern = "/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i")
    private UUID orderId;

    @Schema(description = "Id of the batch.", minLength = UUID_LENGTH,
            maxLength = UUID_LENGTH, implementation = UUID.class,
            pattern = "/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i")
    private UUID batchId;

    @Schema(implementation = Integer.class, description = "Sequential number begins with first (1.) batch.")
    private Integer batchNumber;

    @Schema(implementation = Integer.class, description = "The total number of batches.")
    private Integer batchTotal;

    @Schema(implementation = Integer.class, description = "Total amount of jobs inside the order.")
    private Integer totalJobs;

    @Schema(implementation = ZonedDateTime.class)
    private ZonedDateTime startedOn;

    @Schema(implementation = ZonedDateTime.class)
    private ZonedDateTime completedOn;

    @ArraySchema(arraySchema = @Schema(description = "Array of jobs."), maxItems = Integer.MAX_VALUE)
    private List jobs;

    @Schema(implementation = Integer.class, description = "Expected number of jobs in batch.")
    private Integer jobsInBatchChecksum;

    @Schema(implementation = ProcessingState.class, description = "The state of the batch.")
    private ProcessingState batchProcessingState;

}