A B C D E F G H I J L M N O P R S T U V W
All Classes All Packages

A

addVariable(String, Object) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Defines a Variable in the `ThreadSpec` and returns a handle to it.

addVariable(String, Object, IndexTypePb) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Defines a Variable in the `ThreadSpec` and returns a handle to it.

API_HOST_KEY - Static variable in class io.littlehorse.sdk.common.config.LHClientConfig

The bootstrap host for the LH Server.

API_PORT_KEY - Static variable in class io.littlehorse.sdk.common.config.LHClientConfig

The bootstrap port for the LH Server.

applyRequestMetadata(CallCredentials.RequestInfo, Executor, CallCredentials.MetadataApplier) - Method in class io.littlehorse.sdk.common.auth.OAuthCredentialsProvider

assignUserTaskToUser(String, WfRunVariable) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Adds a User Task Node, and assigns it to a specific user

assignUserTaskToUser(String, String) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Adds a User Task Node, and assigns it to a specific user

assignUserTaskToUserGroup(String, WfRunVariable) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Adds a User Task Node, and assigns it to a group of users.

assignUserTaskToUserGroup(String, String) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Adds a User Task Node, and assigns it to a group of users.

AuthorizationServerException - Exception in io.littlehorse.sdk.common.auth

AuthorizationServerException(String) - Constructor for exception io.littlehorse.sdk.common.auth.AuthorizationServerException

AuthorizationServerException(Throwable) - Constructor for exception io.littlehorse.sdk.common.auth.AuthorizationServerException

B

body(ThreadBuilder) - Method in interface io.littlehorse.sdk.wfsdk.IfElseBody

This is the body of Workflow Code.

C

CA_CERT_KEY - Static variable in class io.littlehorse.sdk.common.config.LHClientConfig

Optional location of CA Cert File.

CLIENT_CERT_KEY - Static variable in class io.littlehorse.sdk.common.config.LHClientConfig

Optional location of Client Cert file.

CLIENT_ID_KEY - Static variable in class io.littlehorse.sdk.common.config.LHClientConfig

The Client Id.

CLIENT_KEY_KEY - Static variable in class io.littlehorse.sdk.common.config.LHClientConfig

Optional location of Client Private Key File.

close() - Method in class io.littlehorse.sdk.worker.LHTaskWorker

Cleanly shuts down the Task Worker.

compile() - Method in class io.littlehorse.sdk.usertask.UserTaskSchema

compileAndSaveToDisk(String) - Method in class io.littlehorse.sdk.wfsdk.Workflow

Writes out all PutTaskDefPb, PutExternalEventDefPb, and PutWfSpecPb in JSON form in a directory.

compileTaskDefs() - Method in class io.littlehorse.sdk.wfsdk.Workflow

Creates a set of all TaskDef's that need to be created for this WfSpec, determined by calls to ThreadBuilder::executeAndRegisterTaskDef().

compileTaskDefsToJson() - Method in class io.littlehorse.sdk.wfsdk.Workflow

Creates a list of all TaskDef's that need to be created for this WfSpec, determined by calls to ThreadBuilder::executeAndRegisterTaskDef().

compileWfToJson() - Method in class io.littlehorse.sdk.wfsdk.Workflow

Returns the associated PutWfSpecPb in JSON form.

compileWorkflow() - Method in class io.littlehorse.sdk.wfsdk.Workflow

Compiles this Workflow into a `WfSpec`.

condition(Object, ComparatorPb, Object) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Returns a WorkflowCondition that can be used in `ThreadBuilder::doIf()` or `ThreadBuilder::doElse()`.

configNames() - Static method in class io.littlehorse.sdk.common.config.LHClientConfig

Returns a set of all config names.

configNames() - Static method in class io.littlehorse.sdk.common.config.LHWorkerConfig

D

DEFAULT_PUBLIC_LISTENER - Static variable in class io.littlehorse.sdk.common.config.LHWorkerConfig

