A C D E F G H I L P R S T V W

A

acceptEither(FlowFuture<? extends T>, Flows.SerConsumer<T>) - Method in interface com.fnproject.fn.api.flow.FlowFuture

Run an action when the first of two futures completes successfully.

addTerminationHook(Flows.SerConsumer<Flow.FlowState>) - Method in interface com.fnproject.fn.api.flow.Flow

Adds a termination hook that will be executed upon completion of the whole flow; the provided hook will received input according to how the flow terminated.

allOf(FlowFuture<?>...) - Method in interface com.fnproject.fn.api.flow.Flow

Wait for all a list of tasks to complete

anyOf(FlowFuture<?>...) - Method in interface com.fnproject.fn.api.flow.Flow

Wait for any of a list of tasks to complete

applyToEither(FlowFuture<? extends T>, Flows.SerFunction<T, U>) - Method in interface com.fnproject.fn.api.flow.FlowFuture

Transform the outcome of the first of two futures to complete successfully.

C

cancel() - Method in interface com.fnproject.fn.api.flow.FlowFuture

If not already completed, completes this future exceptionally with a @{link java.util.concurrent.CancellationException}

com.fnproject.fn.api.flow - package com.fnproject.fn.api.flow

SDK for creating and running asynchronous processes from within fn for Java.

complete(T) - Method in interface com.fnproject.fn.api.flow.FlowFuture

If not already completed, completes this future with the given value.

completedValue(T) - Method in interface com.fnproject.fn.api.flow.Flow

Create a completed future for a specified value.

completeExceptionally(Throwable) - Method in interface com.fnproject.fn.api.flow.FlowFuture

If not already completed, completes this future exceptionally with the supplied Throwable.

createFlowFuture() - Method in interface com.fnproject.fn.api.flow.Flow

Create an uncompleted future

currentFlow() - Static method in class com.fnproject.fn.api.flow.Flows

Return the current flow runtime - this will create a new flow if the current is not already bound to the invocation or an existing flow if one is already bound to the current invocation or if the invocation was triggered from within a flow stage.

currentFlow() - Method in interface com.fnproject.fn.api.flow.Flows.FlowSource

D

delay(long, TimeUnit) - Method in interface com.fnproject.fn.api.flow.Flow

Create a future that completes successfully after a specified delay

E

exceptionally(Flows.SerFunction<Throwable, ? extends T>) - Method in interface com.fnproject.fn.api.flow.FlowFuture

Handle exceptional completion of this future and convert exceptions to the original type of this future.

exceptionallyCompose(Flows.SerFunction<Throwable, FlowFuture<T>>) - Method in interface com.fnproject.fn.api.flow.FlowFuture

Compose a new computation on to the completion of this future to handle errors,

F

failedFuture(Throwable) - Method in interface com.fnproject.fn.api.flow.Flow

Create a completed future that propagates a failed value

fillInStackTrace() - Method in exception com.fnproject.fn.api.flow.PlatformException

These are manufactured exceptions that arise outside the current runtime; therefore, the notion of an embedded stack trace is meaningless.

Flow - Interface in com.fnproject.fn.api.flow

A reference to the Flow object attached to the current invocation context.

Flow.FlowState - Enum in com.fnproject.fn.api.flow

Represents the possible end states of a Flow object, i.e.

FlowCompletionException - Exception in com.fnproject.fn.api.flow

Exception thrown when a blocking operation on a flow fails - this corresponds to a CompletionException in CompletableFuture calls

FlowCompletionException(Throwable) - Constructor for exception com.fnproject.fn.api.flow.FlowCompletionException

If an exception was raised from within a stage, this will be the wrapped cause.

FlowCompletionException(String) - Constructor for exception com.fnproject.fn.api.flow.FlowCompletionException

FlowCompletionException(String, Throwable) - Constructor for exception com.fnproject.fn.api.flow.FlowCompletionException

FlowFuture<T> - Interface in com.fnproject.fn.api.flow

This class exposes operations (with a similar API to CompletionStage) that allow asynchronous computation to be chained into the current execution graph of a Flow.

Flows - Class in com.fnproject.fn.api.flow

Fn Flow API entry point class - this provides access to the current Flow for the current function invocation.

Flows.FlowSource - Interface in com.fnproject.fn.api.flow

Defines a supplier for the current runtime-

Flows.SerBiConsumer<T,U> - Interface in com.fnproject.fn.api.flow

Version of BiConsumer that is implicitly serializable.

Flows.SerBiFunction<T,U,R> - Interface in com.fnproject.fn.api.flow

Version of BiFunction that is implicitly serializable.

Flows.SerCallable<V> - Interface in com.fnproject.fn.api.flow

Version of Callable that is implicitly serializable.

