Source code

001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.reef.client;
020
021import org.apache.reef.annotations.Provided;
022import org.apache.reef.annotations.audience.ClientSide;
023import org.apache.reef.annotations.audience.Public;
024import org.apache.reef.common.AbstractFailure;
025import org.apache.reef.util.Optional;
026
027/**
028 * An error message that REEF Client receives when there is a user error in REEF job.
029 */
030@Public
031@ClientSide
032@Provided
033public final class FailedJob extends AbstractFailure {
034  /**
035   * @param id          Identifier of the Job that produced the error.
036   * @param message     One-line error message.
037   * @param description Long error description.
038   * @param cause       Java Exception that caused the error.
039   * @param data        byte array that contains serialized version of the error.
040   */
041  public FailedJob(final String id,
042                   final String message,
043                   final Optional<String> description,
044                   final Optional<Throwable> cause,
045                   final Optional<byte[]> data) {
046    super(id, message, description, cause, data);
047  }
048}