deleteExternalEventDef(String) - Method in class io.littlehorse.sdk.client.LHClient

Delete san external event definition given its name

deleteTaskDef(String) - Method in class io.littlehorse.sdk.client.LHClient

Deletes a task definition given its name

deleteUserTaskDef(String) - Method in class io.littlehorse.sdk.client.LHClient

Deletes a user task definition given a name

deleteWfRun(String) - Method in class io.littlehorse.sdk.client.LHClient

Deletes a workflow run given its id

deleteWfSpec(String, int) - Method in class io.littlehorse.sdk.client.LHClient

Deletes a workflow specification given its name and version

description() - Method in annotation type io.littlehorse.sdk.usertask.annotations.UserTaskField

displayName() - Method in annotation type io.littlehorse.sdk.usertask.annotations.UserTaskField

doesTaskDefExist() - Method in class io.littlehorse.sdk.worker.LHTaskWorker

Checks if the TaskDef exists

doesWfSpecExist(LHClient) - Method in class io.littlehorse.sdk.wfsdk.Workflow

Checks if the WfSpec exists

doesWfSpecExist(LHClient, Integer) - Method in class io.littlehorse.sdk.wfsdk.Workflow

Checks if the WfSpec exists for a given version

doIf(WorkflowCondition, IfElseBody) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Conditionally executes some workflow code; equivalent to an if() statement in programming.

doIfElse(WorkflowCondition, IfElseBody, IfElseBody) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Conditionally executes one of two workflow code branches; equivalent to an if/else statement in programming.

doWhile(WorkflowCondition, ThreadFunc) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Conditionally executes some workflow code; equivalent to an while() statement in programming.

E

execute(String, Object...) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Adds a TASK node to the ThreadSpec.

F

fail(Object, String, String) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Adds an EXIT node with a Failure defined.

fail(String, String) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Adds an EXIT node with a Failure defined.

format(String, WfRunVariable...) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

G

getAccessToken() - Method in class io.littlehorse.sdk.common.auth.OAuthClient

getApiBootstrapHost() - Method in class io.littlehorse.sdk.common.config.LHClientConfig

getApiBootstrapHost() - Method in class io.littlehorse.sdk.common.config.LHWorkerConfig

Returns the API BootStrap Host.

getApiBootstrapPort() - Method in class io.littlehorse.sdk.common.config.LHClientConfig

getApiBootstrapPort() - Method in class io.littlehorse.sdk.common.config.LHWorkerConfig

Returns the API Bootstrap Port.

getAsyncStub() - Method in class io.littlehorse.sdk.common.config.LHClientConfig

Gets an Async gRPC stub for the LH Public API on the configured host/port, which is generally the loadbalancer url.

getAsyncStub(String, int) - Method in class io.littlehorse.sdk.common.config.LHClientConfig

Gets an Async gRPC stub for the LH Public API on a specified host and port.

getAttemptNumber() - Method in class io.littlehorse.sdk.worker.WorkerContext

Returns the attemptNumber of the NodeRun that's being executed.

getBlockingStub() - Method in class io.littlehorse.sdk.common.config.LHClientConfig

Gets a Blocking gRPC stub for the LH Public API on the configured host/port, which is generally the loadbalancer url.

getBlockingStub(String, int) - Method in class io.littlehorse.sdk.common.config.LHClientConfig

Gets a Blocking gRPC stub for the LH Public API on a specified host and port.

getClientId() - Method in class io.littlehorse.sdk.common.config.LHClientConfig

getConnectListener() - Method in class io.littlehorse.sdk.common.config.LHWorkerConfig

Returns the name of the listener to connect to.

getExternalEvent(String, String, String) - Method in class io.littlehorse.sdk.client.LHClient

Returns an emitted external event for a specific workflow run

getExternalEventDef(String) - Method in class io.littlehorse.sdk.client.LHClient

Gets a external event

getGrpcClient() - Method in class io.littlehorse.sdk.client.LHClient