Flows.SerConsumer<V> - Interface in com.fnproject.fn.api.flow

Version of Consumer that is implicitly serializable.

Flows.SerFunction<T,V> - Interface in com.fnproject.fn.api.flow

Version of Function that is implicitly serializable.

Flows.SerRunnable - Interface in com.fnproject.fn.api.flow

Version of Runnable that is implicitly serializable.

Flows.SerSupplier<V> - Interface in com.fnproject.fn.api.flow

Version of Supplier that is implicitly serializable.

FunctionInvocationException - Exception in com.fnproject.fn.api.flow

Exception thrown when an external function invocation returns a failure.

FunctionInvocationException(HttpResponse) - Constructor for exception com.fnproject.fn.api.flow.FunctionInvocationException

FunctionInvokeFailedException - Exception in com.fnproject.fn.api.flow

Exception thrown when a function call failed within the fn platform - the function may or may not have been invoked and that invocation may or may not have completed.

FunctionInvokeFailedException(String) - Constructor for exception com.fnproject.fn.api.flow.FunctionInvokeFailedException

FunctionTimeoutException - Exception in com.fnproject.fn.api.flow

Exception thrown when a function execution exceeds its configured timeout.

FunctionTimeoutException(String) - Constructor for exception com.fnproject.fn.api.flow.FunctionTimeoutException

G

get() - Method in interface com.fnproject.fn.api.flow.FlowFuture

Get the result of this future

get(long, TimeUnit) - Method in interface com.fnproject.fn.api.flow.FlowFuture

Get the result of this future, indicating not to wait over the specified timeout.

getBodyAsBytes() - Method in interface com.fnproject.fn.api.flow.HttpRequest

Returns the body of the request as a byte array

getBodyAsBytes() - Method in interface com.fnproject.fn.api.flow.HttpResponse

Returns the body of the function result as a byte array

getCurrentFlowSource() - Static method in class com.fnproject.fn.api.flow.Flows

Gets the current supplier of the flow runtime

getFunctionResponse() - Method in exception com.fnproject.fn.api.flow.FunctionInvocationException

The HTTP details returned from the function invocation

getHeaders() - Method in interface com.fnproject.fn.api.flow.HttpRequest

Return the headers on the HTTP request

getHeaders() - Method in interface com.fnproject.fn.api.flow.HttpResponse

Return the headers on the HTTP function response

getMethod() - Method in interface com.fnproject.fn.api.flow.HttpRequest

Return the HTTP method used to supply this value

getNow(T) - Method in interface com.fnproject.fn.api.flow.FlowFuture

Get the result of this future if completed or the provided value if absent.

getOriginalExceptionType() - Method in exception com.fnproject.fn.api.flow.WrappedFunctionException

Exposes the type of the original error

getStatusCode() - Method in interface com.fnproject.fn.api.flow.HttpResponse

Return the HTTP status code of the function response

H

handle(Flows.SerBiFunction<? super T, Throwable, ? extends X>) - Method in interface com.fnproject.fn.api.flow.FlowFuture

Invoke a handler when a computation is complete, regardless of whether it completed successfully or with an error - optionally transforming the resulting value or error to a new value.

HttpMethod - Enum in com.fnproject.fn.api.flow

Enum representing the different HTTP types that can be used to invoke an external function

HttpRequest - Interface in com.fnproject.fn.api.flow

An abstract HTTP request details (without location)

HttpResponse - Interface in com.fnproject.fn.api.flow

