io.digdag.spi.CommandStatus Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of digdag-spi Show documentation

Digdag

There is a newer version: 0.10.5.1

package io.digdag.spi;

import com.fasterxml.jackson.annotation.JsonValue;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.google.common.base.Optional;

public interface CommandStatus
{
    // ToDo: isFinished and statusCode should be merged into an Optional

    /**
     * Check command is finished or not.
     *
     * @return
     */
    boolean isFinished();

    /**
     * Return exit code of command finished. It is valid only when isFinished returns true.
     * @return
     */
    int getStatusCode();

    /**
     * Return error message.
     * @return
     */
    default Optional getErrorMessage()
    {
        return Optional.absent();
    }

    /**
     * Return the same String with CommandRequest.getIoDirectory.
     *
     * @return
     */
    String getIoDirectory(); //relative

    @JsonValue
    ObjectNode toJson();
}