Returns the underline RPC client

getIdempotencyKey() - Method in class io.littlehorse.sdk.worker.WorkerContext

Returns an idempotency key that can be used to make calls to upstream api's idempotent across TaskRun Retries.

getLogOutput() - Method in class io.littlehorse.sdk.worker.WorkerContext

Returns the current logOutput.

getName() - Method in class io.littlehorse.sdk.wfsdk.Workflow

Gets the workflow name passed at Workflow.newWorkflow(String, ThreadFunc)

getNodeRun(String, int, int) - Method in class io.littlehorse.sdk.client.LHClient

Returns a NodeRun given a workflow, thread run number and position in the ThreadRun

getNodeRunId() - Method in class io.littlehorse.sdk.worker.WorkerContext

Returns the NodeRun ID for the Task that was just scheduled.

getRequiredExternalEventDefNames() - Method in class io.littlehorse.sdk.wfsdk.Workflow

Returns the names of all `ExternalEventDef`s used by this workflow.

getRequiredTaskDefNames() - Method in class io.littlehorse.sdk.wfsdk.Workflow

Returns the names of all `TaskDef`s used by this workflow.

getScheduledTime() - Method in class io.littlehorse.sdk.worker.WorkerContext

Returns the time at which the task was scheduled by the processor.

getTaskDef(String) - Method in class io.littlehorse.sdk.client.LHClient

Gets a task definition given the name

getTaskDef(String) - Method in class io.littlehorse.sdk.common.config.LHWorkerConfig

Gets the `TaskDefPb` for a given taskDefName.

getTaskDefName() - Method in class io.littlehorse.sdk.worker.LHTaskWorker

`TaskDef` to execute

getTaskExecutables() - Method in class io.littlehorse.sdk.wfsdk.Workflow

Returns a set of all objects that were passed to executeAndRegisterTaskDef().

getTaskRun(TaskRunIdPb) - Method in class io.littlehorse.sdk.client.LHClient

Returns a TaskRun given an id

getTaskRunId() - Method in class io.littlehorse.sdk.worker.WorkerContext

getTaskWorkerVersion() - Method in class io.littlehorse.sdk.common.config.LHWorkerConfig

Returns the TaskWorker Version of this worker.

getUserTaskRun(UserTaskRunIdPb) - Method in class io.littlehorse.sdk.client.LHClient

Returns a UserTaskRun given an id

getVariable(String, int, String) - Method in class io.littlehorse.sdk.client.LHClient

Returns a passed variable to a thread

getWfRun(String) - Method in class io.littlehorse.sdk.client.LHClient

Gets a workflow run given an id

getWfRunId() - Method in class io.littlehorse.sdk.worker.WorkerContext

Returns the Id of the WfRun for the NodeRun that's being executed.

getWfSpec(String) - Method in class io.littlehorse.sdk.client.LHClient

Gets the workflow specification for a given workflow name

getWfSpec(String, Integer) - Method in class io.littlehorse.sdk.client.LHClient

Gets the workflow specification for a given workflow name and version

getWorkerThreads() - Method in class io.littlehorse.sdk.common.config.LHWorkerConfig

Returns the number of worker threads to run.

H

handleException(NodeOutput, String, ThreadFunc) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Adds a Failure Handler to the Node specified by the provided NodeOutput.

HANDLER_INPUT_VAR - Static variable in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

This is the reserved Variable Name that can be used as a WfRunVariable in an Interrupt Handler or Exception Handler thread.

I

IfElseBody - Interface in io.littlehorse.sdk.wfsdk

Functional interface representing a body of Workflow code to be executed inside an if or else condition.

introspect(String) - Method in class io.littlehorse.sdk.common.auth.OAuthClient

io.littlehorse.sdk.client - package io.littlehorse.sdk.client

io.littlehorse.sdk.common.auth - package io.littlehorse.sdk.common.auth

io.littlehorse.sdk.common.config - package io.littlehorse.sdk.common.config

