org.apache.flink.runtime.rest.handler.async.AsynchronousOperationInfo Maven / Gradle / Ivy
/*
* 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.apache.flink.runtime.rest.handler.async;
import org.apache.flink.runtime.rest.messages.json.SerializedThrowableDeserializer;
import org.apache.flink.runtime.rest.messages.json.SerializedThrowableSerializer;
import org.apache.flink.util.SerializedThrowable;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonInclude;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonProperty;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.annotation.JsonSerialize;
import javax.annotation.Nullable;
/**
* Basic information object for asynchronous operations.
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
public class AsynchronousOperationInfo {
private static final String FIELD_NAME_FAILURE_CAUSE = "failure-cause";
@JsonProperty(FIELD_NAME_FAILURE_CAUSE)
@JsonSerialize(using = SerializedThrowableSerializer.class)
@Nullable
private final SerializedThrowable failureCause;
private AsynchronousOperationInfo(
@JsonProperty(FIELD_NAME_FAILURE_CAUSE)
@JsonDeserialize(using = SerializedThrowableDeserializer.class)
@Nullable SerializedThrowable failureCause) {
this.failureCause = failureCause;
}
@Nullable
public SerializedThrowable getFailureCause() {
return failureCause;
}
public static AsynchronousOperationInfo completeExceptional(SerializedThrowable serializedThrowable) {
return new AsynchronousOperationInfo(serializedThrowable);
}
public static AsynchronousOperationInfo complete() {
return new AsynchronousOperationInfo(null);
}
}