A FunctionResponse represents the HTTP response from an external function invocation (e.g.

I

InvalidStageResponseException - Exception in com.fnproject.fn.api.flow

Exception thrown when a completion stage responds with an incompatible datum type for its corresponding completion graph stage.

InvalidStageResponseException(String) - Constructor for exception com.fnproject.fn.api.flow.InvalidStageResponseException

invokeFunction(String, HttpMethod, Headers, byte[]) - Method in interface com.fnproject.fn.api.flow.Flow

Invoke a fn function and yield the result

invokeFunction(String, HttpMethod, Headers) - Method in interface com.fnproject.fn.api.flow.Flow

Invoke a function by ID with headers and an empty body

invokeFunction(String, U, Class<T>) - Method in interface com.fnproject.fn.api.flow.Flow

Invoke a function by ID using input and output coercion

invokeFunction(String, HttpMethod, Headers, U, Class<T>) - Method in interface com.fnproject.fn.api.flow.Flow

Invoke a function by ID using input and output coercion and a specified method and headers

invokeFunction(String, U) - Method in interface com.fnproject.fn.api.flow.Flow

Invoke a function by ID using input and output coercion, default method (POST) and no response type

invokeFunction(String, HttpMethod, Headers, U) - Method in interface com.fnproject.fn.api.flow.Flow

Invoke a function by ID using input and output coercion and a specified method and headers

invokeFunction(String, HttpMethod) - Method in interface com.fnproject.fn.api.flow.Flow

Invoke a function by ID with no headers

L

LambdaSerializationException - Exception in com.fnproject.fn.api.flow

Exception thrown when a lambda or any referenced objects fail to be serialized.

LambdaSerializationException(String) - Constructor for exception com.fnproject.fn.api.flow.LambdaSerializationException

LambdaSerializationException(String, Exception) - Constructor for exception com.fnproject.fn.api.flow.LambdaSerializationException

P

PlatformException - Exception in com.fnproject.fn.api.flow

Exception thrown when the completion facility fails to operate on a completion graph

PlatformException(Throwable) - Constructor for exception com.fnproject.fn.api.flow.PlatformException

PlatformException(String) - Constructor for exception com.fnproject.fn.api.flow.PlatformException

PlatformException(String, Throwable) - Constructor for exception com.fnproject.fn.api.flow.PlatformException

R

ResultSerializationException - Exception in com.fnproject.fn.api.flow

Exception thrown when a result returned by a completion stage fails to be serialized.

ResultSerializationException(String, Throwable) - Constructor for exception com.fnproject.fn.api.flow.ResultSerializationException

S

setCurrentFlowSource(Flows.FlowSource) - Static method in class com.fnproject.fn.api.flow.Flows

Set the current runtime source - this determines how Flows.currentFlow() behaves

StageInvokeFailedException - Exception in com.fnproject.fn.api.flow

Exception thrown when a a completion stage invocation failed within Fn - the stage may or may not have been invoked and that invocation may or may not have completed.

StageInvokeFailedException(String) - Constructor for exception com.fnproject.fn.api.flow.StageInvokeFailedException

StageLostException - Exception in com.fnproject.fn.api.flow

Exception thrown when a stage failed after an internal error in the flow server, the stage may or may not have been invoked and that invocation may or may not have completed.

StageLostException(String) - Constructor for exception com.fnproject.fn.api.flow.StageLostException

StageTimeoutException - Exception in com.fnproject.fn.api.flow

Exception thrown when a completion stage function execution exceeds it configured timeout - the stage may or may not have completed normally.

StageTimeoutException(String) - Constructor for exception com.fnproject.fn.api.flow.StageTimeoutException

supply(Flows.SerCallable<T>) - Method in interface com.fnproject.fn.api.flow.Flow

Invoke an asynchronous task that yields a value

supply(Flows.SerRunnable) - Method in interface com.fnproject.fn.api.flow.Flow

Invoke an asynchronous task that does not yield a value

T

thenAccept(Flows.SerConsumer<T>) - Method in interface com.fnproject.fn.api.flow.FlowFuture

Perform an action when this future completes successfully.

thenAcceptBoth(FlowFuture<U>, Flows.SerBiConsumer<T, U>) - Method in interface com.fnproject.fn.api.flow.FlowFuture

Perform an action when this and another future have both completed normally:

thenApply(Flows.SerFunction<T, X>) - Method in interface com.fnproject.fn.api.flow.FlowFuture

Applies a transformation to the successfully completed value of this future.

thenCombine(FlowFuture<? extends U>, Flows.SerBiFunction<? super T, ? super U, ? extends X>) - Method in interface com.fnproject.fn.api.flow.FlowFuture

Combine the result of this future and another future into a single value when both have completed normally:

thenCompose(Flows.SerFunction<T, FlowFuture<X>>) - Method in interface com.fnproject.fn.api.flow.FlowFuture

Compose a new computation on to the completion of this future

thenRun(Flows.SerRunnable) - Method in interface com.fnproject.fn.api.flow.FlowFuture

Run an action when this future has completed normally.

toString() - Method in enum com.fnproject.fn.api.flow.HttpMethod

V

valueOf(String) - Static method in enum com.fnproject.fn.api.flow.Flow.FlowState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.fnproject.fn.api.flow.HttpMethod

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.fnproject.fn.api.flow.Flow.FlowState

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.fnproject.fn.api.flow.HttpMethod

Returns an array containing the constants of this enum type, in the order they are declared.

W

whenComplete(Flows.SerBiConsumer<T, Throwable>) - Method in interface com.fnproject.fn.api.flow.FlowFuture

Perform an action when a computation is complete, regardless of whether it completed successfully or with an error.

WrappedFunctionException - Exception in com.fnproject.fn.api.flow

Wrapped exception where the root cause of a function failure was not serializable.

WrappedFunctionException(Throwable) - Constructor for exception com.fnproject.fn.api.flow.WrappedFunctionException

A C D E F G H I L P R S T V W