io.littlehorse.sdk.usertask - package io.littlehorse.sdk.usertask

io.littlehorse.sdk.usertask.annotations - package io.littlehorse.sdk.usertask.annotations

io.littlehorse.sdk.wfsdk - package io.littlehorse.sdk.wfsdk

io.littlehorse.sdk.worker - package io.littlehorse.sdk.worker

isExpired() - Method in class io.littlehorse.sdk.common.auth.TokenStatus

isOauth() - Method in class io.littlehorse.sdk.common.config.LHClientConfig

J

javaTypeToLHType - Static variable in class io.littlehorse.sdk.worker.LHTaskWorker

jsonPath(String) - Method in interface io.littlehorse.sdk.wfsdk.NodeOutput

Valid only for output of the JSON_OBJ or JSON_ARR types.

jsonPath(String) - Method in interface io.littlehorse.sdk.wfsdk.WfRunVariable

Valid only for output of the JSON_OBJ or JSON_ARR types.

L

LHClient - Class in io.littlehorse.sdk.client

LHClient(LHClientConfig) - Constructor for class io.littlehorse.sdk.client.LHClient

Creates a client given a client config

LHClient(Properties) - Constructor for class io.littlehorse.sdk.client.LHClient

Creates a client given a properties object

LHClientConfig - Class in io.littlehorse.sdk.common.config

This class is used to configure the LHClient class.

LHClientConfig() - Constructor for class io.littlehorse.sdk.common.config.LHClientConfig

Creates an LHClientConfig.

LHClientConfig(String) - Constructor for class io.littlehorse.sdk.common.config.LHClientConfig

Creates an LHClientConfig with config props in a specified .properties file.

LHClientConfig(Map<String, Object>) - Constructor for class io.littlehorse.sdk.common.config.LHClientConfig

Creates an LHClientConfig with provided config values.

LHClientConfig(Properties) - Constructor for class io.littlehorse.sdk.common.config.LHClientConfig

Creates an LHClientConfig with provided config values.

LHFormatString - Interface in io.littlehorse.sdk.wfsdk

LHTaskMethod - Annotation Type in io.littlehorse.sdk.worker

Annotation used to indicate that the annotated method should be used as the method to execute a Task in the LH Java Task Worker library.

LHTaskWorker - Class in io.littlehorse.sdk.worker

The LHTaskWorker talks to the LH Servers and executes a specified Task Method every time a Task is scheduled.

LHTaskWorker(Object, String, LHWorkerConfig) - Constructor for class io.littlehorse.sdk.worker.LHTaskWorker

Creates an LHTaskWorker given an Object that has an annotated LHTaskMethod, and a configuration Properties object.

LHWorkerConfig - Class in io.littlehorse.sdk.common.config

This is a configuration class for the Task Workers.

LHWorkerConfig() - Constructor for class io.littlehorse.sdk.common.config.LHWorkerConfig

Creates an LHWorkerConfig using the environment variables as defaults.

LHWorkerConfig(String) - Constructor for class io.littlehorse.sdk.common.config.LHWorkerConfig

Creates an LHWorkerConfig with a .properties file.

LHWorkerConfig(Map<String, Object>) - Constructor for class io.littlehorse.sdk.common.config.LHWorkerConfig

Creates an LHWorkerConfig with provided config values.

LHWorkerConfig(Properties) - Constructor for class io.littlehorse.sdk.common.config.LHWorkerConfig

Creates an LHWorkerConfig with provided properties.

log(Object) - Method in class io.littlehorse.sdk.worker.WorkerContext

Provides a way to push data into the log output.

M

mutate(WfRunVariable, VariableMutationTypePb, Object) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Adds a VariableMutation to the last Node

N

newWorkflow(String, ThreadFunc) - Static method in class io.littlehorse.sdk.wfsdk.Workflow

Creates a new Workflow with the provided name and entrypoint thread function.

NodeOutput - Interface in io.littlehorse.sdk.wfsdk

