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

Go to download
/********************************************************************************
 * 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.io.Serializable;
import java.time.ZonedDateTime;

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

/**
 * Exception container for job
 */
@Getter
@Setter
@Builder(toBuilder = true)
@NoArgsConstructor
@AllArgsConstructor
@SuppressWarnings({ "PMD.ShortClassName", "PMD.MethodArgumentCouldBeFinal" })
public class JobErrorDetails implements Serializable {

    public static final int EXCEPTION_NAME_MAX_LENGTH = 100;
    public static final int ERROR_DETAIL_MAX_LENGTH = 4000;

    @Schema(description = "Exception name.", implementation = String.class,
            maxLength = EXCEPTION_NAME_MAX_LENGTH, example = "IrsTimeoutException")
    private String exception;

    @Schema(description = "Detailed exception information.", implementation = String.class,
            maxLength = ERROR_DETAIL_MAX_LENGTH, example = "Timeout while requesting Digital Registry")
    private String errorDetail;

    @Schema(description = "Datetime error occurs.", implementation = ZonedDateTime.class, example = "2022-02-03T14:48:54.709Z")
    private ZonedDateTime exceptionDate;

}