io.deepsense.neptune.clientlibrary.models.Action Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neptune-client-library Show documentation

Enables integration with Neptune in your Java code

There is a newer version: 1.6.1

Show newest version

/**
 * Copyright (c) 2016, CodiLime Inc.
 */

package io.deepsense.neptune.clientlibrary.models;

import java.util.UUID;
import java.util.function.Function;

/**
 * An Action is a registered function that can be invoked externally with passed argument.
 */
public interface Action {

    /**
     *
     * @return The id of this Action.
     */
    UUID getId();

    /**
     * Gets name of this Action.
     * It must be unique in the scope of a specific job.
     *
     * @return The action name.
     */
    String getName();

    /**
     * Gets handler of this action.
     * Handler is an one argument function that will be called with an action invocation.
     * Handler must take one String argument and return String as the result.
     *
     * @return The action handler.
     */
    Function getHandler();
}