`NodeOutput` represents the output of a Node execution.

NUM_WORKER_THREADS_KEY - Static variable in class io.littlehorse.sdk.common.config.LHWorkerConfig

The number of worker threads to run.

O

OAUTH_AUTHORIZATION_SERVER_KEY - Static variable in class io.littlehorse.sdk.common.config.LHClientConfig

OAUTH_CLIENT_ID_KEY - Static variable in class io.littlehorse.sdk.common.config.LHClientConfig

OAUTH_CLIENT_SECRET_KEY - Static variable in class io.littlehorse.sdk.common.config.LHClientConfig

OAuthClient - Class in io.littlehorse.sdk.common.auth

OAuthClient(OAuthConfig) - Constructor for class io.littlehorse.sdk.common.auth.OAuthClient

OAuthConfig - Class in io.littlehorse.sdk.common.auth

OAuthConfig() - Constructor for class io.littlehorse.sdk.common.auth.OAuthConfig

OAuthCredentialsProvider - Class in io.littlehorse.sdk.common.auth

OAuthCredentialsProvider(OAuthClient) - Constructor for class io.littlehorse.sdk.common.auth.OAuthCredentialsProvider

P

putExternalEvent(PutExternalEventPb) - Method in class io.littlehorse.sdk.client.LHClient

Emits an external event to the server

putExternalEventDef(PutExternalEventDefPb) - Method in class io.littlehorse.sdk.client.LHClient

Creates a new external event definition.

putExternalEventDef(PutExternalEventDefPb, boolean) - Method in class io.littlehorse.sdk.client.LHClient

Creates a new external event definition

putTaskDef(PutTaskDefPb) - Method in class io.littlehorse.sdk.client.LHClient

Creates a task definition.

putTaskDef(PutTaskDefPb, boolean) - Method in class io.littlehorse.sdk.client.LHClient

Creates a task definition

putUserTaskDef(PutUserTaskDefPb) - Method in class io.littlehorse.sdk.client.LHClient

Creates a user task definition.

putUserTaskDef(PutUserTaskDefPb, boolean) - Method in class io.littlehorse.sdk.client.LHClient

Creates a user task definition

putWfSpec(PutWfSpecPb) - Method in class io.littlehorse.sdk.client.LHClient

Creates a new workflow specification.

R

registerInterruptHandler(String, ThreadFunc) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Registers an Interrupt Handler, such that when an ExternalEvent arrives with the specified type, this ThreadRun is interrupted.

registerTaskDef() - Method in class io.littlehorse.sdk.worker.LHTaskWorker

Deploys the TaskDef object to the LH Server.

registerTaskDef(boolean) - Method in class io.littlehorse.sdk.worker.LHTaskWorker

Deploys the TaskDef object to the LH Server.

registerWfSpec(LHClient) - Method in class io.littlehorse.sdk.wfsdk.Workflow

Deploys the WfSpec object to the LH Server.

resumeWfRun(String, int) - Method in class io.littlehorse.sdk.client.LHClient

Resume a thread execution.

runWf(String, Integer, String, Arg...) - Method in class io.littlehorse.sdk.client.LHClient

Makes a request to the server to execute a workflow specification.

S

scheduleTaskAfter(UserTaskOutput, int, String, Object...) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Adds a TASK node to the ThreadSpec.

scheduleTaskAfter(UserTaskOutput, WfRunVariable, String, Object...) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Adds a TASK node to the ThreadSpec.

searchWfRun(String, int, LHStatusPb, Date, Date) - Method in class io.littlehorse.sdk.client.LHClient

Returns a list of ids which match the input parameters

SERVER_CONNECT_LISTENER_KEY - Static variable in class io.littlehorse.sdk.common.config.LHWorkerConfig

Listener to connect to.

sleepSeconds(Object) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Adds a SLEEP node which makes the ThreadRun sleep for a specified number of seconds.

sleepUntil(WfRunVariable) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Adds a SLEEP node which makes the ThreadRun sleep until a specified timestamp, provided as an INT WfRunVariable (note that INT in LH is a 64-bit integer).

SpawnedThread - Interface in io.littlehorse.sdk.wfsdk

This is the output of `ThreadBuilder::spawnThread()`.

spawnThread(ThreadFunc, String, Map<String, Object>) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Adds a SPAWN_THREAD node to the ThreadSpec, which spawns a Child ThreadRun whose ThreadSpec is determined by the provided ThreadFunc.

start() - Method in class io.littlehorse.sdk.worker.LHTaskWorker

Starts polling for and executing tasks.

stopWfRun(String, int) - Method in class io.littlehorse.sdk.client.LHClient

Halts a thread for a given workflow run.

T

TASK_WORKER_VERSION_KEY - Static variable in class io.littlehorse.sdk.common.config.LHWorkerConfig

ThreadBuilder - Interface in io.littlehorse.sdk.wfsdk

This interface is what is used to define the logic of a ThreaSpec in a ThreadFunc.

ThreadFunc - Interface in io.littlehorse.sdk.wfsdk

A ThreadFunc is the interface an object must implement in order to define a `ThreadSpec` programmatically using the Java Library.

threadFunction(ThreadBuilder) - Method in interface io.littlehorse.sdk.wfsdk.ThreadFunc

This function defines the logic of a `ThreadSpec`.

timeout(int) - Method in interface io.littlehorse.sdk.wfsdk.NodeOutput

Adds a timeout to a Node.

TokenStatus - Class in io.littlehorse.sdk.common.auth

TokenStatus() - Constructor for class io.littlehorse.sdk.common.auth.TokenStatus

toString() - Method in class io.littlehorse.sdk.common.auth.TokenStatus

U

UserTaskField - Annotation Type in io.littlehorse.sdk.usertask.annotations

UserTaskOutput - Interface in io.littlehorse.sdk.wfsdk

UserTaskSchema - Class in io.littlehorse.sdk.usertask

UserTaskSchema(Object, String) - Constructor for class io.littlehorse.sdk.usertask.UserTaskSchema

V

value() - Method in annotation type io.littlehorse.sdk.worker.LHTaskMethod

This is the value of the annotation; it corresponds to the name of the TaskDef executed by the annotated Method.

W

waitForEvent(String) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Adds an EXTERNAL_EVENT node which blocks until an 'ExternalEvent' of the specified type arrives.

waitForThreads(SpawnedThread...) - Method in interface io.littlehorse.sdk.wfsdk.ThreadBuilder

Adds a WAIT_FOR_THREAD node which waits for a Child ThreadRun to complete.

WfRunVariable - Interface in io.littlehorse.sdk.wfsdk

A WfRunVariable is a handle on a Variable in a WfSpec.

withNotes(LHFormatString) - Method in interface io.littlehorse.sdk.wfsdk.UserTaskOutput

withNotes(WfRunVariable) - Method in interface io.littlehorse.sdk.wfsdk.UserTaskOutput

withNotes(String) - Method in interface io.littlehorse.sdk.wfsdk.UserTaskOutput

withRetentionHours(int) - Method in class io.littlehorse.sdk.wfsdk.Workflow

Add the hours of life that the workflow will have in the system

WorkerContext - Class in io.littlehorse.sdk.worker

This class contains runtime information about the specific WfRun and NodeRun that is being executed by the Task Worker.

WorkerContext(ScheduledTaskPb, Date) - Constructor for class io.littlehorse.sdk.worker.WorkerContext

Constructor for internal use by the Task Worker Library.

Workflow - Class in io.littlehorse.sdk.wfsdk

The Workflow class represents a `WfSpec` object in the API.

WorkflowCondition - Interface in io.littlehorse.sdk.wfsdk

A WorkflowCondition is a representation of a boolean expression.

A B C D E F G H I J L M N O P R S T U V W
All Classes All Packages