diff --git a/dashboard/apps/web/littlehorse-public-api/acls.ts b/dashboard/apps/web/littlehorse-public-api/acls.ts index de3f3c4e5..6242f2f5e 100644 --- a/dashboard/apps/web/littlehorse-public-api/acls.ts +++ b/dashboard/apps/web/littlehorse-public-api/acls.ts @@ -1016,7 +1016,7 @@ export type Exact = P extends Builtin ? P function toTimestamp(dateStr: string): Timestamp { const date = new globalThis.Date(dateStr); - const seconds = date.getTime() / 1_000; + const seconds = Math.trunc(date.getTime() / 1_000); const nanos = (date.getTime() % 1_000) * 1_000_000; return { seconds, nanos }; } diff --git a/dashboard/apps/web/littlehorse-public-api/common_wfspec.ts b/dashboard/apps/web/littlehorse-public-api/common_wfspec.ts index 92de21157..90f707c25 100644 --- a/dashboard/apps/web/littlehorse-public-api/common_wfspec.ts +++ b/dashboard/apps/web/littlehorse-public-api/common_wfspec.ts @@ -117,14 +117,35 @@ export function variableMutationTypeToNumber(object: VariableMutationType): numb } } +/** Operator for comparing two values to create a boolean expression. */ export enum Comparator { + /** LESS_THAN - Equivalent to `<`. Only valid for primitive types (no JSON_OBJ or JSON_ARR). */ LESS_THAN = "LESS_THAN", + /** GREATER_THAN - Equivalent to `>`. Only valid for primitive types (no JSON_OBJ or JSON_ARR). */ GREATER_THAN = "GREATER_THAN", + /** LESS_THAN_EQ - Equivalent to `<=`. Only valid for primitive types (no JSON_OBJ or JSON_ARR). */ LESS_THAN_EQ = "LESS_THAN_EQ", + /** GREATER_THAN_EQ - Equivalent to `>=`. Only valid for primitive types (no JSON_OBJ or JSON_ARR). */ GREATER_THAN_EQ = "GREATER_THAN_EQ", + /** + * EQUALS - This is valid for any variable type, and is similar to .equals() in Java. + * + * One note: if the RHS is a different type from the LHS, then LittleHorse will + * try to cast the RHS to the same type as the LHS. If the cast fails, then the + * ThreadRun fails with a VAR_SUB_ERROR. + */ EQUALS = "EQUALS", + /** NOT_EQUALS - This is the inverse of `EQUALS` */ NOT_EQUALS = "NOT_EQUALS", + /** + * IN - Only valid if the RHS is a JSON_OBJ or JSON_ARR. Valid for any type on the LHS. + * + * For the JSON_OBJ type, this returns true if the LHS is equal to a *KEY* in the + * RHS. For the JSON_ARR type, it returns true if one of the elements of the RHS + * is equal to the LHS. + */ IN = "IN", + /** NOT_IN - The inverse of IN. */ NOT_IN = "NOT_IN", UNRECOGNIZED = "UNRECOGNIZED", } @@ -253,22 +274,58 @@ export interface VariableAssignment_FormatString { args: VariableAssignment[]; } +/** + * A VariableMutation defines a modification made to one of a ThreadRun's variables. + * The LHS determines the variable that is modified; the operation determines how + * it is modified, and the RHS is the input to the operation. + * + * Day-to-day users of LittleHorse generally don't interact with this structure unless + * they are writing their own WfSpec SDK. + */ export interface VariableMutation { + /** The name of the variable to mutate */ lhsName: string; - lhsJsonPath?: string | undefined; + /** + * For JSON_ARR and JSON_OBJ variables, this allows you to optionally mutate + * a specific sub-field of the variable. + */ + lhsJsonPath?: + | string + | undefined; + /** Defines the operation that we are executing. */ operation: VariableMutationType; - sourceVariable?: VariableAssignment | undefined; - literalValue?: VariableValue | undefined; + /** + * Set the source_variable as the RHS to use another variable from the workflow to + * as the RHS/ + */ + sourceVariable?: + | VariableAssignment + | undefined; + /** Use a literal value as the RHS. */ + literalValue?: + | VariableValue + | undefined; + /** Use the output of the current node as the RHS. */ nodeOutput?: VariableMutation_NodeOutputSource | undefined; } +/** Specifies to use the output of a NodeRun as the RHS. */ export interface VariableMutation_NodeOutputSource { + /** Use this specific field from a JSON output */ jsonpath?: string | undefined; } +/** Declares a Variable. */ export interface VariableDef { + /** The Type of the variable. */ type: VariableType; + /** The name of the variable. */ name: string; + /** + * Optional default value if the variable isn't set; for example, in a ThreadRun + * if you start a ThreadRun or WfRun without passing a variable in, then this is + * used. + */ defaultValue?: VariableValue | undefined; } @@ -292,13 +349,31 @@ export interface UTActionTrigger { reassign?: | UTActionTrigger_UTAReassign | undefined; - /** Action's delay */ - delaySeconds: VariableAssignment | undefined; + /** + * The Action is triggered some time after the Hook matures. The delay is controlled + * by this field. + */ + delaySeconds: + | VariableAssignment + | undefined; + /** The hook on which this UserTaskAction is scheduled. */ hook: UTActionTrigger_UTHook; } +/** Enumerates the different lifecycle hooks that can cause the timer to start running. */ export enum UTActionTrigger_UTHook { + /** + * ON_ARRIVAL - The hook should be scheduled `delay_seconds` after the UserTaskRun is created. This + * hook only causes the action to be scheduled once. + */ ON_ARRIVAL = "ON_ARRIVAL", + /** + * ON_TASK_ASSIGNED - The hook should be scheduled `delay_seconds` after the ownership of the UserTaskRun + * changes. This hook causes the Action to be scheduled one or more times. The first + * time is scheduled when the UserTaskRun is created, since we treat the change from + * "UserTaskRun is nonexistent" to "UserTaskRun is owned by a userId or userGroup" as + * a change in ownership. + */ ON_TASK_ASSIGNED = "ON_TASK_ASSIGNED", UNRECOGNIZED = "UNRECOGNIZED", } @@ -342,23 +417,54 @@ export function uTActionTrigger_UTHookToNumber(object: UTActionTrigger_UTHook): } } +/** A UserTaskAction that causes a UserTaskRun to be CANCELLED when it fires. */ export interface UTActionTrigger_UTACancel { } +/** A UserTaskAction that causes a TaskRun to be scheduled when it fires. */ export interface UTActionTrigger_UTATask { - task: TaskNode | undefined; + /** The specification of the Task to schedule. */ + task: + | TaskNode + | undefined; + /** EXPERIMENTAL: Any variables in the ThreadRun which we should mutate. */ mutations: VariableMutation[]; } +/** A UserTaskAction that causes a UserTaskRun to be reassigned when it fires. */ export interface UTActionTrigger_UTAReassign { - userId?: VariableAssignment | undefined; + /** + * A variable assignment that resolves to a STR representing the new user_id. If + * not set, the user_id of the UserTaskRun will be un-set. + */ + userId?: + | VariableAssignment + | undefined; + /** + * A variable assignment that resolves to a STR representing the new user_group. If + * not set, the user_group of the UserTaskRun will be un-set. + */ userGroup?: VariableAssignment | undefined; } +/** Defines a TaskRun execution. Used in a Node and also in the UserTask Trigger Actions. */ export interface TaskNode { - taskDefId: TaskDefId | undefined; + /** The type of TaskRun to schedule. */ + taskDefId: + | TaskDefId + | undefined; + /** + * How long until LittleHorse determines that the Task Worker had a technical ERROR if + * the worker does not yet reply to the Server. + */ timeoutSeconds: number; + /** + * EXPERIMENTAL: How many times we should retry on retryable ERROR's. + * Please note that this API may change before version 1.0.0, as we are going to + * add significant functionality including backoff policies. + */ retries: number; + /** Input variables into the TaskDef. */ variables: VariableAssignment[]; } diff --git a/dashboard/apps/web/littlehorse-public-api/external_event.ts b/dashboard/apps/web/littlehorse-public-api/external_event.ts index bd0bca3ef..15a5091b1 100644 --- a/dashboard/apps/web/littlehorse-public-api/external_event.ts +++ b/dashboard/apps/web/littlehorse-public-api/external_event.ts @@ -7,22 +7,77 @@ import { VariableValue } from "./variable"; export const protobufPackage = "littlehorse"; +/** + * An ExternalEvent represents A Thing That Happened outside the context of a WfRun. + * Generally, an ExternalEvent is used to represent a document getting signed, an incident + * being resolved, an order being fulfilled, etc. + * + * ExternalEvent's are created via the 'rpc PutExternalEvent' + * + * For more context on ExternalEvents, check our documentation here: + * https://littlehorse.dev/docs/concepts/external-events + */ export interface ExternalEvent { - id: ExternalEventId | undefined; - createdAt: string | undefined; - content: VariableValue | undefined; - threadRunNumber?: number | undefined; - nodeRunPosition?: number | undefined; + /** + * The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId, + * and a unique guid which can be used for idempotency of the `PutExternalEvent` + * rpc call. + */ + id: + | ExternalEventId + | undefined; + /** The time the ExternalEvent was registered with LittleHorse. */ + createdAt: + | string + | undefined; + /** The payload of this ExternalEvent. */ + content: + | VariableValue + | undefined; + /** + * If the ExternalEvent was claimed by a specific ThreadRun (via Interrupt or + * EXTERNAL_EVENT Node), this is set to the number of the relevant ThreadRun. + */ + threadRunNumber?: + | number + | undefined; + /** + * If the ExternalEvent was claimed by a specific ThreadRun (via EXTERNAL_EVENT + * Node; note that in the case of an Interrupt the node_run_position will never + * be set), this is set to the number of the relevant NodeRun. + */ + nodeRunPosition?: + | number + | undefined; + /** Whether the ExternalEvent has been claimed by a WfRun. */ claimed: boolean; } -/** ExternalEventDef */ +/** The ExternalEventDef defines the blueprint for an ExternalEvent. */ export interface ExternalEventDef { + /** The name of the ExternalEventDef. */ name: string; - createdAt: string | undefined; + /** When the ExternalEventDef was created. */ + createdAt: + | string + | undefined; + /** + * The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the + * ExternalEvent **only before** it is matched with a WfRun. + */ retentionPolicy: ExternalEventRetentionPolicy | undefined; } +/** + * Policy to determine how long an ExternalEvent is retained after creation if it + * is not yet claimed by a WfRun. Note that once a WfRun has been matched with the + * ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted. + * If not set, then ExternalEvent's are not deleted if they are not matched with + * a WfRun. + * + * A future version of LittleHorse will allow changing the retention_policy, which + * will trigger a cleanup of old `ExternalEvent`s. + */ export interface ExternalEventRetentionPolicy { /** * Delete such an ExternalEvent X seconds after it has been registered if it @@ -338,7 +393,7 @@ export type Exact = P extends Builtin ? P function toTimestamp(dateStr: string): Timestamp { const date = new globalThis.Date(dateStr); - const seconds = date.getTime() / 1_000; + const seconds = Math.trunc(date.getTime() / 1_000); const nanos = (date.getTime() % 1_000) * 1_000_000; return { seconds, nanos }; } diff --git a/dashboard/apps/web/littlehorse-public-api/node_run.ts b/dashboard/apps/web/littlehorse-public-api/node_run.ts index 47d045e66..6754ccd2f 100644 --- a/dashboard/apps/web/littlehorse-public-api/node_run.ts +++ b/dashboard/apps/web/littlehorse-public-api/node_run.ts @@ -16,77 +16,217 @@ import { VariableValue } from "./variable"; export const protobufPackage = "littlehorse"; +/** + * A NodeRun is a running instance of a Node in a ThreadRun. Note that a NodeRun + * is a Getable object, meaning it can be retried from the LittleHorse grpc API. + */ export interface NodeRun { - id: NodeRunId | undefined; - wfSpecId: WfSpecId | undefined; + /** + * The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the + * ThreadRun's number, and the position of the NodeRun within that ThreadRun. + */ + id: + | NodeRunId + | undefined; + /** + * The ID of the WfSpec that this NodeRun is from. This is not _always_ the same + * as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration + * feature. + */ + wfSpecId: + | WfSpecId + | undefined; + /** A list of all ThreadRun's that ran to handle a failure thrown by this NodeRun. */ failureHandlerIds: number[]; + /** The status of this NodeRun. */ status: LHStatus; - arrivalTime: string | undefined; - endTime?: string | undefined; + /** The time the ThreadRun arrived at this NodeRun. */ + arrivalTime: + | string + | undefined; + /** The time the NodeRun was terminated (failed or completed). */ + endTime?: + | string + | undefined; + /** The name of the ThreadSpec to which this NodeRun belongs. */ threadSpecName: string; + /** The name of the Node in the ThreadSpec that this NodeRun belongs to. */ nodeName: string; - errorMessage?: string | undefined; + /** + * A human-readable error message intended to help developers diagnose WfSpec + * problems. + */ + errorMessage?: + | string + | undefined; + /** A list of Failures thrown by this NodeRun. */ failures: Failure[]; - task?: TaskNodeRun | undefined; - externalEvent?: ExternalEventRun | undefined; - entrypoint?: EntrypointRun | undefined; - exit?: ExitRun | undefined; - startThread?: StartThreadRun | undefined; - waitThreads?: WaitForThreadsRun | undefined; - sleep?: SleepNodeRun | undefined; - userTask?: UserTaskNodeRun | undefined; + /** Denotes a TASK node, which runs a TaskRun. */ + task?: + | TaskNodeRun + | undefined; + /** An EXTERNAL_EVENT node blocks until an ExternalEvent arrives. */ + externalEvent?: + | ExternalEventRun + | undefined; + /** An ENTRYPOINT node is the first thing that runs in a ThreadRun. */ + entrypoint?: + | EntrypointRun + | undefined; + /** An EXIT node completes a ThreadRun. */ + exit?: + | ExitRun + | undefined; + /** A START_THREAD node starts a child ThreadRun. */ + startThread?: + | StartThreadRun + | undefined; + /** A WAIT_THREADS node waits for one or more child ThreadRun's to complete. */ + waitThreads?: + | WaitForThreadsRun + | undefined; + /** A SLEEP node makes the ThreadRun block for a certain amount of time. */ + sleep?: + | SleepNodeRun + | undefined; + /** A USER_TASK node waits until a human executes some work and reports the result. */ + userTask?: + | UserTaskNodeRun + | undefined; + /** + * A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a + * child ThreadRun for each element in the list. + */ startMultipleThreads?: StartMultipleThreadsRun | undefined; } +/** The sub-node structure for a TASK NodeRun. */ export interface TaskNodeRun { + /** + * The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived + * at this TASK Node, then the task_run_id will be unset. + */ taskRunId?: TaskRunId | undefined; } +/** The sub-node structure for a USER_TASK NodeRun. */ export interface UserTaskNodeRun { + /** + * The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived + * at this USER_TASK node, then the user_task_run_id will be unset. + */ userTaskRunId?: UserTaskRunId | undefined; } +/** The sub-node structure for an ENTRYPOINT NodeRun. Currently Empty. */ export interface EntrypointRun { } +/** + * The sub-node structure for an EXIT NodeRun. Currently Empty, will contain info + * about ThreadRun Outputs once those are added in the future. + */ export interface ExitRun { } +/** The sub-node structure for a START_THREAD NodeRun. */ export interface StartThreadRun { - childThreadId?: number | undefined; + /** + * Contains the thread_run_number of the created Child ThreadRun, if it has + * been created already. + */ + childThreadId?: + | number + | undefined; + /** The thread_spec_name of the child thread_run. */ threadSpecName: string; } +/** + * The sub-node structure for a START_MULTIPLE_THREADS NodeRun. + * + * Note: the output of this NodeRun, which can be used to mutate Variables, + * is a JSON_ARR variable containing the ID's of all the child threadRuns. + */ export interface StartMultipleThreadsRun { + /** The thread_spec_name of the child thread_runs. */ threadSpecName: string; } +/** The sub-node structure for a WAIT_FOR_THREADS NodeRun. */ export interface WaitForThreadsRun { + /** The threads that are being waited for. */ threads: WaitForThreadsRun_WaitForThread[]; + /** + * The policy to use when handling failures for Threads. Currently, only + * one policy exists. + */ policy: WaitForThreadsPolicy; } +/** A 'WaitForThread' structure defines a thread that is being waited for. */ export interface WaitForThreadsRun_WaitForThread { - threadEndTime?: string | undefined; + /** + * The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun + * is still RUNNING, HALTED, or HALTING. + */ + threadEndTime?: + | string + | undefined; + /** The current status of the ThreadRun being waited for. */ threadStatus: LHStatus; + /** The number of the ThreadRun being waited for. */ threadRunNumber: number; + /** INTERNAL: flag used by scheduler internally. */ alreadyHandled: boolean; } +/** The sub-node structure for an EXTERNAL_EVENT NodeRun. */ export interface ExternalEventRun { - externalEventDefId: ExternalEventDefId | undefined; - eventTime?: string | undefined; + /** The ExternalEventDefId that we are waiting for. */ + externalEventDefId: + | ExternalEventDefId + | undefined; + /** The time that the ExternalEvent arrived. Unset if still waiting. */ + eventTime?: + | string + | undefined; + /** The ExternalEventId of the ExternalEvent. Unset if still waiting. */ externalEventId?: ExternalEventId | undefined; } +/** The sub-node structure for a SLEEP NodeRun. */ export interface SleepNodeRun { + /** The time at which the NodeRun will wake up. */ maturationTime: string | undefined; } +/** + * Denotes a failure that happened during execution of a NodeRun or the outgoing + * edges. + */ export interface Failure { + /** + * The name of the failure. LittleHorse has certain built-in failures, all named in + * UPPER_UNDERSCORE_CASE. Such failures correspond with the `LHStatus.ERROR`. + * + * Any Failure named in `kebab-case` is a user-defined business `EXCEPTION`, treated + * as an `LHStatus.EXCEPTION`. + */ failureName: string; + /** The human-readable message associated with this Failure. */ message: string; - content?: VariableValue | undefined; + /** + * A user-defined Failure can have a value; for example, in Java an Exception is an + * Object with arbitrary properties and behaviors. + * + * Future versions of LH will allow FailureHandler threads to accept that value as + * an input variable. + */ + content?: + | VariableValue + | undefined; + /** A boolean denoting whether a Failure Handler ThreadRun properly handled the Failure. */ wasProperlyHandled: boolean; } @@ -1262,7 +1402,7 @@ export type Exact = P extends Builtin ? P function toTimestamp(dateStr: string): Timestamp { const date = new globalThis.Date(dateStr); - const seconds = date.getTime() / 1_000; + const seconds = Math.trunc(date.getTime() / 1_000); const nanos = (date.getTime() % 1_000) * 1_000_000; return { seconds, nanos }; } diff --git a/dashboard/apps/web/littlehorse-public-api/object_id.ts b/dashboard/apps/web/littlehorse-public-api/object_id.ts index 724c0c389..5237de16c 100644 --- a/dashboard/apps/web/littlehorse-public-api/object_id.ts +++ b/dashboard/apps/web/littlehorse-public-api/object_id.ts @@ -10,79 +10,183 @@ import { Timestamp } from "./google/protobuf/timestamp"; export const protobufPackage = "littlehorse"; +/** The ID of a WfSpec. */ export interface WfSpecId { + /** Name of the WfSpec. */ name: string; + /** + * Major Version of a WfSpec. + * + * Note that WfSpec's are versioned. Creating a new WfSpec with the same name + * and no breaking changes to the public Variables API results in a new WfSpec + * being created with the same MajorVersion and a new revision. Creating a + * WfSpec with a breaking change to the public Variables API results in a + * new WfSpec being created with the same name, an incremented major_version, + * and revision = 0. + */ majorVersion: number; + /** + * Revision of a WfSpec. + * + * Note that WfSpec's are versioned. Creating a new WfSpec with the same name + * and no breaking changes to the public Variables API results in a new WfSpec + * being created with the same MajorVersion and a new revision. Creating a + * WfSpec with a breaking change to the public Variables API results in a + * new WfSpec being created with the same name, an incremented major_version, + * and revision = 0. + */ revision: number; } +/** ID for a TaskDef. */ export interface TaskDefId { + /** TaskDef's are uniquely identified by their name. */ name: string; } +/** ID for ExternalEventDef */ export interface ExternalEventDefId { + /** ExternalEventDef's are uniquedly identified by their name. */ name: string; } +/** ID for a UserTaskDef */ export interface UserTaskDefId { + /** The name of a UserTaskDef */ name: string; + /** Note that UserTaskDef's use simple versioning. */ version: number; } +/** ID for a TaskWorkerGroup. */ export interface TaskWorkerGroupId { + /** TaskWorkerGroups are uniquely identified by their TaskDefId. */ taskDefId: TaskDefId | undefined; } +/** Id for a Variable. */ export interface VariableId { - wfRunId: WfRunId | undefined; + /** + * WfRunId for the variable. Note that every Variable is associated with + * a WfRun. + */ + wfRunId: + | WfRunId + | undefined; + /** + * Each Variable is owned by a specific ThreadRun inside the WfRun it belongs + * to. This is that ThreadRun's number. + */ threadRunNumber: number; + /** The name of the variable. */ name: string; } +/** ID for an ExternalEvent. */ export interface ExternalEventId { - wfRunId: WfRunId | undefined; - externalEventDefId: ExternalEventDefId | undefined; + /** + * WfRunId for the ExternalEvent. Note that every ExternalEvent is associated + * with a WfRun. + */ + wfRunId: + | WfRunId + | undefined; + /** The ExternalEventDef for this ExternalEvent. */ + externalEventDefId: + | ExternalEventDefId + | undefined; + /** + * A unique guid allowing for distinguishing this ExternalEvent from other events + * of the same ExternalEventDef and WfRun. + */ guid: string; } +/** ID for a WfRun */ export interface WfRunId { + /** The ID for this WfRun instance. */ id: string; + /** A WfRun may have a parent WfRun. If so, this field is set to the parent's ID. */ parentWfRunId?: WfRunId | undefined; } +/** ID for a NodeRun. */ export interface NodeRunId { - wfRunId: WfRunId | undefined; + /** + * ID of the WfRun for this NodeRun. Note that every NodeRun is associated with + * a WfRun. + */ + wfRunId: + | WfRunId + | undefined; + /** ThreadRun of this NodeRun. Note that each NodeRun belongs to a ThreadRun. */ threadRunNumber: number; + /** Position of this NodeRun within its ThreadRun. */ position: number; } +/** ID for a TaskRun. */ export interface TaskRunId { - wfRunId: WfRunId | undefined; + /** + * WfRunId for this TaskRun. Note that every TaskRun is associated with + * a WfRun. + */ + wfRunId: + | WfRunId + | undefined; + /** Unique identifier for this TaskRun. Unique among the WfRun. */ taskGuid: string; } +/** ID for a UserTaskRun */ export interface UserTaskRunId { - wfRunId: WfRunId | undefined; + /** + * WfRunId for this UserTaskRun. Note that every UserTaskRun is associated + * with a WfRun. + */ + wfRunId: + | WfRunId + | undefined; + /** Unique identifier for this UserTaskRun. */ userTaskGuid: string; } +/** ID for a specific window of TaskDef metrics. */ export interface TaskDefMetricsId { - windowStart: string | undefined; + /** The timestamp at which this metrics window starts. */ + windowStart: + | string + | undefined; + /** The length of this window. */ windowType: MetricsWindowLength; + /** The TaskDefId that this metrics window reports on. */ taskDefId: TaskDefId | undefined; } +/** ID for a specific window of WfSpec metrics. */ export interface WfSpecMetricsId { - windowStart: string | undefined; + /** The timestamp at which this metrics window starts. */ + windowStart: + | string + | undefined; + /** The length of this window. */ windowType: MetricsWindowLength; + /** The WfSpecId that this metrics window reports on. */ wfSpecId: WfSpecId | undefined; } +/** ID for a Principal. */ export interface PrincipalId { + /** + * The id of this principal. In OAuth, this is the OAuth Client ID (for + * machine principals) or the OAuth User Id (for human principals). + */ id: string; } +/** ID for a Tenant. */ export interface TenantId { + /** The Tenant ID. */ id: string; } @@ -1241,7 +1345,7 @@ export type Exact = P extends Builtin ? P function toTimestamp(dateStr: string): Timestamp { const date = new globalThis.Date(dateStr); - const seconds = date.getTime() / 1_000; + const seconds = Math.trunc(date.getTime() / 1_000); const nanos = (date.getTime() % 1_000) * 1_000_000; return { seconds, nanos }; } diff --git a/dashboard/apps/web/littlehorse-public-api/service.ts b/dashboard/apps/web/littlehorse-public-api/service.ts index 4e6979ae8..5ea4d8549 100644 --- a/dashboard/apps/web/littlehorse-public-api/service.ts +++ b/dashboard/apps/web/littlehorse-public-api/service.ts @@ -204,7 +204,13 @@ export interface PutExternalEventDefRequest { name: string; /** * Policy to determine how long an ExternalEvent is retained after creation if it - * is not yet claimed by a WfRun. + * is not yet claimed by a WfRun. Note that once a WfRun has been matched with the + * ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted. + * If not set, then ExternalEvent's are not deleted if they are not matched with + * a WfRun. + * + * A future version of LittleHorse will allow changing the retention_policy, which + * will trigger a cleanup of old `ExternalEvent`s. */ retentionPolicy: ExternalEventRetentionPolicy | undefined; } @@ -8638,7 +8644,7 @@ export type Exact = P extends Builtin ? P function toTimestamp(dateStr: string): Timestamp { const date = new globalThis.Date(dateStr); - const seconds = date.getTime() / 1_000; + const seconds = Math.trunc(date.getTime() / 1_000); const nanos = (date.getTime() % 1_000) * 1_000_000; return { seconds, nanos }; } diff --git a/dashboard/apps/web/littlehorse-public-api/task_def.ts b/dashboard/apps/web/littlehorse-public-api/task_def.ts index 69feae403..c78f9318f 100644 --- a/dashboard/apps/web/littlehorse-public-api/task_def.ts +++ b/dashboard/apps/web/littlehorse-public-api/task_def.ts @@ -6,9 +6,15 @@ import { TaskDefId } from "./object_id"; export const protobufPackage = "littlehorse"; +/** A TaskDef defines a blueprint for a TaskRun that can be dispatched to Task Workers. */ export interface TaskDef { - id: TaskDefId | undefined; + /** The ID of this TaskDef. */ + id: + | TaskDefId + | undefined; + /** The input variables required to execute this TaskDef. */ inputVars: VariableDef[]; + /** The time at which this TaskDef was created. */ createdAt: string | undefined; } @@ -117,7 +123,7 @@ export type Exact = P extends Builtin ? P function toTimestamp(dateStr: string): Timestamp { const date = new globalThis.Date(dateStr); - const seconds = date.getTime() / 1_000; + const seconds = Math.trunc(date.getTime() / 1_000); const nanos = (date.getTime() % 1_000) * 1_000_000; return { seconds, nanos }; } diff --git a/dashboard/apps/web/littlehorse-public-api/task_run.ts b/dashboard/apps/web/littlehorse-public-api/task_run.ts index a8c7601c7..438d0d6df 100644 --- a/dashboard/apps/web/littlehorse-public-api/task_run.ts +++ b/dashboard/apps/web/littlehorse-public-api/task_run.ts @@ -17,53 +17,139 @@ import { VariableValue } from "./variable"; export const protobufPackage = "littlehorse"; +/** A TaskRun resents a single instance of a TaskDef being executed. */ export interface TaskRun { - id: TaskRunId | undefined; - taskDefId: TaskDefId | undefined; + /** The ID of the TaskRun. Note that the TaskRunId contains the WfRunId. */ + id: + | TaskRunId + | undefined; + /** The ID of the TaskDef being executed. */ + taskDefId: + | TaskDefId + | undefined; + /** + * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of + * the TaskRun being put on a Task Queue to be executed by the Task Workers. + */ attempts: TaskAttempt[]; + /** The maximum number of attempts that may be scheduled for this TaskRun. */ maxAttempts: number; + /** + * The input variables to pass into this TaskRun. Note that this is a list and not + * a map, because ordering matters. Depending on the language implementation, not + * every LittleHorse Task Worker SDK has the ability to determine the names of the + * variables from the method signature, so we provide both names and ordering. + */ inputVariables: VarNameAndVal[]; - source: TaskRunSource | undefined; - scheduledAt: string | undefined; + /** + * The source (in the WfRun) that caused this TaskRun to be created. Currently, this + * can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such + * as a task used to send reminders). + */ + source: + | TaskRunSource + | undefined; + /** When the TaskRun was scheduled. */ + scheduledAt: + | string + | undefined; + /** The status of the TaskRun. */ status: TaskStatus; + /** The timeout before LH considers a TaskAttempt to be timed out. */ timeoutSeconds: number; } +/** A key-value pair of variable name and value. */ export interface VarNameAndVal { + /** The variable name. */ varName: string; + /** The value of the variable for this TaskRun. */ value: VariableValue | undefined; } +/** A single time that a TaskRun was scheduled for execution on a Task Queue. */ export interface TaskAttempt { - logOutput?: VariableValue | undefined; - scheduleTime?: string | undefined; - startTime?: string | undefined; - endTime?: string | undefined; + /** + * Optional information provided by the Task Worker SDK for debugging. Usually, if set + * it contains a stacktrace or it contains information logged via `WorkerContext#log()`. + */ + logOutput?: + | VariableValue + | undefined; + /** The time the TaskAttempt was scheduled on the Task Queue. */ + scheduleTime?: + | string + | undefined; + /** The time the TaskAttempt was pulled off the queue and sent to a TaskWorker. */ + startTime?: + | string + | undefined; + /** + * The time the TaskAttempt was finished (either completed, reported as failed, or + * timed out) + */ + endTime?: + | string + | undefined; + /** EXPERIMENTAL: the ID of the Task Worker who executed this TaskRun. */ taskWorkerId: string; - taskWorkerVersion?: string | undefined; + /** The version of the Task Worker that executed the TaskAttempt. */ + taskWorkerVersion?: + | string + | undefined; + /** The status of this TaskAttempt. */ status: TaskStatus; - output?: VariableValue | undefined; - error?: LHTaskError | undefined; + /** Denotes the Task Function executed properly and returned an output. */ + output?: + | VariableValue + | undefined; + /** An unexpected technical error was encountered. May or may not be retriable. */ + error?: + | LHTaskError + | undefined; + /** The Task Function encountered a business problem and threw a technical exception. */ exception?: LHTaskException | undefined; } +/** The source of a TaskRun; i.e. why it was scheduled. */ export interface TaskRunSource { - taskNode?: TaskNodeReference | undefined; - userTaskTrigger?: UserTaskTriggerReference | undefined; + /** Reference to a NodeRun of type TASK which scheduled this TaskRun. */ + taskNode?: + | TaskNodeReference + | undefined; + /** Reference to the specific UserTaskRun trigger action which scheduled this TaskRun */ + userTaskTrigger?: + | UserTaskTriggerReference + | undefined; + /** + * The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so + * that the WorkerContext can know this information. + */ wfSpecId?: WfSpecId | undefined; } +/** Reference to a NodeRun of type TASK which caused a TaskRun to be scheduled. */ export interface TaskNodeReference { + /** The ID of the NodeRun which caused this TASK to be scheduled. */ nodeRunId: NodeRunId | undefined; } +/** Message denoting a TaskRun failed for technical reasons. */ export interface LHTaskError { + /** The technical error code. */ type: LHErrorType; + /** Human readable message for debugging. */ message: string; } +/** + * Message denoting a TaskRun's execution signaled that something went wrong in the + * business process, throwing a littlehorse 'EXCEPTION'. + */ export interface LHTaskException { + /** The user-defined Failure name, for example, "credit-card-declined" */ name: string; + /** Human readadble description of the failure. */ message: string; } @@ -871,7 +957,7 @@ export type Exact = P extends Builtin ? P function toTimestamp(dateStr: string): Timestamp { const date = new globalThis.Date(dateStr); - const seconds = date.getTime() / 1_000; + const seconds = Math.trunc(date.getTime() / 1_000); const nanos = (date.getTime() % 1_000) * 1_000_000; return { seconds, nanos }; } diff --git a/dashboard/apps/web/littlehorse-public-api/user_tasks.ts b/dashboard/apps/web/littlehorse-public-api/user_tasks.ts index 60346777d..8a50ecf2a 100644 --- a/dashboard/apps/web/littlehorse-public-api/user_tasks.ts +++ b/dashboard/apps/web/littlehorse-public-api/user_tasks.ts @@ -1666,7 +1666,7 @@ export type Exact = P extends Builtin ? P function toTimestamp(dateStr: string): Timestamp { const date = new globalThis.Date(dateStr); - const seconds = date.getTime() / 1_000; + const seconds = Math.trunc(date.getTime() / 1_000); const nanos = (date.getTime() % 1_000) * 1_000_000; return { seconds, nanos }; } diff --git a/dashboard/apps/web/littlehorse-public-api/variable.ts b/dashboard/apps/web/littlehorse-public-api/variable.ts index cbc667a6f..592ebcbb6 100644 --- a/dashboard/apps/web/littlehorse-public-api/variable.ts +++ b/dashboard/apps/web/littlehorse-public-api/variable.ts @@ -6,20 +6,58 @@ import { VariableId, WfSpecId } from "./object_id"; export const protobufPackage = "littlehorse"; +/** + * VariableValue is a structure containing a value in LittleHorse. It can be + * used to pass input variables into a WfRun/ThreadRun/TaskRun/etc, as output + * from a TaskRun, as the value of a WfRun's Variable, etc. + */ export interface VariableValue { - jsonObj?: string | undefined; - jsonArr?: string | undefined; - double?: number | undefined; - bool?: boolean | undefined; - str?: string | undefined; - int?: number | undefined; + /** A String representing a serialized json object. */ + jsonObj?: + | string + | undefined; + /** A String representing a serialized json list. */ + jsonArr?: + | string + | undefined; + /** A 64-bit floating point number. */ + double?: + | number + | undefined; + /** A boolean. */ + bool?: + | boolean + | undefined; + /** A string. */ + str?: + | string + | undefined; + /** A 64-bit integer. */ + int?: + | number + | undefined; + /** An arbitrary String of bytes. */ bytes?: Uint8Array | undefined; } +/** A Variable is an instance of a variable assigned to a WfRun. */ export interface Variable { - id: VariableId | undefined; - value: VariableValue | undefined; - createdAt: string | undefined; + /** + * ID of this Variable. Note that the VariableId contains the relevant + * WfRunId inside it, the threadRunNumber, and the name of the Variabe. + */ + id: + | VariableId + | undefined; + /** The value of this Variable. */ + value: + | VariableValue + | undefined; + /** When the Variable was created. */ + createdAt: + | string + | undefined; + /** The ID of the WfSpec that this Variable belongs to. */ wfSpecId: WfSpecId | undefined; } @@ -327,7 +365,7 @@ export type Exact = P extends Builtin ? P function toTimestamp(dateStr: string): Timestamp { const date = new globalThis.Date(dateStr); - const seconds = date.getTime() / 1_000; + const seconds = Math.trunc(date.getTime() / 1_000); const nanos = (date.getTime() % 1_000) * 1_000_000; return { seconds, nanos }; } diff --git a/dashboard/apps/web/littlehorse-public-api/wf_run.ts b/dashboard/apps/web/littlehorse-public-api/wf_run.ts index 9d76f0fff..f554d40e4 100644 --- a/dashboard/apps/web/littlehorse-public-api/wf_run.ts +++ b/dashboard/apps/web/littlehorse-public-api/wf_run.ts @@ -6,10 +6,18 @@ import { ExternalEventId, WfRunId, WfSpecId } from "./object_id"; export const protobufPackage = "littlehorse"; +/** The type of a ThreadRUn. */ export enum ThreadType { + /** ENTRYPOINT - The ENTRYPOINT ThreadRun. Exactly one per WfRun. Always has number == 0. */ ENTRYPOINT = "ENTRYPOINT", + /** + * CHILD - A ThreadRun explicitly created by another ThreadRun via a START_THREAD or START_MULTIPLE_THREADS + * NodeRun. + */ CHILD = "CHILD", + /** INTERRUPT - A ThreadRun that was created to handle an Interrupt. */ INTERRUPT = "INTERRUPT", + /** FAILURE_HANDLER - A ThreadRun that was created to handle a Failure. */ FAILURE_HANDLER = "FAILURE_HANDLER", UNRECOGNIZED = "UNRECOGNIZED", } @@ -67,89 +75,240 @@ export function threadTypeToNumber(object: ThreadType): number { } } +/** A WfRun is a running instance of a WfSpec. */ export interface WfRun { - id: WfRunId | undefined; - wfSpecId: WfSpecId | undefined; + /** The ID of the WfRun. */ + id: + | WfRunId + | undefined; + /** The ID of the WfSpec that this WfRun belongs to. */ + wfSpecId: + | WfSpecId + | undefined; + /** + * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the + * old WfSpecId to this list for historical auditing and debugging purposes. + */ oldWfSpecVersions: WfSpecId[]; + /** The status of this WfRun. */ status: LHStatus; /** + * The ID number of the greatest ThreadRUn in this WfRun. The total number of ThreadRuns + * is given by greatest_thread_run_number + 1. + * * Introduced now since with ThreadRun-level retention, we can't rely upon - * thread_runs.size() to determine the number of ThreadRuns. + * thread_runs.size() to determine the number of ThreadRuns, as a ThreadRun is removed + * from the thread_runs list once its retention period expires. */ greatestThreadrunNumber: number; - startTime: string | undefined; - endTime?: string | undefined; + /** The time the WfRun was started. */ + startTime: + | string + | undefined; + /** The time the WfRun failed or completed. */ + endTime?: + | string + | undefined; + /** + * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods + * have not yet expired. + */ threadRuns: ThreadRun[]; + /** + * A list of Interrupt events that will fire once their appropriate ThreadRun's finish + * halting. + */ pendingInterrupts: PendingInterrupt[]; + /** + * A list of pending failure handlers which will fire once their appropriate ThreadRun's + * finish halting. + */ pendingFailures: PendingFailureHandler[]; } +/** A ThreadRun is a running thread of execution within a WfRun. */ export interface ThreadRun { - wfSpecId: WfSpecId | undefined; + /** + * The current WfSpecId of this ThreadRun. This must be set explicitly because + * during a WfSpec Version Migration, it is possible for different ThreadSpec's to + * have different WfSpec versions. + */ + wfSpecId: + | WfSpecId + | undefined; + /** + * The number of the ThreadRun. This is an auto-incremented integer corresponding to + * the chronological ordering of when the ThreadRun's were created. If you have not + * configured any retention policy for the ThreadRun's (i.e. never clean them up), then + * this also corresponds to the position of the ThreadRun in the WfRun's `thread_runs` + * list. + */ number: number; + /** The status of the ThreadRun. */ status: LHStatus; + /** The name of the ThreadSpec being run. */ threadSpecName: string; - startTime: string | undefined; - endTime?: string | undefined; - errorMessage?: string | undefined; + /** The time the ThreadRun was started. */ + startTime: + | string + | undefined; + /** The time the ThreadRun was completed or failed. Unset if still active. */ + endTime?: + | string + | undefined; + /** Human-readable error message detailing what went wrong in the case of a failure. */ + errorMessage?: + | string + | undefined; + /** List of thread_run_number's for all child thread_runs. */ childThreadIds: number[]; - parentThreadId?: number | undefined; + /** Set for every ThreadRun except the ENTRYPOINT. This is the id of the parent thread. */ + parentThreadId?: + | number + | undefined; + /** + * If the ThreadRun is HALTED, this contains a list of every reason for which the + * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list), + * then the ThreadRun will return to the RUNNING state. + */ haltReasons: ThreadHaltReason[]; - interruptTriggerId?: ExternalEventId | undefined; - failureBeingHandled?: FailureBeingHandled | undefined; + /** + * If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the + * ExternalEvent that caused the Interrupt. + */ + interruptTriggerId?: + | ExternalEventId + | undefined; + /** + * If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure + * that is being handled by this ThreadRun. + */ + failureBeingHandled?: + | FailureBeingHandled + | undefined; + /** + * This is the current `position` of the current NodeRun being run. This is an + * auto-incremented field that gets incremented every time we run a new NodeRun. + */ currentNodePosition: number; + /** + * List of every child ThreadRun which both a) failed, and b) was properly handled by a + * Failure Handler. + * + * This is important because at the EXIT node, if a Child ThreadRun was discovered to have + * failed, then this ThreadRun (the parent) also fails with the same failure as the child. + * If, however, a Failure Handler had previously "handled" the Child Failure, that ThreadRun's + * number is appended to this list, and then the EXIT node ignores that ThreadRun. + */ handledFailedChildren: number[]; + /** The Type of this ThreadRun. */ type: ThreadType; } +/** Points to the Failure that is currently being handled in the ThreadRun. */ export interface FailureBeingHandled { + /** The thread run number. */ threadRunNumber: number; + /** The position of the NodeRun causing the failure. */ nodeRunPosition: number; + /** The number of the failure. */ failureNumber: number; } +/** + * Represents an ExternalEvent that has a registered Interrupt Handler for it + * and which is pending to be sent to the relevant ThreadRun's. + */ export interface PendingInterrupt { - externalEventId: ExternalEventId | undefined; + /** The ID of the ExternalEvent triggering the Interrupt. */ + externalEventId: + | ExternalEventId + | undefined; + /** The name of the ThreadSpec to run to handle the Interrupt. */ handlerSpecName: string; + /** + * The ID of the ThreadRun to interrupt. Must wait for this ThreadRun to be + * HALTED before running the Interrupt Handler. + */ interruptedThreadId: number; } +/** Represents a Failure Handler that is pending to be run. */ export interface PendingFailureHandler { + /** The ThreadRun that failed. */ failedThreadRun: number; + /** The name of the ThreadSpec to run to handle the failure. */ handlerSpecName: string; } +/** + * A Halt Reason denoting that a ThreadRun is halted while waiting for an Interrupt handler + * to be run. + */ export interface PendingInterruptHaltReason { + /** The ExternalEventId that caused the Interrupt. */ externalEventId: ExternalEventId | undefined; } +/** + * A Halt Reason denoting that a ThreadRun is halted while a Failure Handler is *enqueued* to be + * run. + */ export interface PendingFailureHandlerHaltReason { + /** The position of the NodeRun which threw the failure. */ nodeRunPosition: number; } +/** A Halt Reason denoting that a ThreadRun is halted while a Failure Handler is being run. */ export interface HandlingFailureHaltReason { + /** The ID of the Failure Handler ThreadRun. */ handlerThreadId: number; } +/** A Halt Reason denoting that a ThreadRun is halted because its parent is also HALTED. */ export interface ParentHalted { + /** The ID of the halted parent. */ parentThreadId: number; } +/** + * A Halt Reason denoting that a ThreadRun is halted because it is waiting for the + * interrupt handler threadRun to run. + */ export interface Interrupted { + /** The ID of the Interrupt Handler ThreadRun. */ interruptThreadId: number; } +/** A Halt Reason denoting that a ThreadRun was halted manually, via the `rpc StopWfRun` request. */ export interface ManualHalt { /** Nothing to store. */ meaningOfLife: boolean; } +/** Denotes a reason why a ThreadRun is halted. See `ThreadRun.halt_reasons` for context. */ export interface ThreadHaltReason { - parentHalted?: ParentHalted | undefined; - interrupted?: Interrupted | undefined; - pendingInterrupt?: PendingInterruptHaltReason | undefined; - pendingFailure?: PendingFailureHandlerHaltReason | undefined; - handlingFailure?: HandlingFailureHaltReason | undefined; + /** Parent threadRun halted. */ + parentHalted?: + | ParentHalted + | undefined; + /** Handling an Interrupt. */ + interrupted?: + | Interrupted + | undefined; + /** Waiting to handle Interrupt. */ + pendingInterrupt?: + | PendingInterruptHaltReason + | undefined; + /** Waiting to handle a failure. */ + pendingFailure?: + | PendingFailureHandlerHaltReason + | undefined; + /** Handling a failure. */ + handlingFailure?: + | HandlingFailureHaltReason + | undefined; + /** Manually stopped the WfRun. */ manualHalt?: ManualHalt | undefined; } @@ -1470,7 +1629,7 @@ export type Exact = P extends Builtin ? P function toTimestamp(dateStr: string): Timestamp { const date = new globalThis.Date(dateStr); - const seconds = date.getTime() / 1_000; + const seconds = Math.trunc(date.getTime() / 1_000); const nanos = (date.getTime() % 1_000) * 1_000_000; return { seconds, nanos }; } diff --git a/dashboard/apps/web/littlehorse-public-api/wf_spec.ts b/dashboard/apps/web/littlehorse-public-api/wf_spec.ts index 0fcd5635e..a496a875b 100644 --- a/dashboard/apps/web/littlehorse-public-api/wf_spec.ts +++ b/dashboard/apps/web/littlehorse-public-api/wf_spec.ts @@ -3371,7 +3371,7 @@ export type Exact = P extends Builtin ? P function toTimestamp(dateStr: string): Timestamp { const date = new globalThis.Date(dateStr); - const seconds = date.getTime() / 1_000; + const seconds = Math.trunc(date.getTime() / 1_000); const nanos = (date.getTime() % 1_000) * 1_000_000; return { seconds, nanos }; } diff --git a/e2e-tests/src/main/java/io/littlehorse/tests/cases/workflow/AUExceptionHandlerTask.java b/e2e-tests/src/main/java/io/littlehorse/tests/cases/workflow/AUExceptionHandlerTask.java index 643a67213..d03c53720 100644 --- a/e2e-tests/src/main/java/io/littlehorse/tests/cases/workflow/AUExceptionHandlerTask.java +++ b/e2e-tests/src/main/java/io/littlehorse/tests/cases/workflow/AUExceptionHandlerTask.java @@ -39,7 +39,7 @@ public List getTaskWorkerObjects() { public List launchAndCheckWorkflows(LittleHorseBlockingStub client) throws TestFailure, InterruptedException, IOException { String wfRunId = runWf(client); - Thread.sleep(300); + Thread.sleep(500); assertStatus(client, wfRunId, LHStatus.COMPLETED); // Check that the handler ran. diff --git a/schemas/common_wfspec.proto b/schemas/common_wfspec.proto index d0a19fa73..b5bd08e08 100644 --- a/schemas/common_wfspec.proto +++ b/schemas/common_wfspec.proto @@ -68,34 +68,89 @@ enum VariableMutationType { REMOVE_KEY = 8; } +// A VariableMutation defines a modification made to one of a ThreadRun's variables. +// The LHS determines the variable that is modified; the operation determines how +// it is modified, and the RHS is the input to the operation. +// +// Day-to-day users of LittleHorse generally don't interact with this structure unless +// they are writing their own WfSpec SDK. message VariableMutation { + // Specifies to use the output of a NodeRun as the RHS. message NodeOutputSource { + // Use this specific field from a JSON output optional string jsonpath = 10; } + + // The name of the variable to mutate string lhs_name = 1; + + // For JSON_ARR and JSON_OBJ variables, this allows you to optionally mutate + // a specific sub-field of the variable. optional string lhs_json_path = 2; + + // Defines the operation that we are executing. VariableMutationType operation = 3; + + // The RHS of the mutation; i.e. what is operated _with_. oneof rhs_value { + // Set the source_variable as the RHS to use another variable from the workflow to + // as the RHS/ VariableAssignment source_variable = 4; + + // Use a literal value as the RHS. VariableValue literal_value = 5; + + // Use the output of the current node as the RHS. NodeOutputSource node_output = 6; } } +// Declares a Variable. message VariableDef { + // The Type of the variable. VariableType type = 1; + + // The name of the variable. string name = 2; + + // Optional default value if the variable isn't set; for example, in a ThreadRun + // if you start a ThreadRun or WfRun without passing a variable in, then this is + // used. optional VariableValue default_value = 3; } +// Operator for comparing two values to create a boolean expression. enum Comparator { + // Equivalent to `<`. Only valid for primitive types (no JSON_OBJ or JSON_ARR). LESS_THAN = 0; + + // Equivalent to `>`. Only valid for primitive types (no JSON_OBJ or JSON_ARR). GREATER_THAN = 1; + + // Equivalent to `<=`. Only valid for primitive types (no JSON_OBJ or JSON_ARR). LESS_THAN_EQ = 2; + + // Equivalent to `>=`. Only valid for primitive types (no JSON_OBJ or JSON_ARR). GREATER_THAN_EQ = 3; + + // This is valid for any variable type, and is similar to .equals() in Java. + // + // One note: if the RHS is a different type from the LHS, then LittleHorse will + // try to cast the RHS to the same type as the LHS. If the cast fails, then the + // ThreadRun fails with a VAR_SUB_ERROR. EQUALS = 4; + + // This is the inverse of `EQUALS` NOT_EQUALS = 5; + + // Only valid if the RHS is a JSON_OBJ or JSON_ARR. Valid for any type on the LHS. + // + // For the JSON_OBJ type, this returns true if the LHS is equal to a *KEY* in the + // RHS. For the JSON_ARR type, it returns true if one of the elements of the RHS + // is equal to the LHS. IN = 6; + + // The inverse of IN. NOT_IN = 7; } @@ -109,19 +164,31 @@ enum Comparator { // - Upon creation of the UserTaskRun // - Upon rescheduling the UserTaskRun message UTActionTrigger { + // A UserTaskAction that causes a UserTaskRun to be CANCELLED when it fires. message UTACancel { } + // A UserTaskAction that causes a TaskRun to be scheduled when it fires. message UTATask { + // The specification of the Task to schedule. TaskNode task = 1; + + // EXPERIMENTAL: Any variables in the ThreadRun which we should mutate. repeated VariableMutation mutations = 2; } + // A UserTaskAction that causes a UserTaskRun to be reassigned when it fires. message UTAReassign { + // A variable assignment that resolves to a STR representing the new user_id. If + // not set, the user_id of the UserTaskRun will be un-set. optional VariableAssignment user_id = 1; + + // A variable assignment that resolves to a STR representing the new user_group. If + // not set, the user_group of the UserTaskRun will be un-set. optional VariableAssignment user_group = 2; } + // The action that is scheduled by the hook oneof action { UTATask task = 1; UTACancel cancel = 2; @@ -129,18 +196,42 @@ message UTActionTrigger { // later on, might enable scheduling entire ThreadRuns } + // The Action is triggered some time after the Hook matures. The delay is controlled + // by this field. + VariableAssignment delay_seconds = 5; + + // Enumerates the different lifecycle hooks that can cause the timer to start running. enum UTHook { + // The hook should be scheduled `delay_seconds` after the UserTaskRun is created. This + // hook only causes the action to be scheduled once. ON_ARRIVAL = 0; + + // The hook should be scheduled `delay_seconds` after the ownership of the UserTaskRun + // changes. This hook causes the Action to be scheduled one or more times. The first + // time is scheduled when the UserTaskRun is created, since we treat the change from + // "UserTaskRun is nonexistent" to "UserTaskRun is owned by a userId or userGroup" as + // a change in ownership. ON_TASK_ASSIGNED = 1; } - //Action's delay - VariableAssignment delay_seconds = 5; + + // The hook on which this UserTaskAction is scheduled. UTHook hook = 6; } +// Defines a TaskRun execution. Used in a Node and also in the UserTask Trigger Actions. message TaskNode { + // The type of TaskRun to schedule. TaskDefId task_def_id = 1; + + // How long until LittleHorse determines that the Task Worker had a technical ERROR if + // the worker does not yet reply to the Server. int32 timeout_seconds = 2; + + // EXPERIMENTAL: How many times we should retry on retryable ERROR's. + // Please note that this API may change before version 1.0.0, as we are going to + // add significant functionality including backoff policies. int32 retries = 3; + + // Input variables into the TaskDef. repeated VariableAssignment variables = 4; } diff --git a/schemas/external_event.proto b/schemas/external_event.proto index 647e5ffcd..cd2eb8b17 100644 --- a/schemas/external_event.proto +++ b/schemas/external_event.proto @@ -11,24 +11,65 @@ option java_multiple_files = true; option java_package = "io.littlehorse.sdk.common.proto"; option csharp_namespace = "LittleHorse.Common.Proto"; +// An ExternalEvent represents A Thing That Happened outside the context of a WfRun. +// Generally, an ExternalEvent is used to represent a document getting signed, an incident +// being resolved, an order being fulfilled, etc. +// +// ExternalEvent's are created via the 'rpc PutExternalEvent' +// +// For more context on ExternalEvents, check our documentation here: +// https://littlehorse.dev/docs/concepts/external-events message ExternalEvent { + // The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId, + // and a unique guid which can be used for idempotency of the `PutExternalEvent` + // rpc call. ExternalEventId id = 1; + + // The time the ExternalEvent was registered with LittleHorse. google.protobuf.Timestamp created_at = 2; + + // The payload of this ExternalEvent. VariableValue content = 3; + + // If the ExternalEvent was claimed by a specific ThreadRun (via Interrupt or + // EXTERNAL_EVENT Node), this is set to the number of the relevant ThreadRun. optional int32 thread_run_number = 4; + + // If the ExternalEvent was claimed by a specific ThreadRun (via EXTERNAL_EVENT + // Node; note that in the case of an Interrupt the node_run_position will never + // be set), this is set to the number of the relevant NodeRun. optional int32 node_run_position = 5; + + // Whether the ExternalEvent has been claimed by a WfRun. bool claimed = 6; } -// ExternalEventDef +// The ExternalEventDef defines the blueprint for an ExternalEvent. message ExternalEventDef { + // The name of the ExternalEventDef. string name = 1; + + // When the ExternalEventDef was created. google.protobuf.Timestamp created_at = 2; + + // The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the + // ExternalEvent **only before** it is matched with a WfRun. ExternalEventRetentionPolicy retention_policy = 3; } +// Policy to determine how long an ExternalEvent is retained after creation if it +// is not yet claimed by a WfRun. Note that once a WfRun has been matched with the +// ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted. +// If not set, then ExternalEvent's are not deleted if they are not matched with +// a WfRun. +// +// A future version of LittleHorse will allow changing the retention_policy, which +// will trigger a cleanup of old `ExternalEvent`s. message ExternalEventRetentionPolicy { + // The retention policy choice. If not set, then the ExternalEvent is not cleaned up + // until matched with a WfRun (which may mean it is never cleaned up). oneof ext_evt_gc_policy { + // Delete such an ExternalEvent X seconds after it has been registered if it // has not yet been claimed by a WfRun. int64 seconds_after_put = 1; diff --git a/schemas/node_run.proto b/schemas/node_run.proto index 230a64545..b62bb797a 100644 --- a/schemas/node_run.proto +++ b/schemas/node_run.proto @@ -12,82 +12,182 @@ option java_multiple_files = true; option java_package = "io.littlehorse.sdk.common.proto"; option csharp_namespace = "LittleHorse.Common.Proto"; +// A NodeRun is a running instance of a Node in a ThreadRun. Note that a NodeRun +// is a Getable object, meaning it can be retried from the LittleHorse grpc API. message NodeRun { + // The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the + // ThreadRun's number, and the position of the NodeRun within that ThreadRun. NodeRunId id = 1; + // The ID of the WfSpec that this NodeRun is from. This is not _always_ the same + // as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration + // feature. WfSpecId wf_spec_id = 4; + + // A list of all ThreadRun's that ran to handle a failure thrown by this NodeRun. repeated int32 failure_handler_ids = 5; + + // The status of this NodeRun. LHStatus status = 6; + // The time the ThreadRun arrived at this NodeRun. google.protobuf.Timestamp arrival_time = 7; + + // The time the NodeRun was terminated (failed or completed). optional google.protobuf.Timestamp end_time = 8; + + // The name of the ThreadSpec to which this NodeRun belongs. string thread_spec_name = 9; + + // The name of the Node in the ThreadSpec that this NodeRun belongs to. string node_name = 10; + // A human-readable error message intended to help developers diagnose WfSpec + // problems. optional string error_message = 11; + + // A list of Failures thrown by this NodeRun. repeated Failure failures = 12; + // There are many types of Nodes in a WfSpec; therefore, we have many different types + // of NodeRun. Each NodeRun can only be one. oneof node_type { + // Denotes a TASK node, which runs a TaskRun. TaskNodeRun task = 13; + + // An EXTERNAL_EVENT node blocks until an ExternalEvent arrives. ExternalEventRun external_event = 14; + + // An ENTRYPOINT node is the first thing that runs in a ThreadRun. EntrypointRun entrypoint = 15; + + // An EXIT node completes a ThreadRun. ExitRun exit = 16; + + // A START_THREAD node starts a child ThreadRun. StartThreadRun start_thread = 17; + + // A WAIT_THREADS node waits for one or more child ThreadRun's to complete. WaitForThreadsRun wait_threads = 18; + + // A SLEEP node makes the ThreadRun block for a certain amount of time. SleepNodeRun sleep = 19; + + // A USER_TASK node waits until a human executes some work and reports the result. UserTaskNodeRun user_task = 20; + + // A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a + // child ThreadRun for each element in the list. StartMultipleThreadsRun start_multiple_threads = 21; } } +// The sub-node structure for a TASK NodeRun. message TaskNodeRun { + // The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived + // at this TASK Node, then the task_run_id will be unset. optional TaskRunId task_run_id = 1; } +// The sub-node structure for a USER_TASK NodeRun. message UserTaskNodeRun { + // The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived + // at this USER_TASK node, then the user_task_run_id will be unset. optional UserTaskRunId user_task_run_id = 1; } +// The sub-node structure for an ENTRYPOINT NodeRun. Currently Empty. message EntrypointRun { } +// The sub-node structure for an EXIT NodeRun. Currently Empty, will contain info +// about ThreadRun Outputs once those are added in the future. message ExitRun { -} // Later will have info once we add threads +} +// The sub-node structure for a START_THREAD NodeRun. message StartThreadRun { + // Contains the thread_run_number of the created Child ThreadRun, if it has + // been created already. optional int32 child_thread_id = 1; + + // The thread_spec_name of the child thread_run. string thread_spec_name = 2; } +// The sub-node structure for a START_MULTIPLE_THREADS NodeRun. +// +// Note: the output of this NodeRun, which can be used to mutate Variables, +// is a JSON_ARR variable containing the ID's of all the child threadRuns. message StartMultipleThreadsRun { + // The thread_spec_name of the child thread_runs. string thread_spec_name = 1; } +// The sub-node structure for a WAIT_FOR_THREADS NodeRun. message WaitForThreadsRun { + // A 'WaitForThread' structure defines a thread that is being waited for. message WaitForThread { + // The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun + // is still RUNNING, HALTED, or HALTING. optional google.protobuf.Timestamp thread_end_time = 1; + + // The current status of the ThreadRun being waited for. LHStatus thread_status = 2; + + // The number of the ThreadRun being waited for. int32 thread_run_number = 3; + + // INTERNAL: flag used by scheduler internally. bool already_handled = 5; } + + // The threads that are being waited for. repeated WaitForThread threads = 1; + + // The policy to use when handling failures for Threads. Currently, only + // one policy exists. WaitForThreadsPolicy policy = 2; } +// The sub-node structure for an EXTERNAL_EVENT NodeRun. message ExternalEventRun { + // The ExternalEventDefId that we are waiting for. ExternalEventDefId external_event_def_id = 1; + + // The time that the ExternalEvent arrived. Unset if still waiting. optional google.protobuf.Timestamp event_time = 2; + + // The ExternalEventId of the ExternalEvent. Unset if still waiting. optional ExternalEventId external_event_id = 3; } +// The sub-node structure for a SLEEP NodeRun. message SleepNodeRun { + // The time at which the NodeRun will wake up. google.protobuf.Timestamp maturation_time = 1; } - +// Denotes a failure that happened during execution of a NodeRun or the outgoing +// edges. message Failure { + // The name of the failure. LittleHorse has certain built-in failures, all named in + // UPPER_UNDERSCORE_CASE. Such failures correspond with the `LHStatus.ERROR`. + // + // Any Failure named in `kebab-case` is a user-defined business `EXCEPTION`, treated + // as an `LHStatus.EXCEPTION`. string failure_name = 1; + + // The human-readable message associated with this Failure. string message = 2; + + // A user-defined Failure can have a value; for example, in Java an Exception is an + // Object with arbitrary properties and behaviors. + // + // Future versions of LH will allow FailureHandler threads to accept that value as + // an input variable. optional VariableValue content = 3; + + // A boolean denoting whether a Failure Handler ThreadRun properly handled the Failure. bool was_properly_handled = 4; } diff --git a/schemas/object_id.proto b/schemas/object_id.proto index bbd16ccda..f73b8bd63 100644 --- a/schemas/object_id.proto +++ b/schemas/object_id.proto @@ -10,78 +10,162 @@ option java_multiple_files = true; option java_package = "io.littlehorse.sdk.common.proto"; option csharp_namespace = "LittleHorse.Common.Proto"; +// The ID of a WfSpec. message WfSpecId { + // Name of the WfSpec. string name = 1; + + // Major Version of a WfSpec. + // + // Note that WfSpec's are versioned. Creating a new WfSpec with the same name + // and no breaking changes to the public Variables API results in a new WfSpec + // being created with the same MajorVersion and a new revision. Creating a + // WfSpec with a breaking change to the public Variables API results in a + // new WfSpec being created with the same name, an incremented major_version, + // and revision = 0. int32 major_version = 2; + + // Revision of a WfSpec. + // + // Note that WfSpec's are versioned. Creating a new WfSpec with the same name + // and no breaking changes to the public Variables API results in a new WfSpec + // being created with the same MajorVersion and a new revision. Creating a + // WfSpec with a breaking change to the public Variables API results in a + // new WfSpec being created with the same name, an incremented major_version, + // and revision = 0. int32 revision = 3; } +// ID for a TaskDef. message TaskDefId { + // TaskDef's are uniquely identified by their name. string name = 1; } +// ID for ExternalEventDef message ExternalEventDefId { + // ExternalEventDef's are uniquedly identified by their name. string name = 1; } +// ID for a UserTaskDef message UserTaskDefId { + // The name of a UserTaskDef string name = 1; + + // Note that UserTaskDef's use simple versioning. int32 version = 2; } +// ID for a TaskWorkerGroup. message TaskWorkerGroupId { + // TaskWorkerGroups are uniquely identified by their TaskDefId. TaskDefId task_def_id = 1; } +// Id for a Variable. message VariableId { + // WfRunId for the variable. Note that every Variable is associated with + // a WfRun. WfRunId wf_run_id = 1; + + // Each Variable is owned by a specific ThreadRun inside the WfRun it belongs + // to. This is that ThreadRun's number. int32 thread_run_number = 2; + + // The name of the variable. string name = 3; } +// ID for an ExternalEvent. message ExternalEventId { + // WfRunId for the ExternalEvent. Note that every ExternalEvent is associated + // with a WfRun. WfRunId wf_run_id = 1; + + // The ExternalEventDef for this ExternalEvent. ExternalEventDefId external_event_def_id = 2; + + // A unique guid allowing for distinguishing this ExternalEvent from other events + // of the same ExternalEventDef and WfRun. string guid = 3; } +// ID for a WfRun message WfRunId { + // The ID for this WfRun instance. string id = 1; + + // A WfRun may have a parent WfRun. If so, this field is set to the parent's ID. optional WfRunId parent_wf_run_id = 2; } +// ID for a NodeRun. message NodeRunId { + // ID of the WfRun for this NodeRun. Note that every NodeRun is associated with + // a WfRun. WfRunId wf_run_id = 1; + + // ThreadRun of this NodeRun. Note that each NodeRun belongs to a ThreadRun. int32 thread_run_number = 2; + + // Position of this NodeRun within its ThreadRun. int32 position = 3; } +// ID for a TaskRun. message TaskRunId { + // WfRunId for this TaskRun. Note that every TaskRun is associated with + // a WfRun. WfRunId wf_run_id = 1; + + // Unique identifier for this TaskRun. Unique among the WfRun. string task_guid = 2; } +// ID for a UserTaskRun message UserTaskRunId { + // WfRunId for this UserTaskRun. Note that every UserTaskRun is associated + // with a WfRun. WfRunId wf_run_id = 1; + + // Unique identifier for this UserTaskRun. string user_task_guid = 2; } +// ID for a specific window of TaskDef metrics. message TaskDefMetricsId { + // The timestamp at which this metrics window starts. google.protobuf.Timestamp window_start = 1; + + // The length of this window. MetricsWindowLength window_type = 2; + + // The TaskDefId that this metrics window reports on. TaskDefId task_def_id = 3; } +// ID for a specific window of WfSpec metrics. message WfSpecMetricsId { + // The timestamp at which this metrics window starts. google.protobuf.Timestamp window_start = 1; + + // The length of this window. MetricsWindowLength window_type = 2; + + // The WfSpecId that this metrics window reports on. WfSpecId wf_spec_id = 3; } +// ID for a Principal. message PrincipalId { + // The id of this principal. In OAuth, this is the OAuth Client ID (for + // machine principals) or the OAuth User Id (for human principals). string id = 1; } +// ID for a Tenant. message TenantId { + // The Tenant ID. string id = 1; } diff --git a/schemas/service.proto b/schemas/service.proto index 1956155d0..ad96d5ee6 100644 --- a/schemas/service.proto +++ b/schemas/service.proto @@ -292,7 +292,13 @@ message PutExternalEventDefRequest { string name = 1; // Policy to determine how long an ExternalEvent is retained after creation if it - // is not yet claimed by a WfRun. + // is not yet claimed by a WfRun. Note that once a WfRun has been matched with the + // ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted. + // If not set, then ExternalEvent's are not deleted if they are not matched with + // a WfRun. + // + // A future version of LittleHorse will allow changing the retention_policy, which + // will trigger a cleanup of old `ExternalEvent`s. ExternalEventRetentionPolicy retention_policy = 2; } diff --git a/schemas/task_def.proto b/schemas/task_def.proto index ebe24ccd3..f75fbfe7c 100644 --- a/schemas/task_def.proto +++ b/schemas/task_def.proto @@ -11,8 +11,14 @@ option java_multiple_files = true; option java_package = "io.littlehorse.sdk.common.proto"; option csharp_namespace = "LittleHorse.Common.Proto"; +// A TaskDef defines a blueprint for a TaskRun that can be dispatched to Task Workers. message TaskDef { + // The ID of this TaskDef. TaskDefId id = 1; + + // The input variables required to execute this TaskDef. repeated VariableDef input_vars = 2; + + // The time at which this TaskDef was created. google.protobuf.Timestamp created_at = 3; } diff --git a/schemas/task_run.proto b/schemas/task_run.proto index 001c7ee90..b5009c865 100644 --- a/schemas/task_run.proto +++ b/schemas/task_run.proto @@ -13,62 +13,128 @@ option java_multiple_files = true; option java_package = "io.littlehorse.sdk.common.proto"; option csharp_namespace = "LittleHorse.Common.Proto"; +// A TaskRun resents a single instance of a TaskDef being executed. message TaskRun { + // The ID of the TaskRun. Note that the TaskRunId contains the WfRunId. TaskRunId id = 1; + + // The ID of the TaskDef being executed. TaskDefId task_def_id = 2; + // All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of + // the TaskRun being put on a Task Queue to be executed by the Task Workers. repeated TaskAttempt attempts = 3; + + // The maximum number of attempts that may be scheduled for this TaskRun. int32 max_attempts = 4; + + // The input variables to pass into this TaskRun. Note that this is a list and not + // a map, because ordering matters. Depending on the language implementation, not + // every LittleHorse Task Worker SDK has the ability to determine the names of the + // variables from the method signature, so we provide both names and ordering. repeated VarNameAndVal input_variables = 5; + // The source (in the WfRun) that caused this TaskRun to be created. Currently, this + // can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such + // as a task used to send reminders). TaskRunSource source = 6; + + // When the TaskRun was scheduled. google.protobuf.Timestamp scheduled_at = 7; + // The status of the TaskRun. TaskStatus status = 8; + + // The timeout before LH considers a TaskAttempt to be timed out. int32 timeout_seconds = 9; } +// A key-value pair of variable name and value. message VarNameAndVal { + // The variable name. string var_name = 1; + + // The value of the variable for this TaskRun. VariableValue value = 2; } +// A single time that a TaskRun was scheduled for execution on a Task Queue. message TaskAttempt { + // Optional information provided by the Task Worker SDK for debugging. Usually, if set + // it contains a stacktrace or it contains information logged via `WorkerContext#log()`. optional VariableValue log_output = 2; + // The time the TaskAttempt was scheduled on the Task Queue. optional google.protobuf.Timestamp schedule_time = 3; + + // The time the TaskAttempt was pulled off the queue and sent to a TaskWorker. optional google.protobuf.Timestamp start_time = 4; + + // The time the TaskAttempt was finished (either completed, reported as failed, or + // timed out) optional google.protobuf.Timestamp end_time = 5; + + // EXPERIMENTAL: the ID of the Task Worker who executed this TaskRun. string task_worker_id = 7; + + // The version of the Task Worker that executed the TaskAttempt. optional string task_worker_version = 8; + // The status of this TaskAttempt. TaskStatus status = 9; + // The result of this TaskAttempt. Can either be a successful run which returns an + // output value, a technical ERROR which returns a LHTaskError, or the Task Function + // can throw a business EXCEPTION (eg. `credit-card-declined`). oneof result { + // Denotes the Task Function executed properly and returned an output. VariableValue output = 1; + + // An unexpected technical error was encountered. May or may not be retriable. LHTaskError error = 10; + + // The Task Function encountered a business problem and threw a technical exception. LHTaskException exception = 11; } } +// The source of a TaskRun; i.e. why it was scheduled. message TaskRunSource { + // The source of the TaskRun. oneof task_run_source { + // Reference to a NodeRun of type TASK which scheduled this TaskRun. TaskNodeReference task_node = 1; + + // Reference to the specific UserTaskRun trigger action which scheduled this TaskRun UserTaskTriggerReference user_task_trigger = 2; } + + // The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so + // that the WorkerContext can know this information. optional WfSpecId wf_spec_id = 3; } +// Reference to a NodeRun of type TASK which caused a TaskRun to be scheduled. message TaskNodeReference { + // The ID of the NodeRun which caused this TASK to be scheduled. NodeRunId node_run_id = 1; } +// Message denoting a TaskRun failed for technical reasons. message LHTaskError { + // The technical error code. LHErrorType type = 1; + + // Human readable message for debugging. string message = 2; } +// Message denoting a TaskRun's execution signaled that something went wrong in the +// business process, throwing a littlehorse 'EXCEPTION'. message LHTaskException { + // The user-defined Failure name, for example, "credit-card-declined" string name = 1; + + // Human readadble description of the failure. string message = 2; } diff --git a/schemas/variable.proto b/schemas/variable.proto index c82e33cf9..557006732 100644 --- a/schemas/variable.proto +++ b/schemas/variable.proto @@ -10,22 +10,50 @@ option java_multiple_files = true; option java_package = "io.littlehorse.sdk.common.proto"; option csharp_namespace = "LittleHorse.Common.Proto"; +// VariableValue is a structure containing a value in LittleHorse. It can be +// used to pass input variables into a WfRun/ThreadRun/TaskRun/etc, as output +// from a TaskRun, as the value of a WfRun's Variable, etc. message VariableValue { reserved 1; + + // The value held in this VariableValue. If this is unset, treat it as + // a NULL. oneof value { + // A String representing a serialized json object. string json_obj = 2; + + // A String representing a serialized json list. string json_arr = 3; + + // A 64-bit floating point number. double double = 4; + + // A boolean. bool bool = 5; + + // A string. string str = 6; + + // A 64-bit integer. int64 int = 7; + + // An arbitrary String of bytes. bytes bytes = 8; } } +// A Variable is an instance of a variable assigned to a WfRun. message Variable { + // ID of this Variable. Note that the VariableId contains the relevant + // WfRunId inside it, the threadRunNumber, and the name of the Variabe. VariableId id = 1; + + // The value of this Variable. VariableValue value = 2; + + // When the Variable was created. google.protobuf.Timestamp created_at = 3; + + // The ID of the WfSpec that this Variable belongs to. WfSpecId wf_spec_id = 4; } diff --git a/schemas/wf_run.proto b/schemas/wf_run.proto index bea891ac5..5d4250f40 100644 --- a/schemas/wf_run.proto +++ b/schemas/wf_run.proto @@ -11,105 +11,223 @@ option java_multiple_files = true; option java_package = "io.littlehorse.sdk.common.proto"; option csharp_namespace = "LittleHorse.Common.Proto"; +// A WfRun is a running instance of a WfSpec. message WfRun { + // The ID of the WfRun. WfRunId id = 1; + + // The ID of the WfSpec that this WfRun belongs to. WfSpecId wf_spec_id = 2; + + // When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the + // old WfSpecId to this list for historical auditing and debugging purposes. repeated WfSpecId old_wf_spec_versions = 3; + + // The status of this WfRun. LHStatus status = 4; + // The ID number of the greatest ThreadRUn in this WfRun. The total number of ThreadRuns + // is given by greatest_thread_run_number + 1. + // // Introduced now since with ThreadRun-level retention, we can't rely upon - // thread_runs.size() to determine the number of ThreadRuns. + // thread_runs.size() to determine the number of ThreadRuns, as a ThreadRun is removed + // from the thread_runs list once its retention period expires. int32 greatest_threadrun_number = 5; + // The time the WfRun was started. google.protobuf.Timestamp start_time = 6; + + // The time the WfRun failed or completed. optional google.protobuf.Timestamp end_time = 7; + + // A list of all active ThreadRun's and terminated ThreadRun's whose retention periods + // have not yet expired. repeated ThreadRun thread_runs = 8; + // A list of Interrupt events that will fire once their appropriate ThreadRun's finish + // halting. repeated PendingInterrupt pending_interrupts = 9; + + // A list of pending failure handlers which will fire once their appropriate ThreadRun's + // finish halting. repeated PendingFailureHandler pending_failures = 10; } +// The type of a ThreadRUn. enum ThreadType { + // The ENTRYPOINT ThreadRun. Exactly one per WfRun. Always has number == 0. ENTRYPOINT = 0; + + // A ThreadRun explicitly created by another ThreadRun via a START_THREAD or START_MULTIPLE_THREADS + // NodeRun. CHILD = 1; + + // A ThreadRun that was created to handle an Interrupt. INTERRUPT = 2; + + // A ThreadRun that was created to handle a Failure. FAILURE_HANDLER = 3; } +// A ThreadRun is a running thread of execution within a WfRun. message ThreadRun { + // The current WfSpecId of this ThreadRun. This must be set explicitly because + // during a WfSpec Version Migration, it is possible for different ThreadSpec's to + // have different WfSpec versions. WfSpecId wf_spec_id = 1; + + // The number of the ThreadRun. This is an auto-incremented integer corresponding to + // the chronological ordering of when the ThreadRun's were created. If you have not + // configured any retention policy for the ThreadRun's (i.e. never clean them up), then + // this also corresponds to the position of the ThreadRun in the WfRun's `thread_runs` + // list. int32 number = 2; + // The status of the ThreadRun. LHStatus status = 3; + + // The name of the ThreadSpec being run. string thread_spec_name = 4; + // The time the ThreadRun was started. google.protobuf.Timestamp start_time = 5; + + // The time the ThreadRun was completed or failed. Unset if still active. optional google.protobuf.Timestamp end_time = 6; + // Human-readable error message detailing what went wrong in the case of a failure. optional string error_message = 7; + // List of thread_run_number's for all child thread_runs. repeated int32 child_thread_ids = 8; + + // Set for every ThreadRun except the ENTRYPOINT. This is the id of the parent thread. optional int32 parent_thread_id = 9; + // If the ThreadRun is HALTED, this contains a list of every reason for which the + // ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list), + // then the ThreadRun will return to the RUNNING state. repeated ThreadHaltReason halt_reasons = 10; + + // If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the + // ExternalEvent that caused the Interrupt. optional ExternalEventId interrupt_trigger_id = 11; + + // If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure + // that is being handled by this ThreadRun. optional FailureBeingHandled failure_being_handled = 12; + // This is the current `position` of the current NodeRun being run. This is an + // auto-incremented field that gets incremented every time we run a new NodeRun. int32 current_node_position = 13; + + // List of every child ThreadRun which both a) failed, and b) was properly handled by a + // Failure Handler. + // + // This is important because at the EXIT node, if a Child ThreadRun was discovered to have + // failed, then this ThreadRun (the parent) also fails with the same failure as the child. + // If, however, a Failure Handler had previously "handled" the Child Failure, that ThreadRun's + // number is appended to this list, and then the EXIT node ignores that ThreadRun. repeated int32 handled_failed_children = 14; + // The Type of this ThreadRun. ThreadType type = 15; } +// Points to the Failure that is currently being handled in the ThreadRun. message FailureBeingHandled { + // The thread run number. int32 thread_run_number = 1; + + // The position of the NodeRun causing the failure. int32 node_run_position = 2; + + // The number of the failure. int32 failure_number = 3; } +// Represents an ExternalEvent that has a registered Interrupt Handler for it +// and which is pending to be sent to the relevant ThreadRun's. message PendingInterrupt { + // The ID of the ExternalEvent triggering the Interrupt. ExternalEventId external_event_id = 1; + + // The name of the ThreadSpec to run to handle the Interrupt. string handler_spec_name = 2; + + // The ID of the ThreadRun to interrupt. Must wait for this ThreadRun to be + // HALTED before running the Interrupt Handler. int32 interrupted_thread_id = 3; } +// Represents a Failure Handler that is pending to be run. message PendingFailureHandler { + // The ThreadRun that failed. int32 failed_thread_run = 1; + + // The name of the ThreadSpec to run to handle the failure. string handler_spec_name = 2; } +// A Halt Reason denoting that a ThreadRun is halted while waiting for an Interrupt handler +// to be run. message PendingInterruptHaltReason { + // The ExternalEventId that caused the Interrupt. ExternalEventId external_event_id = 1; } +// A Halt Reason denoting that a ThreadRun is halted while a Failure Handler is *enqueued* to be +// run. message PendingFailureHandlerHaltReason { + // The position of the NodeRun which threw the failure. int32 node_run_position = 1; } +// A Halt Reason denoting that a ThreadRun is halted while a Failure Handler is being run. message HandlingFailureHaltReason { + // The ID of the Failure Handler ThreadRun. int32 handler_thread_id = 1; } +// A Halt Reason denoting that a ThreadRun is halted because its parent is also HALTED. message ParentHalted { + // The ID of the halted parent. int32 parent_thread_id = 1; } +// A Halt Reason denoting that a ThreadRun is halted because it is waiting for the +// interrupt handler threadRun to run. message Interrupted { + // The ID of the Interrupt Handler ThreadRun. int32 interrupt_thread_id = 1; } +// A Halt Reason denoting that a ThreadRun was halted manually, via the `rpc StopWfRun` request. message ManualHalt { // Nothing to store. bool meaning_of_life = 137; } +// Denotes a reason why a ThreadRun is halted. See `ThreadRun.halt_reasons` for context. message ThreadHaltReason { + // The reason for the halt. oneof reason { + // Parent threadRun halted. ParentHalted parent_halted = 1; + + // Handling an Interrupt. Interrupted interrupted = 2; + + // Waiting to handle Interrupt. PendingInterruptHaltReason pending_interrupt = 3; + + // Waiting to handle a failure. PendingFailureHandlerHaltReason pending_failure = 4; + + // Handling a failure. HandlingFailureHaltReason handling_failure = 5; + + // Manually stopped the WfRun. ManualHalt manual_halt = 6; } } diff --git a/sdk-go/common/model/common_wfspec.pb.go b/sdk-go/common/model/common_wfspec.pb.go index 07ee39fe2..52cc2f607 100644 --- a/sdk-go/common/model/common_wfspec.pb.go +++ b/sdk-go/common/model/common_wfspec.pb.go @@ -97,17 +97,34 @@ func (VariableMutationType) EnumDescriptor() ([]byte, []int) { return file_common_wfspec_proto_rawDescGZIP(), []int{0} } +// Operator for comparing two values to create a boolean expression. type Comparator int32 const ( - Comparator_LESS_THAN Comparator = 0 - Comparator_GREATER_THAN Comparator = 1 - Comparator_LESS_THAN_EQ Comparator = 2 + // Equivalent to `<`. Only valid for primitive types (no JSON_OBJ or JSON_ARR). + Comparator_LESS_THAN Comparator = 0 + // Equivalent to `>`. Only valid for primitive types (no JSON_OBJ or JSON_ARR). + Comparator_GREATER_THAN Comparator = 1 + // Equivalent to `<=`. Only valid for primitive types (no JSON_OBJ or JSON_ARR). + Comparator_LESS_THAN_EQ Comparator = 2 + // Equivalent to `>=`. Only valid for primitive types (no JSON_OBJ or JSON_ARR). Comparator_GREATER_THAN_EQ Comparator = 3 - Comparator_EQUALS Comparator = 4 - Comparator_NOT_EQUALS Comparator = 5 - Comparator_IN Comparator = 6 - Comparator_NOT_IN Comparator = 7 + // This is valid for any variable type, and is similar to .equals() in Java. + // + // One note: if the RHS is a different type from the LHS, then LittleHorse will + // try to cast the RHS to the same type as the LHS. If the cast fails, then the + // ThreadRun fails with a VAR_SUB_ERROR. + Comparator_EQUALS Comparator = 4 + // This is the inverse of `EQUALS` + Comparator_NOT_EQUALS Comparator = 5 + // Only valid if the RHS is a JSON_OBJ or JSON_ARR. Valid for any type on the LHS. + // + // For the JSON_OBJ type, this returns true if the LHS is equal to a *KEY* in the + // RHS. For the JSON_ARR type, it returns true if one of the elements of the RHS + // is equal to the LHS. + Comparator_IN Comparator = 6 + // The inverse of IN. + Comparator_NOT_IN Comparator = 7 ) // Enum value maps for Comparator. @@ -161,10 +178,18 @@ func (Comparator) EnumDescriptor() ([]byte, []int) { return file_common_wfspec_proto_rawDescGZIP(), []int{1} } +// Enumerates the different lifecycle hooks that can cause the timer to start running. type UTActionTrigger_UTHook int32 const ( - UTActionTrigger_ON_ARRIVAL UTActionTrigger_UTHook = 0 + // The hook should be scheduled `delay_seconds` after the UserTaskRun is created. This + // hook only causes the action to be scheduled once. + UTActionTrigger_ON_ARRIVAL UTActionTrigger_UTHook = 0 + // The hook should be scheduled `delay_seconds` after the ownership of the UserTaskRun + // changes. This hook causes the Action to be scheduled one or more times. The first + // time is scheduled when the UserTaskRun is created, since we treat the change from + // "UserTaskRun is nonexistent" to "UserTaskRun is owned by a userId or userGroup" as + // a change in ownership. UTActionTrigger_ON_TASK_ASSIGNED UTActionTrigger_UTHook = 1 ) @@ -324,14 +349,26 @@ func (*VariableAssignment_LiteralValue) isVariableAssignment_Source() {} func (*VariableAssignment_FormatString_) isVariableAssignment_Source() {} +// A VariableMutation defines a modification made to one of a ThreadRun's variables. +// The LHS determines the variable that is modified; the operation determines how +// it is modified, and the RHS is the input to the operation. +// +// Day-to-day users of LittleHorse generally don't interact with this structure unless +// they are writing their own WfSpec SDK. type VariableMutation struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - LhsName string `protobuf:"bytes,1,opt,name=lhs_name,json=lhsName,proto3" json:"lhs_name,omitempty"` - LhsJsonPath *string `protobuf:"bytes,2,opt,name=lhs_json_path,json=lhsJsonPath,proto3,oneof" json:"lhs_json_path,omitempty"` - Operation VariableMutationType `protobuf:"varint,3,opt,name=operation,proto3,enum=littlehorse.VariableMutationType" json:"operation,omitempty"` + // The name of the variable to mutate + LhsName string `protobuf:"bytes,1,opt,name=lhs_name,json=lhsName,proto3" json:"lhs_name,omitempty"` + // For JSON_ARR and JSON_OBJ variables, this allows you to optionally mutate + // a specific sub-field of the variable. + LhsJsonPath *string `protobuf:"bytes,2,opt,name=lhs_json_path,json=lhsJsonPath,proto3,oneof" json:"lhs_json_path,omitempty"` + // Defines the operation that we are executing. + Operation VariableMutationType `protobuf:"varint,3,opt,name=operation,proto3,enum=littlehorse.VariableMutationType" json:"operation,omitempty"` + // The RHS of the mutation; i.e. what is operated _with_. + // // Types that are assignable to RhsValue: // *VariableMutation_SourceVariable // *VariableMutation_LiteralValue @@ -425,14 +462,18 @@ type isVariableMutation_RhsValue interface { } type VariableMutation_SourceVariable struct { + // Set the source_variable as the RHS to use another variable from the workflow to + // as the RHS/ SourceVariable *VariableAssignment `protobuf:"bytes,4,opt,name=source_variable,json=sourceVariable,proto3,oneof"` } type VariableMutation_LiteralValue struct { + // Use a literal value as the RHS. LiteralValue *VariableValue `protobuf:"bytes,5,opt,name=literal_value,json=literalValue,proto3,oneof"` } type VariableMutation_NodeOutput struct { + // Use the output of the current node as the RHS. NodeOutput *VariableMutation_NodeOutputSource `protobuf:"bytes,6,opt,name=node_output,json=nodeOutput,proto3,oneof"` } @@ -442,13 +483,19 @@ func (*VariableMutation_LiteralValue) isVariableMutation_RhsValue() {} func (*VariableMutation_NodeOutput) isVariableMutation_RhsValue() {} +// Declares a Variable. type VariableDef struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - Type VariableType `protobuf:"varint,1,opt,name=type,proto3,enum=littlehorse.VariableType" json:"type,omitempty"` - Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` + // The Type of the variable. + Type VariableType `protobuf:"varint,1,opt,name=type,proto3,enum=littlehorse.VariableType" json:"type,omitempty"` + // The name of the variable. + Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` + // Optional default value if the variable isn't set; for example, in a ThreadRun + // if you start a ThreadRun or WfRun without passing a variable in, then this is + // used. DefaultValue *VariableValue `protobuf:"bytes,3,opt,name=default_value,json=defaultValue,proto3,oneof" json:"default_value,omitempty"` } @@ -519,14 +566,18 @@ type UTActionTrigger struct { sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The action that is scheduled by the hook + // // Types that are assignable to Action: // *UTActionTrigger_Task // *UTActionTrigger_Cancel // *UTActionTrigger_Reassign Action isUTActionTrigger_Action `protobuf_oneof:"action"` - //Action's delay - DelaySeconds *VariableAssignment `protobuf:"bytes,5,opt,name=delay_seconds,json=delaySeconds,proto3" json:"delay_seconds,omitempty"` - Hook UTActionTrigger_UTHook `protobuf:"varint,6,opt,name=hook,proto3,enum=littlehorse.UTActionTrigger_UTHook" json:"hook,omitempty"` + // The Action is triggered some time after the Hook matures. The delay is controlled + // by this field. + DelaySeconds *VariableAssignment `protobuf:"bytes,5,opt,name=delay_seconds,json=delaySeconds,proto3" json:"delay_seconds,omitempty"` + // The hook on which this UserTaskAction is scheduled. + Hook UTActionTrigger_UTHook `protobuf:"varint,6,opt,name=hook,proto3,enum=littlehorse.UTActionTrigger_UTHook" json:"hook,omitempty"` } func (x *UTActionTrigger) Reset() { @@ -625,15 +676,23 @@ func (*UTActionTrigger_Cancel) isUTActionTrigger_Action() {} func (*UTActionTrigger_Reassign) isUTActionTrigger_Action() {} +// Defines a TaskRun execution. Used in a Node and also in the UserTask Trigger Actions. type TaskNode struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - TaskDefId *TaskDefId `protobuf:"bytes,1,opt,name=task_def_id,json=taskDefId,proto3" json:"task_def_id,omitempty"` - TimeoutSeconds int32 `protobuf:"varint,2,opt,name=timeout_seconds,json=timeoutSeconds,proto3" json:"timeout_seconds,omitempty"` - Retries int32 `protobuf:"varint,3,opt,name=retries,proto3" json:"retries,omitempty"` - Variables []*VariableAssignment `protobuf:"bytes,4,rep,name=variables,proto3" json:"variables,omitempty"` + // The type of TaskRun to schedule. + TaskDefId *TaskDefId `protobuf:"bytes,1,opt,name=task_def_id,json=taskDefId,proto3" json:"task_def_id,omitempty"` + // How long until LittleHorse determines that the Task Worker had a technical ERROR if + // the worker does not yet reply to the Server. + TimeoutSeconds int32 `protobuf:"varint,2,opt,name=timeout_seconds,json=timeoutSeconds,proto3" json:"timeout_seconds,omitempty"` + // EXPERIMENTAL: How many times we should retry on retryable ERROR's. + // Please note that this API may change before version 1.0.0, as we are going to + // add significant functionality including backoff policies. + Retries int32 `protobuf:"varint,3,opt,name=retries,proto3" json:"retries,omitempty"` + // Input variables into the TaskDef. + Variables []*VariableAssignment `protobuf:"bytes,4,rep,name=variables,proto3" json:"variables,omitempty"` } func (x *TaskNode) Reset() { @@ -755,11 +814,13 @@ func (x *VariableAssignment_FormatString) GetArgs() []*VariableAssignment { return nil } +// Specifies to use the output of a NodeRun as the RHS. type VariableMutation_NodeOutputSource struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // Use this specific field from a JSON output Jsonpath *string `protobuf:"bytes,10,opt,name=jsonpath,proto3,oneof" json:"jsonpath,omitempty"` } @@ -802,6 +863,7 @@ func (x *VariableMutation_NodeOutputSource) GetJsonpath() string { return "" } +// A UserTaskAction that causes a UserTaskRun to be CANCELLED when it fires. type UTActionTrigger_UTACancel struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache @@ -840,12 +902,15 @@ func (*UTActionTrigger_UTACancel) Descriptor() ([]byte, []int) { return file_common_wfspec_proto_rawDescGZIP(), []int{3, 0} } +// A UserTaskAction that causes a TaskRun to be scheduled when it fires. type UTActionTrigger_UTATask struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - Task *TaskNode `protobuf:"bytes,1,opt,name=task,proto3" json:"task,omitempty"` + // The specification of the Task to schedule. + Task *TaskNode `protobuf:"bytes,1,opt,name=task,proto3" json:"task,omitempty"` + // EXPERIMENTAL: Any variables in the ThreadRun which we should mutate. Mutations []*VariableMutation `protobuf:"bytes,2,rep,name=mutations,proto3" json:"mutations,omitempty"` } @@ -895,12 +960,17 @@ func (x *UTActionTrigger_UTATask) GetMutations() []*VariableMutation { return nil } +// A UserTaskAction that causes a UserTaskRun to be reassigned when it fires. type UTActionTrigger_UTAReassign struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - UserId *VariableAssignment `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3,oneof" json:"user_id,omitempty"` + // A variable assignment that resolves to a STR representing the new user_id. If + // not set, the user_id of the UserTaskRun will be un-set. + UserId *VariableAssignment `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3,oneof" json:"user_id,omitempty"` + // A variable assignment that resolves to a STR representing the new user_group. If + // not set, the user_group of the UserTaskRun will be un-set. UserGroup *VariableAssignment `protobuf:"bytes,2,opt,name=user_group,json=userGroup,proto3,oneof" json:"user_group,omitempty"` } diff --git a/sdk-go/common/model/external_event.pb.go b/sdk-go/common/model/external_event.pb.go index 0177d8c51..11358be6a 100644 --- a/sdk-go/common/model/external_event.pb.go +++ b/sdk-go/common/model/external_event.pb.go @@ -21,17 +21,36 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) +// An ExternalEvent represents A Thing That Happened outside the context of a WfRun. +// Generally, an ExternalEvent is used to represent a document getting signed, an incident +// being resolved, an order being fulfilled, etc. +// +// ExternalEvent's are created via the 'rpc PutExternalEvent' +// +// For more context on ExternalEvents, check our documentation here: +// https://littlehorse.dev/docs/concepts/external-events type ExternalEvent struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - Id *ExternalEventId `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - CreatedAt *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` - Content *VariableValue `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"` - ThreadRunNumber *int32 `protobuf:"varint,4,opt,name=thread_run_number,json=threadRunNumber,proto3,oneof" json:"thread_run_number,omitempty"` - NodeRunPosition *int32 `protobuf:"varint,5,opt,name=node_run_position,json=nodeRunPosition,proto3,oneof" json:"node_run_position,omitempty"` - Claimed bool `protobuf:"varint,6,opt,name=claimed,proto3" json:"claimed,omitempty"` + // The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId, + // and a unique guid which can be used for idempotency of the `PutExternalEvent` + // rpc call. + Id *ExternalEventId `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` + // The time the ExternalEvent was registered with LittleHorse. + CreatedAt *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` + // The payload of this ExternalEvent. + Content *VariableValue `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"` + // If the ExternalEvent was claimed by a specific ThreadRun (via Interrupt or + // EXTERNAL_EVENT Node), this is set to the number of the relevant ThreadRun. + ThreadRunNumber *int32 `protobuf:"varint,4,opt,name=thread_run_number,json=threadRunNumber,proto3,oneof" json:"thread_run_number,omitempty"` + // If the ExternalEvent was claimed by a specific ThreadRun (via EXTERNAL_EVENT + // Node; note that in the case of an Interrupt the node_run_position will never + // be set), this is set to the number of the relevant NodeRun. + NodeRunPosition *int32 `protobuf:"varint,5,opt,name=node_run_position,json=nodeRunPosition,proto3,oneof" json:"node_run_position,omitempty"` + // Whether the ExternalEvent has been claimed by a WfRun. + Claimed bool `protobuf:"varint,6,opt,name=claimed,proto3" json:"claimed,omitempty"` } func (x *ExternalEvent) Reset() { @@ -108,14 +127,18 @@ func (x *ExternalEvent) GetClaimed() bool { return false } -// ExternalEventDef +// The ExternalEventDef defines the blueprint for an ExternalEvent. type ExternalEventDef struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` - CreatedAt *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` + // The name of the ExternalEventDef. + Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` + // When the ExternalEventDef was created. + CreatedAt *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` + // The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the + // ExternalEvent **only before** it is matched with a WfRun. RetentionPolicy *ExternalEventRetentionPolicy `protobuf:"bytes,3,opt,name=retention_policy,json=retentionPolicy,proto3" json:"retention_policy,omitempty"` } @@ -172,11 +195,22 @@ func (x *ExternalEventDef) GetRetentionPolicy() *ExternalEventRetentionPolicy { return nil } +// Policy to determine how long an ExternalEvent is retained after creation if it +// is not yet claimed by a WfRun. Note that once a WfRun has been matched with the +// ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted. +// If not set, then ExternalEvent's are not deleted if they are not matched with +// a WfRun. +// +// A future version of LittleHorse will allow changing the retention_policy, which +// will trigger a cleanup of old `ExternalEvent`s. type ExternalEventRetentionPolicy struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The retention policy choice. If not set, then the ExternalEvent is not cleaned up + // until matched with a WfRun (which may mean it is never cleaned up). + // // Types that are assignable to ExtEvtGcPolicy: // *ExternalEventRetentionPolicy_SecondsAfterPut ExtEvtGcPolicy isExternalEventRetentionPolicy_ExtEvtGcPolicy `protobuf_oneof:"ext_evt_gc_policy"` diff --git a/sdk-go/common/model/node_run.pb.go b/sdk-go/common/model/node_run.pb.go index b9cd9498f..d9f62d5fb 100644 --- a/sdk-go/common/model/node_run.pb.go +++ b/sdk-go/common/model/node_run.pb.go @@ -21,21 +21,40 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) +// A NodeRun is a running instance of a Node in a ThreadRun. Note that a NodeRun +// is a Getable object, meaning it can be retried from the LittleHorse grpc API. type NodeRun struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - Id *NodeRunId `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - WfSpecId *WfSpecId `protobuf:"bytes,4,opt,name=wf_spec_id,json=wfSpecId,proto3" json:"wf_spec_id,omitempty"` - FailureHandlerIds []int32 `protobuf:"varint,5,rep,packed,name=failure_handler_ids,json=failureHandlerIds,proto3" json:"failure_handler_ids,omitempty"` - Status LHStatus `protobuf:"varint,6,opt,name=status,proto3,enum=littlehorse.LHStatus" json:"status,omitempty"` - ArrivalTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=arrival_time,json=arrivalTime,proto3" json:"arrival_time,omitempty"` - EndTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=end_time,json=endTime,proto3,oneof" json:"end_time,omitempty"` - ThreadSpecName string `protobuf:"bytes,9,opt,name=thread_spec_name,json=threadSpecName,proto3" json:"thread_spec_name,omitempty"` - NodeName string `protobuf:"bytes,10,opt,name=node_name,json=nodeName,proto3" json:"node_name,omitempty"` - ErrorMessage *string `protobuf:"bytes,11,opt,name=error_message,json=errorMessage,proto3,oneof" json:"error_message,omitempty"` - Failures []*Failure `protobuf:"bytes,12,rep,name=failures,proto3" json:"failures,omitempty"` + // The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the + // ThreadRun's number, and the position of the NodeRun within that ThreadRun. + Id *NodeRunId `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` + // The ID of the WfSpec that this NodeRun is from. This is not _always_ the same + // as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration + // feature. + WfSpecId *WfSpecId `protobuf:"bytes,4,opt,name=wf_spec_id,json=wfSpecId,proto3" json:"wf_spec_id,omitempty"` + // A list of all ThreadRun's that ran to handle a failure thrown by this NodeRun. + FailureHandlerIds []int32 `protobuf:"varint,5,rep,packed,name=failure_handler_ids,json=failureHandlerIds,proto3" json:"failure_handler_ids,omitempty"` + // The status of this NodeRun. + Status LHStatus `protobuf:"varint,6,opt,name=status,proto3,enum=littlehorse.LHStatus" json:"status,omitempty"` + // The time the ThreadRun arrived at this NodeRun. + ArrivalTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=arrival_time,json=arrivalTime,proto3" json:"arrival_time,omitempty"` + // The time the NodeRun was terminated (failed or completed). + EndTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=end_time,json=endTime,proto3,oneof" json:"end_time,omitempty"` + // The name of the ThreadSpec to which this NodeRun belongs. + ThreadSpecName string `protobuf:"bytes,9,opt,name=thread_spec_name,json=threadSpecName,proto3" json:"thread_spec_name,omitempty"` + // The name of the Node in the ThreadSpec that this NodeRun belongs to. + NodeName string `protobuf:"bytes,10,opt,name=node_name,json=nodeName,proto3" json:"node_name,omitempty"` + // A human-readable error message intended to help developers diagnose WfSpec + // problems. + ErrorMessage *string `protobuf:"bytes,11,opt,name=error_message,json=errorMessage,proto3,oneof" json:"error_message,omitempty"` + // A list of Failures thrown by this NodeRun. + Failures []*Failure `protobuf:"bytes,12,rep,name=failures,proto3" json:"failures,omitempty"` + // There are many types of Nodes in a WfSpec; therefore, we have many different types + // of NodeRun. Each NodeRun can only be one. + // // Types that are assignable to NodeType: // *NodeRun_Task // *NodeRun_ExternalEvent @@ -226,38 +245,48 @@ type isNodeRun_NodeType interface { } type NodeRun_Task struct { + // Denotes a TASK node, which runs a TaskRun. Task *TaskNodeRun `protobuf:"bytes,13,opt,name=task,proto3,oneof"` } type NodeRun_ExternalEvent struct { + // An EXTERNAL_EVENT node blocks until an ExternalEvent arrives. ExternalEvent *ExternalEventRun `protobuf:"bytes,14,opt,name=external_event,json=externalEvent,proto3,oneof"` } type NodeRun_Entrypoint struct { + // An ENTRYPOINT node is the first thing that runs in a ThreadRun. Entrypoint *EntrypointRun `protobuf:"bytes,15,opt,name=entrypoint,proto3,oneof"` } type NodeRun_Exit struct { + // An EXIT node completes a ThreadRun. Exit *ExitRun `protobuf:"bytes,16,opt,name=exit,proto3,oneof"` } type NodeRun_StartThread struct { + // A START_THREAD node starts a child ThreadRun. StartThread *StartThreadRun `protobuf:"bytes,17,opt,name=start_thread,json=startThread,proto3,oneof"` } type NodeRun_WaitThreads struct { + // A WAIT_THREADS node waits for one or more child ThreadRun's to complete. WaitThreads *WaitForThreadsRun `protobuf:"bytes,18,opt,name=wait_threads,json=waitThreads,proto3,oneof"` } type NodeRun_Sleep struct { + // A SLEEP node makes the ThreadRun block for a certain amount of time. Sleep *SleepNodeRun `protobuf:"bytes,19,opt,name=sleep,proto3,oneof"` } type NodeRun_UserTask struct { + // A USER_TASK node waits until a human executes some work and reports the result. UserTask *UserTaskNodeRun `protobuf:"bytes,20,opt,name=user_task,json=userTask,proto3,oneof"` } type NodeRun_StartMultipleThreads struct { + // A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a + // child ThreadRun for each element in the list. StartMultipleThreads *StartMultipleThreadsRun `protobuf:"bytes,21,opt,name=start_multiple_threads,json=startMultipleThreads,proto3,oneof"` } @@ -279,11 +308,14 @@ func (*NodeRun_UserTask) isNodeRun_NodeType() {} func (*NodeRun_StartMultipleThreads) isNodeRun_NodeType() {} +// The sub-node structure for a TASK NodeRun. type TaskNodeRun struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived + // at this TASK Node, then the task_run_id will be unset. TaskRunId *TaskRunId `protobuf:"bytes,1,opt,name=task_run_id,json=taskRunId,proto3,oneof" json:"task_run_id,omitempty"` } @@ -326,11 +358,14 @@ func (x *TaskNodeRun) GetTaskRunId() *TaskRunId { return nil } +// The sub-node structure for a USER_TASK NodeRun. type UserTaskNodeRun struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived + // at this USER_TASK node, then the user_task_run_id will be unset. UserTaskRunId *UserTaskRunId `protobuf:"bytes,1,opt,name=user_task_run_id,json=userTaskRunId,proto3,oneof" json:"user_task_run_id,omitempty"` } @@ -373,6 +408,7 @@ func (x *UserTaskNodeRun) GetUserTaskRunId() *UserTaskRunId { return nil } +// The sub-node structure for an ENTRYPOINT NodeRun. Currently Empty. type EntrypointRun struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache @@ -411,6 +447,8 @@ func (*EntrypointRun) Descriptor() ([]byte, []int) { return file_node_run_proto_rawDescGZIP(), []int{3} } +// The sub-node structure for an EXIT NodeRun. Currently Empty, will contain info +// about ThreadRun Outputs once those are added in the future. type ExitRun struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache @@ -449,12 +487,16 @@ func (*ExitRun) Descriptor() ([]byte, []int) { return file_node_run_proto_rawDescGZIP(), []int{4} } +// The sub-node structure for a START_THREAD NodeRun. type StartThreadRun struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - ChildThreadId *int32 `protobuf:"varint,1,opt,name=child_thread_id,json=childThreadId,proto3,oneof" json:"child_thread_id,omitempty"` + // Contains the thread_run_number of the created Child ThreadRun, if it has + // been created already. + ChildThreadId *int32 `protobuf:"varint,1,opt,name=child_thread_id,json=childThreadId,proto3,oneof" json:"child_thread_id,omitempty"` + // The thread_spec_name of the child thread_run. ThreadSpecName string `protobuf:"bytes,2,opt,name=thread_spec_name,json=threadSpecName,proto3" json:"thread_spec_name,omitempty"` } @@ -504,11 +546,16 @@ func (x *StartThreadRun) GetThreadSpecName() string { return "" } +// The sub-node structure for a START_MULTIPLE_THREADS NodeRun. +// +// Note: the output of this NodeRun, which can be used to mutate Variables, +// is a JSON_ARR variable containing the ID's of all the child threadRuns. type StartMultipleThreadsRun struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The thread_spec_name of the child thread_runs. ThreadSpecName string `protobuf:"bytes,1,opt,name=thread_spec_name,json=threadSpecName,proto3" json:"thread_spec_name,omitempty"` } @@ -551,13 +598,17 @@ func (x *StartMultipleThreadsRun) GetThreadSpecName() string { return "" } +// The sub-node structure for a WAIT_FOR_THREADS NodeRun. type WaitForThreadsRun struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The threads that are being waited for. Threads []*WaitForThreadsRun_WaitForThread `protobuf:"bytes,1,rep,name=threads,proto3" json:"threads,omitempty"` - Policy WaitForThreadsPolicy `protobuf:"varint,2,opt,name=policy,proto3,enum=littlehorse.WaitForThreadsPolicy" json:"policy,omitempty"` + // The policy to use when handling failures for Threads. Currently, only + // one policy exists. + Policy WaitForThreadsPolicy `protobuf:"varint,2,opt,name=policy,proto3,enum=littlehorse.WaitForThreadsPolicy" json:"policy,omitempty"` } func (x *WaitForThreadsRun) Reset() { @@ -606,14 +657,18 @@ func (x *WaitForThreadsRun) GetPolicy() WaitForThreadsPolicy { return WaitForThreadsPolicy_STOP_ON_FAILURE } +// The sub-node structure for an EXTERNAL_EVENT NodeRun. type ExternalEventRun struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - ExternalEventDefId *ExternalEventDefId `protobuf:"bytes,1,opt,name=external_event_def_id,json=externalEventDefId,proto3" json:"external_event_def_id,omitempty"` - EventTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=event_time,json=eventTime,proto3,oneof" json:"event_time,omitempty"` - ExternalEventId *ExternalEventId `protobuf:"bytes,3,opt,name=external_event_id,json=externalEventId,proto3,oneof" json:"external_event_id,omitempty"` + // The ExternalEventDefId that we are waiting for. + ExternalEventDefId *ExternalEventDefId `protobuf:"bytes,1,opt,name=external_event_def_id,json=externalEventDefId,proto3" json:"external_event_def_id,omitempty"` + // The time that the ExternalEvent arrived. Unset if still waiting. + EventTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=event_time,json=eventTime,proto3,oneof" json:"event_time,omitempty"` + // The ExternalEventId of the ExternalEvent. Unset if still waiting. + ExternalEventId *ExternalEventId `protobuf:"bytes,3,opt,name=external_event_id,json=externalEventId,proto3,oneof" json:"external_event_id,omitempty"` } func (x *ExternalEventRun) Reset() { @@ -669,11 +724,13 @@ func (x *ExternalEventRun) GetExternalEventId() *ExternalEventId { return nil } +// The sub-node structure for a SLEEP NodeRun. type SleepNodeRun struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The time at which the NodeRun will wake up. MaturationTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=maturation_time,json=maturationTime,proto3" json:"maturation_time,omitempty"` } @@ -716,15 +773,29 @@ func (x *SleepNodeRun) GetMaturationTime() *timestamppb.Timestamp { return nil } +// Denotes a failure that happened during execution of a NodeRun or the outgoing +// edges. type Failure struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - FailureName string `protobuf:"bytes,1,opt,name=failure_name,json=failureName,proto3" json:"failure_name,omitempty"` - Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"` - Content *VariableValue `protobuf:"bytes,3,opt,name=content,proto3,oneof" json:"content,omitempty"` - WasProperlyHandled bool `protobuf:"varint,4,opt,name=was_properly_handled,json=wasProperlyHandled,proto3" json:"was_properly_handled,omitempty"` + // The name of the failure. LittleHorse has certain built-in failures, all named in + // UPPER_UNDERSCORE_CASE. Such failures correspond with the `LHStatus.ERROR`. + // + // Any Failure named in `kebab-case` is a user-defined business `EXCEPTION`, treated + // as an `LHStatus.EXCEPTION`. + FailureName string `protobuf:"bytes,1,opt,name=failure_name,json=failureName,proto3" json:"failure_name,omitempty"` + // The human-readable message associated with this Failure. + Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"` + // A user-defined Failure can have a value; for example, in Java an Exception is an + // Object with arbitrary properties and behaviors. + // + // Future versions of LH will allow FailureHandler threads to accept that value as + // an input variable. + Content *VariableValue `protobuf:"bytes,3,opt,name=content,proto3,oneof" json:"content,omitempty"` + // A boolean denoting whether a Failure Handler ThreadRun properly handled the Failure. + WasProperlyHandled bool `protobuf:"varint,4,opt,name=was_properly_handled,json=wasProperlyHandled,proto3" json:"was_properly_handled,omitempty"` } func (x *Failure) Reset() { @@ -787,15 +858,21 @@ func (x *Failure) GetWasProperlyHandled() bool { return false } +// A 'WaitForThread' structure defines a thread that is being waited for. type WaitForThreadsRun_WaitForThread struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - ThreadEndTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=thread_end_time,json=threadEndTime,proto3,oneof" json:"thread_end_time,omitempty"` - ThreadStatus LHStatus `protobuf:"varint,2,opt,name=thread_status,json=threadStatus,proto3,enum=littlehorse.LHStatus" json:"thread_status,omitempty"` - ThreadRunNumber int32 `protobuf:"varint,3,opt,name=thread_run_number,json=threadRunNumber,proto3" json:"thread_run_number,omitempty"` - AlreadyHandled bool `protobuf:"varint,5,opt,name=already_handled,json=alreadyHandled,proto3" json:"already_handled,omitempty"` + // The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun + // is still RUNNING, HALTED, or HALTING. + ThreadEndTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=thread_end_time,json=threadEndTime,proto3,oneof" json:"thread_end_time,omitempty"` + // The current status of the ThreadRun being waited for. + ThreadStatus LHStatus `protobuf:"varint,2,opt,name=thread_status,json=threadStatus,proto3,enum=littlehorse.LHStatus" json:"thread_status,omitempty"` + // The number of the ThreadRun being waited for. + ThreadRunNumber int32 `protobuf:"varint,3,opt,name=thread_run_number,json=threadRunNumber,proto3" json:"thread_run_number,omitempty"` + // INTERNAL: flag used by scheduler internally. + AlreadyHandled bool `protobuf:"varint,5,opt,name=already_handled,json=alreadyHandled,proto3" json:"already_handled,omitempty"` } func (x *WaitForThreadsRun_WaitForThread) Reset() { diff --git a/sdk-go/common/model/object_id.pb.go b/sdk-go/common/model/object_id.pb.go index c0c21e207..a203f63df 100644 --- a/sdk-go/common/model/object_id.pb.go +++ b/sdk-go/common/model/object_id.pb.go @@ -21,14 +21,32 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) +// The ID of a WfSpec. type WfSpecId struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` - MajorVersion int32 `protobuf:"varint,2,opt,name=major_version,json=majorVersion,proto3" json:"major_version,omitempty"` - Revision int32 `protobuf:"varint,3,opt,name=revision,proto3" json:"revision,omitempty"` + // Name of the WfSpec. + Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` + // Major Version of a WfSpec. + // + // Note that WfSpec's are versioned. Creating a new WfSpec with the same name + // and no breaking changes to the public Variables API results in a new WfSpec + // being created with the same MajorVersion and a new revision. Creating a + // WfSpec with a breaking change to the public Variables API results in a + // new WfSpec being created with the same name, an incremented major_version, + // and revision = 0. + MajorVersion int32 `protobuf:"varint,2,opt,name=major_version,json=majorVersion,proto3" json:"major_version,omitempty"` + // Revision of a WfSpec. + // + // Note that WfSpec's are versioned. Creating a new WfSpec with the same name + // and no breaking changes to the public Variables API results in a new WfSpec + // being created with the same MajorVersion and a new revision. Creating a + // WfSpec with a breaking change to the public Variables API results in a + // new WfSpec being created with the same name, an incremented major_version, + // and revision = 0. + Revision int32 `protobuf:"varint,3,opt,name=revision,proto3" json:"revision,omitempty"` } func (x *WfSpecId) Reset() { @@ -84,11 +102,13 @@ func (x *WfSpecId) GetRevision() int32 { return 0 } +// ID for a TaskDef. type TaskDefId struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // TaskDef's are uniquely identified by their name. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` } @@ -131,11 +151,13 @@ func (x *TaskDefId) GetName() string { return "" } +// ID for ExternalEventDef type ExternalEventDefId struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // ExternalEventDef's are uniquedly identified by their name. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` } @@ -178,13 +200,16 @@ func (x *ExternalEventDefId) GetName() string { return "" } +// ID for a UserTaskDef type UserTaskDefId struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` - Version int32 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"` + // The name of a UserTaskDef + Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` + // Note that UserTaskDef's use simple versioning. + Version int32 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"` } func (x *UserTaskDefId) Reset() { @@ -233,11 +258,13 @@ func (x *UserTaskDefId) GetVersion() int32 { return 0 } +// ID for a TaskWorkerGroup. type TaskWorkerGroupId struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // TaskWorkerGroups are uniquely identified by their TaskDefId. TaskDefId *TaskDefId `protobuf:"bytes,1,opt,name=task_def_id,json=taskDefId,proto3" json:"task_def_id,omitempty"` } @@ -280,14 +307,20 @@ func (x *TaskWorkerGroupId) GetTaskDefId() *TaskDefId { return nil } +// Id for a Variable. type VariableId struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - WfRunId *WfRunId `protobuf:"bytes,1,opt,name=wf_run_id,json=wfRunId,proto3" json:"wf_run_id,omitempty"` - ThreadRunNumber int32 `protobuf:"varint,2,opt,name=thread_run_number,json=threadRunNumber,proto3" json:"thread_run_number,omitempty"` - Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"` + // WfRunId for the variable. Note that every Variable is associated with + // a WfRun. + WfRunId *WfRunId `protobuf:"bytes,1,opt,name=wf_run_id,json=wfRunId,proto3" json:"wf_run_id,omitempty"` + // Each Variable is owned by a specific ThreadRun inside the WfRun it belongs + // to. This is that ThreadRun's number. + ThreadRunNumber int32 `protobuf:"varint,2,opt,name=thread_run_number,json=threadRunNumber,proto3" json:"thread_run_number,omitempty"` + // The name of the variable. + Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"` } func (x *VariableId) Reset() { @@ -343,14 +376,20 @@ func (x *VariableId) GetName() string { return "" } +// ID for an ExternalEvent. type ExternalEventId struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - WfRunId *WfRunId `protobuf:"bytes,1,opt,name=wf_run_id,json=wfRunId,proto3" json:"wf_run_id,omitempty"` + // WfRunId for the ExternalEvent. Note that every ExternalEvent is associated + // with a WfRun. + WfRunId *WfRunId `protobuf:"bytes,1,opt,name=wf_run_id,json=wfRunId,proto3" json:"wf_run_id,omitempty"` + // The ExternalEventDef for this ExternalEvent. ExternalEventDefId *ExternalEventDefId `protobuf:"bytes,2,opt,name=external_event_def_id,json=externalEventDefId,proto3" json:"external_event_def_id,omitempty"` - Guid string `protobuf:"bytes,3,opt,name=guid,proto3" json:"guid,omitempty"` + // A unique guid allowing for distinguishing this ExternalEvent from other events + // of the same ExternalEventDef and WfRun. + Guid string `protobuf:"bytes,3,opt,name=guid,proto3" json:"guid,omitempty"` } func (x *ExternalEventId) Reset() { @@ -406,12 +445,15 @@ func (x *ExternalEventId) GetGuid() string { return "" } +// ID for a WfRun type WfRunId struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` + // The ID for this WfRun instance. + Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` + // A WfRun may have a parent WfRun. If so, this field is set to the parent's ID. ParentWfRunId *WfRunId `protobuf:"bytes,2,opt,name=parent_wf_run_id,json=parentWfRunId,proto3,oneof" json:"parent_wf_run_id,omitempty"` } @@ -461,14 +503,19 @@ func (x *WfRunId) GetParentWfRunId() *WfRunId { return nil } +// ID for a NodeRun. type NodeRunId struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - WfRunId *WfRunId `protobuf:"bytes,1,opt,name=wf_run_id,json=wfRunId,proto3" json:"wf_run_id,omitempty"` - ThreadRunNumber int32 `protobuf:"varint,2,opt,name=thread_run_number,json=threadRunNumber,proto3" json:"thread_run_number,omitempty"` - Position int32 `protobuf:"varint,3,opt,name=position,proto3" json:"position,omitempty"` + // ID of the WfRun for this NodeRun. Note that every NodeRun is associated with + // a WfRun. + WfRunId *WfRunId `protobuf:"bytes,1,opt,name=wf_run_id,json=wfRunId,proto3" json:"wf_run_id,omitempty"` + // ThreadRun of this NodeRun. Note that each NodeRun belongs to a ThreadRun. + ThreadRunNumber int32 `protobuf:"varint,2,opt,name=thread_run_number,json=threadRunNumber,proto3" json:"thread_run_number,omitempty"` + // Position of this NodeRun within its ThreadRun. + Position int32 `protobuf:"varint,3,opt,name=position,proto3" json:"position,omitempty"` } func (x *NodeRunId) Reset() { @@ -524,13 +571,17 @@ func (x *NodeRunId) GetPosition() int32 { return 0 } +// ID for a TaskRun. type TaskRunId struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - WfRunId *WfRunId `protobuf:"bytes,1,opt,name=wf_run_id,json=wfRunId,proto3" json:"wf_run_id,omitempty"` - TaskGuid string `protobuf:"bytes,2,opt,name=task_guid,json=taskGuid,proto3" json:"task_guid,omitempty"` + // WfRunId for this TaskRun. Note that every TaskRun is associated with + // a WfRun. + WfRunId *WfRunId `protobuf:"bytes,1,opt,name=wf_run_id,json=wfRunId,proto3" json:"wf_run_id,omitempty"` + // Unique identifier for this TaskRun. Unique among the WfRun. + TaskGuid string `protobuf:"bytes,2,opt,name=task_guid,json=taskGuid,proto3" json:"task_guid,omitempty"` } func (x *TaskRunId) Reset() { @@ -579,13 +630,17 @@ func (x *TaskRunId) GetTaskGuid() string { return "" } +// ID for a UserTaskRun type UserTaskRunId struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - WfRunId *WfRunId `protobuf:"bytes,1,opt,name=wf_run_id,json=wfRunId,proto3" json:"wf_run_id,omitempty"` - UserTaskGuid string `protobuf:"bytes,2,opt,name=user_task_guid,json=userTaskGuid,proto3" json:"user_task_guid,omitempty"` + // WfRunId for this UserTaskRun. Note that every UserTaskRun is associated + // with a WfRun. + WfRunId *WfRunId `protobuf:"bytes,1,opt,name=wf_run_id,json=wfRunId,proto3" json:"wf_run_id,omitempty"` + // Unique identifier for this UserTaskRun. + UserTaskGuid string `protobuf:"bytes,2,opt,name=user_task_guid,json=userTaskGuid,proto3" json:"user_task_guid,omitempty"` } func (x *UserTaskRunId) Reset() { @@ -634,14 +689,18 @@ func (x *UserTaskRunId) GetUserTaskGuid() string { return "" } +// ID for a specific window of TaskDef metrics. type TaskDefMetricsId struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The timestamp at which this metrics window starts. WindowStart *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=window_start,json=windowStart,proto3" json:"window_start,omitempty"` - WindowType MetricsWindowLength `protobuf:"varint,2,opt,name=window_type,json=windowType,proto3,enum=littlehorse.MetricsWindowLength" json:"window_type,omitempty"` - TaskDefId *TaskDefId `protobuf:"bytes,3,opt,name=task_def_id,json=taskDefId,proto3" json:"task_def_id,omitempty"` + // The length of this window. + WindowType MetricsWindowLength `protobuf:"varint,2,opt,name=window_type,json=windowType,proto3,enum=littlehorse.MetricsWindowLength" json:"window_type,omitempty"` + // The TaskDefId that this metrics window reports on. + TaskDefId *TaskDefId `protobuf:"bytes,3,opt,name=task_def_id,json=taskDefId,proto3" json:"task_def_id,omitempty"` } func (x *TaskDefMetricsId) Reset() { @@ -697,14 +756,18 @@ func (x *TaskDefMetricsId) GetTaskDefId() *TaskDefId { return nil } +// ID for a specific window of WfSpec metrics. type WfSpecMetricsId struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The timestamp at which this metrics window starts. WindowStart *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=window_start,json=windowStart,proto3" json:"window_start,omitempty"` - WindowType MetricsWindowLength `protobuf:"varint,2,opt,name=window_type,json=windowType,proto3,enum=littlehorse.MetricsWindowLength" json:"window_type,omitempty"` - WfSpecId *WfSpecId `protobuf:"bytes,3,opt,name=wf_spec_id,json=wfSpecId,proto3" json:"wf_spec_id,omitempty"` + // The length of this window. + WindowType MetricsWindowLength `protobuf:"varint,2,opt,name=window_type,json=windowType,proto3,enum=littlehorse.MetricsWindowLength" json:"window_type,omitempty"` + // The WfSpecId that this metrics window reports on. + WfSpecId *WfSpecId `protobuf:"bytes,3,opt,name=wf_spec_id,json=wfSpecId,proto3" json:"wf_spec_id,omitempty"` } func (x *WfSpecMetricsId) Reset() { @@ -760,11 +823,14 @@ func (x *WfSpecMetricsId) GetWfSpecId() *WfSpecId { return nil } +// ID for a Principal. type PrincipalId struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The id of this principal. In OAuth, this is the OAuth Client ID (for + // machine principals) or the OAuth User Id (for human principals). Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` } @@ -807,11 +873,13 @@ func (x *PrincipalId) GetId() string { return "" } +// ID for a Tenant. type TenantId struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The Tenant ID. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` } diff --git a/sdk-go/common/model/service.pb.go b/sdk-go/common/model/service.pb.go index f00a1ed60..27392a038 100644 --- a/sdk-go/common/model/service.pb.go +++ b/sdk-go/common/model/service.pb.go @@ -441,7 +441,13 @@ type PutExternalEventDefRequest struct { // The name of the resulting ExternalEventDef. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Policy to determine how long an ExternalEvent is retained after creation if it - // is not yet claimed by a WfRun. + // is not yet claimed by a WfRun. Note that once a WfRun has been matched with the + // ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted. + // If not set, then ExternalEvent's are not deleted if they are not matched with + // a WfRun. + // + // A future version of LittleHorse will allow changing the retention_policy, which + // will trigger a cleanup of old `ExternalEvent`s. RetentionPolicy *ExternalEventRetentionPolicy `protobuf:"bytes,2,opt,name=retention_policy,json=retentionPolicy,proto3" json:"retention_policy,omitempty"` } diff --git a/sdk-go/common/model/task_def.pb.go b/sdk-go/common/model/task_def.pb.go index 06cf8b177..e8fde7899 100644 --- a/sdk-go/common/model/task_def.pb.go +++ b/sdk-go/common/model/task_def.pb.go @@ -21,13 +21,17 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) +// A TaskDef defines a blueprint for a TaskRun that can be dispatched to Task Workers. type TaskDef struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - Id *TaskDefId `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - InputVars []*VariableDef `protobuf:"bytes,2,rep,name=input_vars,json=inputVars,proto3" json:"input_vars,omitempty"` + // The ID of this TaskDef. + Id *TaskDefId `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` + // The input variables required to execute this TaskDef. + InputVars []*VariableDef `protobuf:"bytes,2,rep,name=input_vars,json=inputVars,proto3" json:"input_vars,omitempty"` + // The time at which this TaskDef was created. CreatedAt *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` } diff --git a/sdk-go/common/model/task_run.pb.go b/sdk-go/common/model/task_run.pb.go index 124c534e6..270f8fd00 100644 --- a/sdk-go/common/model/task_run.pb.go +++ b/sdk-go/common/model/task_run.pb.go @@ -21,20 +21,36 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) +// A TaskRun resents a single instance of a TaskDef being executed. type TaskRun struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - Id *TaskRunId `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - TaskDefId *TaskDefId `protobuf:"bytes,2,opt,name=task_def_id,json=taskDefId,proto3" json:"task_def_id,omitempty"` - Attempts []*TaskAttempt `protobuf:"bytes,3,rep,name=attempts,proto3" json:"attempts,omitempty"` - MaxAttempts int32 `protobuf:"varint,4,opt,name=max_attempts,json=maxAttempts,proto3" json:"max_attempts,omitempty"` - InputVariables []*VarNameAndVal `protobuf:"bytes,5,rep,name=input_variables,json=inputVariables,proto3" json:"input_variables,omitempty"` - Source *TaskRunSource `protobuf:"bytes,6,opt,name=source,proto3" json:"source,omitempty"` - ScheduledAt *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=scheduled_at,json=scheduledAt,proto3" json:"scheduled_at,omitempty"` - Status TaskStatus `protobuf:"varint,8,opt,name=status,proto3,enum=littlehorse.TaskStatus" json:"status,omitempty"` - TimeoutSeconds int32 `protobuf:"varint,9,opt,name=timeout_seconds,json=timeoutSeconds,proto3" json:"timeout_seconds,omitempty"` + // The ID of the TaskRun. Note that the TaskRunId contains the WfRunId. + Id *TaskRunId `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` + // The ID of the TaskDef being executed. + TaskDefId *TaskDefId `protobuf:"bytes,2,opt,name=task_def_id,json=taskDefId,proto3" json:"task_def_id,omitempty"` + // All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of + // the TaskRun being put on a Task Queue to be executed by the Task Workers. + Attempts []*TaskAttempt `protobuf:"bytes,3,rep,name=attempts,proto3" json:"attempts,omitempty"` + // The maximum number of attempts that may be scheduled for this TaskRun. + MaxAttempts int32 `protobuf:"varint,4,opt,name=max_attempts,json=maxAttempts,proto3" json:"max_attempts,omitempty"` + // The input variables to pass into this TaskRun. Note that this is a list and not + // a map, because ordering matters. Depending on the language implementation, not + // every LittleHorse Task Worker SDK has the ability to determine the names of the + // variables from the method signature, so we provide both names and ordering. + InputVariables []*VarNameAndVal `protobuf:"bytes,5,rep,name=input_variables,json=inputVariables,proto3" json:"input_variables,omitempty"` + // The source (in the WfRun) that caused this TaskRun to be created. Currently, this + // can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such + // as a task used to send reminders). + Source *TaskRunSource `protobuf:"bytes,6,opt,name=source,proto3" json:"source,omitempty"` + // When the TaskRun was scheduled. + ScheduledAt *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=scheduled_at,json=scheduledAt,proto3" json:"scheduled_at,omitempty"` + // The status of the TaskRun. + Status TaskStatus `protobuf:"varint,8,opt,name=status,proto3,enum=littlehorse.TaskStatus" json:"status,omitempty"` + // The timeout before LH considers a TaskAttempt to be timed out. + TimeoutSeconds int32 `protobuf:"varint,9,opt,name=timeout_seconds,json=timeoutSeconds,proto3" json:"timeout_seconds,omitempty"` } func (x *TaskRun) Reset() { @@ -132,13 +148,16 @@ func (x *TaskRun) GetTimeoutSeconds() int32 { return 0 } +// A key-value pair of variable name and value. type VarNameAndVal struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - VarName string `protobuf:"bytes,1,opt,name=var_name,json=varName,proto3" json:"var_name,omitempty"` - Value *VariableValue `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` + // The variable name. + VarName string `protobuf:"bytes,1,opt,name=var_name,json=varName,proto3" json:"var_name,omitempty"` + // The value of the variable for this TaskRun. + Value *VariableValue `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` } func (x *VarNameAndVal) Reset() { @@ -187,18 +206,32 @@ func (x *VarNameAndVal) GetValue() *VariableValue { return nil } +// A single time that a TaskRun was scheduled for execution on a Task Queue. type TaskAttempt struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - LogOutput *VariableValue `protobuf:"bytes,2,opt,name=log_output,json=logOutput,proto3,oneof" json:"log_output,omitempty"` - ScheduleTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=schedule_time,json=scheduleTime,proto3,oneof" json:"schedule_time,omitempty"` - StartTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=start_time,json=startTime,proto3,oneof" json:"start_time,omitempty"` - EndTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=end_time,json=endTime,proto3,oneof" json:"end_time,omitempty"` - TaskWorkerId string `protobuf:"bytes,7,opt,name=task_worker_id,json=taskWorkerId,proto3" json:"task_worker_id,omitempty"` - TaskWorkerVersion *string `protobuf:"bytes,8,opt,name=task_worker_version,json=taskWorkerVersion,proto3,oneof" json:"task_worker_version,omitempty"` - Status TaskStatus `protobuf:"varint,9,opt,name=status,proto3,enum=littlehorse.TaskStatus" json:"status,omitempty"` + // Optional information provided by the Task Worker SDK for debugging. Usually, if set + // it contains a stacktrace or it contains information logged via `WorkerContext#log()`. + LogOutput *VariableValue `protobuf:"bytes,2,opt,name=log_output,json=logOutput,proto3,oneof" json:"log_output,omitempty"` + // The time the TaskAttempt was scheduled on the Task Queue. + ScheduleTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=schedule_time,json=scheduleTime,proto3,oneof" json:"schedule_time,omitempty"` + // The time the TaskAttempt was pulled off the queue and sent to a TaskWorker. + StartTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=start_time,json=startTime,proto3,oneof" json:"start_time,omitempty"` + // The time the TaskAttempt was finished (either completed, reported as failed, or + // timed out) + EndTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=end_time,json=endTime,proto3,oneof" json:"end_time,omitempty"` + // EXPERIMENTAL: the ID of the Task Worker who executed this TaskRun. + TaskWorkerId string `protobuf:"bytes,7,opt,name=task_worker_id,json=taskWorkerId,proto3" json:"task_worker_id,omitempty"` + // The version of the Task Worker that executed the TaskAttempt. + TaskWorkerVersion *string `protobuf:"bytes,8,opt,name=task_worker_version,json=taskWorkerVersion,proto3,oneof" json:"task_worker_version,omitempty"` + // The status of this TaskAttempt. + Status TaskStatus `protobuf:"varint,9,opt,name=status,proto3,enum=littlehorse.TaskStatus" json:"status,omitempty"` + // The result of this TaskAttempt. Can either be a successful run which returns an + // output value, a technical ERROR which returns a LHTaskError, or the Task Function + // can throw a business EXCEPTION (eg. `credit-card-declined`). + // // Types that are assignable to Result: // *TaskAttempt_Output // *TaskAttempt_Error @@ -320,14 +353,17 @@ type isTaskAttempt_Result interface { } type TaskAttempt_Output struct { + // Denotes the Task Function executed properly and returned an output. Output *VariableValue `protobuf:"bytes,1,opt,name=output,proto3,oneof"` } type TaskAttempt_Error struct { + // An unexpected technical error was encountered. May or may not be retriable. Error *LHTaskError `protobuf:"bytes,10,opt,name=error,proto3,oneof"` } type TaskAttempt_Exception struct { + // The Task Function encountered a business problem and threw a technical exception. Exception *LHTaskException `protobuf:"bytes,11,opt,name=exception,proto3,oneof"` } @@ -337,16 +373,21 @@ func (*TaskAttempt_Error) isTaskAttempt_Result() {} func (*TaskAttempt_Exception) isTaskAttempt_Result() {} +// The source of a TaskRun; i.e. why it was scheduled. type TaskRunSource struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The source of the TaskRun. + // // Types that are assignable to TaskRunSource: // *TaskRunSource_TaskNode // *TaskRunSource_UserTaskTrigger TaskRunSource isTaskRunSource_TaskRunSource `protobuf_oneof:"task_run_source"` - WfSpecId *WfSpecId `protobuf:"bytes,3,opt,name=wf_spec_id,json=wfSpecId,proto3,oneof" json:"wf_spec_id,omitempty"` + // The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so + // that the WorkerContext can know this information. + WfSpecId *WfSpecId `protobuf:"bytes,3,opt,name=wf_spec_id,json=wfSpecId,proto3,oneof" json:"wf_spec_id,omitempty"` } func (x *TaskRunSource) Reset() { @@ -414,10 +455,12 @@ type isTaskRunSource_TaskRunSource interface { } type TaskRunSource_TaskNode struct { + // Reference to a NodeRun of type TASK which scheduled this TaskRun. TaskNode *TaskNodeReference `protobuf:"bytes,1,opt,name=task_node,json=taskNode,proto3,oneof"` } type TaskRunSource_UserTaskTrigger struct { + // Reference to the specific UserTaskRun trigger action which scheduled this TaskRun UserTaskTrigger *UserTaskTriggerReference `protobuf:"bytes,2,opt,name=user_task_trigger,json=userTaskTrigger,proto3,oneof"` } @@ -425,11 +468,13 @@ func (*TaskRunSource_TaskNode) isTaskRunSource_TaskRunSource() {} func (*TaskRunSource_UserTaskTrigger) isTaskRunSource_TaskRunSource() {} +// Reference to a NodeRun of type TASK which caused a TaskRun to be scheduled. type TaskNodeReference struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The ID of the NodeRun which caused this TASK to be scheduled. NodeRunId *NodeRunId `protobuf:"bytes,1,opt,name=node_run_id,json=nodeRunId,proto3" json:"node_run_id,omitempty"` } @@ -472,13 +517,16 @@ func (x *TaskNodeReference) GetNodeRunId() *NodeRunId { return nil } +// Message denoting a TaskRun failed for technical reasons. type LHTaskError struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - Type LHErrorType `protobuf:"varint,1,opt,name=type,proto3,enum=littlehorse.LHErrorType" json:"type,omitempty"` - Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"` + // The technical error code. + Type LHErrorType `protobuf:"varint,1,opt,name=type,proto3,enum=littlehorse.LHErrorType" json:"type,omitempty"` + // Human readable message for debugging. + Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"` } func (x *LHTaskError) Reset() { @@ -527,12 +575,16 @@ func (x *LHTaskError) GetMessage() string { return "" } +// Message denoting a TaskRun's execution signaled that something went wrong in the +// business process, throwing a littlehorse 'EXCEPTION'. type LHTaskException struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` + // The user-defined Failure name, for example, "credit-card-declined" + Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` + // Human readadble description of the failure. Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"` } diff --git a/sdk-go/common/model/variable.pb.go b/sdk-go/common/model/variable.pb.go index 9b343d3d7..e4f513d6e 100644 --- a/sdk-go/common/model/variable.pb.go +++ b/sdk-go/common/model/variable.pb.go @@ -21,11 +21,17 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) +// VariableValue is a structure containing a value in LittleHorse. It can be +// used to pass input variables into a WfRun/ThreadRun/TaskRun/etc, as output +// from a TaskRun, as the value of a WfRun's Variable, etc. type VariableValue struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The value held in this VariableValue. If this is unset, treat it as + // a NULL. + // // Types that are assignable to Value: // *VariableValue_JsonObj // *VariableValue_JsonArr @@ -130,30 +136,37 @@ type isVariableValue_Value interface { } type VariableValue_JsonObj struct { + // A String representing a serialized json object. JsonObj string `protobuf:"bytes,2,opt,name=json_obj,json=jsonObj,proto3,oneof"` } type VariableValue_JsonArr struct { + // A String representing a serialized json list. JsonArr string `protobuf:"bytes,3,opt,name=json_arr,json=jsonArr,proto3,oneof"` } type VariableValue_Double struct { + // A 64-bit floating point number. Double float64 `protobuf:"fixed64,4,opt,name=double,proto3,oneof"` } type VariableValue_Bool struct { + // A boolean. Bool bool `protobuf:"varint,5,opt,name=bool,proto3,oneof"` } type VariableValue_Str struct { + // A string. Str string `protobuf:"bytes,6,opt,name=str,proto3,oneof"` } type VariableValue_Int struct { + // A 64-bit integer. Int int64 `protobuf:"varint,7,opt,name=int,proto3,oneof"` } type VariableValue_Bytes struct { + // An arbitrary String of bytes. Bytes []byte `protobuf:"bytes,8,opt,name=bytes,proto3,oneof"` } @@ -171,15 +184,21 @@ func (*VariableValue_Int) isVariableValue_Value() {} func (*VariableValue_Bytes) isVariableValue_Value() {} +// A Variable is an instance of a variable assigned to a WfRun. type Variable struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - Id *VariableId `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - Value *VariableValue `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` + // ID of this Variable. Note that the VariableId contains the relevant + // WfRunId inside it, the threadRunNumber, and the name of the Variabe. + Id *VariableId `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` + // The value of this Variable. + Value *VariableValue `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` + // When the Variable was created. CreatedAt *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` - WfSpecId *WfSpecId `protobuf:"bytes,4,opt,name=wf_spec_id,json=wfSpecId,proto3" json:"wf_spec_id,omitempty"` + // The ID of the WfSpec that this Variable belongs to. + WfSpecId *WfSpecId `protobuf:"bytes,4,opt,name=wf_spec_id,json=wfSpecId,proto3" json:"wf_spec_id,omitempty"` } func (x *Variable) Reset() { diff --git a/sdk-go/common/model/wf_run.pb.go b/sdk-go/common/model/wf_run.pb.go index 6f707970a..641c7e703 100644 --- a/sdk-go/common/model/wf_run.pb.go +++ b/sdk-go/common/model/wf_run.pb.go @@ -21,12 +21,18 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) +// The type of a ThreadRUn. type ThreadType int32 const ( - ThreadType_ENTRYPOINT ThreadType = 0 - ThreadType_CHILD ThreadType = 1 - ThreadType_INTERRUPT ThreadType = 2 + // The ENTRYPOINT ThreadRun. Exactly one per WfRun. Always has number == 0. + ThreadType_ENTRYPOINT ThreadType = 0 + // A ThreadRun explicitly created by another ThreadRun via a START_THREAD or START_MULTIPLE_THREADS + // NodeRun. + ThreadType_CHILD ThreadType = 1 + // A ThreadRun that was created to handle an Interrupt. + ThreadType_INTERRUPT ThreadType = 2 + // A ThreadRun that was created to handle a Failure. ThreadType_FAILURE_HANDLER ThreadType = 3 ) @@ -73,23 +79,41 @@ func (ThreadType) EnumDescriptor() ([]byte, []int) { return file_wf_run_proto_rawDescGZIP(), []int{0} } +// A WfRun is a running instance of a WfSpec. type WfRun struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - Id *WfRunId `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - WfSpecId *WfSpecId `protobuf:"bytes,2,opt,name=wf_spec_id,json=wfSpecId,proto3" json:"wf_spec_id,omitempty"` + // The ID of the WfRun. + Id *WfRunId `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` + // The ID of the WfSpec that this WfRun belongs to. + WfSpecId *WfSpecId `protobuf:"bytes,2,opt,name=wf_spec_id,json=wfSpecId,proto3" json:"wf_spec_id,omitempty"` + // When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the + // old WfSpecId to this list for historical auditing and debugging purposes. OldWfSpecVersions []*WfSpecId `protobuf:"bytes,3,rep,name=old_wf_spec_versions,json=oldWfSpecVersions,proto3" json:"old_wf_spec_versions,omitempty"` - Status LHStatus `protobuf:"varint,4,opt,name=status,proto3,enum=littlehorse.LHStatus" json:"status,omitempty"` + // The status of this WfRun. + Status LHStatus `protobuf:"varint,4,opt,name=status,proto3,enum=littlehorse.LHStatus" json:"status,omitempty"` + // The ID number of the greatest ThreadRUn in this WfRun. The total number of ThreadRuns + // is given by greatest_thread_run_number + 1. + // // Introduced now since with ThreadRun-level retention, we can't rely upon - // thread_runs.size() to determine the number of ThreadRuns. - GreatestThreadrunNumber int32 `protobuf:"varint,5,opt,name=greatest_threadrun_number,json=greatestThreadrunNumber,proto3" json:"greatest_threadrun_number,omitempty"` - StartTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"` - EndTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=end_time,json=endTime,proto3,oneof" json:"end_time,omitempty"` - ThreadRuns []*ThreadRun `protobuf:"bytes,8,rep,name=thread_runs,json=threadRuns,proto3" json:"thread_runs,omitempty"` - PendingInterrupts []*PendingInterrupt `protobuf:"bytes,9,rep,name=pending_interrupts,json=pendingInterrupts,proto3" json:"pending_interrupts,omitempty"` - PendingFailures []*PendingFailureHandler `protobuf:"bytes,10,rep,name=pending_failures,json=pendingFailures,proto3" json:"pending_failures,omitempty"` + // thread_runs.size() to determine the number of ThreadRuns, as a ThreadRun is removed + // from the thread_runs list once its retention period expires. + GreatestThreadrunNumber int32 `protobuf:"varint,5,opt,name=greatest_threadrun_number,json=greatestThreadrunNumber,proto3" json:"greatest_threadrun_number,omitempty"` + // The time the WfRun was started. + StartTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"` + // The time the WfRun failed or completed. + EndTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=end_time,json=endTime,proto3,oneof" json:"end_time,omitempty"` + // A list of all active ThreadRun's and terminated ThreadRun's whose retention periods + // have not yet expired. + ThreadRuns []*ThreadRun `protobuf:"bytes,8,rep,name=thread_runs,json=threadRuns,proto3" json:"thread_runs,omitempty"` + // A list of Interrupt events that will fire once their appropriate ThreadRun's finish + // halting. + PendingInterrupts []*PendingInterrupt `protobuf:"bytes,9,rep,name=pending_interrupts,json=pendingInterrupts,proto3" json:"pending_interrupts,omitempty"` + // A list of pending failure handlers which will fire once their appropriate ThreadRun's + // finish halting. + PendingFailures []*PendingFailureHandler `protobuf:"bytes,10,rep,name=pending_failures,json=pendingFailures,proto3" json:"pending_failures,omitempty"` } func (x *WfRun) Reset() { @@ -194,26 +218,59 @@ func (x *WfRun) GetPendingFailures() []*PendingFailureHandler { return nil } +// A ThreadRun is a running thread of execution within a WfRun. type ThreadRun struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - WfSpecId *WfSpecId `protobuf:"bytes,1,opt,name=wf_spec_id,json=wfSpecId,proto3" json:"wf_spec_id,omitempty"` - Number int32 `protobuf:"varint,2,opt,name=number,proto3" json:"number,omitempty"` - Status LHStatus `protobuf:"varint,3,opt,name=status,proto3,enum=littlehorse.LHStatus" json:"status,omitempty"` - ThreadSpecName string `protobuf:"bytes,4,opt,name=thread_spec_name,json=threadSpecName,proto3" json:"thread_spec_name,omitempty"` - StartTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"` - EndTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=end_time,json=endTime,proto3,oneof" json:"end_time,omitempty"` - ErrorMessage *string `protobuf:"bytes,7,opt,name=error_message,json=errorMessage,proto3,oneof" json:"error_message,omitempty"` - ChildThreadIds []int32 `protobuf:"varint,8,rep,packed,name=child_thread_ids,json=childThreadIds,proto3" json:"child_thread_ids,omitempty"` - ParentThreadId *int32 `protobuf:"varint,9,opt,name=parent_thread_id,json=parentThreadId,proto3,oneof" json:"parent_thread_id,omitempty"` - HaltReasons []*ThreadHaltReason `protobuf:"bytes,10,rep,name=halt_reasons,json=haltReasons,proto3" json:"halt_reasons,omitempty"` - InterruptTriggerId *ExternalEventId `protobuf:"bytes,11,opt,name=interrupt_trigger_id,json=interruptTriggerId,proto3,oneof" json:"interrupt_trigger_id,omitempty"` - FailureBeingHandled *FailureBeingHandled `protobuf:"bytes,12,opt,name=failure_being_handled,json=failureBeingHandled,proto3,oneof" json:"failure_being_handled,omitempty"` - CurrentNodePosition int32 `protobuf:"varint,13,opt,name=current_node_position,json=currentNodePosition,proto3" json:"current_node_position,omitempty"` - HandledFailedChildren []int32 `protobuf:"varint,14,rep,packed,name=handled_failed_children,json=handledFailedChildren,proto3" json:"handled_failed_children,omitempty"` - Type ThreadType `protobuf:"varint,15,opt,name=type,proto3,enum=littlehorse.ThreadType" json:"type,omitempty"` + // The current WfSpecId of this ThreadRun. This must be set explicitly because + // during a WfSpec Version Migration, it is possible for different ThreadSpec's to + // have different WfSpec versions. + WfSpecId *WfSpecId `protobuf:"bytes,1,opt,name=wf_spec_id,json=wfSpecId,proto3" json:"wf_spec_id,omitempty"` + // The number of the ThreadRun. This is an auto-incremented integer corresponding to + // the chronological ordering of when the ThreadRun's were created. If you have not + // configured any retention policy for the ThreadRun's (i.e. never clean them up), then + // this also corresponds to the position of the ThreadRun in the WfRun's `thread_runs` + // list. + Number int32 `protobuf:"varint,2,opt,name=number,proto3" json:"number,omitempty"` + // The status of the ThreadRun. + Status LHStatus `protobuf:"varint,3,opt,name=status,proto3,enum=littlehorse.LHStatus" json:"status,omitempty"` + // The name of the ThreadSpec being run. + ThreadSpecName string `protobuf:"bytes,4,opt,name=thread_spec_name,json=threadSpecName,proto3" json:"thread_spec_name,omitempty"` + // The time the ThreadRun was started. + StartTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"` + // The time the ThreadRun was completed or failed. Unset if still active. + EndTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=end_time,json=endTime,proto3,oneof" json:"end_time,omitempty"` + // Human-readable error message detailing what went wrong in the case of a failure. + ErrorMessage *string `protobuf:"bytes,7,opt,name=error_message,json=errorMessage,proto3,oneof" json:"error_message,omitempty"` + // List of thread_run_number's for all child thread_runs. + ChildThreadIds []int32 `protobuf:"varint,8,rep,packed,name=child_thread_ids,json=childThreadIds,proto3" json:"child_thread_ids,omitempty"` + // Set for every ThreadRun except the ENTRYPOINT. This is the id of the parent thread. + ParentThreadId *int32 `protobuf:"varint,9,opt,name=parent_thread_id,json=parentThreadId,proto3,oneof" json:"parent_thread_id,omitempty"` + // If the ThreadRun is HALTED, this contains a list of every reason for which the + // ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list), + // then the ThreadRun will return to the RUNNING state. + HaltReasons []*ThreadHaltReason `protobuf:"bytes,10,rep,name=halt_reasons,json=haltReasons,proto3" json:"halt_reasons,omitempty"` + // If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the + // ExternalEvent that caused the Interrupt. + InterruptTriggerId *ExternalEventId `protobuf:"bytes,11,opt,name=interrupt_trigger_id,json=interruptTriggerId,proto3,oneof" json:"interrupt_trigger_id,omitempty"` + // If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure + // that is being handled by this ThreadRun. + FailureBeingHandled *FailureBeingHandled `protobuf:"bytes,12,opt,name=failure_being_handled,json=failureBeingHandled,proto3,oneof" json:"failure_being_handled,omitempty"` + // This is the current `position` of the current NodeRun being run. This is an + // auto-incremented field that gets incremented every time we run a new NodeRun. + CurrentNodePosition int32 `protobuf:"varint,13,opt,name=current_node_position,json=currentNodePosition,proto3" json:"current_node_position,omitempty"` + // List of every child ThreadRun which both a) failed, and b) was properly handled by a + // Failure Handler. + // + // This is important because at the EXIT node, if a Child ThreadRun was discovered to have + // failed, then this ThreadRun (the parent) also fails with the same failure as the child. + // If, however, a Failure Handler had previously "handled" the Child Failure, that ThreadRun's + // number is appended to this list, and then the EXIT node ignores that ThreadRun. + HandledFailedChildren []int32 `protobuf:"varint,14,rep,packed,name=handled_failed_children,json=handledFailedChildren,proto3" json:"handled_failed_children,omitempty"` + // The Type of this ThreadRun. + Type ThreadType `protobuf:"varint,15,opt,name=type,proto3,enum=littlehorse.ThreadType" json:"type,omitempty"` } func (x *ThreadRun) Reset() { @@ -353,14 +410,18 @@ func (x *ThreadRun) GetType() ThreadType { return ThreadType_ENTRYPOINT } +// Points to the Failure that is currently being handled in the ThreadRun. type FailureBeingHandled struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The thread run number. ThreadRunNumber int32 `protobuf:"varint,1,opt,name=thread_run_number,json=threadRunNumber,proto3" json:"thread_run_number,omitempty"` + // The position of the NodeRun causing the failure. NodeRunPosition int32 `protobuf:"varint,2,opt,name=node_run_position,json=nodeRunPosition,proto3" json:"node_run_position,omitempty"` - FailureNumber int32 `protobuf:"varint,3,opt,name=failure_number,json=failureNumber,proto3" json:"failure_number,omitempty"` + // The number of the failure. + FailureNumber int32 `protobuf:"varint,3,opt,name=failure_number,json=failureNumber,proto3" json:"failure_number,omitempty"` } func (x *FailureBeingHandled) Reset() { @@ -416,14 +477,20 @@ func (x *FailureBeingHandled) GetFailureNumber() int32 { return 0 } +// Represents an ExternalEvent that has a registered Interrupt Handler for it +// and which is pending to be sent to the relevant ThreadRun's. type PendingInterrupt struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - ExternalEventId *ExternalEventId `protobuf:"bytes,1,opt,name=external_event_id,json=externalEventId,proto3" json:"external_event_id,omitempty"` - HandlerSpecName string `protobuf:"bytes,2,opt,name=handler_spec_name,json=handlerSpecName,proto3" json:"handler_spec_name,omitempty"` - InterruptedThreadId int32 `protobuf:"varint,3,opt,name=interrupted_thread_id,json=interruptedThreadId,proto3" json:"interrupted_thread_id,omitempty"` + // The ID of the ExternalEvent triggering the Interrupt. + ExternalEventId *ExternalEventId `protobuf:"bytes,1,opt,name=external_event_id,json=externalEventId,proto3" json:"external_event_id,omitempty"` + // The name of the ThreadSpec to run to handle the Interrupt. + HandlerSpecName string `protobuf:"bytes,2,opt,name=handler_spec_name,json=handlerSpecName,proto3" json:"handler_spec_name,omitempty"` + // The ID of the ThreadRun to interrupt. Must wait for this ThreadRun to be + // HALTED before running the Interrupt Handler. + InterruptedThreadId int32 `protobuf:"varint,3,opt,name=interrupted_thread_id,json=interruptedThreadId,proto3" json:"interrupted_thread_id,omitempty"` } func (x *PendingInterrupt) Reset() { @@ -479,12 +546,15 @@ func (x *PendingInterrupt) GetInterruptedThreadId() int32 { return 0 } +// Represents a Failure Handler that is pending to be run. type PendingFailureHandler struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - FailedThreadRun int32 `protobuf:"varint,1,opt,name=failed_thread_run,json=failedThreadRun,proto3" json:"failed_thread_run,omitempty"` + // The ThreadRun that failed. + FailedThreadRun int32 `protobuf:"varint,1,opt,name=failed_thread_run,json=failedThreadRun,proto3" json:"failed_thread_run,omitempty"` + // The name of the ThreadSpec to run to handle the failure. HandlerSpecName string `protobuf:"bytes,2,opt,name=handler_spec_name,json=handlerSpecName,proto3" json:"handler_spec_name,omitempty"` } @@ -534,11 +604,14 @@ func (x *PendingFailureHandler) GetHandlerSpecName() string { return "" } +// A Halt Reason denoting that a ThreadRun is halted while waiting for an Interrupt handler +// to be run. type PendingInterruptHaltReason struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The ExternalEventId that caused the Interrupt. ExternalEventId *ExternalEventId `protobuf:"bytes,1,opt,name=external_event_id,json=externalEventId,proto3" json:"external_event_id,omitempty"` } @@ -581,11 +654,14 @@ func (x *PendingInterruptHaltReason) GetExternalEventId() *ExternalEventId { return nil } +// A Halt Reason denoting that a ThreadRun is halted while a Failure Handler is *enqueued* to be +// run. type PendingFailureHandlerHaltReason struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The position of the NodeRun which threw the failure. NodeRunPosition int32 `protobuf:"varint,1,opt,name=node_run_position,json=nodeRunPosition,proto3" json:"node_run_position,omitempty"` } @@ -628,11 +704,13 @@ func (x *PendingFailureHandlerHaltReason) GetNodeRunPosition() int32 { return 0 } +// A Halt Reason denoting that a ThreadRun is halted while a Failure Handler is being run. type HandlingFailureHaltReason struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The ID of the Failure Handler ThreadRun. HandlerThreadId int32 `protobuf:"varint,1,opt,name=handler_thread_id,json=handlerThreadId,proto3" json:"handler_thread_id,omitempty"` } @@ -675,11 +753,13 @@ func (x *HandlingFailureHaltReason) GetHandlerThreadId() int32 { return 0 } +// A Halt Reason denoting that a ThreadRun is halted because its parent is also HALTED. type ParentHalted struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The ID of the halted parent. ParentThreadId int32 `protobuf:"varint,1,opt,name=parent_thread_id,json=parentThreadId,proto3" json:"parent_thread_id,omitempty"` } @@ -722,11 +802,14 @@ func (x *ParentHalted) GetParentThreadId() int32 { return 0 } +// A Halt Reason denoting that a ThreadRun is halted because it is waiting for the +// interrupt handler threadRun to run. type Interrupted struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The ID of the Interrupt Handler ThreadRun. InterruptThreadId int32 `protobuf:"varint,1,opt,name=interrupt_thread_id,json=interruptThreadId,proto3" json:"interrupt_thread_id,omitempty"` } @@ -769,6 +852,7 @@ func (x *Interrupted) GetInterruptThreadId() int32 { return 0 } +// A Halt Reason denoting that a ThreadRun was halted manually, via the `rpc StopWfRun` request. type ManualHalt struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache @@ -817,11 +901,14 @@ func (x *ManualHalt) GetMeaningOfLife() bool { return false } +// Denotes a reason why a ThreadRun is halted. See `ThreadRun.halt_reasons` for context. type ThreadHaltReason struct { state protoimpl.MessageState sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields + // The reason for the halt. + // // Types that are assignable to Reason: // *ThreadHaltReason_ParentHalted // *ThreadHaltReason_Interrupted @@ -918,26 +1005,32 @@ type isThreadHaltReason_Reason interface { } type ThreadHaltReason_ParentHalted struct { + // Parent threadRun halted. ParentHalted *ParentHalted `protobuf:"bytes,1,opt,name=parent_halted,json=parentHalted,proto3,oneof"` } type ThreadHaltReason_Interrupted struct { + // Handling an Interrupt. Interrupted *Interrupted `protobuf:"bytes,2,opt,name=interrupted,proto3,oneof"` } type ThreadHaltReason_PendingInterrupt struct { + // Waiting to handle Interrupt. PendingInterrupt *PendingInterruptHaltReason `protobuf:"bytes,3,opt,name=pending_interrupt,json=pendingInterrupt,proto3,oneof"` } type ThreadHaltReason_PendingFailure struct { + // Waiting to handle a failure. PendingFailure *PendingFailureHandlerHaltReason `protobuf:"bytes,4,opt,name=pending_failure,json=pendingFailure,proto3,oneof"` } type ThreadHaltReason_HandlingFailure struct { + // Handling a failure. HandlingFailure *HandlingFailureHaltReason `protobuf:"bytes,5,opt,name=handling_failure,json=handlingFailure,proto3,oneof"` } type ThreadHaltReason_ManualHalt struct { + // Manually stopped the WfRun. ManualHalt *ManualHalt `protobuf:"bytes,6,opt,name=manual_halt,json=manualHalt,proto3,oneof"` } diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/Comparator.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/Comparator.java index 461fd0ce5..c843adca9 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/Comparator.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/Comparator.java @@ -4,39 +4,83 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * Operator for comparing two values to create a boolean expression.
+ * 
+ * * Protobuf enum {@code littlehorse.Comparator} */ public enum Comparator implements com.google.protobuf.ProtocolMessageEnum { /** + *
+   * Equivalent to `<`. Only valid for primitive types (no JSON_OBJ or JSON_ARR).
+   * 
+ * * LESS_THAN = 0; */ LESS_THAN(0), /** + *
+   * Equivalent to `>`. Only valid for primitive types (no JSON_OBJ or JSON_ARR).
+   * 
+ * * GREATER_THAN = 1; */ GREATER_THAN(1), /** + *
+   * Equivalent to `<=`. Only valid for primitive types (no JSON_OBJ or JSON_ARR).
+   * 
+ * * LESS_THAN_EQ = 2; */ LESS_THAN_EQ(2), /** + *
+   * Equivalent to `>=`. Only valid for primitive types (no JSON_OBJ or JSON_ARR).
+   * 
+ * * GREATER_THAN_EQ = 3; */ GREATER_THAN_EQ(3), /** + *
+   * This is valid for any variable type, and is similar to .equals() in Java.
+   *
+   * One note: if the RHS is a different type from the LHS, then LittleHorse will
+   * try to cast the RHS to the same type as the LHS. If the cast fails, then the
+   * ThreadRun fails with a VAR_SUB_ERROR.
+   * 
+ * * EQUALS = 4; */ EQUALS(4), /** + *
+   * This is the inverse of `EQUALS`
+   * 
+ * * NOT_EQUALS = 5; */ NOT_EQUALS(5), /** + *
+   * Only valid if the RHS is a JSON_OBJ or JSON_ARR. Valid for any type on the LHS.
+   *
+   * For the JSON_OBJ type, this returns true if the LHS is equal to a *KEY* in the
+   * RHS. For the JSON_ARR type, it returns true if one of the elements of the RHS
+   * is equal to the LHS.
+   * 
+ * * IN = 6; */ IN(6), /** + *
+   * The inverse of IN.
+   * 
+ * * NOT_IN = 7; */ NOT_IN(7), @@ -44,34 +88,74 @@ public enum Comparator ; /** + *
+   * Equivalent to `<`. Only valid for primitive types (no JSON_OBJ or JSON_ARR).
+   * 
+ * * LESS_THAN = 0; */ public static final int LESS_THAN_VALUE = 0; /** + *
+   * Equivalent to `>`. Only valid for primitive types (no JSON_OBJ or JSON_ARR).
+   * 
+ * * GREATER_THAN = 1; */ public static final int GREATER_THAN_VALUE = 1; /** + *
+   * Equivalent to `<=`. Only valid for primitive types (no JSON_OBJ or JSON_ARR).
+   * 
+ * * LESS_THAN_EQ = 2; */ public static final int LESS_THAN_EQ_VALUE = 2; /** + *
+   * Equivalent to `>=`. Only valid for primitive types (no JSON_OBJ or JSON_ARR).
+   * 
+ * * GREATER_THAN_EQ = 3; */ public static final int GREATER_THAN_EQ_VALUE = 3; /** + *
+   * This is valid for any variable type, and is similar to .equals() in Java.
+   *
+   * One note: if the RHS is a different type from the LHS, then LittleHorse will
+   * try to cast the RHS to the same type as the LHS. If the cast fails, then the
+   * ThreadRun fails with a VAR_SUB_ERROR.
+   * 
+ * * EQUALS = 4; */ public static final int EQUALS_VALUE = 4; /** + *
+   * This is the inverse of `EQUALS`
+   * 
+ * * NOT_EQUALS = 5; */ public static final int NOT_EQUALS_VALUE = 5; /** + *
+   * Only valid if the RHS is a JSON_OBJ or JSON_ARR. Valid for any type on the LHS.
+   *
+   * For the JSON_OBJ type, this returns true if the LHS is equal to a *KEY* in the
+   * RHS. For the JSON_ARR type, it returns true if one of the elements of the RHS
+   * is equal to the LHS.
+   * 
+ * * IN = 6; */ public static final int IN_VALUE = 6; /** + *
+   * The inverse of IN.
+   * 
+ * * NOT_IN = 7; */ public static final int NOT_IN_VALUE = 7; diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/EntrypointRun.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/EntrypointRun.java index eb1392867..6c918981e 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/EntrypointRun.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/EntrypointRun.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * The sub-node structure for an ENTRYPOINT NodeRun. Currently Empty.
+ * 
+ * * Protobuf type {@code littlehorse.EntrypointRun} */ public final class EntrypointRun extends @@ -185,6 +189,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * The sub-node structure for an ENTRYPOINT NodeRun. Currently Empty.
+   * 
+ * * Protobuf type {@code littlehorse.EntrypointRun} */ public static final class Builder extends diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExitRun.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExitRun.java index b6f0c8fc9..1e77e128b 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExitRun.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExitRun.java @@ -4,6 +4,11 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * The sub-node structure for an EXIT NodeRun. Currently Empty, will contain info
+ * about ThreadRun Outputs once those are added in the future.
+ * 
+ * * Protobuf type {@code littlehorse.ExitRun} */ public final class ExitRun extends @@ -185,6 +190,11 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * The sub-node structure for an EXIT NodeRun. Currently Empty, will contain info
+   * about ThreadRun Outputs once those are added in the future.
+   * 
+ * * Protobuf type {@code littlehorse.ExitRun} */ public static final class Builder extends diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEvent.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEvent.java index befd80c52..518e29d01 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEvent.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEvent.java @@ -4,6 +4,17 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * An ExternalEvent represents A Thing That Happened outside the context of a WfRun.
+ * Generally, an ExternalEvent is used to represent a document getting signed, an incident
+ * being resolved, an order being fulfilled, etc.
+ *
+ * ExternalEvent's are created via the 'rpc PutExternalEvent'
+ *
+ * For more context on ExternalEvents, check our documentation here:
+ * https://littlehorse.dev/docs/concepts/external-events
+ * 
+ * * Protobuf type {@code littlehorse.ExternalEvent} */ public final class ExternalEvent extends @@ -42,6 +53,12 @@ protected java.lang.Object newInstance( public static final int ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.ExternalEventId id_; /** + *
+   * The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId,
+   * and a unique guid which can be used for idempotency of the `PutExternalEvent`
+   * rpc call.
+   * 
+ * * .littlehorse.ExternalEventId id = 1; * @return Whether the id field is set. */ @@ -50,6 +67,12 @@ public boolean hasId() { return id_ != null; } /** + *
+   * The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId,
+   * and a unique guid which can be used for idempotency of the `PutExternalEvent`
+   * rpc call.
+   * 
+ * * .littlehorse.ExternalEventId id = 1; * @return The id. */ @@ -58,6 +81,12 @@ public io.littlehorse.sdk.common.proto.ExternalEventId getId() { return id_ == null ? io.littlehorse.sdk.common.proto.ExternalEventId.getDefaultInstance() : id_; } /** + *
+   * The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId,
+   * and a unique guid which can be used for idempotency of the `PutExternalEvent`
+   * rpc call.
+   * 
+ * * .littlehorse.ExternalEventId id = 1; */ @java.lang.Override @@ -68,6 +97,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getIdOrBuilder() public static final int CREATED_AT_FIELD_NUMBER = 2; private com.google.protobuf.Timestamp createdAt_; /** + *
+   * The time the ExternalEvent was registered with LittleHorse.
+   * 
+ * * .google.protobuf.Timestamp created_at = 2; * @return Whether the createdAt field is set. */ @@ -76,6 +109,10 @@ public boolean hasCreatedAt() { return createdAt_ != null; } /** + *
+   * The time the ExternalEvent was registered with LittleHorse.
+   * 
+ * * .google.protobuf.Timestamp created_at = 2; * @return The createdAt. */ @@ -84,6 +121,10 @@ public com.google.protobuf.Timestamp getCreatedAt() { return createdAt_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : createdAt_; } /** + *
+   * The time the ExternalEvent was registered with LittleHorse.
+   * 
+ * * .google.protobuf.Timestamp created_at = 2; */ @java.lang.Override @@ -94,6 +135,10 @@ public com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder() { public static final int CONTENT_FIELD_NUMBER = 3; private io.littlehorse.sdk.common.proto.VariableValue content_; /** + *
+   * The payload of this ExternalEvent.
+   * 
+ * * .littlehorse.VariableValue content = 3; * @return Whether the content field is set. */ @@ -102,6 +147,10 @@ public boolean hasContent() { return content_ != null; } /** + *
+   * The payload of this ExternalEvent.
+   * 
+ * * .littlehorse.VariableValue content = 3; * @return The content. */ @@ -110,6 +159,10 @@ public io.littlehorse.sdk.common.proto.VariableValue getContent() { return content_ == null ? io.littlehorse.sdk.common.proto.VariableValue.getDefaultInstance() : content_; } /** + *
+   * The payload of this ExternalEvent.
+   * 
+ * * .littlehorse.VariableValue content = 3; */ @java.lang.Override @@ -120,6 +173,11 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getContentOrBuilde public static final int THREAD_RUN_NUMBER_FIELD_NUMBER = 4; private int threadRunNumber_ = 0; /** + *
+   * If the ExternalEvent was claimed by a specific ThreadRun (via Interrupt or
+   * EXTERNAL_EVENT Node), this is set to the number of the relevant ThreadRun.
+   * 
+ * * optional int32 thread_run_number = 4; * @return Whether the threadRunNumber field is set. */ @@ -128,6 +186,11 @@ public boolean hasThreadRunNumber() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+   * If the ExternalEvent was claimed by a specific ThreadRun (via Interrupt or
+   * EXTERNAL_EVENT Node), this is set to the number of the relevant ThreadRun.
+   * 
+ * * optional int32 thread_run_number = 4; * @return The threadRunNumber. */ @@ -139,6 +202,12 @@ public int getThreadRunNumber() { public static final int NODE_RUN_POSITION_FIELD_NUMBER = 5; private int nodeRunPosition_ = 0; /** + *
+   * If the ExternalEvent was claimed by a specific ThreadRun (via EXTERNAL_EVENT
+   * Node; note that in the case of an Interrupt the node_run_position will never
+   * be set), this is set to the number of the relevant NodeRun.
+   * 
+ * * optional int32 node_run_position = 5; * @return Whether the nodeRunPosition field is set. */ @@ -147,6 +216,12 @@ public boolean hasNodeRunPosition() { return ((bitField0_ & 0x00000002) != 0); } /** + *
+   * If the ExternalEvent was claimed by a specific ThreadRun (via EXTERNAL_EVENT
+   * Node; note that in the case of an Interrupt the node_run_position will never
+   * be set), this is set to the number of the relevant NodeRun.
+   * 
+ * * optional int32 node_run_position = 5; * @return The nodeRunPosition. */ @@ -158,6 +233,10 @@ public int getNodeRunPosition() { public static final int CLAIMED_FIELD_NUMBER = 6; private boolean claimed_ = false; /** + *
+   * Whether the ExternalEvent has been claimed by a WfRun.
+   * 
+ * * bool claimed = 6; * @return The claimed. */ @@ -405,6 +484,17 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * An ExternalEvent represents A Thing That Happened outside the context of a WfRun.
+   * Generally, an ExternalEvent is used to represent a document getting signed, an incident
+   * being resolved, an order being fulfilled, etc.
+   *
+   * ExternalEvent's are created via the 'rpc PutExternalEvent'
+   *
+   * For more context on ExternalEvents, check our documentation here:
+   * https://littlehorse.dev/docs/concepts/external-events
+   * 
+ * * Protobuf type {@code littlehorse.ExternalEvent} */ public static final class Builder extends @@ -664,6 +754,12 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.ExternalEventId, io.littlehorse.sdk.common.proto.ExternalEventId.Builder, io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder> idBuilder_; /** + *
+     * The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId,
+     * and a unique guid which can be used for idempotency of the `PutExternalEvent`
+     * rpc call.
+     * 
+ * * .littlehorse.ExternalEventId id = 1; * @return Whether the id field is set. */ @@ -671,6 +767,12 @@ public boolean hasId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId,
+     * and a unique guid which can be used for idempotency of the `PutExternalEvent`
+     * rpc call.
+     * 
+ * * .littlehorse.ExternalEventId id = 1; * @return The id. */ @@ -682,6 +784,12 @@ public io.littlehorse.sdk.common.proto.ExternalEventId getId() { } } /** + *
+     * The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId,
+     * and a unique guid which can be used for idempotency of the `PutExternalEvent`
+     * rpc call.
+     * 
+ * * .littlehorse.ExternalEventId id = 1; */ public Builder setId(io.littlehorse.sdk.common.proto.ExternalEventId value) { @@ -698,6 +806,12 @@ public Builder setId(io.littlehorse.sdk.common.proto.ExternalEventId value) { return this; } /** + *
+     * The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId,
+     * and a unique guid which can be used for idempotency of the `PutExternalEvent`
+     * rpc call.
+     * 
+ * * .littlehorse.ExternalEventId id = 1; */ public Builder setId( @@ -712,6 +826,12 @@ public Builder setId( return this; } /** + *
+     * The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId,
+     * and a unique guid which can be used for idempotency of the `PutExternalEvent`
+     * rpc call.
+     * 
+ * * .littlehorse.ExternalEventId id = 1; */ public Builder mergeId(io.littlehorse.sdk.common.proto.ExternalEventId value) { @@ -731,6 +851,12 @@ public Builder mergeId(io.littlehorse.sdk.common.proto.ExternalEventId value) { return this; } /** + *
+     * The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId,
+     * and a unique guid which can be used for idempotency of the `PutExternalEvent`
+     * rpc call.
+     * 
+ * * .littlehorse.ExternalEventId id = 1; */ public Builder clearId() { @@ -744,6 +870,12 @@ public Builder clearId() { return this; } /** + *
+     * The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId,
+     * and a unique guid which can be used for idempotency of the `PutExternalEvent`
+     * rpc call.
+     * 
+ * * .littlehorse.ExternalEventId id = 1; */ public io.littlehorse.sdk.common.proto.ExternalEventId.Builder getIdBuilder() { @@ -752,6 +884,12 @@ public io.littlehorse.sdk.common.proto.ExternalEventId.Builder getIdBuilder() { return getIdFieldBuilder().getBuilder(); } /** + *
+     * The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId,
+     * and a unique guid which can be used for idempotency of the `PutExternalEvent`
+     * rpc call.
+     * 
+ * * .littlehorse.ExternalEventId id = 1; */ public io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getIdOrBuilder() { @@ -763,6 +901,12 @@ public io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getIdOrBuilder() } } /** + *
+     * The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId,
+     * and a unique guid which can be used for idempotency of the `PutExternalEvent`
+     * rpc call.
+     * 
+ * * .littlehorse.ExternalEventId id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -783,6 +927,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getIdOrBuilder() private com.google.protobuf.SingleFieldBuilderV3< com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> createdAtBuilder_; /** + *
+     * The time the ExternalEvent was registered with LittleHorse.
+     * 
+ * * .google.protobuf.Timestamp created_at = 2; * @return Whether the createdAt field is set. */ @@ -790,6 +938,10 @@ public boolean hasCreatedAt() { return ((bitField0_ & 0x00000002) != 0); } /** + *
+     * The time the ExternalEvent was registered with LittleHorse.
+     * 
+ * * .google.protobuf.Timestamp created_at = 2; * @return The createdAt. */ @@ -801,6 +953,10 @@ public com.google.protobuf.Timestamp getCreatedAt() { } } /** + *
+     * The time the ExternalEvent was registered with LittleHorse.
+     * 
+ * * .google.protobuf.Timestamp created_at = 2; */ public Builder setCreatedAt(com.google.protobuf.Timestamp value) { @@ -817,6 +973,10 @@ public Builder setCreatedAt(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the ExternalEvent was registered with LittleHorse.
+     * 
+ * * .google.protobuf.Timestamp created_at = 2; */ public Builder setCreatedAt( @@ -831,6 +991,10 @@ public Builder setCreatedAt( return this; } /** + *
+     * The time the ExternalEvent was registered with LittleHorse.
+     * 
+ * * .google.protobuf.Timestamp created_at = 2; */ public Builder mergeCreatedAt(com.google.protobuf.Timestamp value) { @@ -850,6 +1014,10 @@ public Builder mergeCreatedAt(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the ExternalEvent was registered with LittleHorse.
+     * 
+ * * .google.protobuf.Timestamp created_at = 2; */ public Builder clearCreatedAt() { @@ -863,6 +1031,10 @@ public Builder clearCreatedAt() { return this; } /** + *
+     * The time the ExternalEvent was registered with LittleHorse.
+     * 
+ * * .google.protobuf.Timestamp created_at = 2; */ public com.google.protobuf.Timestamp.Builder getCreatedAtBuilder() { @@ -871,6 +1043,10 @@ public com.google.protobuf.Timestamp.Builder getCreatedAtBuilder() { return getCreatedAtFieldBuilder().getBuilder(); } /** + *
+     * The time the ExternalEvent was registered with LittleHorse.
+     * 
+ * * .google.protobuf.Timestamp created_at = 2; */ public com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder() { @@ -882,6 +1058,10 @@ public com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder() { } } /** + *
+     * The time the ExternalEvent was registered with LittleHorse.
+     * 
+ * * .google.protobuf.Timestamp created_at = 2; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -902,6 +1082,10 @@ public com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder() { private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.VariableValue, io.littlehorse.sdk.common.proto.VariableValue.Builder, io.littlehorse.sdk.common.proto.VariableValueOrBuilder> contentBuilder_; /** + *
+     * The payload of this ExternalEvent.
+     * 
+ * * .littlehorse.VariableValue content = 3; * @return Whether the content field is set. */ @@ -909,6 +1093,10 @@ public boolean hasContent() { return ((bitField0_ & 0x00000004) != 0); } /** + *
+     * The payload of this ExternalEvent.
+     * 
+ * * .littlehorse.VariableValue content = 3; * @return The content. */ @@ -920,6 +1108,10 @@ public io.littlehorse.sdk.common.proto.VariableValue getContent() { } } /** + *
+     * The payload of this ExternalEvent.
+     * 
+ * * .littlehorse.VariableValue content = 3; */ public Builder setContent(io.littlehorse.sdk.common.proto.VariableValue value) { @@ -936,6 +1128,10 @@ public Builder setContent(io.littlehorse.sdk.common.proto.VariableValue value) { return this; } /** + *
+     * The payload of this ExternalEvent.
+     * 
+ * * .littlehorse.VariableValue content = 3; */ public Builder setContent( @@ -950,6 +1146,10 @@ public Builder setContent( return this; } /** + *
+     * The payload of this ExternalEvent.
+     * 
+ * * .littlehorse.VariableValue content = 3; */ public Builder mergeContent(io.littlehorse.sdk.common.proto.VariableValue value) { @@ -969,6 +1169,10 @@ public Builder mergeContent(io.littlehorse.sdk.common.proto.VariableValue value) return this; } /** + *
+     * The payload of this ExternalEvent.
+     * 
+ * * .littlehorse.VariableValue content = 3; */ public Builder clearContent() { @@ -982,6 +1186,10 @@ public Builder clearContent() { return this; } /** + *
+     * The payload of this ExternalEvent.
+     * 
+ * * .littlehorse.VariableValue content = 3; */ public io.littlehorse.sdk.common.proto.VariableValue.Builder getContentBuilder() { @@ -990,6 +1198,10 @@ public io.littlehorse.sdk.common.proto.VariableValue.Builder getContentBuilder() return getContentFieldBuilder().getBuilder(); } /** + *
+     * The payload of this ExternalEvent.
+     * 
+ * * .littlehorse.VariableValue content = 3; */ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getContentOrBuilder() { @@ -1001,6 +1213,10 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getContentOrBuilde } } /** + *
+     * The payload of this ExternalEvent.
+     * 
+ * * .littlehorse.VariableValue content = 3; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1019,6 +1235,11 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getContentOrBuilde private int threadRunNumber_ ; /** + *
+     * If the ExternalEvent was claimed by a specific ThreadRun (via Interrupt or
+     * EXTERNAL_EVENT Node), this is set to the number of the relevant ThreadRun.
+     * 
+ * * optional int32 thread_run_number = 4; * @return Whether the threadRunNumber field is set. */ @@ -1027,6 +1248,11 @@ public boolean hasThreadRunNumber() { return ((bitField0_ & 0x00000008) != 0); } /** + *
+     * If the ExternalEvent was claimed by a specific ThreadRun (via Interrupt or
+     * EXTERNAL_EVENT Node), this is set to the number of the relevant ThreadRun.
+     * 
+ * * optional int32 thread_run_number = 4; * @return The threadRunNumber. */ @@ -1035,6 +1261,11 @@ public int getThreadRunNumber() { return threadRunNumber_; } /** + *
+     * If the ExternalEvent was claimed by a specific ThreadRun (via Interrupt or
+     * EXTERNAL_EVENT Node), this is set to the number of the relevant ThreadRun.
+     * 
+ * * optional int32 thread_run_number = 4; * @param value The threadRunNumber to set. * @return This builder for chaining. @@ -1047,6 +1278,11 @@ public Builder setThreadRunNumber(int value) { return this; } /** + *
+     * If the ExternalEvent was claimed by a specific ThreadRun (via Interrupt or
+     * EXTERNAL_EVENT Node), this is set to the number of the relevant ThreadRun.
+     * 
+ * * optional int32 thread_run_number = 4; * @return This builder for chaining. */ @@ -1059,6 +1295,12 @@ public Builder clearThreadRunNumber() { private int nodeRunPosition_ ; /** + *
+     * If the ExternalEvent was claimed by a specific ThreadRun (via EXTERNAL_EVENT
+     * Node; note that in the case of an Interrupt the node_run_position will never
+     * be set), this is set to the number of the relevant NodeRun.
+     * 
+ * * optional int32 node_run_position = 5; * @return Whether the nodeRunPosition field is set. */ @@ -1067,6 +1309,12 @@ public boolean hasNodeRunPosition() { return ((bitField0_ & 0x00000010) != 0); } /** + *
+     * If the ExternalEvent was claimed by a specific ThreadRun (via EXTERNAL_EVENT
+     * Node; note that in the case of an Interrupt the node_run_position will never
+     * be set), this is set to the number of the relevant NodeRun.
+     * 
+ * * optional int32 node_run_position = 5; * @return The nodeRunPosition. */ @@ -1075,6 +1323,12 @@ public int getNodeRunPosition() { return nodeRunPosition_; } /** + *
+     * If the ExternalEvent was claimed by a specific ThreadRun (via EXTERNAL_EVENT
+     * Node; note that in the case of an Interrupt the node_run_position will never
+     * be set), this is set to the number of the relevant NodeRun.
+     * 
+ * * optional int32 node_run_position = 5; * @param value The nodeRunPosition to set. * @return This builder for chaining. @@ -1087,6 +1341,12 @@ public Builder setNodeRunPosition(int value) { return this; } /** + *
+     * If the ExternalEvent was claimed by a specific ThreadRun (via EXTERNAL_EVENT
+     * Node; note that in the case of an Interrupt the node_run_position will never
+     * be set), this is set to the number of the relevant NodeRun.
+     * 
+ * * optional int32 node_run_position = 5; * @return This builder for chaining. */ @@ -1099,6 +1359,10 @@ public Builder clearNodeRunPosition() { private boolean claimed_ ; /** + *
+     * Whether the ExternalEvent has been claimed by a WfRun.
+     * 
+ * * bool claimed = 6; * @return The claimed. */ @@ -1107,6 +1371,10 @@ public boolean getClaimed() { return claimed_; } /** + *
+     * Whether the ExternalEvent has been claimed by a WfRun.
+     * 
+ * * bool claimed = 6; * @param value The claimed to set. * @return This builder for chaining. @@ -1119,6 +1387,10 @@ public Builder setClaimed(boolean value) { return this; } /** + *
+     * Whether the ExternalEvent has been claimed by a WfRun.
+     * 
+ * * bool claimed = 6; * @return This builder for chaining. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventDef.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventDef.java index b64b96545..3a8eaa9a3 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventDef.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventDef.java @@ -5,7 +5,7 @@ /** *
- * ExternalEventDef
+ * The ExternalEventDef defines the blueprint for an ExternalEvent.
  * 
* * Protobuf type {@code littlehorse.ExternalEventDef} @@ -47,6 +47,10 @@ protected java.lang.Object newInstance( @SuppressWarnings("serial") private volatile java.lang.Object name_ = ""; /** + *
+   * The name of the ExternalEventDef.
+   * 
+ * * string name = 1; * @return The name. */ @@ -64,6 +68,10 @@ public java.lang.String getName() { } } /** + *
+   * The name of the ExternalEventDef.
+   * 
+ * * string name = 1; * @return The bytes for name. */ @@ -85,6 +93,10 @@ public java.lang.String getName() { public static final int CREATED_AT_FIELD_NUMBER = 2; private com.google.protobuf.Timestamp createdAt_; /** + *
+   * When the ExternalEventDef was created.
+   * 
+ * * .google.protobuf.Timestamp created_at = 2; * @return Whether the createdAt field is set. */ @@ -93,6 +105,10 @@ public boolean hasCreatedAt() { return createdAt_ != null; } /** + *
+   * When the ExternalEventDef was created.
+   * 
+ * * .google.protobuf.Timestamp created_at = 2; * @return The createdAt. */ @@ -101,6 +117,10 @@ public com.google.protobuf.Timestamp getCreatedAt() { return createdAt_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : createdAt_; } /** + *
+   * When the ExternalEventDef was created.
+   * 
+ * * .google.protobuf.Timestamp created_at = 2; */ @java.lang.Override @@ -111,6 +131,11 @@ public com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder() { public static final int RETENTION_POLICY_FIELD_NUMBER = 3; private io.littlehorse.sdk.common.proto.ExternalEventRetentionPolicy retentionPolicy_; /** + *
+   * The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the
+   * ExternalEvent **only before** it is matched with a WfRun.
+   * 
+ * * .littlehorse.ExternalEventRetentionPolicy retention_policy = 3; * @return Whether the retentionPolicy field is set. */ @@ -119,6 +144,11 @@ public boolean hasRetentionPolicy() { return retentionPolicy_ != null; } /** + *
+   * The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the
+   * ExternalEvent **only before** it is matched with a WfRun.
+   * 
+ * * .littlehorse.ExternalEventRetentionPolicy retention_policy = 3; * @return The retentionPolicy. */ @@ -127,6 +157,11 @@ public io.littlehorse.sdk.common.proto.ExternalEventRetentionPolicy getRetention return retentionPolicy_ == null ? io.littlehorse.sdk.common.proto.ExternalEventRetentionPolicy.getDefaultInstance() : retentionPolicy_; } /** + *
+   * The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the
+   * ExternalEvent **only before** it is matched with a WfRun.
+   * 
+ * * .littlehorse.ExternalEventRetentionPolicy retention_policy = 3; */ @java.lang.Override @@ -324,7 +359,7 @@ protected Builder newBuilderForType( } /** *
-   * ExternalEventDef
+   * The ExternalEventDef defines the blueprint for an ExternalEvent.
    * 
* * Protobuf type {@code littlehorse.ExternalEventDef} @@ -538,6 +573,10 @@ public Builder mergeFrom( private java.lang.Object name_ = ""; /** + *
+     * The name of the ExternalEventDef.
+     * 
+ * * string name = 1; * @return The name. */ @@ -554,6 +593,10 @@ public java.lang.String getName() { } } /** + *
+     * The name of the ExternalEventDef.
+     * 
+ * * string name = 1; * @return The bytes for name. */ @@ -571,6 +614,10 @@ public java.lang.String getName() { } } /** + *
+     * The name of the ExternalEventDef.
+     * 
+ * * string name = 1; * @param value The name to set. * @return This builder for chaining. @@ -584,6 +631,10 @@ public Builder setName( return this; } /** + *
+     * The name of the ExternalEventDef.
+     * 
+ * * string name = 1; * @return This builder for chaining. */ @@ -594,6 +645,10 @@ public Builder clearName() { return this; } /** + *
+     * The name of the ExternalEventDef.
+     * 
+ * * string name = 1; * @param value The bytes for name to set. * @return This builder for chaining. @@ -612,6 +667,10 @@ public Builder setNameBytes( private com.google.protobuf.SingleFieldBuilderV3< com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> createdAtBuilder_; /** + *
+     * When the ExternalEventDef was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 2; * @return Whether the createdAt field is set. */ @@ -619,6 +678,10 @@ public boolean hasCreatedAt() { return ((bitField0_ & 0x00000002) != 0); } /** + *
+     * When the ExternalEventDef was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 2; * @return The createdAt. */ @@ -630,6 +693,10 @@ public com.google.protobuf.Timestamp getCreatedAt() { } } /** + *
+     * When the ExternalEventDef was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 2; */ public Builder setCreatedAt(com.google.protobuf.Timestamp value) { @@ -646,6 +713,10 @@ public Builder setCreatedAt(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * When the ExternalEventDef was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 2; */ public Builder setCreatedAt( @@ -660,6 +731,10 @@ public Builder setCreatedAt( return this; } /** + *
+     * When the ExternalEventDef was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 2; */ public Builder mergeCreatedAt(com.google.protobuf.Timestamp value) { @@ -679,6 +754,10 @@ public Builder mergeCreatedAt(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * When the ExternalEventDef was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 2; */ public Builder clearCreatedAt() { @@ -692,6 +771,10 @@ public Builder clearCreatedAt() { return this; } /** + *
+     * When the ExternalEventDef was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 2; */ public com.google.protobuf.Timestamp.Builder getCreatedAtBuilder() { @@ -700,6 +783,10 @@ public com.google.protobuf.Timestamp.Builder getCreatedAtBuilder() { return getCreatedAtFieldBuilder().getBuilder(); } /** + *
+     * When the ExternalEventDef was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 2; */ public com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder() { @@ -711,6 +798,10 @@ public com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder() { } } /** + *
+     * When the ExternalEventDef was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 2; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -731,6 +822,11 @@ public com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder() { private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.ExternalEventRetentionPolicy, io.littlehorse.sdk.common.proto.ExternalEventRetentionPolicy.Builder, io.littlehorse.sdk.common.proto.ExternalEventRetentionPolicyOrBuilder> retentionPolicyBuilder_; /** + *
+     * The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the
+     * ExternalEvent **only before** it is matched with a WfRun.
+     * 
+ * * .littlehorse.ExternalEventRetentionPolicy retention_policy = 3; * @return Whether the retentionPolicy field is set. */ @@ -738,6 +834,11 @@ public boolean hasRetentionPolicy() { return ((bitField0_ & 0x00000004) != 0); } /** + *
+     * The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the
+     * ExternalEvent **only before** it is matched with a WfRun.
+     * 
+ * * .littlehorse.ExternalEventRetentionPolicy retention_policy = 3; * @return The retentionPolicy. */ @@ -749,6 +850,11 @@ public io.littlehorse.sdk.common.proto.ExternalEventRetentionPolicy getRetention } } /** + *
+     * The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the
+     * ExternalEvent **only before** it is matched with a WfRun.
+     * 
+ * * .littlehorse.ExternalEventRetentionPolicy retention_policy = 3; */ public Builder setRetentionPolicy(io.littlehorse.sdk.common.proto.ExternalEventRetentionPolicy value) { @@ -765,6 +871,11 @@ public Builder setRetentionPolicy(io.littlehorse.sdk.common.proto.ExternalEventR return this; } /** + *
+     * The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the
+     * ExternalEvent **only before** it is matched with a WfRun.
+     * 
+ * * .littlehorse.ExternalEventRetentionPolicy retention_policy = 3; */ public Builder setRetentionPolicy( @@ -779,6 +890,11 @@ public Builder setRetentionPolicy( return this; } /** + *
+     * The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the
+     * ExternalEvent **only before** it is matched with a WfRun.
+     * 
+ * * .littlehorse.ExternalEventRetentionPolicy retention_policy = 3; */ public Builder mergeRetentionPolicy(io.littlehorse.sdk.common.proto.ExternalEventRetentionPolicy value) { @@ -798,6 +914,11 @@ public Builder mergeRetentionPolicy(io.littlehorse.sdk.common.proto.ExternalEven return this; } /** + *
+     * The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the
+     * ExternalEvent **only before** it is matched with a WfRun.
+     * 
+ * * .littlehorse.ExternalEventRetentionPolicy retention_policy = 3; */ public Builder clearRetentionPolicy() { @@ -811,6 +932,11 @@ public Builder clearRetentionPolicy() { return this; } /** + *
+     * The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the
+     * ExternalEvent **only before** it is matched with a WfRun.
+     * 
+ * * .littlehorse.ExternalEventRetentionPolicy retention_policy = 3; */ public io.littlehorse.sdk.common.proto.ExternalEventRetentionPolicy.Builder getRetentionPolicyBuilder() { @@ -819,6 +945,11 @@ public io.littlehorse.sdk.common.proto.ExternalEventRetentionPolicy.Builder getR return getRetentionPolicyFieldBuilder().getBuilder(); } /** + *
+     * The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the
+     * ExternalEvent **only before** it is matched with a WfRun.
+     * 
+ * * .littlehorse.ExternalEventRetentionPolicy retention_policy = 3; */ public io.littlehorse.sdk.common.proto.ExternalEventRetentionPolicyOrBuilder getRetentionPolicyOrBuilder() { @@ -830,6 +961,11 @@ public io.littlehorse.sdk.common.proto.ExternalEventRetentionPolicyOrBuilder get } } /** + *
+     * The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the
+     * ExternalEvent **only before** it is matched with a WfRun.
+     * 
+ * * .littlehorse.ExternalEventRetentionPolicy retention_policy = 3; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventDefId.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventDefId.java index 02086541c..a31f79a8b 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventDefId.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventDefId.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * ID for ExternalEventDef
+ * 
+ * * Protobuf type {@code littlehorse.ExternalEventDefId} */ public final class ExternalEventDefId extends @@ -43,6 +47,10 @@ protected java.lang.Object newInstance( @SuppressWarnings("serial") private volatile java.lang.Object name_ = ""; /** + *
+   * ExternalEventDef's are uniquedly identified by their name.
+   * 
+ * * string name = 1; * @return The name. */ @@ -60,6 +68,10 @@ public java.lang.String getName() { } } /** + *
+   * ExternalEventDef's are uniquedly identified by their name.
+   * 
+ * * string name = 1; * @return The bytes for name. */ @@ -235,6 +247,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * ID for ExternalEventDef
+   * 
+ * * Protobuf type {@code littlehorse.ExternalEventDefId} */ public static final class Builder extends @@ -406,6 +422,10 @@ public Builder mergeFrom( private java.lang.Object name_ = ""; /** + *
+     * ExternalEventDef's are uniquedly identified by their name.
+     * 
+ * * string name = 1; * @return The name. */ @@ -422,6 +442,10 @@ public java.lang.String getName() { } } /** + *
+     * ExternalEventDef's are uniquedly identified by their name.
+     * 
+ * * string name = 1; * @return The bytes for name. */ @@ -439,6 +463,10 @@ public java.lang.String getName() { } } /** + *
+     * ExternalEventDef's are uniquedly identified by their name.
+     * 
+ * * string name = 1; * @param value The name to set. * @return This builder for chaining. @@ -452,6 +480,10 @@ public Builder setName( return this; } /** + *
+     * ExternalEventDef's are uniquedly identified by their name.
+     * 
+ * * string name = 1; * @return This builder for chaining. */ @@ -462,6 +494,10 @@ public Builder clearName() { return this; } /** + *
+     * ExternalEventDef's are uniquedly identified by their name.
+     * 
+ * * string name = 1; * @param value The bytes for name to set. * @return This builder for chaining. diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventDefIdOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventDefIdOrBuilder.java index 0a160b359..de2e2475d 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventDefIdOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventDefIdOrBuilder.java @@ -8,11 +8,19 @@ public interface ExternalEventDefIdOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * ExternalEventDef's are uniquedly identified by their name.
+   * 
+ * * string name = 1; * @return The name. */ java.lang.String getName(); /** + *
+   * ExternalEventDef's are uniquedly identified by their name.
+   * 
+ * * string name = 1; * @return The bytes for name. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventDefOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventDefOrBuilder.java index f27cb1d85..be779d041 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventDefOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventDefOrBuilder.java @@ -8,11 +8,19 @@ public interface ExternalEventDefOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The name of the ExternalEventDef.
+   * 
+ * * string name = 1; * @return The name. */ java.lang.String getName(); /** + *
+   * The name of the ExternalEventDef.
+   * 
+ * * string name = 1; * @return The bytes for name. */ @@ -20,31 +28,58 @@ public interface ExternalEventDefOrBuilder extends getNameBytes(); /** + *
+   * When the ExternalEventDef was created.
+   * 
+ * * .google.protobuf.Timestamp created_at = 2; * @return Whether the createdAt field is set. */ boolean hasCreatedAt(); /** + *
+   * When the ExternalEventDef was created.
+   * 
+ * * .google.protobuf.Timestamp created_at = 2; * @return The createdAt. */ com.google.protobuf.Timestamp getCreatedAt(); /** + *
+   * When the ExternalEventDef was created.
+   * 
+ * * .google.protobuf.Timestamp created_at = 2; */ com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder(); /** + *
+   * The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the
+   * ExternalEvent **only before** it is matched with a WfRun.
+   * 
+ * * .littlehorse.ExternalEventRetentionPolicy retention_policy = 3; * @return Whether the retentionPolicy field is set. */ boolean hasRetentionPolicy(); /** + *
+   * The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the
+   * ExternalEvent **only before** it is matched with a WfRun.
+   * 
+ * * .littlehorse.ExternalEventRetentionPolicy retention_policy = 3; * @return The retentionPolicy. */ io.littlehorse.sdk.common.proto.ExternalEventRetentionPolicy getRetentionPolicy(); /** + *
+   * The retention policy for ExternalEvent's of this ExternalEventDef. This applies to the
+   * ExternalEvent **only before** it is matched with a WfRun.
+   * 
+ * * .littlehorse.ExternalEventRetentionPolicy retention_policy = 3; */ io.littlehorse.sdk.common.proto.ExternalEventRetentionPolicyOrBuilder getRetentionPolicyOrBuilder(); diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventId.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventId.java index 87f6ce436..303cd94af 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventId.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventId.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * ID for an ExternalEvent.
+ * 
+ * * Protobuf type {@code littlehorse.ExternalEventId} */ public final class ExternalEventId extends @@ -42,6 +46,11 @@ protected java.lang.Object newInstance( public static final int WF_RUN_ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.WfRunId wfRunId_; /** + *
+   * WfRunId for the ExternalEvent. Note that every ExternalEvent is associated
+   * with a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return Whether the wfRunId field is set. */ @@ -50,6 +59,11 @@ public boolean hasWfRunId() { return wfRunId_ != null; } /** + *
+   * WfRunId for the ExternalEvent. Note that every ExternalEvent is associated
+   * with a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return The wfRunId. */ @@ -58,6 +72,11 @@ public io.littlehorse.sdk.common.proto.WfRunId getWfRunId() { return wfRunId_ == null ? io.littlehorse.sdk.common.proto.WfRunId.getDefaultInstance() : wfRunId_; } /** + *
+   * WfRunId for the ExternalEvent. Note that every ExternalEvent is associated
+   * with a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ @java.lang.Override @@ -68,6 +87,10 @@ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { public static final int EXTERNAL_EVENT_DEF_ID_FIELD_NUMBER = 2; private io.littlehorse.sdk.common.proto.ExternalEventDefId externalEventDefId_; /** + *
+   * The ExternalEventDef for this ExternalEvent.
+   * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 2; * @return Whether the externalEventDefId field is set. */ @@ -76,6 +99,10 @@ public boolean hasExternalEventDefId() { return externalEventDefId_ != null; } /** + *
+   * The ExternalEventDef for this ExternalEvent.
+   * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 2; * @return The externalEventDefId. */ @@ -84,6 +111,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventDefId getExternalEventDefId( return externalEventDefId_ == null ? io.littlehorse.sdk.common.proto.ExternalEventDefId.getDefaultInstance() : externalEventDefId_; } /** + *
+   * The ExternalEventDef for this ExternalEvent.
+   * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 2; */ @java.lang.Override @@ -95,6 +126,11 @@ public io.littlehorse.sdk.common.proto.ExternalEventDefIdOrBuilder getExternalEv @SuppressWarnings("serial") private volatile java.lang.Object guid_ = ""; /** + *
+   * A unique guid allowing for distinguishing this ExternalEvent from other events
+   * of the same ExternalEventDef and WfRun.
+   * 
+ * * string guid = 3; * @return The guid. */ @@ -112,6 +148,11 @@ public java.lang.String getGuid() { } } /** + *
+   * A unique guid allowing for distinguishing this ExternalEvent from other events
+   * of the same ExternalEventDef and WfRun.
+   * 
+ * * string guid = 3; * @return The bytes for guid. */ @@ -319,6 +360,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * ID for an ExternalEvent.
+   * 
+ * * Protobuf type {@code littlehorse.ExternalEventId} */ public static final class Builder extends @@ -532,6 +577,11 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.WfRunId, io.littlehorse.sdk.common.proto.WfRunId.Builder, io.littlehorse.sdk.common.proto.WfRunIdOrBuilder> wfRunIdBuilder_; /** + *
+     * WfRunId for the ExternalEvent. Note that every ExternalEvent is associated
+     * with a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return Whether the wfRunId field is set. */ @@ -539,6 +589,11 @@ public boolean hasWfRunId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * WfRunId for the ExternalEvent. Note that every ExternalEvent is associated
+     * with a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return The wfRunId. */ @@ -550,6 +605,11 @@ public io.littlehorse.sdk.common.proto.WfRunId getWfRunId() { } } /** + *
+     * WfRunId for the ExternalEvent. Note that every ExternalEvent is associated
+     * with a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder setWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { @@ -566,6 +626,11 @@ public Builder setWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { return this; } /** + *
+     * WfRunId for the ExternalEvent. Note that every ExternalEvent is associated
+     * with a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder setWfRunId( @@ -580,6 +645,11 @@ public Builder setWfRunId( return this; } /** + *
+     * WfRunId for the ExternalEvent. Note that every ExternalEvent is associated
+     * with a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder mergeWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { @@ -599,6 +669,11 @@ public Builder mergeWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { return this; } /** + *
+     * WfRunId for the ExternalEvent. Note that every ExternalEvent is associated
+     * with a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder clearWfRunId() { @@ -612,6 +687,11 @@ public Builder clearWfRunId() { return this; } /** + *
+     * WfRunId for the ExternalEvent. Note that every ExternalEvent is associated
+     * with a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public io.littlehorse.sdk.common.proto.WfRunId.Builder getWfRunIdBuilder() { @@ -620,6 +700,11 @@ public io.littlehorse.sdk.common.proto.WfRunId.Builder getWfRunIdBuilder() { return getWfRunIdFieldBuilder().getBuilder(); } /** + *
+     * WfRunId for the ExternalEvent. Note that every ExternalEvent is associated
+     * with a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { @@ -631,6 +716,11 @@ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { } } /** + *
+     * WfRunId for the ExternalEvent. Note that every ExternalEvent is associated
+     * with a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -651,6 +741,10 @@ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.ExternalEventDefId, io.littlehorse.sdk.common.proto.ExternalEventDefId.Builder, io.littlehorse.sdk.common.proto.ExternalEventDefIdOrBuilder> externalEventDefIdBuilder_; /** + *
+     * The ExternalEventDef for this ExternalEvent.
+     * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 2; * @return Whether the externalEventDefId field is set. */ @@ -658,6 +752,10 @@ public boolean hasExternalEventDefId() { return ((bitField0_ & 0x00000002) != 0); } /** + *
+     * The ExternalEventDef for this ExternalEvent.
+     * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 2; * @return The externalEventDefId. */ @@ -669,6 +767,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventDefId getExternalEventDefId( } } /** + *
+     * The ExternalEventDef for this ExternalEvent.
+     * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 2; */ public Builder setExternalEventDefId(io.littlehorse.sdk.common.proto.ExternalEventDefId value) { @@ -685,6 +787,10 @@ public Builder setExternalEventDefId(io.littlehorse.sdk.common.proto.ExternalEve return this; } /** + *
+     * The ExternalEventDef for this ExternalEvent.
+     * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 2; */ public Builder setExternalEventDefId( @@ -699,6 +805,10 @@ public Builder setExternalEventDefId( return this; } /** + *
+     * The ExternalEventDef for this ExternalEvent.
+     * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 2; */ public Builder mergeExternalEventDefId(io.littlehorse.sdk.common.proto.ExternalEventDefId value) { @@ -718,6 +828,10 @@ public Builder mergeExternalEventDefId(io.littlehorse.sdk.common.proto.ExternalE return this; } /** + *
+     * The ExternalEventDef for this ExternalEvent.
+     * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 2; */ public Builder clearExternalEventDefId() { @@ -731,6 +845,10 @@ public Builder clearExternalEventDefId() { return this; } /** + *
+     * The ExternalEventDef for this ExternalEvent.
+     * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 2; */ public io.littlehorse.sdk.common.proto.ExternalEventDefId.Builder getExternalEventDefIdBuilder() { @@ -739,6 +857,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventDefId.Builder getExternalEve return getExternalEventDefIdFieldBuilder().getBuilder(); } /** + *
+     * The ExternalEventDef for this ExternalEvent.
+     * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 2; */ public io.littlehorse.sdk.common.proto.ExternalEventDefIdOrBuilder getExternalEventDefIdOrBuilder() { @@ -750,6 +872,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventDefIdOrBuilder getExternalEv } } /** + *
+     * The ExternalEventDef for this ExternalEvent.
+     * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 2; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -768,6 +894,11 @@ public io.littlehorse.sdk.common.proto.ExternalEventDefIdOrBuilder getExternalEv private java.lang.Object guid_ = ""; /** + *
+     * A unique guid allowing for distinguishing this ExternalEvent from other events
+     * of the same ExternalEventDef and WfRun.
+     * 
+ * * string guid = 3; * @return The guid. */ @@ -784,6 +915,11 @@ public java.lang.String getGuid() { } } /** + *
+     * A unique guid allowing for distinguishing this ExternalEvent from other events
+     * of the same ExternalEventDef and WfRun.
+     * 
+ * * string guid = 3; * @return The bytes for guid. */ @@ -801,6 +937,11 @@ public java.lang.String getGuid() { } } /** + *
+     * A unique guid allowing for distinguishing this ExternalEvent from other events
+     * of the same ExternalEventDef and WfRun.
+     * 
+ * * string guid = 3; * @param value The guid to set. * @return This builder for chaining. @@ -814,6 +955,11 @@ public Builder setGuid( return this; } /** + *
+     * A unique guid allowing for distinguishing this ExternalEvent from other events
+     * of the same ExternalEventDef and WfRun.
+     * 
+ * * string guid = 3; * @return This builder for chaining. */ @@ -824,6 +970,11 @@ public Builder clearGuid() { return this; } /** + *
+     * A unique guid allowing for distinguishing this ExternalEvent from other events
+     * of the same ExternalEventDef and WfRun.
+     * 
+ * * string guid = 3; * @param value The bytes for guid to set. * @return This builder for chaining. diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventIdOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventIdOrBuilder.java index a10e83b72..1156ae527 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventIdOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventIdOrBuilder.java @@ -8,41 +8,78 @@ public interface ExternalEventIdOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * WfRunId for the ExternalEvent. Note that every ExternalEvent is associated
+   * with a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return Whether the wfRunId field is set. */ boolean hasWfRunId(); /** + *
+   * WfRunId for the ExternalEvent. Note that every ExternalEvent is associated
+   * with a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return The wfRunId. */ io.littlehorse.sdk.common.proto.WfRunId getWfRunId(); /** + *
+   * WfRunId for the ExternalEvent. Note that every ExternalEvent is associated
+   * with a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder(); /** + *
+   * The ExternalEventDef for this ExternalEvent.
+   * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 2; * @return Whether the externalEventDefId field is set. */ boolean hasExternalEventDefId(); /** + *
+   * The ExternalEventDef for this ExternalEvent.
+   * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 2; * @return The externalEventDefId. */ io.littlehorse.sdk.common.proto.ExternalEventDefId getExternalEventDefId(); /** + *
+   * The ExternalEventDef for this ExternalEvent.
+   * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 2; */ io.littlehorse.sdk.common.proto.ExternalEventDefIdOrBuilder getExternalEventDefIdOrBuilder(); /** + *
+   * A unique guid allowing for distinguishing this ExternalEvent from other events
+   * of the same ExternalEventDef and WfRun.
+   * 
+ * * string guid = 3; * @return The guid. */ java.lang.String getGuid(); /** + *
+   * A unique guid allowing for distinguishing this ExternalEvent from other events
+   * of the same ExternalEventDef and WfRun.
+   * 
+ * * string guid = 3; * @return The bytes for guid. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventOrBuilder.java index f930c03e8..6fe4aaff7 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventOrBuilder.java @@ -8,73 +8,141 @@ public interface ExternalEventOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId,
+   * and a unique guid which can be used for idempotency of the `PutExternalEvent`
+   * rpc call.
+   * 
+ * * .littlehorse.ExternalEventId id = 1; * @return Whether the id field is set. */ boolean hasId(); /** + *
+   * The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId,
+   * and a unique guid which can be used for idempotency of the `PutExternalEvent`
+   * rpc call.
+   * 
+ * * .littlehorse.ExternalEventId id = 1; * @return The id. */ io.littlehorse.sdk.common.proto.ExternalEventId getId(); /** + *
+   * The ID of the ExternalEvent. This contains WfRunId, ExternalEventDefId,
+   * and a unique guid which can be used for idempotency of the `PutExternalEvent`
+   * rpc call.
+   * 
+ * * .littlehorse.ExternalEventId id = 1; */ io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getIdOrBuilder(); /** + *
+   * The time the ExternalEvent was registered with LittleHorse.
+   * 
+ * * .google.protobuf.Timestamp created_at = 2; * @return Whether the createdAt field is set. */ boolean hasCreatedAt(); /** + *
+   * The time the ExternalEvent was registered with LittleHorse.
+   * 
+ * * .google.protobuf.Timestamp created_at = 2; * @return The createdAt. */ com.google.protobuf.Timestamp getCreatedAt(); /** + *
+   * The time the ExternalEvent was registered with LittleHorse.
+   * 
+ * * .google.protobuf.Timestamp created_at = 2; */ com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder(); /** + *
+   * The payload of this ExternalEvent.
+   * 
+ * * .littlehorse.VariableValue content = 3; * @return Whether the content field is set. */ boolean hasContent(); /** + *
+   * The payload of this ExternalEvent.
+   * 
+ * * .littlehorse.VariableValue content = 3; * @return The content. */ io.littlehorse.sdk.common.proto.VariableValue getContent(); /** + *
+   * The payload of this ExternalEvent.
+   * 
+ * * .littlehorse.VariableValue content = 3; */ io.littlehorse.sdk.common.proto.VariableValueOrBuilder getContentOrBuilder(); /** + *
+   * If the ExternalEvent was claimed by a specific ThreadRun (via Interrupt or
+   * EXTERNAL_EVENT Node), this is set to the number of the relevant ThreadRun.
+   * 
+ * * optional int32 thread_run_number = 4; * @return Whether the threadRunNumber field is set. */ boolean hasThreadRunNumber(); /** + *
+   * If the ExternalEvent was claimed by a specific ThreadRun (via Interrupt or
+   * EXTERNAL_EVENT Node), this is set to the number of the relevant ThreadRun.
+   * 
+ * * optional int32 thread_run_number = 4; * @return The threadRunNumber. */ int getThreadRunNumber(); /** + *
+   * If the ExternalEvent was claimed by a specific ThreadRun (via EXTERNAL_EVENT
+   * Node; note that in the case of an Interrupt the node_run_position will never
+   * be set), this is set to the number of the relevant NodeRun.
+   * 
+ * * optional int32 node_run_position = 5; * @return Whether the nodeRunPosition field is set. */ boolean hasNodeRunPosition(); /** + *
+   * If the ExternalEvent was claimed by a specific ThreadRun (via EXTERNAL_EVENT
+   * Node; note that in the case of an Interrupt the node_run_position will never
+   * be set), this is set to the number of the relevant NodeRun.
+   * 
+ * * optional int32 node_run_position = 5; * @return The nodeRunPosition. */ int getNodeRunPosition(); /** + *
+   * Whether the ExternalEvent has been claimed by a WfRun.
+   * 
+ * * bool claimed = 6; * @return The claimed. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventRetentionPolicy.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventRetentionPolicy.java index ac3a7d599..ca68bef0a 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventRetentionPolicy.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventRetentionPolicy.java @@ -4,6 +4,17 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * Policy to determine how long an ExternalEvent is retained after creation if it
+ * is not yet claimed by a WfRun. Note that once a WfRun has been matched with the
+ * ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted.
+ * If not set, then ExternalEvent's are not deleted if they are not matched with
+ * a WfRun.
+ *
+ * A future version of LittleHorse will allow changing the retention_policy, which
+ * will trigger a cleanup of old `ExternalEvent`s.
+ * 
+ * * Protobuf type {@code littlehorse.ExternalEventRetentionPolicy} */ public final class ExternalEventRetentionPolicy extends @@ -283,6 +294,17 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * Policy to determine how long an ExternalEvent is retained after creation if it
+   * is not yet claimed by a WfRun. Note that once a WfRun has been matched with the
+   * ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted.
+   * If not set, then ExternalEvent's are not deleted if they are not matched with
+   * a WfRun.
+   *
+   * A future version of LittleHorse will allow changing the retention_policy, which
+   * will trigger a cleanup of old `ExternalEvent`s.
+   * 
+ * * Protobuf type {@code littlehorse.ExternalEventRetentionPolicy} */ public static final class Builder extends diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventRun.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventRun.java index c748acd66..3e893f527 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventRun.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventRun.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * The sub-node structure for an EXTERNAL_EVENT NodeRun.
+ * 
+ * * Protobuf type {@code littlehorse.ExternalEventRun} */ public final class ExternalEventRun extends @@ -42,6 +46,10 @@ protected java.lang.Object newInstance( public static final int EXTERNAL_EVENT_DEF_ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.ExternalEventDefId externalEventDefId_; /** + *
+   * The ExternalEventDefId that we are waiting for.
+   * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 1; * @return Whether the externalEventDefId field is set. */ @@ -50,6 +58,10 @@ public boolean hasExternalEventDefId() { return externalEventDefId_ != null; } /** + *
+   * The ExternalEventDefId that we are waiting for.
+   * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 1; * @return The externalEventDefId. */ @@ -58,6 +70,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventDefId getExternalEventDefId( return externalEventDefId_ == null ? io.littlehorse.sdk.common.proto.ExternalEventDefId.getDefaultInstance() : externalEventDefId_; } /** + *
+   * The ExternalEventDefId that we are waiting for.
+   * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 1; */ @java.lang.Override @@ -68,6 +84,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventDefIdOrBuilder getExternalEv public static final int EVENT_TIME_FIELD_NUMBER = 2; private com.google.protobuf.Timestamp eventTime_; /** + *
+   * The time that the ExternalEvent arrived. Unset if still waiting.
+   * 
+ * * optional .google.protobuf.Timestamp event_time = 2; * @return Whether the eventTime field is set. */ @@ -76,6 +96,10 @@ public boolean hasEventTime() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+   * The time that the ExternalEvent arrived. Unset if still waiting.
+   * 
+ * * optional .google.protobuf.Timestamp event_time = 2; * @return The eventTime. */ @@ -84,6 +108,10 @@ public com.google.protobuf.Timestamp getEventTime() { return eventTime_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : eventTime_; } /** + *
+   * The time that the ExternalEvent arrived. Unset if still waiting.
+   * 
+ * * optional .google.protobuf.Timestamp event_time = 2; */ @java.lang.Override @@ -94,6 +122,10 @@ public com.google.protobuf.TimestampOrBuilder getEventTimeOrBuilder() { public static final int EXTERNAL_EVENT_ID_FIELD_NUMBER = 3; private io.littlehorse.sdk.common.proto.ExternalEventId externalEventId_; /** + *
+   * The ExternalEventId of the ExternalEvent. Unset if still waiting.
+   * 
+ * * optional .littlehorse.ExternalEventId external_event_id = 3; * @return Whether the externalEventId field is set. */ @@ -102,6 +134,10 @@ public boolean hasExternalEventId() { return ((bitField0_ & 0x00000002) != 0); } /** + *
+   * The ExternalEventId of the ExternalEvent. Unset if still waiting.
+   * 
+ * * optional .littlehorse.ExternalEventId external_event_id = 3; * @return The externalEventId. */ @@ -110,6 +146,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventId getExternalEventId() { return externalEventId_ == null ? io.littlehorse.sdk.common.proto.ExternalEventId.getDefaultInstance() : externalEventId_; } /** + *
+   * The ExternalEventId of the ExternalEvent. Unset if still waiting.
+   * 
+ * * optional .littlehorse.ExternalEventId external_event_id = 3; */ @java.lang.Override @@ -312,6 +352,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * The sub-node structure for an EXTERNAL_EVENT NodeRun.
+   * 
+ * * Protobuf type {@code littlehorse.ExternalEventRun} */ public static final class Builder extends @@ -543,6 +587,10 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.ExternalEventDefId, io.littlehorse.sdk.common.proto.ExternalEventDefId.Builder, io.littlehorse.sdk.common.proto.ExternalEventDefIdOrBuilder> externalEventDefIdBuilder_; /** + *
+     * The ExternalEventDefId that we are waiting for.
+     * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 1; * @return Whether the externalEventDefId field is set. */ @@ -550,6 +598,10 @@ public boolean hasExternalEventDefId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * The ExternalEventDefId that we are waiting for.
+     * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 1; * @return The externalEventDefId. */ @@ -561,6 +613,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventDefId getExternalEventDefId( } } /** + *
+     * The ExternalEventDefId that we are waiting for.
+     * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 1; */ public Builder setExternalEventDefId(io.littlehorse.sdk.common.proto.ExternalEventDefId value) { @@ -577,6 +633,10 @@ public Builder setExternalEventDefId(io.littlehorse.sdk.common.proto.ExternalEve return this; } /** + *
+     * The ExternalEventDefId that we are waiting for.
+     * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 1; */ public Builder setExternalEventDefId( @@ -591,6 +651,10 @@ public Builder setExternalEventDefId( return this; } /** + *
+     * The ExternalEventDefId that we are waiting for.
+     * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 1; */ public Builder mergeExternalEventDefId(io.littlehorse.sdk.common.proto.ExternalEventDefId value) { @@ -610,6 +674,10 @@ public Builder mergeExternalEventDefId(io.littlehorse.sdk.common.proto.ExternalE return this; } /** + *
+     * The ExternalEventDefId that we are waiting for.
+     * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 1; */ public Builder clearExternalEventDefId() { @@ -623,6 +691,10 @@ public Builder clearExternalEventDefId() { return this; } /** + *
+     * The ExternalEventDefId that we are waiting for.
+     * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 1; */ public io.littlehorse.sdk.common.proto.ExternalEventDefId.Builder getExternalEventDefIdBuilder() { @@ -631,6 +703,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventDefId.Builder getExternalEve return getExternalEventDefIdFieldBuilder().getBuilder(); } /** + *
+     * The ExternalEventDefId that we are waiting for.
+     * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 1; */ public io.littlehorse.sdk.common.proto.ExternalEventDefIdOrBuilder getExternalEventDefIdOrBuilder() { @@ -642,6 +718,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventDefIdOrBuilder getExternalEv } } /** + *
+     * The ExternalEventDefId that we are waiting for.
+     * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -662,6 +742,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventDefIdOrBuilder getExternalEv private com.google.protobuf.SingleFieldBuilderV3< com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> eventTimeBuilder_; /** + *
+     * The time that the ExternalEvent arrived. Unset if still waiting.
+     * 
+ * * optional .google.protobuf.Timestamp event_time = 2; * @return Whether the eventTime field is set. */ @@ -669,6 +753,10 @@ public boolean hasEventTime() { return ((bitField0_ & 0x00000002) != 0); } /** + *
+     * The time that the ExternalEvent arrived. Unset if still waiting.
+     * 
+ * * optional .google.protobuf.Timestamp event_time = 2; * @return The eventTime. */ @@ -680,6 +768,10 @@ public com.google.protobuf.Timestamp getEventTime() { } } /** + *
+     * The time that the ExternalEvent arrived. Unset if still waiting.
+     * 
+ * * optional .google.protobuf.Timestamp event_time = 2; */ public Builder setEventTime(com.google.protobuf.Timestamp value) { @@ -696,6 +788,10 @@ public Builder setEventTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time that the ExternalEvent arrived. Unset if still waiting.
+     * 
+ * * optional .google.protobuf.Timestamp event_time = 2; */ public Builder setEventTime( @@ -710,6 +806,10 @@ public Builder setEventTime( return this; } /** + *
+     * The time that the ExternalEvent arrived. Unset if still waiting.
+     * 
+ * * optional .google.protobuf.Timestamp event_time = 2; */ public Builder mergeEventTime(com.google.protobuf.Timestamp value) { @@ -729,6 +829,10 @@ public Builder mergeEventTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time that the ExternalEvent arrived. Unset if still waiting.
+     * 
+ * * optional .google.protobuf.Timestamp event_time = 2; */ public Builder clearEventTime() { @@ -742,6 +846,10 @@ public Builder clearEventTime() { return this; } /** + *
+     * The time that the ExternalEvent arrived. Unset if still waiting.
+     * 
+ * * optional .google.protobuf.Timestamp event_time = 2; */ public com.google.protobuf.Timestamp.Builder getEventTimeBuilder() { @@ -750,6 +858,10 @@ public com.google.protobuf.Timestamp.Builder getEventTimeBuilder() { return getEventTimeFieldBuilder().getBuilder(); } /** + *
+     * The time that the ExternalEvent arrived. Unset if still waiting.
+     * 
+ * * optional .google.protobuf.Timestamp event_time = 2; */ public com.google.protobuf.TimestampOrBuilder getEventTimeOrBuilder() { @@ -761,6 +873,10 @@ public com.google.protobuf.TimestampOrBuilder getEventTimeOrBuilder() { } } /** + *
+     * The time that the ExternalEvent arrived. Unset if still waiting.
+     * 
+ * * optional .google.protobuf.Timestamp event_time = 2; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -781,6 +897,10 @@ public com.google.protobuf.TimestampOrBuilder getEventTimeOrBuilder() { private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.ExternalEventId, io.littlehorse.sdk.common.proto.ExternalEventId.Builder, io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder> externalEventIdBuilder_; /** + *
+     * The ExternalEventId of the ExternalEvent. Unset if still waiting.
+     * 
+ * * optional .littlehorse.ExternalEventId external_event_id = 3; * @return Whether the externalEventId field is set. */ @@ -788,6 +908,10 @@ public boolean hasExternalEventId() { return ((bitField0_ & 0x00000004) != 0); } /** + *
+     * The ExternalEventId of the ExternalEvent. Unset if still waiting.
+     * 
+ * * optional .littlehorse.ExternalEventId external_event_id = 3; * @return The externalEventId. */ @@ -799,6 +923,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventId getExternalEventId() { } } /** + *
+     * The ExternalEventId of the ExternalEvent. Unset if still waiting.
+     * 
+ * * optional .littlehorse.ExternalEventId external_event_id = 3; */ public Builder setExternalEventId(io.littlehorse.sdk.common.proto.ExternalEventId value) { @@ -815,6 +943,10 @@ public Builder setExternalEventId(io.littlehorse.sdk.common.proto.ExternalEventI return this; } /** + *
+     * The ExternalEventId of the ExternalEvent. Unset if still waiting.
+     * 
+ * * optional .littlehorse.ExternalEventId external_event_id = 3; */ public Builder setExternalEventId( @@ -829,6 +961,10 @@ public Builder setExternalEventId( return this; } /** + *
+     * The ExternalEventId of the ExternalEvent. Unset if still waiting.
+     * 
+ * * optional .littlehorse.ExternalEventId external_event_id = 3; */ public Builder mergeExternalEventId(io.littlehorse.sdk.common.proto.ExternalEventId value) { @@ -848,6 +984,10 @@ public Builder mergeExternalEventId(io.littlehorse.sdk.common.proto.ExternalEven return this; } /** + *
+     * The ExternalEventId of the ExternalEvent. Unset if still waiting.
+     * 
+ * * optional .littlehorse.ExternalEventId external_event_id = 3; */ public Builder clearExternalEventId() { @@ -861,6 +1001,10 @@ public Builder clearExternalEventId() { return this; } /** + *
+     * The ExternalEventId of the ExternalEvent. Unset if still waiting.
+     * 
+ * * optional .littlehorse.ExternalEventId external_event_id = 3; */ public io.littlehorse.sdk.common.proto.ExternalEventId.Builder getExternalEventIdBuilder() { @@ -869,6 +1013,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventId.Builder getExternalEventI return getExternalEventIdFieldBuilder().getBuilder(); } /** + *
+     * The ExternalEventId of the ExternalEvent. Unset if still waiting.
+     * 
+ * * optional .littlehorse.ExternalEventId external_event_id = 3; */ public io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getExternalEventIdOrBuilder() { @@ -880,6 +1028,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getExternalEvent } } /** + *
+     * The ExternalEventId of the ExternalEvent. Unset if still waiting.
+     * 
+ * * optional .littlehorse.ExternalEventId external_event_id = 3; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventRunOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventRunOrBuilder.java index 79cfa56ec..61d94ed1e 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventRunOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ExternalEventRunOrBuilder.java @@ -8,46 +8,82 @@ public interface ExternalEventRunOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The ExternalEventDefId that we are waiting for.
+   * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 1; * @return Whether the externalEventDefId field is set. */ boolean hasExternalEventDefId(); /** + *
+   * The ExternalEventDefId that we are waiting for.
+   * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 1; * @return The externalEventDefId. */ io.littlehorse.sdk.common.proto.ExternalEventDefId getExternalEventDefId(); /** + *
+   * The ExternalEventDefId that we are waiting for.
+   * 
+ * * .littlehorse.ExternalEventDefId external_event_def_id = 1; */ io.littlehorse.sdk.common.proto.ExternalEventDefIdOrBuilder getExternalEventDefIdOrBuilder(); /** + *
+   * The time that the ExternalEvent arrived. Unset if still waiting.
+   * 
+ * * optional .google.protobuf.Timestamp event_time = 2; * @return Whether the eventTime field is set. */ boolean hasEventTime(); /** + *
+   * The time that the ExternalEvent arrived. Unset if still waiting.
+   * 
+ * * optional .google.protobuf.Timestamp event_time = 2; * @return The eventTime. */ com.google.protobuf.Timestamp getEventTime(); /** + *
+   * The time that the ExternalEvent arrived. Unset if still waiting.
+   * 
+ * * optional .google.protobuf.Timestamp event_time = 2; */ com.google.protobuf.TimestampOrBuilder getEventTimeOrBuilder(); /** + *
+   * The ExternalEventId of the ExternalEvent. Unset if still waiting.
+   * 
+ * * optional .littlehorse.ExternalEventId external_event_id = 3; * @return Whether the externalEventId field is set. */ boolean hasExternalEventId(); /** + *
+   * The ExternalEventId of the ExternalEvent. Unset if still waiting.
+   * 
+ * * optional .littlehorse.ExternalEventId external_event_id = 3; * @return The externalEventId. */ io.littlehorse.sdk.common.proto.ExternalEventId getExternalEventId(); /** + *
+   * The ExternalEventId of the ExternalEvent. Unset if still waiting.
+   * 
+ * * optional .littlehorse.ExternalEventId external_event_id = 3; */ io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getExternalEventIdOrBuilder(); diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/Failure.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/Failure.java index b5df23529..0899924c0 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/Failure.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/Failure.java @@ -4,6 +4,11 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * Denotes a failure that happened during execution of a NodeRun or the outgoing
+ * edges.
+ * 
+ * * Protobuf type {@code littlehorse.Failure} */ public final class Failure extends @@ -45,6 +50,14 @@ protected java.lang.Object newInstance( @SuppressWarnings("serial") private volatile java.lang.Object failureName_ = ""; /** + *
+   * The name of the failure. LittleHorse has certain built-in failures, all named in
+   * UPPER_UNDERSCORE_CASE. Such failures correspond with the `LHStatus.ERROR`.
+   *
+   * Any Failure named in `kebab-case` is a user-defined business `EXCEPTION`, treated
+   * as an `LHStatus.EXCEPTION`.
+   * 
+ * * string failure_name = 1; * @return The failureName. */ @@ -62,6 +75,14 @@ public java.lang.String getFailureName() { } } /** + *
+   * The name of the failure. LittleHorse has certain built-in failures, all named in
+   * UPPER_UNDERSCORE_CASE. Such failures correspond with the `LHStatus.ERROR`.
+   *
+   * Any Failure named in `kebab-case` is a user-defined business `EXCEPTION`, treated
+   * as an `LHStatus.EXCEPTION`.
+   * 
+ * * string failure_name = 1; * @return The bytes for failureName. */ @@ -84,6 +105,10 @@ public java.lang.String getFailureName() { @SuppressWarnings("serial") private volatile java.lang.Object message_ = ""; /** + *
+   * The human-readable message associated with this Failure.
+   * 
+ * * string message = 2; * @return The message. */ @@ -101,6 +126,10 @@ public java.lang.String getMessage() { } } /** + *
+   * The human-readable message associated with this Failure.
+   * 
+ * * string message = 2; * @return The bytes for message. */ @@ -122,6 +151,14 @@ public java.lang.String getMessage() { public static final int CONTENT_FIELD_NUMBER = 3; private io.littlehorse.sdk.common.proto.VariableValue content_; /** + *
+   * A user-defined Failure can have a value; for example, in Java an Exception is an
+   * Object with arbitrary properties and behaviors.
+   *
+   * Future versions of LH will allow FailureHandler threads to accept that value as
+   * an input variable.
+   * 
+ * * optional .littlehorse.VariableValue content = 3; * @return Whether the content field is set. */ @@ -130,6 +167,14 @@ public boolean hasContent() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+   * A user-defined Failure can have a value; for example, in Java an Exception is an
+   * Object with arbitrary properties and behaviors.
+   *
+   * Future versions of LH will allow FailureHandler threads to accept that value as
+   * an input variable.
+   * 
+ * * optional .littlehorse.VariableValue content = 3; * @return The content. */ @@ -138,6 +183,14 @@ public io.littlehorse.sdk.common.proto.VariableValue getContent() { return content_ == null ? io.littlehorse.sdk.common.proto.VariableValue.getDefaultInstance() : content_; } /** + *
+   * A user-defined Failure can have a value; for example, in Java an Exception is an
+   * Object with arbitrary properties and behaviors.
+   *
+   * Future versions of LH will allow FailureHandler threads to accept that value as
+   * an input variable.
+   * 
+ * * optional .littlehorse.VariableValue content = 3; */ @java.lang.Override @@ -148,6 +201,10 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getContentOrBuilde public static final int WAS_PROPERLY_HANDLED_FIELD_NUMBER = 4; private boolean wasProperlyHandled_ = false; /** + *
+   * A boolean denoting whether a Failure Handler ThreadRun properly handled the Failure.
+   * 
+ * * bool was_properly_handled = 4; * @return The wasProperlyHandled. */ @@ -351,6 +408,11 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * Denotes a failure that happened during execution of a NodeRun or the outgoing
+   * edges.
+   * 
+ * * Protobuf type {@code littlehorse.Failure} */ public static final class Builder extends @@ -577,6 +639,14 @@ public Builder mergeFrom( private java.lang.Object failureName_ = ""; /** + *
+     * The name of the failure. LittleHorse has certain built-in failures, all named in
+     * UPPER_UNDERSCORE_CASE. Such failures correspond with the `LHStatus.ERROR`.
+     *
+     * Any Failure named in `kebab-case` is a user-defined business `EXCEPTION`, treated
+     * as an `LHStatus.EXCEPTION`.
+     * 
+ * * string failure_name = 1; * @return The failureName. */ @@ -593,6 +663,14 @@ public java.lang.String getFailureName() { } } /** + *
+     * The name of the failure. LittleHorse has certain built-in failures, all named in
+     * UPPER_UNDERSCORE_CASE. Such failures correspond with the `LHStatus.ERROR`.
+     *
+     * Any Failure named in `kebab-case` is a user-defined business `EXCEPTION`, treated
+     * as an `LHStatus.EXCEPTION`.
+     * 
+ * * string failure_name = 1; * @return The bytes for failureName. */ @@ -610,6 +688,14 @@ public java.lang.String getFailureName() { } } /** + *
+     * The name of the failure. LittleHorse has certain built-in failures, all named in
+     * UPPER_UNDERSCORE_CASE. Such failures correspond with the `LHStatus.ERROR`.
+     *
+     * Any Failure named in `kebab-case` is a user-defined business `EXCEPTION`, treated
+     * as an `LHStatus.EXCEPTION`.
+     * 
+ * * string failure_name = 1; * @param value The failureName to set. * @return This builder for chaining. @@ -623,6 +709,14 @@ public Builder setFailureName( return this; } /** + *
+     * The name of the failure. LittleHorse has certain built-in failures, all named in
+     * UPPER_UNDERSCORE_CASE. Such failures correspond with the `LHStatus.ERROR`.
+     *
+     * Any Failure named in `kebab-case` is a user-defined business `EXCEPTION`, treated
+     * as an `LHStatus.EXCEPTION`.
+     * 
+ * * string failure_name = 1; * @return This builder for chaining. */ @@ -633,6 +727,14 @@ public Builder clearFailureName() { return this; } /** + *
+     * The name of the failure. LittleHorse has certain built-in failures, all named in
+     * UPPER_UNDERSCORE_CASE. Such failures correspond with the `LHStatus.ERROR`.
+     *
+     * Any Failure named in `kebab-case` is a user-defined business `EXCEPTION`, treated
+     * as an `LHStatus.EXCEPTION`.
+     * 
+ * * string failure_name = 1; * @param value The bytes for failureName to set. * @return This builder for chaining. @@ -649,6 +751,10 @@ public Builder setFailureNameBytes( private java.lang.Object message_ = ""; /** + *
+     * The human-readable message associated with this Failure.
+     * 
+ * * string message = 2; * @return The message. */ @@ -665,6 +771,10 @@ public java.lang.String getMessage() { } } /** + *
+     * The human-readable message associated with this Failure.
+     * 
+ * * string message = 2; * @return The bytes for message. */ @@ -682,6 +792,10 @@ public java.lang.String getMessage() { } } /** + *
+     * The human-readable message associated with this Failure.
+     * 
+ * * string message = 2; * @param value The message to set. * @return This builder for chaining. @@ -695,6 +809,10 @@ public Builder setMessage( return this; } /** + *
+     * The human-readable message associated with this Failure.
+     * 
+ * * string message = 2; * @return This builder for chaining. */ @@ -705,6 +823,10 @@ public Builder clearMessage() { return this; } /** + *
+     * The human-readable message associated with this Failure.
+     * 
+ * * string message = 2; * @param value The bytes for message to set. * @return This builder for chaining. @@ -723,6 +845,14 @@ public Builder setMessageBytes( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.VariableValue, io.littlehorse.sdk.common.proto.VariableValue.Builder, io.littlehorse.sdk.common.proto.VariableValueOrBuilder> contentBuilder_; /** + *
+     * A user-defined Failure can have a value; for example, in Java an Exception is an
+     * Object with arbitrary properties and behaviors.
+     *
+     * Future versions of LH will allow FailureHandler threads to accept that value as
+     * an input variable.
+     * 
+ * * optional .littlehorse.VariableValue content = 3; * @return Whether the content field is set. */ @@ -730,6 +860,14 @@ public boolean hasContent() { return ((bitField0_ & 0x00000004) != 0); } /** + *
+     * A user-defined Failure can have a value; for example, in Java an Exception is an
+     * Object with arbitrary properties and behaviors.
+     *
+     * Future versions of LH will allow FailureHandler threads to accept that value as
+     * an input variable.
+     * 
+ * * optional .littlehorse.VariableValue content = 3; * @return The content. */ @@ -741,6 +879,14 @@ public io.littlehorse.sdk.common.proto.VariableValue getContent() { } } /** + *
+     * A user-defined Failure can have a value; for example, in Java an Exception is an
+     * Object with arbitrary properties and behaviors.
+     *
+     * Future versions of LH will allow FailureHandler threads to accept that value as
+     * an input variable.
+     * 
+ * * optional .littlehorse.VariableValue content = 3; */ public Builder setContent(io.littlehorse.sdk.common.proto.VariableValue value) { @@ -757,6 +903,14 @@ public Builder setContent(io.littlehorse.sdk.common.proto.VariableValue value) { return this; } /** + *
+     * A user-defined Failure can have a value; for example, in Java an Exception is an
+     * Object with arbitrary properties and behaviors.
+     *
+     * Future versions of LH will allow FailureHandler threads to accept that value as
+     * an input variable.
+     * 
+ * * optional .littlehorse.VariableValue content = 3; */ public Builder setContent( @@ -771,6 +925,14 @@ public Builder setContent( return this; } /** + *
+     * A user-defined Failure can have a value; for example, in Java an Exception is an
+     * Object with arbitrary properties and behaviors.
+     *
+     * Future versions of LH will allow FailureHandler threads to accept that value as
+     * an input variable.
+     * 
+ * * optional .littlehorse.VariableValue content = 3; */ public Builder mergeContent(io.littlehorse.sdk.common.proto.VariableValue value) { @@ -790,6 +952,14 @@ public Builder mergeContent(io.littlehorse.sdk.common.proto.VariableValue value) return this; } /** + *
+     * A user-defined Failure can have a value; for example, in Java an Exception is an
+     * Object with arbitrary properties and behaviors.
+     *
+     * Future versions of LH will allow FailureHandler threads to accept that value as
+     * an input variable.
+     * 
+ * * optional .littlehorse.VariableValue content = 3; */ public Builder clearContent() { @@ -803,6 +973,14 @@ public Builder clearContent() { return this; } /** + *
+     * A user-defined Failure can have a value; for example, in Java an Exception is an
+     * Object with arbitrary properties and behaviors.
+     *
+     * Future versions of LH will allow FailureHandler threads to accept that value as
+     * an input variable.
+     * 
+ * * optional .littlehorse.VariableValue content = 3; */ public io.littlehorse.sdk.common.proto.VariableValue.Builder getContentBuilder() { @@ -811,6 +989,14 @@ public io.littlehorse.sdk.common.proto.VariableValue.Builder getContentBuilder() return getContentFieldBuilder().getBuilder(); } /** + *
+     * A user-defined Failure can have a value; for example, in Java an Exception is an
+     * Object with arbitrary properties and behaviors.
+     *
+     * Future versions of LH will allow FailureHandler threads to accept that value as
+     * an input variable.
+     * 
+ * * optional .littlehorse.VariableValue content = 3; */ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getContentOrBuilder() { @@ -822,6 +1008,14 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getContentOrBuilde } } /** + *
+     * A user-defined Failure can have a value; for example, in Java an Exception is an
+     * Object with arbitrary properties and behaviors.
+     *
+     * Future versions of LH will allow FailureHandler threads to accept that value as
+     * an input variable.
+     * 
+ * * optional .littlehorse.VariableValue content = 3; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -840,6 +1034,10 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getContentOrBuilde private boolean wasProperlyHandled_ ; /** + *
+     * A boolean denoting whether a Failure Handler ThreadRun properly handled the Failure.
+     * 
+ * * bool was_properly_handled = 4; * @return The wasProperlyHandled. */ @@ -848,6 +1046,10 @@ public boolean getWasProperlyHandled() { return wasProperlyHandled_; } /** + *
+     * A boolean denoting whether a Failure Handler ThreadRun properly handled the Failure.
+     * 
+ * * bool was_properly_handled = 4; * @param value The wasProperlyHandled to set. * @return This builder for chaining. @@ -860,6 +1062,10 @@ public Builder setWasProperlyHandled(boolean value) { return this; } /** + *
+     * A boolean denoting whether a Failure Handler ThreadRun properly handled the Failure.
+     * 
+ * * bool was_properly_handled = 4; * @return This builder for chaining. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/FailureBeingHandled.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/FailureBeingHandled.java index 1d46bb57c..09e623aea 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/FailureBeingHandled.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/FailureBeingHandled.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * Points to the Failure that is currently being handled in the ThreadRun.
+ * 
+ * * Protobuf type {@code littlehorse.FailureBeingHandled} */ public final class FailureBeingHandled extends @@ -41,6 +45,10 @@ protected java.lang.Object newInstance( public static final int THREAD_RUN_NUMBER_FIELD_NUMBER = 1; private int threadRunNumber_ = 0; /** + *
+   * The thread run number.
+   * 
+ * * int32 thread_run_number = 1; * @return The threadRunNumber. */ @@ -52,6 +60,10 @@ public int getThreadRunNumber() { public static final int NODE_RUN_POSITION_FIELD_NUMBER = 2; private int nodeRunPosition_ = 0; /** + *
+   * The position of the NodeRun causing the failure.
+   * 
+ * * int32 node_run_position = 2; * @return The nodeRunPosition. */ @@ -63,6 +75,10 @@ public int getNodeRunPosition() { public static final int FAILURE_NUMBER_FIELD_NUMBER = 3; private int failureNumber_ = 0; /** + *
+   * The number of the failure.
+   * 
+ * * int32 failure_number = 3; * @return The failureNumber. */ @@ -251,6 +267,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * Points to the Failure that is currently being handled in the ThreadRun.
+   * 
+ * * Protobuf type {@code littlehorse.FailureBeingHandled} */ public static final class Builder extends @@ -444,6 +464,10 @@ public Builder mergeFrom( private int threadRunNumber_ ; /** + *
+     * The thread run number.
+     * 
+ * * int32 thread_run_number = 1; * @return The threadRunNumber. */ @@ -452,6 +476,10 @@ public int getThreadRunNumber() { return threadRunNumber_; } /** + *
+     * The thread run number.
+     * 
+ * * int32 thread_run_number = 1; * @param value The threadRunNumber to set. * @return This builder for chaining. @@ -464,6 +492,10 @@ public Builder setThreadRunNumber(int value) { return this; } /** + *
+     * The thread run number.
+     * 
+ * * int32 thread_run_number = 1; * @return This builder for chaining. */ @@ -476,6 +508,10 @@ public Builder clearThreadRunNumber() { private int nodeRunPosition_ ; /** + *
+     * The position of the NodeRun causing the failure.
+     * 
+ * * int32 node_run_position = 2; * @return The nodeRunPosition. */ @@ -484,6 +520,10 @@ public int getNodeRunPosition() { return nodeRunPosition_; } /** + *
+     * The position of the NodeRun causing the failure.
+     * 
+ * * int32 node_run_position = 2; * @param value The nodeRunPosition to set. * @return This builder for chaining. @@ -496,6 +536,10 @@ public Builder setNodeRunPosition(int value) { return this; } /** + *
+     * The position of the NodeRun causing the failure.
+     * 
+ * * int32 node_run_position = 2; * @return This builder for chaining. */ @@ -508,6 +552,10 @@ public Builder clearNodeRunPosition() { private int failureNumber_ ; /** + *
+     * The number of the failure.
+     * 
+ * * int32 failure_number = 3; * @return The failureNumber. */ @@ -516,6 +564,10 @@ public int getFailureNumber() { return failureNumber_; } /** + *
+     * The number of the failure.
+     * 
+ * * int32 failure_number = 3; * @param value The failureNumber to set. * @return This builder for chaining. @@ -528,6 +580,10 @@ public Builder setFailureNumber(int value) { return this; } /** + *
+     * The number of the failure.
+     * 
+ * * int32 failure_number = 3; * @return This builder for chaining. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/FailureBeingHandledOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/FailureBeingHandledOrBuilder.java index 724536f6e..e479b7e08 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/FailureBeingHandledOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/FailureBeingHandledOrBuilder.java @@ -8,18 +8,30 @@ public interface FailureBeingHandledOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The thread run number.
+   * 
+ * * int32 thread_run_number = 1; * @return The threadRunNumber. */ int getThreadRunNumber(); /** + *
+   * The position of the NodeRun causing the failure.
+   * 
+ * * int32 node_run_position = 2; * @return The nodeRunPosition. */ int getNodeRunPosition(); /** + *
+   * The number of the failure.
+   * 
+ * * int32 failure_number = 3; * @return The failureNumber. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/FailureOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/FailureOrBuilder.java index 691e1143c..7e5133c20 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/FailureOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/FailureOrBuilder.java @@ -8,11 +8,27 @@ public interface FailureOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The name of the failure. LittleHorse has certain built-in failures, all named in
+   * UPPER_UNDERSCORE_CASE. Such failures correspond with the `LHStatus.ERROR`.
+   *
+   * Any Failure named in `kebab-case` is a user-defined business `EXCEPTION`, treated
+   * as an `LHStatus.EXCEPTION`.
+   * 
+ * * string failure_name = 1; * @return The failureName. */ java.lang.String getFailureName(); /** + *
+   * The name of the failure. LittleHorse has certain built-in failures, all named in
+   * UPPER_UNDERSCORE_CASE. Such failures correspond with the `LHStatus.ERROR`.
+   *
+   * Any Failure named in `kebab-case` is a user-defined business `EXCEPTION`, treated
+   * as an `LHStatus.EXCEPTION`.
+   * 
+ * * string failure_name = 1; * @return The bytes for failureName. */ @@ -20,11 +36,19 @@ public interface FailureOrBuilder extends getFailureNameBytes(); /** + *
+   * The human-readable message associated with this Failure.
+   * 
+ * * string message = 2; * @return The message. */ java.lang.String getMessage(); /** + *
+   * The human-readable message associated with this Failure.
+   * 
+ * * string message = 2; * @return The bytes for message. */ @@ -32,21 +56,49 @@ public interface FailureOrBuilder extends getMessageBytes(); /** + *
+   * A user-defined Failure can have a value; for example, in Java an Exception is an
+   * Object with arbitrary properties and behaviors.
+   *
+   * Future versions of LH will allow FailureHandler threads to accept that value as
+   * an input variable.
+   * 
+ * * optional .littlehorse.VariableValue content = 3; * @return Whether the content field is set. */ boolean hasContent(); /** + *
+   * A user-defined Failure can have a value; for example, in Java an Exception is an
+   * Object with arbitrary properties and behaviors.
+   *
+   * Future versions of LH will allow FailureHandler threads to accept that value as
+   * an input variable.
+   * 
+ * * optional .littlehorse.VariableValue content = 3; * @return The content. */ io.littlehorse.sdk.common.proto.VariableValue getContent(); /** + *
+   * A user-defined Failure can have a value; for example, in Java an Exception is an
+   * Object with arbitrary properties and behaviors.
+   *
+   * Future versions of LH will allow FailureHandler threads to accept that value as
+   * an input variable.
+   * 
+ * * optional .littlehorse.VariableValue content = 3; */ io.littlehorse.sdk.common.proto.VariableValueOrBuilder getContentOrBuilder(); /** + *
+   * A boolean denoting whether a Failure Handler ThreadRun properly handled the Failure.
+   * 
+ * * bool was_properly_handled = 4; * @return The wasProperlyHandled. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/HandlingFailureHaltReason.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/HandlingFailureHaltReason.java index 8000e7e31..c44096889 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/HandlingFailureHaltReason.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/HandlingFailureHaltReason.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * A Halt Reason denoting that a ThreadRun is halted while a Failure Handler is being run.
+ * 
+ * * Protobuf type {@code littlehorse.HandlingFailureHaltReason} */ public final class HandlingFailureHaltReason extends @@ -41,6 +45,10 @@ protected java.lang.Object newInstance( public static final int HANDLER_THREAD_ID_FIELD_NUMBER = 1; private int handlerThreadId_ = 0; /** + *
+   * The ID of the Failure Handler ThreadRun.
+   * 
+ * * int32 handler_thread_id = 1; * @return The handlerThreadId. */ @@ -207,6 +215,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * A Halt Reason denoting that a ThreadRun is halted while a Failure Handler is being run.
+   * 
+ * * Protobuf type {@code littlehorse.HandlingFailureHaltReason} */ public static final class Builder extends @@ -376,6 +388,10 @@ public Builder mergeFrom( private int handlerThreadId_ ; /** + *
+     * The ID of the Failure Handler ThreadRun.
+     * 
+ * * int32 handler_thread_id = 1; * @return The handlerThreadId. */ @@ -384,6 +400,10 @@ public int getHandlerThreadId() { return handlerThreadId_; } /** + *
+     * The ID of the Failure Handler ThreadRun.
+     * 
+ * * int32 handler_thread_id = 1; * @param value The handlerThreadId to set. * @return This builder for chaining. @@ -396,6 +416,10 @@ public Builder setHandlerThreadId(int value) { return this; } /** + *
+     * The ID of the Failure Handler ThreadRun.
+     * 
+ * * int32 handler_thread_id = 1; * @return This builder for chaining. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/HandlingFailureHaltReasonOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/HandlingFailureHaltReasonOrBuilder.java index f582ff810..5913e165a 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/HandlingFailureHaltReasonOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/HandlingFailureHaltReasonOrBuilder.java @@ -8,6 +8,10 @@ public interface HandlingFailureHaltReasonOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The ID of the Failure Handler ThreadRun.
+   * 
+ * * int32 handler_thread_id = 1; * @return The handlerThreadId. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/Interrupted.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/Interrupted.java index 5720728eb..1f566fa25 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/Interrupted.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/Interrupted.java @@ -4,6 +4,11 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * A Halt Reason denoting that a ThreadRun is halted because it is waiting for the
+ * interrupt handler threadRun to run.
+ * 
+ * * Protobuf type {@code littlehorse.Interrupted} */ public final class Interrupted extends @@ -41,6 +46,10 @@ protected java.lang.Object newInstance( public static final int INTERRUPT_THREAD_ID_FIELD_NUMBER = 1; private int interruptThreadId_ = 0; /** + *
+   * The ID of the Interrupt Handler ThreadRun.
+   * 
+ * * int32 interrupt_thread_id = 1; * @return The interruptThreadId. */ @@ -207,6 +216,11 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * A Halt Reason denoting that a ThreadRun is halted because it is waiting for the
+   * interrupt handler threadRun to run.
+   * 
+ * * Protobuf type {@code littlehorse.Interrupted} */ public static final class Builder extends @@ -376,6 +390,10 @@ public Builder mergeFrom( private int interruptThreadId_ ; /** + *
+     * The ID of the Interrupt Handler ThreadRun.
+     * 
+ * * int32 interrupt_thread_id = 1; * @return The interruptThreadId. */ @@ -384,6 +402,10 @@ public int getInterruptThreadId() { return interruptThreadId_; } /** + *
+     * The ID of the Interrupt Handler ThreadRun.
+     * 
+ * * int32 interrupt_thread_id = 1; * @param value The interruptThreadId to set. * @return This builder for chaining. @@ -396,6 +418,10 @@ public Builder setInterruptThreadId(int value) { return this; } /** + *
+     * The ID of the Interrupt Handler ThreadRun.
+     * 
+ * * int32 interrupt_thread_id = 1; * @return This builder for chaining. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/InterruptedOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/InterruptedOrBuilder.java index 065d103ef..f319a3fa4 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/InterruptedOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/InterruptedOrBuilder.java @@ -8,6 +8,10 @@ public interface InterruptedOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The ID of the Interrupt Handler ThreadRun.
+   * 
+ * * int32 interrupt_thread_id = 1; * @return The interruptThreadId. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/LHTaskError.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/LHTaskError.java index a913de58c..7ddc42a3c 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/LHTaskError.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/LHTaskError.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * Message denoting a TaskRun failed for technical reasons.
+ * 
+ * * Protobuf type {@code littlehorse.LHTaskError} */ public final class LHTaskError extends @@ -43,6 +47,10 @@ protected java.lang.Object newInstance( public static final int TYPE_FIELD_NUMBER = 1; private int type_ = 0; /** + *
+   * The technical error code.
+   * 
+ * * .littlehorse.LHErrorType type = 1; * @return The enum numeric value on the wire for type. */ @@ -50,6 +58,10 @@ protected java.lang.Object newInstance( return type_; } /** + *
+   * The technical error code.
+   * 
+ * * .littlehorse.LHErrorType type = 1; * @return The type. */ @@ -62,6 +74,10 @@ protected java.lang.Object newInstance( @SuppressWarnings("serial") private volatile java.lang.Object message_ = ""; /** + *
+   * Human readable message for debugging.
+   * 
+ * * string message = 2; * @return The message. */ @@ -79,6 +95,10 @@ public java.lang.String getMessage() { } } /** + *
+   * Human readable message for debugging.
+   * 
+ * * string message = 2; * @return The bytes for message. */ @@ -264,6 +284,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * Message denoting a TaskRun failed for technical reasons.
+   * 
+ * * Protobuf type {@code littlehorse.LHTaskError} */ public static final class Builder extends @@ -447,6 +471,10 @@ public Builder mergeFrom( private int type_ = 0; /** + *
+     * The technical error code.
+     * 
+ * * .littlehorse.LHErrorType type = 1; * @return The enum numeric value on the wire for type. */ @@ -454,6 +482,10 @@ public Builder mergeFrom( return type_; } /** + *
+     * The technical error code.
+     * 
+ * * .littlehorse.LHErrorType type = 1; * @param value The enum numeric value on the wire for type to set. * @return This builder for chaining. @@ -465,6 +497,10 @@ public Builder setTypeValue(int value) { return this; } /** + *
+     * The technical error code.
+     * 
+ * * .littlehorse.LHErrorType type = 1; * @return The type. */ @@ -474,6 +510,10 @@ public io.littlehorse.sdk.common.proto.LHErrorType getType() { return result == null ? io.littlehorse.sdk.common.proto.LHErrorType.UNRECOGNIZED : result; } /** + *
+     * The technical error code.
+     * 
+ * * .littlehorse.LHErrorType type = 1; * @param value The type to set. * @return This builder for chaining. @@ -488,6 +528,10 @@ public Builder setType(io.littlehorse.sdk.common.proto.LHErrorType value) { return this; } /** + *
+     * The technical error code.
+     * 
+ * * .littlehorse.LHErrorType type = 1; * @return This builder for chaining. */ @@ -500,6 +544,10 @@ public Builder clearType() { private java.lang.Object message_ = ""; /** + *
+     * Human readable message for debugging.
+     * 
+ * * string message = 2; * @return The message. */ @@ -516,6 +564,10 @@ public java.lang.String getMessage() { } } /** + *
+     * Human readable message for debugging.
+     * 
+ * * string message = 2; * @return The bytes for message. */ @@ -533,6 +585,10 @@ public java.lang.String getMessage() { } } /** + *
+     * Human readable message for debugging.
+     * 
+ * * string message = 2; * @param value The message to set. * @return This builder for chaining. @@ -546,6 +602,10 @@ public Builder setMessage( return this; } /** + *
+     * Human readable message for debugging.
+     * 
+ * * string message = 2; * @return This builder for chaining. */ @@ -556,6 +616,10 @@ public Builder clearMessage() { return this; } /** + *
+     * Human readable message for debugging.
+     * 
+ * * string message = 2; * @param value The bytes for message to set. * @return This builder for chaining. diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/LHTaskErrorOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/LHTaskErrorOrBuilder.java index d550bbb48..0698d7ca7 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/LHTaskErrorOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/LHTaskErrorOrBuilder.java @@ -8,22 +8,38 @@ public interface LHTaskErrorOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The technical error code.
+   * 
+ * * .littlehorse.LHErrorType type = 1; * @return The enum numeric value on the wire for type. */ int getTypeValue(); /** + *
+   * The technical error code.
+   * 
+ * * .littlehorse.LHErrorType type = 1; * @return The type. */ io.littlehorse.sdk.common.proto.LHErrorType getType(); /** + *
+   * Human readable message for debugging.
+   * 
+ * * string message = 2; * @return The message. */ java.lang.String getMessage(); /** + *
+   * Human readable message for debugging.
+   * 
+ * * string message = 2; * @return The bytes for message. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/LHTaskException.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/LHTaskException.java index 83cc8e215..a4c6395ff 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/LHTaskException.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/LHTaskException.java @@ -4,6 +4,11 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * Message denoting a TaskRun's execution signaled that something went wrong in the
+ * business process, throwing a littlehorse 'EXCEPTION'.
+ * 
+ * * Protobuf type {@code littlehorse.LHTaskException} */ public final class LHTaskException extends @@ -44,6 +49,10 @@ protected java.lang.Object newInstance( @SuppressWarnings("serial") private volatile java.lang.Object name_ = ""; /** + *
+   * The user-defined Failure name, for example, "credit-card-declined"
+   * 
+ * * string name = 1; * @return The name. */ @@ -61,6 +70,10 @@ public java.lang.String getName() { } } /** + *
+   * The user-defined Failure name, for example, "credit-card-declined"
+   * 
+ * * string name = 1; * @return The bytes for name. */ @@ -83,6 +96,10 @@ public java.lang.String getName() { @SuppressWarnings("serial") private volatile java.lang.Object message_ = ""; /** + *
+   * Human readadble description of the failure.
+   * 
+ * * string message = 2; * @return The message. */ @@ -100,6 +117,10 @@ public java.lang.String getMessage() { } } /** + *
+   * Human readadble description of the failure.
+   * 
+ * * string message = 2; * @return The bytes for message. */ @@ -285,6 +306,11 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * Message denoting a TaskRun's execution signaled that something went wrong in the
+   * business process, throwing a littlehorse 'EXCEPTION'.
+   * 
+ * * Protobuf type {@code littlehorse.LHTaskException} */ public static final class Builder extends @@ -470,6 +496,10 @@ public Builder mergeFrom( private java.lang.Object name_ = ""; /** + *
+     * The user-defined Failure name, for example, "credit-card-declined"
+     * 
+ * * string name = 1; * @return The name. */ @@ -486,6 +516,10 @@ public java.lang.String getName() { } } /** + *
+     * The user-defined Failure name, for example, "credit-card-declined"
+     * 
+ * * string name = 1; * @return The bytes for name. */ @@ -503,6 +537,10 @@ public java.lang.String getName() { } } /** + *
+     * The user-defined Failure name, for example, "credit-card-declined"
+     * 
+ * * string name = 1; * @param value The name to set. * @return This builder for chaining. @@ -516,6 +554,10 @@ public Builder setName( return this; } /** + *
+     * The user-defined Failure name, for example, "credit-card-declined"
+     * 
+ * * string name = 1; * @return This builder for chaining. */ @@ -526,6 +568,10 @@ public Builder clearName() { return this; } /** + *
+     * The user-defined Failure name, for example, "credit-card-declined"
+     * 
+ * * string name = 1; * @param value The bytes for name to set. * @return This builder for chaining. @@ -542,6 +588,10 @@ public Builder setNameBytes( private java.lang.Object message_ = ""; /** + *
+     * Human readadble description of the failure.
+     * 
+ * * string message = 2; * @return The message. */ @@ -558,6 +608,10 @@ public java.lang.String getMessage() { } } /** + *
+     * Human readadble description of the failure.
+     * 
+ * * string message = 2; * @return The bytes for message. */ @@ -575,6 +629,10 @@ public java.lang.String getMessage() { } } /** + *
+     * Human readadble description of the failure.
+     * 
+ * * string message = 2; * @param value The message to set. * @return This builder for chaining. @@ -588,6 +646,10 @@ public Builder setMessage( return this; } /** + *
+     * Human readadble description of the failure.
+     * 
+ * * string message = 2; * @return This builder for chaining. */ @@ -598,6 +660,10 @@ public Builder clearMessage() { return this; } /** + *
+     * Human readadble description of the failure.
+     * 
+ * * string message = 2; * @param value The bytes for message to set. * @return This builder for chaining. diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/LHTaskExceptionOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/LHTaskExceptionOrBuilder.java index 64adcacd7..687524a9c 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/LHTaskExceptionOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/LHTaskExceptionOrBuilder.java @@ -8,11 +8,19 @@ public interface LHTaskExceptionOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The user-defined Failure name, for example, "credit-card-declined"
+   * 
+ * * string name = 1; * @return The name. */ java.lang.String getName(); /** + *
+   * The user-defined Failure name, for example, "credit-card-declined"
+   * 
+ * * string name = 1; * @return The bytes for name. */ @@ -20,11 +28,19 @@ public interface LHTaskExceptionOrBuilder extends getNameBytes(); /** + *
+   * Human readadble description of the failure.
+   * 
+ * * string message = 2; * @return The message. */ java.lang.String getMessage(); /** + *
+   * Human readadble description of the failure.
+   * 
+ * * string message = 2; * @return The bytes for message. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ManualHalt.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ManualHalt.java index ff1e67327..50bc9cce1 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ManualHalt.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ManualHalt.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * A Halt Reason denoting that a ThreadRun was halted manually, via the `rpc StopWfRun` request.
+ * 
+ * * Protobuf type {@code littlehorse.ManualHalt} */ public final class ManualHalt extends @@ -212,6 +216,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * A Halt Reason denoting that a ThreadRun was halted manually, via the `rpc StopWfRun` request.
+   * 
+ * * Protobuf type {@code littlehorse.ManualHalt} */ public static final class Builder extends diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/NodeRun.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/NodeRun.java index 65e3d775a..201f2bf6d 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/NodeRun.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/NodeRun.java @@ -4,6 +4,11 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * A NodeRun is a running instance of a Node in a ThreadRun. Note that a NodeRun
+ * is a Getable object, meaning it can be retried from the LittleHorse grpc API.
+ * 
+ * * Protobuf type {@code littlehorse.NodeRun} */ public final class NodeRun extends @@ -104,6 +109,11 @@ public int getNumber() { public static final int ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.NodeRunId id_; /** + *
+   * The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the
+   * ThreadRun's number, and the position of the NodeRun within that ThreadRun.
+   * 
+ * * .littlehorse.NodeRunId id = 1; * @return Whether the id field is set. */ @@ -112,6 +122,11 @@ public boolean hasId() { return id_ != null; } /** + *
+   * The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the
+   * ThreadRun's number, and the position of the NodeRun within that ThreadRun.
+   * 
+ * * .littlehorse.NodeRunId id = 1; * @return The id. */ @@ -120,6 +135,11 @@ public io.littlehorse.sdk.common.proto.NodeRunId getId() { return id_ == null ? io.littlehorse.sdk.common.proto.NodeRunId.getDefaultInstance() : id_; } /** + *
+   * The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the
+   * ThreadRun's number, and the position of the NodeRun within that ThreadRun.
+   * 
+ * * .littlehorse.NodeRunId id = 1; */ @java.lang.Override @@ -130,6 +150,12 @@ public io.littlehorse.sdk.common.proto.NodeRunIdOrBuilder getIdOrBuilder() { public static final int WF_SPEC_ID_FIELD_NUMBER = 4; private io.littlehorse.sdk.common.proto.WfSpecId wfSpecId_; /** + *
+   * The ID of the WfSpec that this NodeRun is from. This is not _always_ the same
+   * as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration
+   * feature.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; * @return Whether the wfSpecId field is set. */ @@ -138,6 +164,12 @@ public boolean hasWfSpecId() { return wfSpecId_ != null; } /** + *
+   * The ID of the WfSpec that this NodeRun is from. This is not _always_ the same
+   * as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration
+   * feature.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; * @return The wfSpecId. */ @@ -146,6 +178,12 @@ public io.littlehorse.sdk.common.proto.WfSpecId getWfSpecId() { return wfSpecId_ == null ? io.littlehorse.sdk.common.proto.WfSpecId.getDefaultInstance() : wfSpecId_; } /** + *
+   * The ID of the WfSpec that this NodeRun is from. This is not _always_ the same
+   * as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration
+   * feature.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; */ @java.lang.Override @@ -157,6 +195,10 @@ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder() @SuppressWarnings("serial") private com.google.protobuf.Internal.IntList failureHandlerIds_; /** + *
+   * A list of all ThreadRun's that ran to handle a failure thrown by this NodeRun.
+   * 
+ * * repeated int32 failure_handler_ids = 5; * @return A list containing the failureHandlerIds. */ @@ -166,6 +208,10 @@ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder() return failureHandlerIds_; } /** + *
+   * A list of all ThreadRun's that ran to handle a failure thrown by this NodeRun.
+   * 
+ * * repeated int32 failure_handler_ids = 5; * @return The count of failureHandlerIds. */ @@ -173,6 +219,10 @@ public int getFailureHandlerIdsCount() { return failureHandlerIds_.size(); } /** + *
+   * A list of all ThreadRun's that ran to handle a failure thrown by this NodeRun.
+   * 
+ * * repeated int32 failure_handler_ids = 5; * @param index The index of the element to return. * @return The failureHandlerIds at the given index. @@ -185,6 +235,10 @@ public int getFailureHandlerIds(int index) { public static final int STATUS_FIELD_NUMBER = 6; private int status_ = 0; /** + *
+   * The status of this NodeRun.
+   * 
+ * * .littlehorse.LHStatus status = 6; * @return The enum numeric value on the wire for status. */ @@ -192,6 +246,10 @@ public int getFailureHandlerIds(int index) { return status_; } /** + *
+   * The status of this NodeRun.
+   * 
+ * * .littlehorse.LHStatus status = 6; * @return The status. */ @@ -203,6 +261,10 @@ public int getFailureHandlerIds(int index) { public static final int ARRIVAL_TIME_FIELD_NUMBER = 7; private com.google.protobuf.Timestamp arrivalTime_; /** + *
+   * The time the ThreadRun arrived at this NodeRun.
+   * 
+ * * .google.protobuf.Timestamp arrival_time = 7; * @return Whether the arrivalTime field is set. */ @@ -211,6 +273,10 @@ public boolean hasArrivalTime() { return arrivalTime_ != null; } /** + *
+   * The time the ThreadRun arrived at this NodeRun.
+   * 
+ * * .google.protobuf.Timestamp arrival_time = 7; * @return The arrivalTime. */ @@ -219,6 +285,10 @@ public com.google.protobuf.Timestamp getArrivalTime() { return arrivalTime_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : arrivalTime_; } /** + *
+   * The time the ThreadRun arrived at this NodeRun.
+   * 
+ * * .google.protobuf.Timestamp arrival_time = 7; */ @java.lang.Override @@ -229,6 +299,10 @@ public com.google.protobuf.TimestampOrBuilder getArrivalTimeOrBuilder() { public static final int END_TIME_FIELD_NUMBER = 8; private com.google.protobuf.Timestamp endTime_; /** + *
+   * The time the NodeRun was terminated (failed or completed).
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 8; * @return Whether the endTime field is set. */ @@ -237,6 +311,10 @@ public boolean hasEndTime() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+   * The time the NodeRun was terminated (failed or completed).
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 8; * @return The endTime. */ @@ -245,6 +323,10 @@ public com.google.protobuf.Timestamp getEndTime() { return endTime_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : endTime_; } /** + *
+   * The time the NodeRun was terminated (failed or completed).
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 8; */ @java.lang.Override @@ -256,6 +338,10 @@ public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder() { @SuppressWarnings("serial") private volatile java.lang.Object threadSpecName_ = ""; /** + *
+   * The name of the ThreadSpec to which this NodeRun belongs.
+   * 
+ * * string thread_spec_name = 9; * @return The threadSpecName. */ @@ -273,6 +359,10 @@ public java.lang.String getThreadSpecName() { } } /** + *
+   * The name of the ThreadSpec to which this NodeRun belongs.
+   * 
+ * * string thread_spec_name = 9; * @return The bytes for threadSpecName. */ @@ -295,6 +385,10 @@ public java.lang.String getThreadSpecName() { @SuppressWarnings("serial") private volatile java.lang.Object nodeName_ = ""; /** + *
+   * The name of the Node in the ThreadSpec that this NodeRun belongs to.
+   * 
+ * * string node_name = 10; * @return The nodeName. */ @@ -312,6 +406,10 @@ public java.lang.String getNodeName() { } } /** + *
+   * The name of the Node in the ThreadSpec that this NodeRun belongs to.
+   * 
+ * * string node_name = 10; * @return The bytes for nodeName. */ @@ -334,6 +432,11 @@ public java.lang.String getNodeName() { @SuppressWarnings("serial") private volatile java.lang.Object errorMessage_ = ""; /** + *
+   * A human-readable error message intended to help developers diagnose WfSpec
+   * problems.
+   * 
+ * * optional string error_message = 11; * @return Whether the errorMessage field is set. */ @@ -342,6 +445,11 @@ public boolean hasErrorMessage() { return ((bitField0_ & 0x00000002) != 0); } /** + *
+   * A human-readable error message intended to help developers diagnose WfSpec
+   * problems.
+   * 
+ * * optional string error_message = 11; * @return The errorMessage. */ @@ -359,6 +467,11 @@ public java.lang.String getErrorMessage() { } } /** + *
+   * A human-readable error message intended to help developers diagnose WfSpec
+   * problems.
+   * 
+ * * optional string error_message = 11; * @return The bytes for errorMessage. */ @@ -381,6 +494,10 @@ public java.lang.String getErrorMessage() { @SuppressWarnings("serial") private java.util.List failures_; /** + *
+   * A list of Failures thrown by this NodeRun.
+   * 
+ * * repeated .littlehorse.Failure failures = 12; */ @java.lang.Override @@ -388,6 +505,10 @@ public java.util.List getFailuresList() return failures_; } /** + *
+   * A list of Failures thrown by this NodeRun.
+   * 
+ * * repeated .littlehorse.Failure failures = 12; */ @java.lang.Override @@ -396,6 +517,10 @@ public java.util.List getFailuresList() return failures_; } /** + *
+   * A list of Failures thrown by this NodeRun.
+   * 
+ * * repeated .littlehorse.Failure failures = 12; */ @java.lang.Override @@ -403,6 +528,10 @@ public int getFailuresCount() { return failures_.size(); } /** + *
+   * A list of Failures thrown by this NodeRun.
+   * 
+ * * repeated .littlehorse.Failure failures = 12; */ @java.lang.Override @@ -410,6 +539,10 @@ public io.littlehorse.sdk.common.proto.Failure getFailures(int index) { return failures_.get(index); } /** + *
+   * A list of Failures thrown by this NodeRun.
+   * 
+ * * repeated .littlehorse.Failure failures = 12; */ @java.lang.Override @@ -420,6 +553,10 @@ public io.littlehorse.sdk.common.proto.FailureOrBuilder getFailuresOrBuilder( public static final int TASK_FIELD_NUMBER = 13; /** + *
+   * Denotes a TASK node, which runs a TaskRun.
+   * 
+ * * .littlehorse.TaskNodeRun task = 13; * @return Whether the task field is set. */ @@ -428,6 +565,10 @@ public boolean hasTask() { return nodeTypeCase_ == 13; } /** + *
+   * Denotes a TASK node, which runs a TaskRun.
+   * 
+ * * .littlehorse.TaskNodeRun task = 13; * @return The task. */ @@ -439,6 +580,10 @@ public io.littlehorse.sdk.common.proto.TaskNodeRun getTask() { return io.littlehorse.sdk.common.proto.TaskNodeRun.getDefaultInstance(); } /** + *
+   * Denotes a TASK node, which runs a TaskRun.
+   * 
+ * * .littlehorse.TaskNodeRun task = 13; */ @java.lang.Override @@ -451,6 +596,10 @@ public io.littlehorse.sdk.common.proto.TaskNodeRunOrBuilder getTaskOrBuilder() { public static final int EXTERNAL_EVENT_FIELD_NUMBER = 14; /** + *
+   * An EXTERNAL_EVENT node blocks until an ExternalEvent arrives.
+   * 
+ * * .littlehorse.ExternalEventRun external_event = 14; * @return Whether the externalEvent field is set. */ @@ -459,6 +608,10 @@ public boolean hasExternalEvent() { return nodeTypeCase_ == 14; } /** + *
+   * An EXTERNAL_EVENT node blocks until an ExternalEvent arrives.
+   * 
+ * * .littlehorse.ExternalEventRun external_event = 14; * @return The externalEvent. */ @@ -470,6 +623,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventRun getExternalEvent() { return io.littlehorse.sdk.common.proto.ExternalEventRun.getDefaultInstance(); } /** + *
+   * An EXTERNAL_EVENT node blocks until an ExternalEvent arrives.
+   * 
+ * * .littlehorse.ExternalEventRun external_event = 14; */ @java.lang.Override @@ -482,6 +639,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventRunOrBuilder getExternalEven public static final int ENTRYPOINT_FIELD_NUMBER = 15; /** + *
+   * An ENTRYPOINT node is the first thing that runs in a ThreadRun.
+   * 
+ * * .littlehorse.EntrypointRun entrypoint = 15; * @return Whether the entrypoint field is set. */ @@ -490,6 +651,10 @@ public boolean hasEntrypoint() { return nodeTypeCase_ == 15; } /** + *
+   * An ENTRYPOINT node is the first thing that runs in a ThreadRun.
+   * 
+ * * .littlehorse.EntrypointRun entrypoint = 15; * @return The entrypoint. */ @@ -501,6 +666,10 @@ public io.littlehorse.sdk.common.proto.EntrypointRun getEntrypoint() { return io.littlehorse.sdk.common.proto.EntrypointRun.getDefaultInstance(); } /** + *
+   * An ENTRYPOINT node is the first thing that runs in a ThreadRun.
+   * 
+ * * .littlehorse.EntrypointRun entrypoint = 15; */ @java.lang.Override @@ -513,6 +682,10 @@ public io.littlehorse.sdk.common.proto.EntrypointRunOrBuilder getEntrypointOrBui public static final int EXIT_FIELD_NUMBER = 16; /** + *
+   * An EXIT node completes a ThreadRun.
+   * 
+ * * .littlehorse.ExitRun exit = 16; * @return Whether the exit field is set. */ @@ -521,6 +694,10 @@ public boolean hasExit() { return nodeTypeCase_ == 16; } /** + *
+   * An EXIT node completes a ThreadRun.
+   * 
+ * * .littlehorse.ExitRun exit = 16; * @return The exit. */ @@ -532,6 +709,10 @@ public io.littlehorse.sdk.common.proto.ExitRun getExit() { return io.littlehorse.sdk.common.proto.ExitRun.getDefaultInstance(); } /** + *
+   * An EXIT node completes a ThreadRun.
+   * 
+ * * .littlehorse.ExitRun exit = 16; */ @java.lang.Override @@ -544,6 +725,10 @@ public io.littlehorse.sdk.common.proto.ExitRunOrBuilder getExitOrBuilder() { public static final int START_THREAD_FIELD_NUMBER = 17; /** + *
+   * A START_THREAD node starts a child ThreadRun.
+   * 
+ * * .littlehorse.StartThreadRun start_thread = 17; * @return Whether the startThread field is set. */ @@ -552,6 +737,10 @@ public boolean hasStartThread() { return nodeTypeCase_ == 17; } /** + *
+   * A START_THREAD node starts a child ThreadRun.
+   * 
+ * * .littlehorse.StartThreadRun start_thread = 17; * @return The startThread. */ @@ -563,6 +752,10 @@ public io.littlehorse.sdk.common.proto.StartThreadRun getStartThread() { return io.littlehorse.sdk.common.proto.StartThreadRun.getDefaultInstance(); } /** + *
+   * A START_THREAD node starts a child ThreadRun.
+   * 
+ * * .littlehorse.StartThreadRun start_thread = 17; */ @java.lang.Override @@ -575,6 +768,10 @@ public io.littlehorse.sdk.common.proto.StartThreadRunOrBuilder getStartThreadOrB public static final int WAIT_THREADS_FIELD_NUMBER = 18; /** + *
+   * A WAIT_THREADS node waits for one or more child ThreadRun's to complete.
+   * 
+ * * .littlehorse.WaitForThreadsRun wait_threads = 18; * @return Whether the waitThreads field is set. */ @@ -583,6 +780,10 @@ public boolean hasWaitThreads() { return nodeTypeCase_ == 18; } /** + *
+   * A WAIT_THREADS node waits for one or more child ThreadRun's to complete.
+   * 
+ * * .littlehorse.WaitForThreadsRun wait_threads = 18; * @return The waitThreads. */ @@ -594,6 +795,10 @@ public io.littlehorse.sdk.common.proto.WaitForThreadsRun getWaitThreads() { return io.littlehorse.sdk.common.proto.WaitForThreadsRun.getDefaultInstance(); } /** + *
+   * A WAIT_THREADS node waits for one or more child ThreadRun's to complete.
+   * 
+ * * .littlehorse.WaitForThreadsRun wait_threads = 18; */ @java.lang.Override @@ -606,6 +811,10 @@ public io.littlehorse.sdk.common.proto.WaitForThreadsRunOrBuilder getWaitThreads public static final int SLEEP_FIELD_NUMBER = 19; /** + *
+   * A SLEEP node makes the ThreadRun block for a certain amount of time.
+   * 
+ * * .littlehorse.SleepNodeRun sleep = 19; * @return Whether the sleep field is set. */ @@ -614,6 +823,10 @@ public boolean hasSleep() { return nodeTypeCase_ == 19; } /** + *
+   * A SLEEP node makes the ThreadRun block for a certain amount of time.
+   * 
+ * * .littlehorse.SleepNodeRun sleep = 19; * @return The sleep. */ @@ -625,6 +838,10 @@ public io.littlehorse.sdk.common.proto.SleepNodeRun getSleep() { return io.littlehorse.sdk.common.proto.SleepNodeRun.getDefaultInstance(); } /** + *
+   * A SLEEP node makes the ThreadRun block for a certain amount of time.
+   * 
+ * * .littlehorse.SleepNodeRun sleep = 19; */ @java.lang.Override @@ -637,6 +854,10 @@ public io.littlehorse.sdk.common.proto.SleepNodeRunOrBuilder getSleepOrBuilder() public static final int USER_TASK_FIELD_NUMBER = 20; /** + *
+   * A USER_TASK node waits until a human executes some work and reports the result.
+   * 
+ * * .littlehorse.UserTaskNodeRun user_task = 20; * @return Whether the userTask field is set. */ @@ -645,6 +866,10 @@ public boolean hasUserTask() { return nodeTypeCase_ == 20; } /** + *
+   * A USER_TASK node waits until a human executes some work and reports the result.
+   * 
+ * * .littlehorse.UserTaskNodeRun user_task = 20; * @return The userTask. */ @@ -656,6 +881,10 @@ public io.littlehorse.sdk.common.proto.UserTaskNodeRun getUserTask() { return io.littlehorse.sdk.common.proto.UserTaskNodeRun.getDefaultInstance(); } /** + *
+   * A USER_TASK node waits until a human executes some work and reports the result.
+   * 
+ * * .littlehorse.UserTaskNodeRun user_task = 20; */ @java.lang.Override @@ -668,6 +897,11 @@ public io.littlehorse.sdk.common.proto.UserTaskNodeRunOrBuilder getUserTaskOrBui public static final int START_MULTIPLE_THREADS_FIELD_NUMBER = 21; /** + *
+   * A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a
+   * child ThreadRun for each element in the list.
+   * 
+ * * .littlehorse.StartMultipleThreadsRun start_multiple_threads = 21; * @return Whether the startMultipleThreads field is set. */ @@ -676,6 +910,11 @@ public boolean hasStartMultipleThreads() { return nodeTypeCase_ == 21; } /** + *
+   * A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a
+   * child ThreadRun for each element in the list.
+   * 
+ * * .littlehorse.StartMultipleThreadsRun start_multiple_threads = 21; * @return The startMultipleThreads. */ @@ -687,6 +926,11 @@ public io.littlehorse.sdk.common.proto.StartMultipleThreadsRun getStartMultipleT return io.littlehorse.sdk.common.proto.StartMultipleThreadsRun.getDefaultInstance(); } /** + *
+   * A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a
+   * child ThreadRun for each element in the list.
+   * 
+ * * .littlehorse.StartMultipleThreadsRun start_multiple_threads = 21; */ @java.lang.Override @@ -1138,6 +1382,11 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * A NodeRun is a running instance of a Node in a ThreadRun. Note that a NodeRun
+   * is a Getable object, meaning it can be retried from the LittleHorse grpc API.
+   * 
+ * * Protobuf type {@code littlehorse.NodeRun} */ public static final class Builder extends @@ -1726,6 +1975,11 @@ public Builder clearNodeType() { private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.NodeRunId, io.littlehorse.sdk.common.proto.NodeRunId.Builder, io.littlehorse.sdk.common.proto.NodeRunIdOrBuilder> idBuilder_; /** + *
+     * The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the
+     * ThreadRun's number, and the position of the NodeRun within that ThreadRun.
+     * 
+ * * .littlehorse.NodeRunId id = 1; * @return Whether the id field is set. */ @@ -1733,6 +1987,11 @@ public boolean hasId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the
+     * ThreadRun's number, and the position of the NodeRun within that ThreadRun.
+     * 
+ * * .littlehorse.NodeRunId id = 1; * @return The id. */ @@ -1744,6 +2003,11 @@ public io.littlehorse.sdk.common.proto.NodeRunId getId() { } } /** + *
+     * The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the
+     * ThreadRun's number, and the position of the NodeRun within that ThreadRun.
+     * 
+ * * .littlehorse.NodeRunId id = 1; */ public Builder setId(io.littlehorse.sdk.common.proto.NodeRunId value) { @@ -1760,6 +2024,11 @@ public Builder setId(io.littlehorse.sdk.common.proto.NodeRunId value) { return this; } /** + *
+     * The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the
+     * ThreadRun's number, and the position of the NodeRun within that ThreadRun.
+     * 
+ * * .littlehorse.NodeRunId id = 1; */ public Builder setId( @@ -1774,6 +2043,11 @@ public Builder setId( return this; } /** + *
+     * The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the
+     * ThreadRun's number, and the position of the NodeRun within that ThreadRun.
+     * 
+ * * .littlehorse.NodeRunId id = 1; */ public Builder mergeId(io.littlehorse.sdk.common.proto.NodeRunId value) { @@ -1793,6 +2067,11 @@ public Builder mergeId(io.littlehorse.sdk.common.proto.NodeRunId value) { return this; } /** + *
+     * The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the
+     * ThreadRun's number, and the position of the NodeRun within that ThreadRun.
+     * 
+ * * .littlehorse.NodeRunId id = 1; */ public Builder clearId() { @@ -1806,6 +2085,11 @@ public Builder clearId() { return this; } /** + *
+     * The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the
+     * ThreadRun's number, and the position of the NodeRun within that ThreadRun.
+     * 
+ * * .littlehorse.NodeRunId id = 1; */ public io.littlehorse.sdk.common.proto.NodeRunId.Builder getIdBuilder() { @@ -1814,6 +2098,11 @@ public io.littlehorse.sdk.common.proto.NodeRunId.Builder getIdBuilder() { return getIdFieldBuilder().getBuilder(); } /** + *
+     * The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the
+     * ThreadRun's number, and the position of the NodeRun within that ThreadRun.
+     * 
+ * * .littlehorse.NodeRunId id = 1; */ public io.littlehorse.sdk.common.proto.NodeRunIdOrBuilder getIdOrBuilder() { @@ -1825,6 +2114,11 @@ public io.littlehorse.sdk.common.proto.NodeRunIdOrBuilder getIdOrBuilder() { } } /** + *
+     * The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the
+     * ThreadRun's number, and the position of the NodeRun within that ThreadRun.
+     * 
+ * * .littlehorse.NodeRunId id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1845,6 +2139,12 @@ public io.littlehorse.sdk.common.proto.NodeRunIdOrBuilder getIdOrBuilder() { private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.WfSpecId, io.littlehorse.sdk.common.proto.WfSpecId.Builder, io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder> wfSpecIdBuilder_; /** + *
+     * The ID of the WfSpec that this NodeRun is from. This is not _always_ the same
+     * as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration
+     * feature.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; * @return Whether the wfSpecId field is set. */ @@ -1852,6 +2152,12 @@ public boolean hasWfSpecId() { return ((bitField0_ & 0x00000002) != 0); } /** + *
+     * The ID of the WfSpec that this NodeRun is from. This is not _always_ the same
+     * as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration
+     * feature.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; * @return The wfSpecId. */ @@ -1863,6 +2169,12 @@ public io.littlehorse.sdk.common.proto.WfSpecId getWfSpecId() { } } /** + *
+     * The ID of the WfSpec that this NodeRun is from. This is not _always_ the same
+     * as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration
+     * feature.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; */ public Builder setWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { @@ -1879,6 +2191,12 @@ public Builder setWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { return this; } /** + *
+     * The ID of the WfSpec that this NodeRun is from. This is not _always_ the same
+     * as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration
+     * feature.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; */ public Builder setWfSpecId( @@ -1893,6 +2211,12 @@ public Builder setWfSpecId( return this; } /** + *
+     * The ID of the WfSpec that this NodeRun is from. This is not _always_ the same
+     * as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration
+     * feature.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; */ public Builder mergeWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { @@ -1912,6 +2236,12 @@ public Builder mergeWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { return this; } /** + *
+     * The ID of the WfSpec that this NodeRun is from. This is not _always_ the same
+     * as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration
+     * feature.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; */ public Builder clearWfSpecId() { @@ -1925,6 +2255,12 @@ public Builder clearWfSpecId() { return this; } /** + *
+     * The ID of the WfSpec that this NodeRun is from. This is not _always_ the same
+     * as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration
+     * feature.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; */ public io.littlehorse.sdk.common.proto.WfSpecId.Builder getWfSpecIdBuilder() { @@ -1933,6 +2269,12 @@ public io.littlehorse.sdk.common.proto.WfSpecId.Builder getWfSpecIdBuilder() { return getWfSpecIdFieldBuilder().getBuilder(); } /** + *
+     * The ID of the WfSpec that this NodeRun is from. This is not _always_ the same
+     * as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration
+     * feature.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; */ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder() { @@ -1944,6 +2286,12 @@ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder() } } /** + *
+     * The ID of the WfSpec that this NodeRun is from. This is not _always_ the same
+     * as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration
+     * feature.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1968,6 +2316,10 @@ private void ensureFailureHandlerIdsIsMutable() { } } /** + *
+     * A list of all ThreadRun's that ran to handle a failure thrown by this NodeRun.
+     * 
+ * * repeated int32 failure_handler_ids = 5; * @return A list containing the failureHandlerIds. */ @@ -1977,6 +2329,10 @@ private void ensureFailureHandlerIdsIsMutable() { java.util.Collections.unmodifiableList(failureHandlerIds_) : failureHandlerIds_; } /** + *
+     * A list of all ThreadRun's that ran to handle a failure thrown by this NodeRun.
+     * 
+ * * repeated int32 failure_handler_ids = 5; * @return The count of failureHandlerIds. */ @@ -1984,6 +2340,10 @@ public int getFailureHandlerIdsCount() { return failureHandlerIds_.size(); } /** + *
+     * A list of all ThreadRun's that ran to handle a failure thrown by this NodeRun.
+     * 
+ * * repeated int32 failure_handler_ids = 5; * @param index The index of the element to return. * @return The failureHandlerIds at the given index. @@ -1992,6 +2352,10 @@ public int getFailureHandlerIds(int index) { return failureHandlerIds_.getInt(index); } /** + *
+     * A list of all ThreadRun's that ran to handle a failure thrown by this NodeRun.
+     * 
+ * * repeated int32 failure_handler_ids = 5; * @param index The index to set the value at. * @param value The failureHandlerIds to set. @@ -2006,6 +2370,10 @@ public Builder setFailureHandlerIds( return this; } /** + *
+     * A list of all ThreadRun's that ran to handle a failure thrown by this NodeRun.
+     * 
+ * * repeated int32 failure_handler_ids = 5; * @param value The failureHandlerIds to add. * @return This builder for chaining. @@ -2018,6 +2386,10 @@ public Builder addFailureHandlerIds(int value) { return this; } /** + *
+     * A list of all ThreadRun's that ran to handle a failure thrown by this NodeRun.
+     * 
+ * * repeated int32 failure_handler_ids = 5; * @param values The failureHandlerIds to add. * @return This builder for chaining. @@ -2031,6 +2403,10 @@ public Builder addAllFailureHandlerIds( return this; } /** + *
+     * A list of all ThreadRun's that ran to handle a failure thrown by this NodeRun.
+     * 
+ * * repeated int32 failure_handler_ids = 5; * @return This builder for chaining. */ @@ -2043,6 +2419,10 @@ public Builder clearFailureHandlerIds() { private int status_ = 0; /** + *
+     * The status of this NodeRun.
+     * 
+ * * .littlehorse.LHStatus status = 6; * @return The enum numeric value on the wire for status. */ @@ -2050,6 +2430,10 @@ public Builder clearFailureHandlerIds() { return status_; } /** + *
+     * The status of this NodeRun.
+     * 
+ * * .littlehorse.LHStatus status = 6; * @param value The enum numeric value on the wire for status to set. * @return This builder for chaining. @@ -2061,6 +2445,10 @@ public Builder setStatusValue(int value) { return this; } /** + *
+     * The status of this NodeRun.
+     * 
+ * * .littlehorse.LHStatus status = 6; * @return The status. */ @@ -2070,6 +2458,10 @@ public io.littlehorse.sdk.common.proto.LHStatus getStatus() { return result == null ? io.littlehorse.sdk.common.proto.LHStatus.UNRECOGNIZED : result; } /** + *
+     * The status of this NodeRun.
+     * 
+ * * .littlehorse.LHStatus status = 6; * @param value The status to set. * @return This builder for chaining. @@ -2084,6 +2476,10 @@ public Builder setStatus(io.littlehorse.sdk.common.proto.LHStatus value) { return this; } /** + *
+     * The status of this NodeRun.
+     * 
+ * * .littlehorse.LHStatus status = 6; * @return This builder for chaining. */ @@ -2098,6 +2494,10 @@ public Builder clearStatus() { private com.google.protobuf.SingleFieldBuilderV3< com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> arrivalTimeBuilder_; /** + *
+     * The time the ThreadRun arrived at this NodeRun.
+     * 
+ * * .google.protobuf.Timestamp arrival_time = 7; * @return Whether the arrivalTime field is set. */ @@ -2105,6 +2505,10 @@ public boolean hasArrivalTime() { return ((bitField0_ & 0x00000010) != 0); } /** + *
+     * The time the ThreadRun arrived at this NodeRun.
+     * 
+ * * .google.protobuf.Timestamp arrival_time = 7; * @return The arrivalTime. */ @@ -2116,6 +2520,10 @@ public com.google.protobuf.Timestamp getArrivalTime() { } } /** + *
+     * The time the ThreadRun arrived at this NodeRun.
+     * 
+ * * .google.protobuf.Timestamp arrival_time = 7; */ public Builder setArrivalTime(com.google.protobuf.Timestamp value) { @@ -2132,6 +2540,10 @@ public Builder setArrivalTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the ThreadRun arrived at this NodeRun.
+     * 
+ * * .google.protobuf.Timestamp arrival_time = 7; */ public Builder setArrivalTime( @@ -2146,6 +2558,10 @@ public Builder setArrivalTime( return this; } /** + *
+     * The time the ThreadRun arrived at this NodeRun.
+     * 
+ * * .google.protobuf.Timestamp arrival_time = 7; */ public Builder mergeArrivalTime(com.google.protobuf.Timestamp value) { @@ -2165,6 +2581,10 @@ public Builder mergeArrivalTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the ThreadRun arrived at this NodeRun.
+     * 
+ * * .google.protobuf.Timestamp arrival_time = 7; */ public Builder clearArrivalTime() { @@ -2178,6 +2598,10 @@ public Builder clearArrivalTime() { return this; } /** + *
+     * The time the ThreadRun arrived at this NodeRun.
+     * 
+ * * .google.protobuf.Timestamp arrival_time = 7; */ public com.google.protobuf.Timestamp.Builder getArrivalTimeBuilder() { @@ -2186,6 +2610,10 @@ public com.google.protobuf.Timestamp.Builder getArrivalTimeBuilder() { return getArrivalTimeFieldBuilder().getBuilder(); } /** + *
+     * The time the ThreadRun arrived at this NodeRun.
+     * 
+ * * .google.protobuf.Timestamp arrival_time = 7; */ public com.google.protobuf.TimestampOrBuilder getArrivalTimeOrBuilder() { @@ -2197,6 +2625,10 @@ public com.google.protobuf.TimestampOrBuilder getArrivalTimeOrBuilder() { } } /** + *
+     * The time the ThreadRun arrived at this NodeRun.
+     * 
+ * * .google.protobuf.Timestamp arrival_time = 7; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -2217,6 +2649,10 @@ public com.google.protobuf.TimestampOrBuilder getArrivalTimeOrBuilder() { private com.google.protobuf.SingleFieldBuilderV3< com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> endTimeBuilder_; /** + *
+     * The time the NodeRun was terminated (failed or completed).
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 8; * @return Whether the endTime field is set. */ @@ -2224,6 +2660,10 @@ public boolean hasEndTime() { return ((bitField0_ & 0x00000020) != 0); } /** + *
+     * The time the NodeRun was terminated (failed or completed).
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 8; * @return The endTime. */ @@ -2235,6 +2675,10 @@ public com.google.protobuf.Timestamp getEndTime() { } } /** + *
+     * The time the NodeRun was terminated (failed or completed).
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 8; */ public Builder setEndTime(com.google.protobuf.Timestamp value) { @@ -2251,6 +2695,10 @@ public Builder setEndTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the NodeRun was terminated (failed or completed).
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 8; */ public Builder setEndTime( @@ -2265,6 +2713,10 @@ public Builder setEndTime( return this; } /** + *
+     * The time the NodeRun was terminated (failed or completed).
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 8; */ public Builder mergeEndTime(com.google.protobuf.Timestamp value) { @@ -2284,6 +2736,10 @@ public Builder mergeEndTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the NodeRun was terminated (failed or completed).
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 8; */ public Builder clearEndTime() { @@ -2297,6 +2753,10 @@ public Builder clearEndTime() { return this; } /** + *
+     * The time the NodeRun was terminated (failed or completed).
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 8; */ public com.google.protobuf.Timestamp.Builder getEndTimeBuilder() { @@ -2305,6 +2765,10 @@ public com.google.protobuf.Timestamp.Builder getEndTimeBuilder() { return getEndTimeFieldBuilder().getBuilder(); } /** + *
+     * The time the NodeRun was terminated (failed or completed).
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 8; */ public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder() { @@ -2316,6 +2780,10 @@ public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder() { } } /** + *
+     * The time the NodeRun was terminated (failed or completed).
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 8; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -2334,6 +2802,10 @@ public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder() { private java.lang.Object threadSpecName_ = ""; /** + *
+     * The name of the ThreadSpec to which this NodeRun belongs.
+     * 
+ * * string thread_spec_name = 9; * @return The threadSpecName. */ @@ -2350,6 +2822,10 @@ public java.lang.String getThreadSpecName() { } } /** + *
+     * The name of the ThreadSpec to which this NodeRun belongs.
+     * 
+ * * string thread_spec_name = 9; * @return The bytes for threadSpecName. */ @@ -2367,6 +2843,10 @@ public java.lang.String getThreadSpecName() { } } /** + *
+     * The name of the ThreadSpec to which this NodeRun belongs.
+     * 
+ * * string thread_spec_name = 9; * @param value The threadSpecName to set. * @return This builder for chaining. @@ -2380,6 +2860,10 @@ public Builder setThreadSpecName( return this; } /** + *
+     * The name of the ThreadSpec to which this NodeRun belongs.
+     * 
+ * * string thread_spec_name = 9; * @return This builder for chaining. */ @@ -2390,6 +2874,10 @@ public Builder clearThreadSpecName() { return this; } /** + *
+     * The name of the ThreadSpec to which this NodeRun belongs.
+     * 
+ * * string thread_spec_name = 9; * @param value The bytes for threadSpecName to set. * @return This builder for chaining. @@ -2406,6 +2894,10 @@ public Builder setThreadSpecNameBytes( private java.lang.Object nodeName_ = ""; /** + *
+     * The name of the Node in the ThreadSpec that this NodeRun belongs to.
+     * 
+ * * string node_name = 10; * @return The nodeName. */ @@ -2422,6 +2914,10 @@ public java.lang.String getNodeName() { } } /** + *
+     * The name of the Node in the ThreadSpec that this NodeRun belongs to.
+     * 
+ * * string node_name = 10; * @return The bytes for nodeName. */ @@ -2439,6 +2935,10 @@ public java.lang.String getNodeName() { } } /** + *
+     * The name of the Node in the ThreadSpec that this NodeRun belongs to.
+     * 
+ * * string node_name = 10; * @param value The nodeName to set. * @return This builder for chaining. @@ -2452,6 +2952,10 @@ public Builder setNodeName( return this; } /** + *
+     * The name of the Node in the ThreadSpec that this NodeRun belongs to.
+     * 
+ * * string node_name = 10; * @return This builder for chaining. */ @@ -2462,6 +2966,10 @@ public Builder clearNodeName() { return this; } /** + *
+     * The name of the Node in the ThreadSpec that this NodeRun belongs to.
+     * 
+ * * string node_name = 10; * @param value The bytes for nodeName to set. * @return This builder for chaining. @@ -2478,6 +2986,11 @@ public Builder setNodeNameBytes( private java.lang.Object errorMessage_ = ""; /** + *
+     * A human-readable error message intended to help developers diagnose WfSpec
+     * problems.
+     * 
+ * * optional string error_message = 11; * @return Whether the errorMessage field is set. */ @@ -2485,6 +2998,11 @@ public boolean hasErrorMessage() { return ((bitField0_ & 0x00000100) != 0); } /** + *
+     * A human-readable error message intended to help developers diagnose WfSpec
+     * problems.
+     * 
+ * * optional string error_message = 11; * @return The errorMessage. */ @@ -2501,6 +3019,11 @@ public java.lang.String getErrorMessage() { } } /** + *
+     * A human-readable error message intended to help developers diagnose WfSpec
+     * problems.
+     * 
+ * * optional string error_message = 11; * @return The bytes for errorMessage. */ @@ -2518,6 +3041,11 @@ public java.lang.String getErrorMessage() { } } /** + *
+     * A human-readable error message intended to help developers diagnose WfSpec
+     * problems.
+     * 
+ * * optional string error_message = 11; * @param value The errorMessage to set. * @return This builder for chaining. @@ -2531,6 +3059,11 @@ public Builder setErrorMessage( return this; } /** + *
+     * A human-readable error message intended to help developers diagnose WfSpec
+     * problems.
+     * 
+ * * optional string error_message = 11; * @return This builder for chaining. */ @@ -2541,6 +3074,11 @@ public Builder clearErrorMessage() { return this; } /** + *
+     * A human-readable error message intended to help developers diagnose WfSpec
+     * problems.
+     * 
+ * * optional string error_message = 11; * @param value The bytes for errorMessage to set. * @return This builder for chaining. @@ -2568,6 +3106,10 @@ private void ensureFailuresIsMutable() { io.littlehorse.sdk.common.proto.Failure, io.littlehorse.sdk.common.proto.Failure.Builder, io.littlehorse.sdk.common.proto.FailureOrBuilder> failuresBuilder_; /** + *
+     * A list of Failures thrown by this NodeRun.
+     * 
+ * * repeated .littlehorse.Failure failures = 12; */ public java.util.List getFailuresList() { @@ -2578,6 +3120,10 @@ public java.util.List getFailuresList() } } /** + *
+     * A list of Failures thrown by this NodeRun.
+     * 
+ * * repeated .littlehorse.Failure failures = 12; */ public int getFailuresCount() { @@ -2588,6 +3134,10 @@ public int getFailuresCount() { } } /** + *
+     * A list of Failures thrown by this NodeRun.
+     * 
+ * * repeated .littlehorse.Failure failures = 12; */ public io.littlehorse.sdk.common.proto.Failure getFailures(int index) { @@ -2598,6 +3148,10 @@ public io.littlehorse.sdk.common.proto.Failure getFailures(int index) { } } /** + *
+     * A list of Failures thrown by this NodeRun.
+     * 
+ * * repeated .littlehorse.Failure failures = 12; */ public Builder setFailures( @@ -2615,6 +3169,10 @@ public Builder setFailures( return this; } /** + *
+     * A list of Failures thrown by this NodeRun.
+     * 
+ * * repeated .littlehorse.Failure failures = 12; */ public Builder setFailures( @@ -2629,6 +3187,10 @@ public Builder setFailures( return this; } /** + *
+     * A list of Failures thrown by this NodeRun.
+     * 
+ * * repeated .littlehorse.Failure failures = 12; */ public Builder addFailures(io.littlehorse.sdk.common.proto.Failure value) { @@ -2645,6 +3207,10 @@ public Builder addFailures(io.littlehorse.sdk.common.proto.Failure value) { return this; } /** + *
+     * A list of Failures thrown by this NodeRun.
+     * 
+ * * repeated .littlehorse.Failure failures = 12; */ public Builder addFailures( @@ -2662,6 +3228,10 @@ public Builder addFailures( return this; } /** + *
+     * A list of Failures thrown by this NodeRun.
+     * 
+ * * repeated .littlehorse.Failure failures = 12; */ public Builder addFailures( @@ -2676,6 +3246,10 @@ public Builder addFailures( return this; } /** + *
+     * A list of Failures thrown by this NodeRun.
+     * 
+ * * repeated .littlehorse.Failure failures = 12; */ public Builder addFailures( @@ -2690,6 +3264,10 @@ public Builder addFailures( return this; } /** + *
+     * A list of Failures thrown by this NodeRun.
+     * 
+ * * repeated .littlehorse.Failure failures = 12; */ public Builder addAllFailures( @@ -2705,6 +3283,10 @@ public Builder addAllFailures( return this; } /** + *
+     * A list of Failures thrown by this NodeRun.
+     * 
+ * * repeated .littlehorse.Failure failures = 12; */ public Builder clearFailures() { @@ -2718,6 +3300,10 @@ public Builder clearFailures() { return this; } /** + *
+     * A list of Failures thrown by this NodeRun.
+     * 
+ * * repeated .littlehorse.Failure failures = 12; */ public Builder removeFailures(int index) { @@ -2731,6 +3317,10 @@ public Builder removeFailures(int index) { return this; } /** + *
+     * A list of Failures thrown by this NodeRun.
+     * 
+ * * repeated .littlehorse.Failure failures = 12; */ public io.littlehorse.sdk.common.proto.Failure.Builder getFailuresBuilder( @@ -2738,6 +3328,10 @@ public io.littlehorse.sdk.common.proto.Failure.Builder getFailuresBuilder( return getFailuresFieldBuilder().getBuilder(index); } /** + *
+     * A list of Failures thrown by this NodeRun.
+     * 
+ * * repeated .littlehorse.Failure failures = 12; */ public io.littlehorse.sdk.common.proto.FailureOrBuilder getFailuresOrBuilder( @@ -2748,6 +3342,10 @@ public io.littlehorse.sdk.common.proto.FailureOrBuilder getFailuresOrBuilder( } } /** + *
+     * A list of Failures thrown by this NodeRun.
+     * 
+ * * repeated .littlehorse.Failure failures = 12; */ public java.util.List @@ -2759,6 +3357,10 @@ public io.littlehorse.sdk.common.proto.FailureOrBuilder getFailuresOrBuilder( } } /** + *
+     * A list of Failures thrown by this NodeRun.
+     * 
+ * * repeated .littlehorse.Failure failures = 12; */ public io.littlehorse.sdk.common.proto.Failure.Builder addFailuresBuilder() { @@ -2766,6 +3368,10 @@ public io.littlehorse.sdk.common.proto.Failure.Builder addFailuresBuilder() { io.littlehorse.sdk.common.proto.Failure.getDefaultInstance()); } /** + *
+     * A list of Failures thrown by this NodeRun.
+     * 
+ * * repeated .littlehorse.Failure failures = 12; */ public io.littlehorse.sdk.common.proto.Failure.Builder addFailuresBuilder( @@ -2774,6 +3380,10 @@ public io.littlehorse.sdk.common.proto.Failure.Builder addFailuresBuilder( index, io.littlehorse.sdk.common.proto.Failure.getDefaultInstance()); } /** + *
+     * A list of Failures thrown by this NodeRun.
+     * 
+ * * repeated .littlehorse.Failure failures = 12; */ public java.util.List @@ -2798,6 +3408,10 @@ public io.littlehorse.sdk.common.proto.Failure.Builder addFailuresBuilder( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.TaskNodeRun, io.littlehorse.sdk.common.proto.TaskNodeRun.Builder, io.littlehorse.sdk.common.proto.TaskNodeRunOrBuilder> taskBuilder_; /** + *
+     * Denotes a TASK node, which runs a TaskRun.
+     * 
+ * * .littlehorse.TaskNodeRun task = 13; * @return Whether the task field is set. */ @@ -2806,6 +3420,10 @@ public boolean hasTask() { return nodeTypeCase_ == 13; } /** + *
+     * Denotes a TASK node, which runs a TaskRun.
+     * 
+ * * .littlehorse.TaskNodeRun task = 13; * @return The task. */ @@ -2824,6 +3442,10 @@ public io.littlehorse.sdk.common.proto.TaskNodeRun getTask() { } } /** + *
+     * Denotes a TASK node, which runs a TaskRun.
+     * 
+ * * .littlehorse.TaskNodeRun task = 13; */ public Builder setTask(io.littlehorse.sdk.common.proto.TaskNodeRun value) { @@ -2840,6 +3462,10 @@ public Builder setTask(io.littlehorse.sdk.common.proto.TaskNodeRun value) { return this; } /** + *
+     * Denotes a TASK node, which runs a TaskRun.
+     * 
+ * * .littlehorse.TaskNodeRun task = 13; */ public Builder setTask( @@ -2854,6 +3480,10 @@ public Builder setTask( return this; } /** + *
+     * Denotes a TASK node, which runs a TaskRun.
+     * 
+ * * .littlehorse.TaskNodeRun task = 13; */ public Builder mergeTask(io.littlehorse.sdk.common.proto.TaskNodeRun value) { @@ -2877,6 +3507,10 @@ public Builder mergeTask(io.littlehorse.sdk.common.proto.TaskNodeRun value) { return this; } /** + *
+     * Denotes a TASK node, which runs a TaskRun.
+     * 
+ * * .littlehorse.TaskNodeRun task = 13; */ public Builder clearTask() { @@ -2896,12 +3530,20 @@ public Builder clearTask() { return this; } /** + *
+     * Denotes a TASK node, which runs a TaskRun.
+     * 
+ * * .littlehorse.TaskNodeRun task = 13; */ public io.littlehorse.sdk.common.proto.TaskNodeRun.Builder getTaskBuilder() { return getTaskFieldBuilder().getBuilder(); } /** + *
+     * Denotes a TASK node, which runs a TaskRun.
+     * 
+ * * .littlehorse.TaskNodeRun task = 13; */ @java.lang.Override @@ -2916,6 +3558,10 @@ public io.littlehorse.sdk.common.proto.TaskNodeRunOrBuilder getTaskOrBuilder() { } } /** + *
+     * Denotes a TASK node, which runs a TaskRun.
+     * 
+ * * .littlehorse.TaskNodeRun task = 13; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -2940,6 +3586,10 @@ public io.littlehorse.sdk.common.proto.TaskNodeRunOrBuilder getTaskOrBuilder() { private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.ExternalEventRun, io.littlehorse.sdk.common.proto.ExternalEventRun.Builder, io.littlehorse.sdk.common.proto.ExternalEventRunOrBuilder> externalEventBuilder_; /** + *
+     * An EXTERNAL_EVENT node blocks until an ExternalEvent arrives.
+     * 
+ * * .littlehorse.ExternalEventRun external_event = 14; * @return Whether the externalEvent field is set. */ @@ -2948,6 +3598,10 @@ public boolean hasExternalEvent() { return nodeTypeCase_ == 14; } /** + *
+     * An EXTERNAL_EVENT node blocks until an ExternalEvent arrives.
+     * 
+ * * .littlehorse.ExternalEventRun external_event = 14; * @return The externalEvent. */ @@ -2966,6 +3620,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventRun getExternalEvent() { } } /** + *
+     * An EXTERNAL_EVENT node blocks until an ExternalEvent arrives.
+     * 
+ * * .littlehorse.ExternalEventRun external_event = 14; */ public Builder setExternalEvent(io.littlehorse.sdk.common.proto.ExternalEventRun value) { @@ -2982,6 +3640,10 @@ public Builder setExternalEvent(io.littlehorse.sdk.common.proto.ExternalEventRun return this; } /** + *
+     * An EXTERNAL_EVENT node blocks until an ExternalEvent arrives.
+     * 
+ * * .littlehorse.ExternalEventRun external_event = 14; */ public Builder setExternalEvent( @@ -2996,6 +3658,10 @@ public Builder setExternalEvent( return this; } /** + *
+     * An EXTERNAL_EVENT node blocks until an ExternalEvent arrives.
+     * 
+ * * .littlehorse.ExternalEventRun external_event = 14; */ public Builder mergeExternalEvent(io.littlehorse.sdk.common.proto.ExternalEventRun value) { @@ -3019,6 +3685,10 @@ public Builder mergeExternalEvent(io.littlehorse.sdk.common.proto.ExternalEventR return this; } /** + *
+     * An EXTERNAL_EVENT node blocks until an ExternalEvent arrives.
+     * 
+ * * .littlehorse.ExternalEventRun external_event = 14; */ public Builder clearExternalEvent() { @@ -3038,12 +3708,20 @@ public Builder clearExternalEvent() { return this; } /** + *
+     * An EXTERNAL_EVENT node blocks until an ExternalEvent arrives.
+     * 
+ * * .littlehorse.ExternalEventRun external_event = 14; */ public io.littlehorse.sdk.common.proto.ExternalEventRun.Builder getExternalEventBuilder() { return getExternalEventFieldBuilder().getBuilder(); } /** + *
+     * An EXTERNAL_EVENT node blocks until an ExternalEvent arrives.
+     * 
+ * * .littlehorse.ExternalEventRun external_event = 14; */ @java.lang.Override @@ -3058,6 +3736,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventRunOrBuilder getExternalEven } } /** + *
+     * An EXTERNAL_EVENT node blocks until an ExternalEvent arrives.
+     * 
+ * * .littlehorse.ExternalEventRun external_event = 14; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -3082,6 +3764,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventRunOrBuilder getExternalEven private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.EntrypointRun, io.littlehorse.sdk.common.proto.EntrypointRun.Builder, io.littlehorse.sdk.common.proto.EntrypointRunOrBuilder> entrypointBuilder_; /** + *
+     * An ENTRYPOINT node is the first thing that runs in a ThreadRun.
+     * 
+ * * .littlehorse.EntrypointRun entrypoint = 15; * @return Whether the entrypoint field is set. */ @@ -3090,6 +3776,10 @@ public boolean hasEntrypoint() { return nodeTypeCase_ == 15; } /** + *
+     * An ENTRYPOINT node is the first thing that runs in a ThreadRun.
+     * 
+ * * .littlehorse.EntrypointRun entrypoint = 15; * @return The entrypoint. */ @@ -3108,6 +3798,10 @@ public io.littlehorse.sdk.common.proto.EntrypointRun getEntrypoint() { } } /** + *
+     * An ENTRYPOINT node is the first thing that runs in a ThreadRun.
+     * 
+ * * .littlehorse.EntrypointRun entrypoint = 15; */ public Builder setEntrypoint(io.littlehorse.sdk.common.proto.EntrypointRun value) { @@ -3124,6 +3818,10 @@ public Builder setEntrypoint(io.littlehorse.sdk.common.proto.EntrypointRun value return this; } /** + *
+     * An ENTRYPOINT node is the first thing that runs in a ThreadRun.
+     * 
+ * * .littlehorse.EntrypointRun entrypoint = 15; */ public Builder setEntrypoint( @@ -3138,6 +3836,10 @@ public Builder setEntrypoint( return this; } /** + *
+     * An ENTRYPOINT node is the first thing that runs in a ThreadRun.
+     * 
+ * * .littlehorse.EntrypointRun entrypoint = 15; */ public Builder mergeEntrypoint(io.littlehorse.sdk.common.proto.EntrypointRun value) { @@ -3161,6 +3863,10 @@ public Builder mergeEntrypoint(io.littlehorse.sdk.common.proto.EntrypointRun val return this; } /** + *
+     * An ENTRYPOINT node is the first thing that runs in a ThreadRun.
+     * 
+ * * .littlehorse.EntrypointRun entrypoint = 15; */ public Builder clearEntrypoint() { @@ -3180,12 +3886,20 @@ public Builder clearEntrypoint() { return this; } /** + *
+     * An ENTRYPOINT node is the first thing that runs in a ThreadRun.
+     * 
+ * * .littlehorse.EntrypointRun entrypoint = 15; */ public io.littlehorse.sdk.common.proto.EntrypointRun.Builder getEntrypointBuilder() { return getEntrypointFieldBuilder().getBuilder(); } /** + *
+     * An ENTRYPOINT node is the first thing that runs in a ThreadRun.
+     * 
+ * * .littlehorse.EntrypointRun entrypoint = 15; */ @java.lang.Override @@ -3200,6 +3914,10 @@ public io.littlehorse.sdk.common.proto.EntrypointRunOrBuilder getEntrypointOrBui } } /** + *
+     * An ENTRYPOINT node is the first thing that runs in a ThreadRun.
+     * 
+ * * .littlehorse.EntrypointRun entrypoint = 15; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -3224,6 +3942,10 @@ public io.littlehorse.sdk.common.proto.EntrypointRunOrBuilder getEntrypointOrBui private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.ExitRun, io.littlehorse.sdk.common.proto.ExitRun.Builder, io.littlehorse.sdk.common.proto.ExitRunOrBuilder> exitBuilder_; /** + *
+     * An EXIT node completes a ThreadRun.
+     * 
+ * * .littlehorse.ExitRun exit = 16; * @return Whether the exit field is set. */ @@ -3232,6 +3954,10 @@ public boolean hasExit() { return nodeTypeCase_ == 16; } /** + *
+     * An EXIT node completes a ThreadRun.
+     * 
+ * * .littlehorse.ExitRun exit = 16; * @return The exit. */ @@ -3250,6 +3976,10 @@ public io.littlehorse.sdk.common.proto.ExitRun getExit() { } } /** + *
+     * An EXIT node completes a ThreadRun.
+     * 
+ * * .littlehorse.ExitRun exit = 16; */ public Builder setExit(io.littlehorse.sdk.common.proto.ExitRun value) { @@ -3266,6 +3996,10 @@ public Builder setExit(io.littlehorse.sdk.common.proto.ExitRun value) { return this; } /** + *
+     * An EXIT node completes a ThreadRun.
+     * 
+ * * .littlehorse.ExitRun exit = 16; */ public Builder setExit( @@ -3280,6 +4014,10 @@ public Builder setExit( return this; } /** + *
+     * An EXIT node completes a ThreadRun.
+     * 
+ * * .littlehorse.ExitRun exit = 16; */ public Builder mergeExit(io.littlehorse.sdk.common.proto.ExitRun value) { @@ -3303,6 +4041,10 @@ public Builder mergeExit(io.littlehorse.sdk.common.proto.ExitRun value) { return this; } /** + *
+     * An EXIT node completes a ThreadRun.
+     * 
+ * * .littlehorse.ExitRun exit = 16; */ public Builder clearExit() { @@ -3322,12 +4064,20 @@ public Builder clearExit() { return this; } /** + *
+     * An EXIT node completes a ThreadRun.
+     * 
+ * * .littlehorse.ExitRun exit = 16; */ public io.littlehorse.sdk.common.proto.ExitRun.Builder getExitBuilder() { return getExitFieldBuilder().getBuilder(); } /** + *
+     * An EXIT node completes a ThreadRun.
+     * 
+ * * .littlehorse.ExitRun exit = 16; */ @java.lang.Override @@ -3342,6 +4092,10 @@ public io.littlehorse.sdk.common.proto.ExitRunOrBuilder getExitOrBuilder() { } } /** + *
+     * An EXIT node completes a ThreadRun.
+     * 
+ * * .littlehorse.ExitRun exit = 16; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -3366,6 +4120,10 @@ public io.littlehorse.sdk.common.proto.ExitRunOrBuilder getExitOrBuilder() { private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.StartThreadRun, io.littlehorse.sdk.common.proto.StartThreadRun.Builder, io.littlehorse.sdk.common.proto.StartThreadRunOrBuilder> startThreadBuilder_; /** + *
+     * A START_THREAD node starts a child ThreadRun.
+     * 
+ * * .littlehorse.StartThreadRun start_thread = 17; * @return Whether the startThread field is set. */ @@ -3374,6 +4132,10 @@ public boolean hasStartThread() { return nodeTypeCase_ == 17; } /** + *
+     * A START_THREAD node starts a child ThreadRun.
+     * 
+ * * .littlehorse.StartThreadRun start_thread = 17; * @return The startThread. */ @@ -3392,6 +4154,10 @@ public io.littlehorse.sdk.common.proto.StartThreadRun getStartThread() { } } /** + *
+     * A START_THREAD node starts a child ThreadRun.
+     * 
+ * * .littlehorse.StartThreadRun start_thread = 17; */ public Builder setStartThread(io.littlehorse.sdk.common.proto.StartThreadRun value) { @@ -3408,6 +4174,10 @@ public Builder setStartThread(io.littlehorse.sdk.common.proto.StartThreadRun val return this; } /** + *
+     * A START_THREAD node starts a child ThreadRun.
+     * 
+ * * .littlehorse.StartThreadRun start_thread = 17; */ public Builder setStartThread( @@ -3422,6 +4192,10 @@ public Builder setStartThread( return this; } /** + *
+     * A START_THREAD node starts a child ThreadRun.
+     * 
+ * * .littlehorse.StartThreadRun start_thread = 17; */ public Builder mergeStartThread(io.littlehorse.sdk.common.proto.StartThreadRun value) { @@ -3445,6 +4219,10 @@ public Builder mergeStartThread(io.littlehorse.sdk.common.proto.StartThreadRun v return this; } /** + *
+     * A START_THREAD node starts a child ThreadRun.
+     * 
+ * * .littlehorse.StartThreadRun start_thread = 17; */ public Builder clearStartThread() { @@ -3464,12 +4242,20 @@ public Builder clearStartThread() { return this; } /** + *
+     * A START_THREAD node starts a child ThreadRun.
+     * 
+ * * .littlehorse.StartThreadRun start_thread = 17; */ public io.littlehorse.sdk.common.proto.StartThreadRun.Builder getStartThreadBuilder() { return getStartThreadFieldBuilder().getBuilder(); } /** + *
+     * A START_THREAD node starts a child ThreadRun.
+     * 
+ * * .littlehorse.StartThreadRun start_thread = 17; */ @java.lang.Override @@ -3484,6 +4270,10 @@ public io.littlehorse.sdk.common.proto.StartThreadRunOrBuilder getStartThreadOrB } } /** + *
+     * A START_THREAD node starts a child ThreadRun.
+     * 
+ * * .littlehorse.StartThreadRun start_thread = 17; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -3508,6 +4298,10 @@ public io.littlehorse.sdk.common.proto.StartThreadRunOrBuilder getStartThreadOrB private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.WaitForThreadsRun, io.littlehorse.sdk.common.proto.WaitForThreadsRun.Builder, io.littlehorse.sdk.common.proto.WaitForThreadsRunOrBuilder> waitThreadsBuilder_; /** + *
+     * A WAIT_THREADS node waits for one or more child ThreadRun's to complete.
+     * 
+ * * .littlehorse.WaitForThreadsRun wait_threads = 18; * @return Whether the waitThreads field is set. */ @@ -3516,6 +4310,10 @@ public boolean hasWaitThreads() { return nodeTypeCase_ == 18; } /** + *
+     * A WAIT_THREADS node waits for one or more child ThreadRun's to complete.
+     * 
+ * * .littlehorse.WaitForThreadsRun wait_threads = 18; * @return The waitThreads. */ @@ -3534,6 +4332,10 @@ public io.littlehorse.sdk.common.proto.WaitForThreadsRun getWaitThreads() { } } /** + *
+     * A WAIT_THREADS node waits for one or more child ThreadRun's to complete.
+     * 
+ * * .littlehorse.WaitForThreadsRun wait_threads = 18; */ public Builder setWaitThreads(io.littlehorse.sdk.common.proto.WaitForThreadsRun value) { @@ -3550,6 +4352,10 @@ public Builder setWaitThreads(io.littlehorse.sdk.common.proto.WaitForThreadsRun return this; } /** + *
+     * A WAIT_THREADS node waits for one or more child ThreadRun's to complete.
+     * 
+ * * .littlehorse.WaitForThreadsRun wait_threads = 18; */ public Builder setWaitThreads( @@ -3564,6 +4370,10 @@ public Builder setWaitThreads( return this; } /** + *
+     * A WAIT_THREADS node waits for one or more child ThreadRun's to complete.
+     * 
+ * * .littlehorse.WaitForThreadsRun wait_threads = 18; */ public Builder mergeWaitThreads(io.littlehorse.sdk.common.proto.WaitForThreadsRun value) { @@ -3587,6 +4397,10 @@ public Builder mergeWaitThreads(io.littlehorse.sdk.common.proto.WaitForThreadsRu return this; } /** + *
+     * A WAIT_THREADS node waits for one or more child ThreadRun's to complete.
+     * 
+ * * .littlehorse.WaitForThreadsRun wait_threads = 18; */ public Builder clearWaitThreads() { @@ -3606,12 +4420,20 @@ public Builder clearWaitThreads() { return this; } /** + *
+     * A WAIT_THREADS node waits for one or more child ThreadRun's to complete.
+     * 
+ * * .littlehorse.WaitForThreadsRun wait_threads = 18; */ public io.littlehorse.sdk.common.proto.WaitForThreadsRun.Builder getWaitThreadsBuilder() { return getWaitThreadsFieldBuilder().getBuilder(); } /** + *
+     * A WAIT_THREADS node waits for one or more child ThreadRun's to complete.
+     * 
+ * * .littlehorse.WaitForThreadsRun wait_threads = 18; */ @java.lang.Override @@ -3626,6 +4448,10 @@ public io.littlehorse.sdk.common.proto.WaitForThreadsRunOrBuilder getWaitThreads } } /** + *
+     * A WAIT_THREADS node waits for one or more child ThreadRun's to complete.
+     * 
+ * * .littlehorse.WaitForThreadsRun wait_threads = 18; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -3650,6 +4476,10 @@ public io.littlehorse.sdk.common.proto.WaitForThreadsRunOrBuilder getWaitThreads private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.SleepNodeRun, io.littlehorse.sdk.common.proto.SleepNodeRun.Builder, io.littlehorse.sdk.common.proto.SleepNodeRunOrBuilder> sleepBuilder_; /** + *
+     * A SLEEP node makes the ThreadRun block for a certain amount of time.
+     * 
+ * * .littlehorse.SleepNodeRun sleep = 19; * @return Whether the sleep field is set. */ @@ -3658,6 +4488,10 @@ public boolean hasSleep() { return nodeTypeCase_ == 19; } /** + *
+     * A SLEEP node makes the ThreadRun block for a certain amount of time.
+     * 
+ * * .littlehorse.SleepNodeRun sleep = 19; * @return The sleep. */ @@ -3676,6 +4510,10 @@ public io.littlehorse.sdk.common.proto.SleepNodeRun getSleep() { } } /** + *
+     * A SLEEP node makes the ThreadRun block for a certain amount of time.
+     * 
+ * * .littlehorse.SleepNodeRun sleep = 19; */ public Builder setSleep(io.littlehorse.sdk.common.proto.SleepNodeRun value) { @@ -3692,6 +4530,10 @@ public Builder setSleep(io.littlehorse.sdk.common.proto.SleepNodeRun value) { return this; } /** + *
+     * A SLEEP node makes the ThreadRun block for a certain amount of time.
+     * 
+ * * .littlehorse.SleepNodeRun sleep = 19; */ public Builder setSleep( @@ -3706,6 +4548,10 @@ public Builder setSleep( return this; } /** + *
+     * A SLEEP node makes the ThreadRun block for a certain amount of time.
+     * 
+ * * .littlehorse.SleepNodeRun sleep = 19; */ public Builder mergeSleep(io.littlehorse.sdk.common.proto.SleepNodeRun value) { @@ -3729,6 +4575,10 @@ public Builder mergeSleep(io.littlehorse.sdk.common.proto.SleepNodeRun value) { return this; } /** + *
+     * A SLEEP node makes the ThreadRun block for a certain amount of time.
+     * 
+ * * .littlehorse.SleepNodeRun sleep = 19; */ public Builder clearSleep() { @@ -3748,12 +4598,20 @@ public Builder clearSleep() { return this; } /** + *
+     * A SLEEP node makes the ThreadRun block for a certain amount of time.
+     * 
+ * * .littlehorse.SleepNodeRun sleep = 19; */ public io.littlehorse.sdk.common.proto.SleepNodeRun.Builder getSleepBuilder() { return getSleepFieldBuilder().getBuilder(); } /** + *
+     * A SLEEP node makes the ThreadRun block for a certain amount of time.
+     * 
+ * * .littlehorse.SleepNodeRun sleep = 19; */ @java.lang.Override @@ -3768,6 +4626,10 @@ public io.littlehorse.sdk.common.proto.SleepNodeRunOrBuilder getSleepOrBuilder() } } /** + *
+     * A SLEEP node makes the ThreadRun block for a certain amount of time.
+     * 
+ * * .littlehorse.SleepNodeRun sleep = 19; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -3792,6 +4654,10 @@ public io.littlehorse.sdk.common.proto.SleepNodeRunOrBuilder getSleepOrBuilder() private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.UserTaskNodeRun, io.littlehorse.sdk.common.proto.UserTaskNodeRun.Builder, io.littlehorse.sdk.common.proto.UserTaskNodeRunOrBuilder> userTaskBuilder_; /** + *
+     * A USER_TASK node waits until a human executes some work and reports the result.
+     * 
+ * * .littlehorse.UserTaskNodeRun user_task = 20; * @return Whether the userTask field is set. */ @@ -3800,6 +4666,10 @@ public boolean hasUserTask() { return nodeTypeCase_ == 20; } /** + *
+     * A USER_TASK node waits until a human executes some work and reports the result.
+     * 
+ * * .littlehorse.UserTaskNodeRun user_task = 20; * @return The userTask. */ @@ -3818,6 +4688,10 @@ public io.littlehorse.sdk.common.proto.UserTaskNodeRun getUserTask() { } } /** + *
+     * A USER_TASK node waits until a human executes some work and reports the result.
+     * 
+ * * .littlehorse.UserTaskNodeRun user_task = 20; */ public Builder setUserTask(io.littlehorse.sdk.common.proto.UserTaskNodeRun value) { @@ -3834,6 +4708,10 @@ public Builder setUserTask(io.littlehorse.sdk.common.proto.UserTaskNodeRun value return this; } /** + *
+     * A USER_TASK node waits until a human executes some work and reports the result.
+     * 
+ * * .littlehorse.UserTaskNodeRun user_task = 20; */ public Builder setUserTask( @@ -3848,6 +4726,10 @@ public Builder setUserTask( return this; } /** + *
+     * A USER_TASK node waits until a human executes some work and reports the result.
+     * 
+ * * .littlehorse.UserTaskNodeRun user_task = 20; */ public Builder mergeUserTask(io.littlehorse.sdk.common.proto.UserTaskNodeRun value) { @@ -3871,6 +4753,10 @@ public Builder mergeUserTask(io.littlehorse.sdk.common.proto.UserTaskNodeRun val return this; } /** + *
+     * A USER_TASK node waits until a human executes some work and reports the result.
+     * 
+ * * .littlehorse.UserTaskNodeRun user_task = 20; */ public Builder clearUserTask() { @@ -3890,12 +4776,20 @@ public Builder clearUserTask() { return this; } /** + *
+     * A USER_TASK node waits until a human executes some work and reports the result.
+     * 
+ * * .littlehorse.UserTaskNodeRun user_task = 20; */ public io.littlehorse.sdk.common.proto.UserTaskNodeRun.Builder getUserTaskBuilder() { return getUserTaskFieldBuilder().getBuilder(); } /** + *
+     * A USER_TASK node waits until a human executes some work and reports the result.
+     * 
+ * * .littlehorse.UserTaskNodeRun user_task = 20; */ @java.lang.Override @@ -3910,6 +4804,10 @@ public io.littlehorse.sdk.common.proto.UserTaskNodeRunOrBuilder getUserTaskOrBui } } /** + *
+     * A USER_TASK node waits until a human executes some work and reports the result.
+     * 
+ * * .littlehorse.UserTaskNodeRun user_task = 20; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -3934,6 +4832,11 @@ public io.littlehorse.sdk.common.proto.UserTaskNodeRunOrBuilder getUserTaskOrBui private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.StartMultipleThreadsRun, io.littlehorse.sdk.common.proto.StartMultipleThreadsRun.Builder, io.littlehorse.sdk.common.proto.StartMultipleThreadsRunOrBuilder> startMultipleThreadsBuilder_; /** + *
+     * A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a
+     * child ThreadRun for each element in the list.
+     * 
+ * * .littlehorse.StartMultipleThreadsRun start_multiple_threads = 21; * @return Whether the startMultipleThreads field is set. */ @@ -3942,6 +4845,11 @@ public boolean hasStartMultipleThreads() { return nodeTypeCase_ == 21; } /** + *
+     * A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a
+     * child ThreadRun for each element in the list.
+     * 
+ * * .littlehorse.StartMultipleThreadsRun start_multiple_threads = 21; * @return The startMultipleThreads. */ @@ -3960,6 +4868,11 @@ public io.littlehorse.sdk.common.proto.StartMultipleThreadsRun getStartMultipleT } } /** + *
+     * A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a
+     * child ThreadRun for each element in the list.
+     * 
+ * * .littlehorse.StartMultipleThreadsRun start_multiple_threads = 21; */ public Builder setStartMultipleThreads(io.littlehorse.sdk.common.proto.StartMultipleThreadsRun value) { @@ -3976,6 +4889,11 @@ public Builder setStartMultipleThreads(io.littlehorse.sdk.common.proto.StartMult return this; } /** + *
+     * A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a
+     * child ThreadRun for each element in the list.
+     * 
+ * * .littlehorse.StartMultipleThreadsRun start_multiple_threads = 21; */ public Builder setStartMultipleThreads( @@ -3990,6 +4908,11 @@ public Builder setStartMultipleThreads( return this; } /** + *
+     * A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a
+     * child ThreadRun for each element in the list.
+     * 
+ * * .littlehorse.StartMultipleThreadsRun start_multiple_threads = 21; */ public Builder mergeStartMultipleThreads(io.littlehorse.sdk.common.proto.StartMultipleThreadsRun value) { @@ -4013,6 +4936,11 @@ public Builder mergeStartMultipleThreads(io.littlehorse.sdk.common.proto.StartMu return this; } /** + *
+     * A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a
+     * child ThreadRun for each element in the list.
+     * 
+ * * .littlehorse.StartMultipleThreadsRun start_multiple_threads = 21; */ public Builder clearStartMultipleThreads() { @@ -4032,12 +4960,22 @@ public Builder clearStartMultipleThreads() { return this; } /** + *
+     * A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a
+     * child ThreadRun for each element in the list.
+     * 
+ * * .littlehorse.StartMultipleThreadsRun start_multiple_threads = 21; */ public io.littlehorse.sdk.common.proto.StartMultipleThreadsRun.Builder getStartMultipleThreadsBuilder() { return getStartMultipleThreadsFieldBuilder().getBuilder(); } /** + *
+     * A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a
+     * child ThreadRun for each element in the list.
+     * 
+ * * .littlehorse.StartMultipleThreadsRun start_multiple_threads = 21; */ @java.lang.Override @@ -4052,6 +4990,11 @@ public io.littlehorse.sdk.common.proto.StartMultipleThreadsRunOrBuilder getStart } } /** + *
+     * A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a
+     * child ThreadRun for each element in the list.
+     * 
+ * * .littlehorse.StartMultipleThreadsRun start_multiple_threads = 21; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/NodeRunId.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/NodeRunId.java index 79d0ebc98..2b6aaf29f 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/NodeRunId.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/NodeRunId.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * ID for a NodeRun.
+ * 
+ * * Protobuf type {@code littlehorse.NodeRunId} */ public final class NodeRunId extends @@ -41,6 +45,11 @@ protected java.lang.Object newInstance( public static final int WF_RUN_ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.WfRunId wfRunId_; /** + *
+   * ID of the WfRun for this NodeRun. Note that every NodeRun is associated with
+   * a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return Whether the wfRunId field is set. */ @@ -49,6 +58,11 @@ public boolean hasWfRunId() { return wfRunId_ != null; } /** + *
+   * ID of the WfRun for this NodeRun. Note that every NodeRun is associated with
+   * a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return The wfRunId. */ @@ -57,6 +71,11 @@ public io.littlehorse.sdk.common.proto.WfRunId getWfRunId() { return wfRunId_ == null ? io.littlehorse.sdk.common.proto.WfRunId.getDefaultInstance() : wfRunId_; } /** + *
+   * ID of the WfRun for this NodeRun. Note that every NodeRun is associated with
+   * a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ @java.lang.Override @@ -67,6 +86,10 @@ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { public static final int THREAD_RUN_NUMBER_FIELD_NUMBER = 2; private int threadRunNumber_ = 0; /** + *
+   * ThreadRun of this NodeRun. Note that each NodeRun belongs to a ThreadRun.
+   * 
+ * * int32 thread_run_number = 2; * @return The threadRunNumber. */ @@ -78,6 +101,10 @@ public int getThreadRunNumber() { public static final int POSITION_FIELD_NUMBER = 3; private int position_ = 0; /** + *
+   * Position of this NodeRun within its ThreadRun.
+   * 
+ * * int32 position = 3; * @return The position. */ @@ -271,6 +298,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * ID for a NodeRun.
+   * 
+ * * Protobuf type {@code littlehorse.NodeRunId} */ public static final class Builder extends @@ -474,6 +505,11 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.WfRunId, io.littlehorse.sdk.common.proto.WfRunId.Builder, io.littlehorse.sdk.common.proto.WfRunIdOrBuilder> wfRunIdBuilder_; /** + *
+     * ID of the WfRun for this NodeRun. Note that every NodeRun is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return Whether the wfRunId field is set. */ @@ -481,6 +517,11 @@ public boolean hasWfRunId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * ID of the WfRun for this NodeRun. Note that every NodeRun is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return The wfRunId. */ @@ -492,6 +533,11 @@ public io.littlehorse.sdk.common.proto.WfRunId getWfRunId() { } } /** + *
+     * ID of the WfRun for this NodeRun. Note that every NodeRun is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder setWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { @@ -508,6 +554,11 @@ public Builder setWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { return this; } /** + *
+     * ID of the WfRun for this NodeRun. Note that every NodeRun is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder setWfRunId( @@ -522,6 +573,11 @@ public Builder setWfRunId( return this; } /** + *
+     * ID of the WfRun for this NodeRun. Note that every NodeRun is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder mergeWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { @@ -541,6 +597,11 @@ public Builder mergeWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { return this; } /** + *
+     * ID of the WfRun for this NodeRun. Note that every NodeRun is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder clearWfRunId() { @@ -554,6 +615,11 @@ public Builder clearWfRunId() { return this; } /** + *
+     * ID of the WfRun for this NodeRun. Note that every NodeRun is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public io.littlehorse.sdk.common.proto.WfRunId.Builder getWfRunIdBuilder() { @@ -562,6 +628,11 @@ public io.littlehorse.sdk.common.proto.WfRunId.Builder getWfRunIdBuilder() { return getWfRunIdFieldBuilder().getBuilder(); } /** + *
+     * ID of the WfRun for this NodeRun. Note that every NodeRun is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { @@ -573,6 +644,11 @@ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { } } /** + *
+     * ID of the WfRun for this NodeRun. Note that every NodeRun is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -591,6 +667,10 @@ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { private int threadRunNumber_ ; /** + *
+     * ThreadRun of this NodeRun. Note that each NodeRun belongs to a ThreadRun.
+     * 
+ * * int32 thread_run_number = 2; * @return The threadRunNumber. */ @@ -599,6 +679,10 @@ public int getThreadRunNumber() { return threadRunNumber_; } /** + *
+     * ThreadRun of this NodeRun. Note that each NodeRun belongs to a ThreadRun.
+     * 
+ * * int32 thread_run_number = 2; * @param value The threadRunNumber to set. * @return This builder for chaining. @@ -611,6 +695,10 @@ public Builder setThreadRunNumber(int value) { return this; } /** + *
+     * ThreadRun of this NodeRun. Note that each NodeRun belongs to a ThreadRun.
+     * 
+ * * int32 thread_run_number = 2; * @return This builder for chaining. */ @@ -623,6 +711,10 @@ public Builder clearThreadRunNumber() { private int position_ ; /** + *
+     * Position of this NodeRun within its ThreadRun.
+     * 
+ * * int32 position = 3; * @return The position. */ @@ -631,6 +723,10 @@ public int getPosition() { return position_; } /** + *
+     * Position of this NodeRun within its ThreadRun.
+     * 
+ * * int32 position = 3; * @param value The position to set. * @return This builder for chaining. @@ -643,6 +739,10 @@ public Builder setPosition(int value) { return this; } /** + *
+     * Position of this NodeRun within its ThreadRun.
+     * 
+ * * int32 position = 3; * @return This builder for chaining. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/NodeRunIdOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/NodeRunIdOrBuilder.java index 251300087..9c0728c4c 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/NodeRunIdOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/NodeRunIdOrBuilder.java @@ -8,27 +8,50 @@ public interface NodeRunIdOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * ID of the WfRun for this NodeRun. Note that every NodeRun is associated with
+   * a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return Whether the wfRunId field is set. */ boolean hasWfRunId(); /** + *
+   * ID of the WfRun for this NodeRun. Note that every NodeRun is associated with
+   * a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return The wfRunId. */ io.littlehorse.sdk.common.proto.WfRunId getWfRunId(); /** + *
+   * ID of the WfRun for this NodeRun. Note that every NodeRun is associated with
+   * a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder(); /** + *
+   * ThreadRun of this NodeRun. Note that each NodeRun belongs to a ThreadRun.
+   * 
+ * * int32 thread_run_number = 2; * @return The threadRunNumber. */ int getThreadRunNumber(); /** + *
+   * Position of this NodeRun within its ThreadRun.
+   * 
+ * * int32 position = 3; * @return The position. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/NodeRunOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/NodeRunOrBuilder.java index 68663b85a..31db681a0 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/NodeRunOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/NodeRunOrBuilder.java @@ -8,46 +8,91 @@ public interface NodeRunOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the
+   * ThreadRun's number, and the position of the NodeRun within that ThreadRun.
+   * 
+ * * .littlehorse.NodeRunId id = 1; * @return Whether the id field is set. */ boolean hasId(); /** + *
+   * The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the
+   * ThreadRun's number, and the position of the NodeRun within that ThreadRun.
+   * 
+ * * .littlehorse.NodeRunId id = 1; * @return The id. */ io.littlehorse.sdk.common.proto.NodeRunId getId(); /** + *
+   * The ID of the NodeRun. Note that the NodeRunId contains the WfRunId, the
+   * ThreadRun's number, and the position of the NodeRun within that ThreadRun.
+   * 
+ * * .littlehorse.NodeRunId id = 1; */ io.littlehorse.sdk.common.proto.NodeRunIdOrBuilder getIdOrBuilder(); /** + *
+   * The ID of the WfSpec that this NodeRun is from. This is not _always_ the same
+   * as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration
+   * feature.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; * @return Whether the wfSpecId field is set. */ boolean hasWfSpecId(); /** + *
+   * The ID of the WfSpec that this NodeRun is from. This is not _always_ the same
+   * as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration
+   * feature.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; * @return The wfSpecId. */ io.littlehorse.sdk.common.proto.WfSpecId getWfSpecId(); /** + *
+   * The ID of the WfSpec that this NodeRun is from. This is not _always_ the same
+   * as the ThreadRun it belongs to because of the upcoming WfSpec Version Migration
+   * feature.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; */ io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder(); /** + *
+   * A list of all ThreadRun's that ran to handle a failure thrown by this NodeRun.
+   * 
+ * * repeated int32 failure_handler_ids = 5; * @return A list containing the failureHandlerIds. */ java.util.List getFailureHandlerIdsList(); /** + *
+   * A list of all ThreadRun's that ran to handle a failure thrown by this NodeRun.
+   * 
+ * * repeated int32 failure_handler_ids = 5; * @return The count of failureHandlerIds. */ int getFailureHandlerIdsCount(); /** + *
+   * A list of all ThreadRun's that ran to handle a failure thrown by this NodeRun.
+   * 
+ * * repeated int32 failure_handler_ids = 5; * @param index The index of the element to return. * @return The failureHandlerIds at the given index. @@ -55,52 +100,92 @@ public interface NodeRunOrBuilder extends int getFailureHandlerIds(int index); /** + *
+   * The status of this NodeRun.
+   * 
+ * * .littlehorse.LHStatus status = 6; * @return The enum numeric value on the wire for status. */ int getStatusValue(); /** + *
+   * The status of this NodeRun.
+   * 
+ * * .littlehorse.LHStatus status = 6; * @return The status. */ io.littlehorse.sdk.common.proto.LHStatus getStatus(); /** + *
+   * The time the ThreadRun arrived at this NodeRun.
+   * 
+ * * .google.protobuf.Timestamp arrival_time = 7; * @return Whether the arrivalTime field is set. */ boolean hasArrivalTime(); /** + *
+   * The time the ThreadRun arrived at this NodeRun.
+   * 
+ * * .google.protobuf.Timestamp arrival_time = 7; * @return The arrivalTime. */ com.google.protobuf.Timestamp getArrivalTime(); /** + *
+   * The time the ThreadRun arrived at this NodeRun.
+   * 
+ * * .google.protobuf.Timestamp arrival_time = 7; */ com.google.protobuf.TimestampOrBuilder getArrivalTimeOrBuilder(); /** + *
+   * The time the NodeRun was terminated (failed or completed).
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 8; * @return Whether the endTime field is set. */ boolean hasEndTime(); /** + *
+   * The time the NodeRun was terminated (failed or completed).
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 8; * @return The endTime. */ com.google.protobuf.Timestamp getEndTime(); /** + *
+   * The time the NodeRun was terminated (failed or completed).
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 8; */ com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder(); /** + *
+   * The name of the ThreadSpec to which this NodeRun belongs.
+   * 
+ * * string thread_spec_name = 9; * @return The threadSpecName. */ java.lang.String getThreadSpecName(); /** + *
+   * The name of the ThreadSpec to which this NodeRun belongs.
+   * 
+ * * string thread_spec_name = 9; * @return The bytes for threadSpecName. */ @@ -108,11 +193,19 @@ public interface NodeRunOrBuilder extends getThreadSpecNameBytes(); /** + *
+   * The name of the Node in the ThreadSpec that this NodeRun belongs to.
+   * 
+ * * string node_name = 10; * @return The nodeName. */ java.lang.String getNodeName(); /** + *
+   * The name of the Node in the ThreadSpec that this NodeRun belongs to.
+   * 
+ * * string node_name = 10; * @return The bytes for nodeName. */ @@ -120,16 +213,31 @@ public interface NodeRunOrBuilder extends getNodeNameBytes(); /** + *
+   * A human-readable error message intended to help developers diagnose WfSpec
+   * problems.
+   * 
+ * * optional string error_message = 11; * @return Whether the errorMessage field is set. */ boolean hasErrorMessage(); /** + *
+   * A human-readable error message intended to help developers diagnose WfSpec
+   * problems.
+   * 
+ * * optional string error_message = 11; * @return The errorMessage. */ java.lang.String getErrorMessage(); /** + *
+   * A human-readable error message intended to help developers diagnose WfSpec
+   * problems.
+   * 
+ * * optional string error_message = 11; * @return The bytes for errorMessage. */ @@ -137,160 +245,291 @@ public interface NodeRunOrBuilder extends getErrorMessageBytes(); /** + *
+   * A list of Failures thrown by this NodeRun.
+   * 
+ * * repeated .littlehorse.Failure failures = 12; */ java.util.List getFailuresList(); /** + *
+   * A list of Failures thrown by this NodeRun.
+   * 
+ * * repeated .littlehorse.Failure failures = 12; */ io.littlehorse.sdk.common.proto.Failure getFailures(int index); /** + *
+   * A list of Failures thrown by this NodeRun.
+   * 
+ * * repeated .littlehorse.Failure failures = 12; */ int getFailuresCount(); /** + *
+   * A list of Failures thrown by this NodeRun.
+   * 
+ * * repeated .littlehorse.Failure failures = 12; */ java.util.List getFailuresOrBuilderList(); /** + *
+   * A list of Failures thrown by this NodeRun.
+   * 
+ * * repeated .littlehorse.Failure failures = 12; */ io.littlehorse.sdk.common.proto.FailureOrBuilder getFailuresOrBuilder( int index); /** + *
+   * Denotes a TASK node, which runs a TaskRun.
+   * 
+ * * .littlehorse.TaskNodeRun task = 13; * @return Whether the task field is set. */ boolean hasTask(); /** + *
+   * Denotes a TASK node, which runs a TaskRun.
+   * 
+ * * .littlehorse.TaskNodeRun task = 13; * @return The task. */ io.littlehorse.sdk.common.proto.TaskNodeRun getTask(); /** + *
+   * Denotes a TASK node, which runs a TaskRun.
+   * 
+ * * .littlehorse.TaskNodeRun task = 13; */ io.littlehorse.sdk.common.proto.TaskNodeRunOrBuilder getTaskOrBuilder(); /** + *
+   * An EXTERNAL_EVENT node blocks until an ExternalEvent arrives.
+   * 
+ * * .littlehorse.ExternalEventRun external_event = 14; * @return Whether the externalEvent field is set. */ boolean hasExternalEvent(); /** + *
+   * An EXTERNAL_EVENT node blocks until an ExternalEvent arrives.
+   * 
+ * * .littlehorse.ExternalEventRun external_event = 14; * @return The externalEvent. */ io.littlehorse.sdk.common.proto.ExternalEventRun getExternalEvent(); /** + *
+   * An EXTERNAL_EVENT node blocks until an ExternalEvent arrives.
+   * 
+ * * .littlehorse.ExternalEventRun external_event = 14; */ io.littlehorse.sdk.common.proto.ExternalEventRunOrBuilder getExternalEventOrBuilder(); /** + *
+   * An ENTRYPOINT node is the first thing that runs in a ThreadRun.
+   * 
+ * * .littlehorse.EntrypointRun entrypoint = 15; * @return Whether the entrypoint field is set. */ boolean hasEntrypoint(); /** + *
+   * An ENTRYPOINT node is the first thing that runs in a ThreadRun.
+   * 
+ * * .littlehorse.EntrypointRun entrypoint = 15; * @return The entrypoint. */ io.littlehorse.sdk.common.proto.EntrypointRun getEntrypoint(); /** + *
+   * An ENTRYPOINT node is the first thing that runs in a ThreadRun.
+   * 
+ * * .littlehorse.EntrypointRun entrypoint = 15; */ io.littlehorse.sdk.common.proto.EntrypointRunOrBuilder getEntrypointOrBuilder(); /** + *
+   * An EXIT node completes a ThreadRun.
+   * 
+ * * .littlehorse.ExitRun exit = 16; * @return Whether the exit field is set. */ boolean hasExit(); /** + *
+   * An EXIT node completes a ThreadRun.
+   * 
+ * * .littlehorse.ExitRun exit = 16; * @return The exit. */ io.littlehorse.sdk.common.proto.ExitRun getExit(); /** + *
+   * An EXIT node completes a ThreadRun.
+   * 
+ * * .littlehorse.ExitRun exit = 16; */ io.littlehorse.sdk.common.proto.ExitRunOrBuilder getExitOrBuilder(); /** + *
+   * A START_THREAD node starts a child ThreadRun.
+   * 
+ * * .littlehorse.StartThreadRun start_thread = 17; * @return Whether the startThread field is set. */ boolean hasStartThread(); /** + *
+   * A START_THREAD node starts a child ThreadRun.
+   * 
+ * * .littlehorse.StartThreadRun start_thread = 17; * @return The startThread. */ io.littlehorse.sdk.common.proto.StartThreadRun getStartThread(); /** + *
+   * A START_THREAD node starts a child ThreadRun.
+   * 
+ * * .littlehorse.StartThreadRun start_thread = 17; */ io.littlehorse.sdk.common.proto.StartThreadRunOrBuilder getStartThreadOrBuilder(); /** + *
+   * A WAIT_THREADS node waits for one or more child ThreadRun's to complete.
+   * 
+ * * .littlehorse.WaitForThreadsRun wait_threads = 18; * @return Whether the waitThreads field is set. */ boolean hasWaitThreads(); /** + *
+   * A WAIT_THREADS node waits for one or more child ThreadRun's to complete.
+   * 
+ * * .littlehorse.WaitForThreadsRun wait_threads = 18; * @return The waitThreads. */ io.littlehorse.sdk.common.proto.WaitForThreadsRun getWaitThreads(); /** + *
+   * A WAIT_THREADS node waits for one or more child ThreadRun's to complete.
+   * 
+ * * .littlehorse.WaitForThreadsRun wait_threads = 18; */ io.littlehorse.sdk.common.proto.WaitForThreadsRunOrBuilder getWaitThreadsOrBuilder(); /** + *
+   * A SLEEP node makes the ThreadRun block for a certain amount of time.
+   * 
+ * * .littlehorse.SleepNodeRun sleep = 19; * @return Whether the sleep field is set. */ boolean hasSleep(); /** + *
+   * A SLEEP node makes the ThreadRun block for a certain amount of time.
+   * 
+ * * .littlehorse.SleepNodeRun sleep = 19; * @return The sleep. */ io.littlehorse.sdk.common.proto.SleepNodeRun getSleep(); /** + *
+   * A SLEEP node makes the ThreadRun block for a certain amount of time.
+   * 
+ * * .littlehorse.SleepNodeRun sleep = 19; */ io.littlehorse.sdk.common.proto.SleepNodeRunOrBuilder getSleepOrBuilder(); /** + *
+   * A USER_TASK node waits until a human executes some work and reports the result.
+   * 
+ * * .littlehorse.UserTaskNodeRun user_task = 20; * @return Whether the userTask field is set. */ boolean hasUserTask(); /** + *
+   * A USER_TASK node waits until a human executes some work and reports the result.
+   * 
+ * * .littlehorse.UserTaskNodeRun user_task = 20; * @return The userTask. */ io.littlehorse.sdk.common.proto.UserTaskNodeRun getUserTask(); /** + *
+   * A USER_TASK node waits until a human executes some work and reports the result.
+   * 
+ * * .littlehorse.UserTaskNodeRun user_task = 20; */ io.littlehorse.sdk.common.proto.UserTaskNodeRunOrBuilder getUserTaskOrBuilder(); /** + *
+   * A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a
+   * child ThreadRun for each element in the list.
+   * 
+ * * .littlehorse.StartMultipleThreadsRun start_multiple_threads = 21; * @return Whether the startMultipleThreads field is set. */ boolean hasStartMultipleThreads(); /** + *
+   * A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a
+   * child ThreadRun for each element in the list.
+   * 
+ * * .littlehorse.StartMultipleThreadsRun start_multiple_threads = 21; * @return The startMultipleThreads. */ io.littlehorse.sdk.common.proto.StartMultipleThreadsRun getStartMultipleThreads(); /** + *
+   * A START_MULTIPLE_THREADS node iterates over a JSON_ARR variable and spawns a
+   * child ThreadRun for each element in the list.
+   * 
+ * * .littlehorse.StartMultipleThreadsRun start_multiple_threads = 21; */ io.littlehorse.sdk.common.proto.StartMultipleThreadsRunOrBuilder getStartMultipleThreadsOrBuilder(); diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ParentHalted.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ParentHalted.java index ee05ba3a9..f5e25376d 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ParentHalted.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ParentHalted.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * A Halt Reason denoting that a ThreadRun is halted because its parent is also HALTED.
+ * 
+ * * Protobuf type {@code littlehorse.ParentHalted} */ public final class ParentHalted extends @@ -41,6 +45,10 @@ protected java.lang.Object newInstance( public static final int PARENT_THREAD_ID_FIELD_NUMBER = 1; private int parentThreadId_ = 0; /** + *
+   * The ID of the halted parent.
+   * 
+ * * int32 parent_thread_id = 1; * @return The parentThreadId. */ @@ -207,6 +215,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * A Halt Reason denoting that a ThreadRun is halted because its parent is also HALTED.
+   * 
+ * * Protobuf type {@code littlehorse.ParentHalted} */ public static final class Builder extends @@ -376,6 +388,10 @@ public Builder mergeFrom( private int parentThreadId_ ; /** + *
+     * The ID of the halted parent.
+     * 
+ * * int32 parent_thread_id = 1; * @return The parentThreadId. */ @@ -384,6 +400,10 @@ public int getParentThreadId() { return parentThreadId_; } /** + *
+     * The ID of the halted parent.
+     * 
+ * * int32 parent_thread_id = 1; * @param value The parentThreadId to set. * @return This builder for chaining. @@ -396,6 +416,10 @@ public Builder setParentThreadId(int value) { return this; } /** + *
+     * The ID of the halted parent.
+     * 
+ * * int32 parent_thread_id = 1; * @return This builder for chaining. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ParentHaltedOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ParentHaltedOrBuilder.java index 073e6933b..816b7ea5f 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ParentHaltedOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ParentHaltedOrBuilder.java @@ -8,6 +8,10 @@ public interface ParentHaltedOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The ID of the halted parent.
+   * 
+ * * int32 parent_thread_id = 1; * @return The parentThreadId. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingFailureHandler.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingFailureHandler.java index e3cae5e24..a091f6653 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingFailureHandler.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingFailureHandler.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * Represents a Failure Handler that is pending to be run.
+ * 
+ * * Protobuf type {@code littlehorse.PendingFailureHandler} */ public final class PendingFailureHandler extends @@ -42,6 +46,10 @@ protected java.lang.Object newInstance( public static final int FAILED_THREAD_RUN_FIELD_NUMBER = 1; private int failedThreadRun_ = 0; /** + *
+   * The ThreadRun that failed.
+   * 
+ * * int32 failed_thread_run = 1; * @return The failedThreadRun. */ @@ -54,6 +62,10 @@ public int getFailedThreadRun() { @SuppressWarnings("serial") private volatile java.lang.Object handlerSpecName_ = ""; /** + *
+   * The name of the ThreadSpec to run to handle the failure.
+   * 
+ * * string handler_spec_name = 2; * @return The handlerSpecName. */ @@ -71,6 +83,10 @@ public java.lang.String getHandlerSpecName() { } } /** + *
+   * The name of the ThreadSpec to run to handle the failure.
+   * 
+ * * string handler_spec_name = 2; * @return The bytes for handlerSpecName. */ @@ -257,6 +273,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * Represents a Failure Handler that is pending to be run.
+   * 
+ * * Protobuf type {@code littlehorse.PendingFailureHandler} */ public static final class Builder extends @@ -440,6 +460,10 @@ public Builder mergeFrom( private int failedThreadRun_ ; /** + *
+     * The ThreadRun that failed.
+     * 
+ * * int32 failed_thread_run = 1; * @return The failedThreadRun. */ @@ -448,6 +472,10 @@ public int getFailedThreadRun() { return failedThreadRun_; } /** + *
+     * The ThreadRun that failed.
+     * 
+ * * int32 failed_thread_run = 1; * @param value The failedThreadRun to set. * @return This builder for chaining. @@ -460,6 +488,10 @@ public Builder setFailedThreadRun(int value) { return this; } /** + *
+     * The ThreadRun that failed.
+     * 
+ * * int32 failed_thread_run = 1; * @return This builder for chaining. */ @@ -472,6 +504,10 @@ public Builder clearFailedThreadRun() { private java.lang.Object handlerSpecName_ = ""; /** + *
+     * The name of the ThreadSpec to run to handle the failure.
+     * 
+ * * string handler_spec_name = 2; * @return The handlerSpecName. */ @@ -488,6 +524,10 @@ public java.lang.String getHandlerSpecName() { } } /** + *
+     * The name of the ThreadSpec to run to handle the failure.
+     * 
+ * * string handler_spec_name = 2; * @return The bytes for handlerSpecName. */ @@ -505,6 +545,10 @@ public java.lang.String getHandlerSpecName() { } } /** + *
+     * The name of the ThreadSpec to run to handle the failure.
+     * 
+ * * string handler_spec_name = 2; * @param value The handlerSpecName to set. * @return This builder for chaining. @@ -518,6 +562,10 @@ public Builder setHandlerSpecName( return this; } /** + *
+     * The name of the ThreadSpec to run to handle the failure.
+     * 
+ * * string handler_spec_name = 2; * @return This builder for chaining. */ @@ -528,6 +576,10 @@ public Builder clearHandlerSpecName() { return this; } /** + *
+     * The name of the ThreadSpec to run to handle the failure.
+     * 
+ * * string handler_spec_name = 2; * @param value The bytes for handlerSpecName to set. * @return This builder for chaining. diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingFailureHandlerHaltReason.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingFailureHandlerHaltReason.java index 38389fa77..3a5b18f1c 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingFailureHandlerHaltReason.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingFailureHandlerHaltReason.java @@ -4,6 +4,11 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * A Halt Reason denoting that a ThreadRun is halted while a Failure Handler is *enqueued* to be
+ * run.
+ * 
+ * * Protobuf type {@code littlehorse.PendingFailureHandlerHaltReason} */ public final class PendingFailureHandlerHaltReason extends @@ -41,6 +46,10 @@ protected java.lang.Object newInstance( public static final int NODE_RUN_POSITION_FIELD_NUMBER = 1; private int nodeRunPosition_ = 0; /** + *
+   * The position of the NodeRun which threw the failure.
+   * 
+ * * int32 node_run_position = 1; * @return The nodeRunPosition. */ @@ -207,6 +216,11 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * A Halt Reason denoting that a ThreadRun is halted while a Failure Handler is *enqueued* to be
+   * run.
+   * 
+ * * Protobuf type {@code littlehorse.PendingFailureHandlerHaltReason} */ public static final class Builder extends @@ -376,6 +390,10 @@ public Builder mergeFrom( private int nodeRunPosition_ ; /** + *
+     * The position of the NodeRun which threw the failure.
+     * 
+ * * int32 node_run_position = 1; * @return The nodeRunPosition. */ @@ -384,6 +402,10 @@ public int getNodeRunPosition() { return nodeRunPosition_; } /** + *
+     * The position of the NodeRun which threw the failure.
+     * 
+ * * int32 node_run_position = 1; * @param value The nodeRunPosition to set. * @return This builder for chaining. @@ -396,6 +418,10 @@ public Builder setNodeRunPosition(int value) { return this; } /** + *
+     * The position of the NodeRun which threw the failure.
+     * 
+ * * int32 node_run_position = 1; * @return This builder for chaining. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingFailureHandlerHaltReasonOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingFailureHandlerHaltReasonOrBuilder.java index 412458e55..42987a1ba 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingFailureHandlerHaltReasonOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingFailureHandlerHaltReasonOrBuilder.java @@ -8,6 +8,10 @@ public interface PendingFailureHandlerHaltReasonOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The position of the NodeRun which threw the failure.
+   * 
+ * * int32 node_run_position = 1; * @return The nodeRunPosition. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingFailureHandlerOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingFailureHandlerOrBuilder.java index 29624c154..8cb535a5f 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingFailureHandlerOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingFailureHandlerOrBuilder.java @@ -8,17 +8,29 @@ public interface PendingFailureHandlerOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The ThreadRun that failed.
+   * 
+ * * int32 failed_thread_run = 1; * @return The failedThreadRun. */ int getFailedThreadRun(); /** + *
+   * The name of the ThreadSpec to run to handle the failure.
+   * 
+ * * string handler_spec_name = 2; * @return The handlerSpecName. */ java.lang.String getHandlerSpecName(); /** + *
+   * The name of the ThreadSpec to run to handle the failure.
+   * 
+ * * string handler_spec_name = 2; * @return The bytes for handlerSpecName. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingInterrupt.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingInterrupt.java index df650ecf8..61bc87d65 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingInterrupt.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingInterrupt.java @@ -4,6 +4,11 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * Represents an ExternalEvent that has a registered Interrupt Handler for it
+ * and which is pending to be sent to the relevant ThreadRun's.
+ * 
+ * * Protobuf type {@code littlehorse.PendingInterrupt} */ public final class PendingInterrupt extends @@ -42,6 +47,10 @@ protected java.lang.Object newInstance( public static final int EXTERNAL_EVENT_ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.ExternalEventId externalEventId_; /** + *
+   * The ID of the ExternalEvent triggering the Interrupt.
+   * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; * @return Whether the externalEventId field is set. */ @@ -50,6 +59,10 @@ public boolean hasExternalEventId() { return externalEventId_ != null; } /** + *
+   * The ID of the ExternalEvent triggering the Interrupt.
+   * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; * @return The externalEventId. */ @@ -58,6 +71,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventId getExternalEventId() { return externalEventId_ == null ? io.littlehorse.sdk.common.proto.ExternalEventId.getDefaultInstance() : externalEventId_; } /** + *
+   * The ID of the ExternalEvent triggering the Interrupt.
+   * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; */ @java.lang.Override @@ -69,6 +86,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getExternalEvent @SuppressWarnings("serial") private volatile java.lang.Object handlerSpecName_ = ""; /** + *
+   * The name of the ThreadSpec to run to handle the Interrupt.
+   * 
+ * * string handler_spec_name = 2; * @return The handlerSpecName. */ @@ -86,6 +107,10 @@ public java.lang.String getHandlerSpecName() { } } /** + *
+   * The name of the ThreadSpec to run to handle the Interrupt.
+   * 
+ * * string handler_spec_name = 2; * @return The bytes for handlerSpecName. */ @@ -107,6 +132,11 @@ public java.lang.String getHandlerSpecName() { public static final int INTERRUPTED_THREAD_ID_FIELD_NUMBER = 3; private int interruptedThreadId_ = 0; /** + *
+   * The ID of the ThreadRun to interrupt. Must wait for this ThreadRun to be
+   * HALTED before running the Interrupt Handler.
+   * 
+ * * int32 interrupted_thread_id = 3; * @return The interruptedThreadId. */ @@ -299,6 +329,11 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * Represents an ExternalEvent that has a registered Interrupt Handler for it
+   * and which is pending to be sent to the relevant ThreadRun's.
+   * 
+ * * Protobuf type {@code littlehorse.PendingInterrupt} */ public static final class Builder extends @@ -504,6 +539,10 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.ExternalEventId, io.littlehorse.sdk.common.proto.ExternalEventId.Builder, io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder> externalEventIdBuilder_; /** + *
+     * The ID of the ExternalEvent triggering the Interrupt.
+     * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; * @return Whether the externalEventId field is set. */ @@ -511,6 +550,10 @@ public boolean hasExternalEventId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * The ID of the ExternalEvent triggering the Interrupt.
+     * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; * @return The externalEventId. */ @@ -522,6 +565,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventId getExternalEventId() { } } /** + *
+     * The ID of the ExternalEvent triggering the Interrupt.
+     * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; */ public Builder setExternalEventId(io.littlehorse.sdk.common.proto.ExternalEventId value) { @@ -538,6 +585,10 @@ public Builder setExternalEventId(io.littlehorse.sdk.common.proto.ExternalEventI return this; } /** + *
+     * The ID of the ExternalEvent triggering the Interrupt.
+     * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; */ public Builder setExternalEventId( @@ -552,6 +603,10 @@ public Builder setExternalEventId( return this; } /** + *
+     * The ID of the ExternalEvent triggering the Interrupt.
+     * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; */ public Builder mergeExternalEventId(io.littlehorse.sdk.common.proto.ExternalEventId value) { @@ -571,6 +626,10 @@ public Builder mergeExternalEventId(io.littlehorse.sdk.common.proto.ExternalEven return this; } /** + *
+     * The ID of the ExternalEvent triggering the Interrupt.
+     * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; */ public Builder clearExternalEventId() { @@ -584,6 +643,10 @@ public Builder clearExternalEventId() { return this; } /** + *
+     * The ID of the ExternalEvent triggering the Interrupt.
+     * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; */ public io.littlehorse.sdk.common.proto.ExternalEventId.Builder getExternalEventIdBuilder() { @@ -592,6 +655,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventId.Builder getExternalEventI return getExternalEventIdFieldBuilder().getBuilder(); } /** + *
+     * The ID of the ExternalEvent triggering the Interrupt.
+     * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; */ public io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getExternalEventIdOrBuilder() { @@ -603,6 +670,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getExternalEvent } } /** + *
+     * The ID of the ExternalEvent triggering the Interrupt.
+     * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -621,6 +692,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getExternalEvent private java.lang.Object handlerSpecName_ = ""; /** + *
+     * The name of the ThreadSpec to run to handle the Interrupt.
+     * 
+ * * string handler_spec_name = 2; * @return The handlerSpecName. */ @@ -637,6 +712,10 @@ public java.lang.String getHandlerSpecName() { } } /** + *
+     * The name of the ThreadSpec to run to handle the Interrupt.
+     * 
+ * * string handler_spec_name = 2; * @return The bytes for handlerSpecName. */ @@ -654,6 +733,10 @@ public java.lang.String getHandlerSpecName() { } } /** + *
+     * The name of the ThreadSpec to run to handle the Interrupt.
+     * 
+ * * string handler_spec_name = 2; * @param value The handlerSpecName to set. * @return This builder for chaining. @@ -667,6 +750,10 @@ public Builder setHandlerSpecName( return this; } /** + *
+     * The name of the ThreadSpec to run to handle the Interrupt.
+     * 
+ * * string handler_spec_name = 2; * @return This builder for chaining. */ @@ -677,6 +764,10 @@ public Builder clearHandlerSpecName() { return this; } /** + *
+     * The name of the ThreadSpec to run to handle the Interrupt.
+     * 
+ * * string handler_spec_name = 2; * @param value The bytes for handlerSpecName to set. * @return This builder for chaining. @@ -693,6 +784,11 @@ public Builder setHandlerSpecNameBytes( private int interruptedThreadId_ ; /** + *
+     * The ID of the ThreadRun to interrupt. Must wait for this ThreadRun to be
+     * HALTED before running the Interrupt Handler.
+     * 
+ * * int32 interrupted_thread_id = 3; * @return The interruptedThreadId. */ @@ -701,6 +797,11 @@ public int getInterruptedThreadId() { return interruptedThreadId_; } /** + *
+     * The ID of the ThreadRun to interrupt. Must wait for this ThreadRun to be
+     * HALTED before running the Interrupt Handler.
+     * 
+ * * int32 interrupted_thread_id = 3; * @param value The interruptedThreadId to set. * @return This builder for chaining. @@ -713,6 +814,11 @@ public Builder setInterruptedThreadId(int value) { return this; } /** + *
+     * The ID of the ThreadRun to interrupt. Must wait for this ThreadRun to be
+     * HALTED before running the Interrupt Handler.
+     * 
+ * * int32 interrupted_thread_id = 3; * @return This builder for chaining. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingInterruptHaltReason.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingInterruptHaltReason.java index 317721602..33c5b67d6 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingInterruptHaltReason.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingInterruptHaltReason.java @@ -4,6 +4,11 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * A Halt Reason denoting that a ThreadRun is halted while waiting for an Interrupt handler
+ * to be run.
+ * 
+ * * Protobuf type {@code littlehorse.PendingInterruptHaltReason} */ public final class PendingInterruptHaltReason extends @@ -41,6 +46,10 @@ protected java.lang.Object newInstance( public static final int EXTERNAL_EVENT_ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.ExternalEventId externalEventId_; /** + *
+   * The ExternalEventId that caused the Interrupt.
+   * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; * @return Whether the externalEventId field is set. */ @@ -49,6 +58,10 @@ public boolean hasExternalEventId() { return externalEventId_ != null; } /** + *
+   * The ExternalEventId that caused the Interrupt.
+   * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; * @return The externalEventId. */ @@ -57,6 +70,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventId getExternalEventId() { return externalEventId_ == null ? io.littlehorse.sdk.common.proto.ExternalEventId.getDefaultInstance() : externalEventId_; } /** + *
+   * The ExternalEventId that caused the Interrupt.
+   * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; */ @java.lang.Override @@ -227,6 +244,11 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * A Halt Reason denoting that a ThreadRun is halted while waiting for an Interrupt handler
+   * to be run.
+   * 
+ * * Protobuf type {@code littlehorse.PendingInterruptHaltReason} */ public static final class Builder extends @@ -406,6 +428,10 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.ExternalEventId, io.littlehorse.sdk.common.proto.ExternalEventId.Builder, io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder> externalEventIdBuilder_; /** + *
+     * The ExternalEventId that caused the Interrupt.
+     * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; * @return Whether the externalEventId field is set. */ @@ -413,6 +439,10 @@ public boolean hasExternalEventId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * The ExternalEventId that caused the Interrupt.
+     * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; * @return The externalEventId. */ @@ -424,6 +454,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventId getExternalEventId() { } } /** + *
+     * The ExternalEventId that caused the Interrupt.
+     * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; */ public Builder setExternalEventId(io.littlehorse.sdk.common.proto.ExternalEventId value) { @@ -440,6 +474,10 @@ public Builder setExternalEventId(io.littlehorse.sdk.common.proto.ExternalEventI return this; } /** + *
+     * The ExternalEventId that caused the Interrupt.
+     * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; */ public Builder setExternalEventId( @@ -454,6 +492,10 @@ public Builder setExternalEventId( return this; } /** + *
+     * The ExternalEventId that caused the Interrupt.
+     * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; */ public Builder mergeExternalEventId(io.littlehorse.sdk.common.proto.ExternalEventId value) { @@ -473,6 +515,10 @@ public Builder mergeExternalEventId(io.littlehorse.sdk.common.proto.ExternalEven return this; } /** + *
+     * The ExternalEventId that caused the Interrupt.
+     * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; */ public Builder clearExternalEventId() { @@ -486,6 +532,10 @@ public Builder clearExternalEventId() { return this; } /** + *
+     * The ExternalEventId that caused the Interrupt.
+     * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; */ public io.littlehorse.sdk.common.proto.ExternalEventId.Builder getExternalEventIdBuilder() { @@ -494,6 +544,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventId.Builder getExternalEventI return getExternalEventIdFieldBuilder().getBuilder(); } /** + *
+     * The ExternalEventId that caused the Interrupt.
+     * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; */ public io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getExternalEventIdOrBuilder() { @@ -505,6 +559,10 @@ public io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getExternalEvent } } /** + *
+     * The ExternalEventId that caused the Interrupt.
+     * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingInterruptHaltReasonOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingInterruptHaltReasonOrBuilder.java index 1e46942a7..b884585af 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingInterruptHaltReasonOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingInterruptHaltReasonOrBuilder.java @@ -8,16 +8,28 @@ public interface PendingInterruptHaltReasonOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The ExternalEventId that caused the Interrupt.
+   * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; * @return Whether the externalEventId field is set. */ boolean hasExternalEventId(); /** + *
+   * The ExternalEventId that caused the Interrupt.
+   * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; * @return The externalEventId. */ io.littlehorse.sdk.common.proto.ExternalEventId getExternalEventId(); /** + *
+   * The ExternalEventId that caused the Interrupt.
+   * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; */ io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getExternalEventIdOrBuilder(); diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingInterruptOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingInterruptOrBuilder.java index 7851c93b2..795c9c3be 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingInterruptOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PendingInterruptOrBuilder.java @@ -8,26 +8,46 @@ public interface PendingInterruptOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The ID of the ExternalEvent triggering the Interrupt.
+   * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; * @return Whether the externalEventId field is set. */ boolean hasExternalEventId(); /** + *
+   * The ID of the ExternalEvent triggering the Interrupt.
+   * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; * @return The externalEventId. */ io.littlehorse.sdk.common.proto.ExternalEventId getExternalEventId(); /** + *
+   * The ID of the ExternalEvent triggering the Interrupt.
+   * 
+ * * .littlehorse.ExternalEventId external_event_id = 1; */ io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getExternalEventIdOrBuilder(); /** + *
+   * The name of the ThreadSpec to run to handle the Interrupt.
+   * 
+ * * string handler_spec_name = 2; * @return The handlerSpecName. */ java.lang.String getHandlerSpecName(); /** + *
+   * The name of the ThreadSpec to run to handle the Interrupt.
+   * 
+ * * string handler_spec_name = 2; * @return The bytes for handlerSpecName. */ @@ -35,6 +55,11 @@ public interface PendingInterruptOrBuilder extends getHandlerSpecNameBytes(); /** + *
+   * The ID of the ThreadRun to interrupt. Must wait for this ThreadRun to be
+   * HALTED before running the Interrupt Handler.
+   * 
+ * * int32 interrupted_thread_id = 3; * @return The interruptedThreadId. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PrincipalId.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PrincipalId.java index f0be8ffc2..d364944d6 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PrincipalId.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PrincipalId.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * ID for a Principal.
+ * 
+ * * Protobuf type {@code littlehorse.PrincipalId} */ public final class PrincipalId extends @@ -43,6 +47,11 @@ protected java.lang.Object newInstance( @SuppressWarnings("serial") private volatile java.lang.Object id_ = ""; /** + *
+   * The id of this principal. In OAuth, this is the OAuth Client ID (for
+   * machine principals) or the OAuth User Id (for human principals).
+   * 
+ * * string id = 1; * @return The id. */ @@ -60,6 +69,11 @@ public java.lang.String getId() { } } /** + *
+   * The id of this principal. In OAuth, this is the OAuth Client ID (for
+   * machine principals) or the OAuth User Id (for human principals).
+   * 
+ * * string id = 1; * @return The bytes for id. */ @@ -235,6 +249,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * ID for a Principal.
+   * 
+ * * Protobuf type {@code littlehorse.PrincipalId} */ public static final class Builder extends @@ -406,6 +424,11 @@ public Builder mergeFrom( private java.lang.Object id_ = ""; /** + *
+     * The id of this principal. In OAuth, this is the OAuth Client ID (for
+     * machine principals) or the OAuth User Id (for human principals).
+     * 
+ * * string id = 1; * @return The id. */ @@ -422,6 +445,11 @@ public java.lang.String getId() { } } /** + *
+     * The id of this principal. In OAuth, this is the OAuth Client ID (for
+     * machine principals) or the OAuth User Id (for human principals).
+     * 
+ * * string id = 1; * @return The bytes for id. */ @@ -439,6 +467,11 @@ public java.lang.String getId() { } } /** + *
+     * The id of this principal. In OAuth, this is the OAuth Client ID (for
+     * machine principals) or the OAuth User Id (for human principals).
+     * 
+ * * string id = 1; * @param value The id to set. * @return This builder for chaining. @@ -452,6 +485,11 @@ public Builder setId( return this; } /** + *
+     * The id of this principal. In OAuth, this is the OAuth Client ID (for
+     * machine principals) or the OAuth User Id (for human principals).
+     * 
+ * * string id = 1; * @return This builder for chaining. */ @@ -462,6 +500,11 @@ public Builder clearId() { return this; } /** + *
+     * The id of this principal. In OAuth, this is the OAuth Client ID (for
+     * machine principals) or the OAuth User Id (for human principals).
+     * 
+ * * string id = 1; * @param value The bytes for id to set. * @return This builder for chaining. diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PrincipalIdOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PrincipalIdOrBuilder.java index ff27ede30..bc35ed71b 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PrincipalIdOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PrincipalIdOrBuilder.java @@ -8,11 +8,21 @@ public interface PrincipalIdOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The id of this principal. In OAuth, this is the OAuth Client ID (for
+   * machine principals) or the OAuth User Id (for human principals).
+   * 
+ * * string id = 1; * @return The id. */ java.lang.String getId(); /** + *
+   * The id of this principal. In OAuth, this is the OAuth Client ID (for
+   * machine principals) or the OAuth User Id (for human principals).
+   * 
+ * * string id = 1; * @return The bytes for id. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PutExternalEventDefRequest.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PutExternalEventDefRequest.java index 186fc0b84..c8d1c3a34 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PutExternalEventDefRequest.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PutExternalEventDefRequest.java @@ -95,7 +95,13 @@ public java.lang.String getName() { /** *
    * Policy to determine how long an ExternalEvent is retained after creation if it
-   * is not yet claimed by a WfRun.
+   * is not yet claimed by a WfRun. Note that once a WfRun has been matched with the
+   * ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted.
+   * If not set, then ExternalEvent's are not deleted if they are not matched with
+   * a WfRun.
+   *
+   * A future version of LittleHorse will allow changing the retention_policy, which
+   * will trigger a cleanup of old `ExternalEvent`s.
    * 
* * .littlehorse.ExternalEventRetentionPolicy retention_policy = 2; @@ -108,7 +114,13 @@ public boolean hasRetentionPolicy() { /** *
    * Policy to determine how long an ExternalEvent is retained after creation if it
-   * is not yet claimed by a WfRun.
+   * is not yet claimed by a WfRun. Note that once a WfRun has been matched with the
+   * ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted.
+   * If not set, then ExternalEvent's are not deleted if they are not matched with
+   * a WfRun.
+   *
+   * A future version of LittleHorse will allow changing the retention_policy, which
+   * will trigger a cleanup of old `ExternalEvent`s.
    * 
* * .littlehorse.ExternalEventRetentionPolicy retention_policy = 2; @@ -121,7 +133,13 @@ public io.littlehorse.sdk.common.proto.ExternalEventRetentionPolicy getRetention /** *
    * Policy to determine how long an ExternalEvent is retained after creation if it
-   * is not yet claimed by a WfRun.
+   * is not yet claimed by a WfRun. Note that once a WfRun has been matched with the
+   * ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted.
+   * If not set, then ExternalEvent's are not deleted if they are not matched with
+   * a WfRun.
+   *
+   * A future version of LittleHorse will allow changing the retention_policy, which
+   * will trigger a cleanup of old `ExternalEvent`s.
    * 
* * .littlehorse.ExternalEventRetentionPolicy retention_policy = 2; @@ -595,7 +613,13 @@ public Builder setNameBytes( /** *
      * Policy to determine how long an ExternalEvent is retained after creation if it
-     * is not yet claimed by a WfRun.
+     * is not yet claimed by a WfRun. Note that once a WfRun has been matched with the
+     * ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted.
+     * If not set, then ExternalEvent's are not deleted if they are not matched with
+     * a WfRun.
+     *
+     * A future version of LittleHorse will allow changing the retention_policy, which
+     * will trigger a cleanup of old `ExternalEvent`s.
      * 
* * .littlehorse.ExternalEventRetentionPolicy retention_policy = 2; @@ -607,7 +631,13 @@ public boolean hasRetentionPolicy() { /** *
      * Policy to determine how long an ExternalEvent is retained after creation if it
-     * is not yet claimed by a WfRun.
+     * is not yet claimed by a WfRun. Note that once a WfRun has been matched with the
+     * ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted.
+     * If not set, then ExternalEvent's are not deleted if they are not matched with
+     * a WfRun.
+     *
+     * A future version of LittleHorse will allow changing the retention_policy, which
+     * will trigger a cleanup of old `ExternalEvent`s.
      * 
* * .littlehorse.ExternalEventRetentionPolicy retention_policy = 2; @@ -623,7 +653,13 @@ public io.littlehorse.sdk.common.proto.ExternalEventRetentionPolicy getRetention /** *
      * Policy to determine how long an ExternalEvent is retained after creation if it
-     * is not yet claimed by a WfRun.
+     * is not yet claimed by a WfRun. Note that once a WfRun has been matched with the
+     * ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted.
+     * If not set, then ExternalEvent's are not deleted if they are not matched with
+     * a WfRun.
+     *
+     * A future version of LittleHorse will allow changing the retention_policy, which
+     * will trigger a cleanup of old `ExternalEvent`s.
      * 
* * .littlehorse.ExternalEventRetentionPolicy retention_policy = 2; @@ -644,7 +680,13 @@ public Builder setRetentionPolicy(io.littlehorse.sdk.common.proto.ExternalEventR /** *
      * Policy to determine how long an ExternalEvent is retained after creation if it
-     * is not yet claimed by a WfRun.
+     * is not yet claimed by a WfRun. Note that once a WfRun has been matched with the
+     * ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted.
+     * If not set, then ExternalEvent's are not deleted if they are not matched with
+     * a WfRun.
+     *
+     * A future version of LittleHorse will allow changing the retention_policy, which
+     * will trigger a cleanup of old `ExternalEvent`s.
      * 
* * .littlehorse.ExternalEventRetentionPolicy retention_policy = 2; @@ -663,7 +705,13 @@ public Builder setRetentionPolicy( /** *
      * Policy to determine how long an ExternalEvent is retained after creation if it
-     * is not yet claimed by a WfRun.
+     * is not yet claimed by a WfRun. Note that once a WfRun has been matched with the
+     * ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted.
+     * If not set, then ExternalEvent's are not deleted if they are not matched with
+     * a WfRun.
+     *
+     * A future version of LittleHorse will allow changing the retention_policy, which
+     * will trigger a cleanup of old `ExternalEvent`s.
      * 
* * .littlehorse.ExternalEventRetentionPolicy retention_policy = 2; @@ -687,7 +735,13 @@ public Builder mergeRetentionPolicy(io.littlehorse.sdk.common.proto.ExternalEven /** *
      * Policy to determine how long an ExternalEvent is retained after creation if it
-     * is not yet claimed by a WfRun.
+     * is not yet claimed by a WfRun. Note that once a WfRun has been matched with the
+     * ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted.
+     * If not set, then ExternalEvent's are not deleted if they are not matched with
+     * a WfRun.
+     *
+     * A future version of LittleHorse will allow changing the retention_policy, which
+     * will trigger a cleanup of old `ExternalEvent`s.
      * 
* * .littlehorse.ExternalEventRetentionPolicy retention_policy = 2; @@ -705,7 +759,13 @@ public Builder clearRetentionPolicy() { /** *
      * Policy to determine how long an ExternalEvent is retained after creation if it
-     * is not yet claimed by a WfRun.
+     * is not yet claimed by a WfRun. Note that once a WfRun has been matched with the
+     * ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted.
+     * If not set, then ExternalEvent's are not deleted if they are not matched with
+     * a WfRun.
+     *
+     * A future version of LittleHorse will allow changing the retention_policy, which
+     * will trigger a cleanup of old `ExternalEvent`s.
      * 
* * .littlehorse.ExternalEventRetentionPolicy retention_policy = 2; @@ -718,7 +778,13 @@ public io.littlehorse.sdk.common.proto.ExternalEventRetentionPolicy.Builder getR /** *
      * Policy to determine how long an ExternalEvent is retained after creation if it
-     * is not yet claimed by a WfRun.
+     * is not yet claimed by a WfRun. Note that once a WfRun has been matched with the
+     * ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted.
+     * If not set, then ExternalEvent's are not deleted if they are not matched with
+     * a WfRun.
+     *
+     * A future version of LittleHorse will allow changing the retention_policy, which
+     * will trigger a cleanup of old `ExternalEvent`s.
      * 
* * .littlehorse.ExternalEventRetentionPolicy retention_policy = 2; @@ -734,7 +800,13 @@ public io.littlehorse.sdk.common.proto.ExternalEventRetentionPolicyOrBuilder get /** *
      * Policy to determine how long an ExternalEvent is retained after creation if it
-     * is not yet claimed by a WfRun.
+     * is not yet claimed by a WfRun. Note that once a WfRun has been matched with the
+     * ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted.
+     * If not set, then ExternalEvent's are not deleted if they are not matched with
+     * a WfRun.
+     *
+     * A future version of LittleHorse will allow changing the retention_policy, which
+     * will trigger a cleanup of old `ExternalEvent`s.
      * 
* * .littlehorse.ExternalEventRetentionPolicy retention_policy = 2; diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PutExternalEventDefRequestOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PutExternalEventDefRequestOrBuilder.java index 87855283c..603c03783 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PutExternalEventDefRequestOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/PutExternalEventDefRequestOrBuilder.java @@ -30,7 +30,13 @@ public interface PutExternalEventDefRequestOrBuilder extends /** *
    * Policy to determine how long an ExternalEvent is retained after creation if it
-   * is not yet claimed by a WfRun.
+   * is not yet claimed by a WfRun. Note that once a WfRun has been matched with the
+   * ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted.
+   * If not set, then ExternalEvent's are not deleted if they are not matched with
+   * a WfRun.
+   *
+   * A future version of LittleHorse will allow changing the retention_policy, which
+   * will trigger a cleanup of old `ExternalEvent`s.
    * 
* * .littlehorse.ExternalEventRetentionPolicy retention_policy = 2; @@ -40,7 +46,13 @@ public interface PutExternalEventDefRequestOrBuilder extends /** *
    * Policy to determine how long an ExternalEvent is retained after creation if it
-   * is not yet claimed by a WfRun.
+   * is not yet claimed by a WfRun. Note that once a WfRun has been matched with the
+   * ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted.
+   * If not set, then ExternalEvent's are not deleted if they are not matched with
+   * a WfRun.
+   *
+   * A future version of LittleHorse will allow changing the retention_policy, which
+   * will trigger a cleanup of old `ExternalEvent`s.
    * 
* * .littlehorse.ExternalEventRetentionPolicy retention_policy = 2; @@ -50,7 +62,13 @@ public interface PutExternalEventDefRequestOrBuilder extends /** *
    * Policy to determine how long an ExternalEvent is retained after creation if it
-   * is not yet claimed by a WfRun.
+   * is not yet claimed by a WfRun. Note that once a WfRun has been matched with the
+   * ExternalEvent, the ExternalEvent is deleted if/when that WfRun is deleted.
+   * If not set, then ExternalEvent's are not deleted if they are not matched with
+   * a WfRun.
+   *
+   * A future version of LittleHorse will allow changing the retention_policy, which
+   * will trigger a cleanup of old `ExternalEvent`s.
    * 
* * .littlehorse.ExternalEventRetentionPolicy retention_policy = 2; diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/SleepNodeRun.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/SleepNodeRun.java index cd8efcf4d..3f6919a8a 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/SleepNodeRun.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/SleepNodeRun.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * The sub-node structure for a SLEEP NodeRun.
+ * 
+ * * Protobuf type {@code littlehorse.SleepNodeRun} */ public final class SleepNodeRun extends @@ -41,6 +45,10 @@ protected java.lang.Object newInstance( public static final int MATURATION_TIME_FIELD_NUMBER = 1; private com.google.protobuf.Timestamp maturationTime_; /** + *
+   * The time at which the NodeRun will wake up.
+   * 
+ * * .google.protobuf.Timestamp maturation_time = 1; * @return Whether the maturationTime field is set. */ @@ -49,6 +57,10 @@ public boolean hasMaturationTime() { return maturationTime_ != null; } /** + *
+   * The time at which the NodeRun will wake up.
+   * 
+ * * .google.protobuf.Timestamp maturation_time = 1; * @return The maturationTime. */ @@ -57,6 +69,10 @@ public com.google.protobuf.Timestamp getMaturationTime() { return maturationTime_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : maturationTime_; } /** + *
+   * The time at which the NodeRun will wake up.
+   * 
+ * * .google.protobuf.Timestamp maturation_time = 1; */ @java.lang.Override @@ -227,6 +243,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * The sub-node structure for a SLEEP NodeRun.
+   * 
+ * * Protobuf type {@code littlehorse.SleepNodeRun} */ public static final class Builder extends @@ -406,6 +426,10 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> maturationTimeBuilder_; /** + *
+     * The time at which the NodeRun will wake up.
+     * 
+ * * .google.protobuf.Timestamp maturation_time = 1; * @return Whether the maturationTime field is set. */ @@ -413,6 +437,10 @@ public boolean hasMaturationTime() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * The time at which the NodeRun will wake up.
+     * 
+ * * .google.protobuf.Timestamp maturation_time = 1; * @return The maturationTime. */ @@ -424,6 +452,10 @@ public com.google.protobuf.Timestamp getMaturationTime() { } } /** + *
+     * The time at which the NodeRun will wake up.
+     * 
+ * * .google.protobuf.Timestamp maturation_time = 1; */ public Builder setMaturationTime(com.google.protobuf.Timestamp value) { @@ -440,6 +472,10 @@ public Builder setMaturationTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time at which the NodeRun will wake up.
+     * 
+ * * .google.protobuf.Timestamp maturation_time = 1; */ public Builder setMaturationTime( @@ -454,6 +490,10 @@ public Builder setMaturationTime( return this; } /** + *
+     * The time at which the NodeRun will wake up.
+     * 
+ * * .google.protobuf.Timestamp maturation_time = 1; */ public Builder mergeMaturationTime(com.google.protobuf.Timestamp value) { @@ -473,6 +513,10 @@ public Builder mergeMaturationTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time at which the NodeRun will wake up.
+     * 
+ * * .google.protobuf.Timestamp maturation_time = 1; */ public Builder clearMaturationTime() { @@ -486,6 +530,10 @@ public Builder clearMaturationTime() { return this; } /** + *
+     * The time at which the NodeRun will wake up.
+     * 
+ * * .google.protobuf.Timestamp maturation_time = 1; */ public com.google.protobuf.Timestamp.Builder getMaturationTimeBuilder() { @@ -494,6 +542,10 @@ public com.google.protobuf.Timestamp.Builder getMaturationTimeBuilder() { return getMaturationTimeFieldBuilder().getBuilder(); } /** + *
+     * The time at which the NodeRun will wake up.
+     * 
+ * * .google.protobuf.Timestamp maturation_time = 1; */ public com.google.protobuf.TimestampOrBuilder getMaturationTimeOrBuilder() { @@ -505,6 +557,10 @@ public com.google.protobuf.TimestampOrBuilder getMaturationTimeOrBuilder() { } } /** + *
+     * The time at which the NodeRun will wake up.
+     * 
+ * * .google.protobuf.Timestamp maturation_time = 1; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/SleepNodeRunOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/SleepNodeRunOrBuilder.java index fba587272..c2dc5c0d1 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/SleepNodeRunOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/SleepNodeRunOrBuilder.java @@ -8,16 +8,28 @@ public interface SleepNodeRunOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The time at which the NodeRun will wake up.
+   * 
+ * * .google.protobuf.Timestamp maturation_time = 1; * @return Whether the maturationTime field is set. */ boolean hasMaturationTime(); /** + *
+   * The time at which the NodeRun will wake up.
+   * 
+ * * .google.protobuf.Timestamp maturation_time = 1; * @return The maturationTime. */ com.google.protobuf.Timestamp getMaturationTime(); /** + *
+   * The time at which the NodeRun will wake up.
+   * 
+ * * .google.protobuf.Timestamp maturation_time = 1; */ com.google.protobuf.TimestampOrBuilder getMaturationTimeOrBuilder(); diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/StartMultipleThreadsRun.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/StartMultipleThreadsRun.java index 372ae0d68..446fa572d 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/StartMultipleThreadsRun.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/StartMultipleThreadsRun.java @@ -4,6 +4,13 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * The sub-node structure for a START_MULTIPLE_THREADS NodeRun.
+ *
+ * Note: the output of this NodeRun, which can be used to mutate Variables,
+ * is a JSON_ARR variable containing the ID's of all the child threadRuns.
+ * 
+ * * Protobuf type {@code littlehorse.StartMultipleThreadsRun} */ public final class StartMultipleThreadsRun extends @@ -43,6 +50,10 @@ protected java.lang.Object newInstance( @SuppressWarnings("serial") private volatile java.lang.Object threadSpecName_ = ""; /** + *
+   * The thread_spec_name of the child thread_runs.
+   * 
+ * * string thread_spec_name = 1; * @return The threadSpecName. */ @@ -60,6 +71,10 @@ public java.lang.String getThreadSpecName() { } } /** + *
+   * The thread_spec_name of the child thread_runs.
+   * 
+ * * string thread_spec_name = 1; * @return The bytes for threadSpecName. */ @@ -235,6 +250,13 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * The sub-node structure for a START_MULTIPLE_THREADS NodeRun.
+   *
+   * Note: the output of this NodeRun, which can be used to mutate Variables,
+   * is a JSON_ARR variable containing the ID's of all the child threadRuns.
+   * 
+ * * Protobuf type {@code littlehorse.StartMultipleThreadsRun} */ public static final class Builder extends @@ -406,6 +428,10 @@ public Builder mergeFrom( private java.lang.Object threadSpecName_ = ""; /** + *
+     * The thread_spec_name of the child thread_runs.
+     * 
+ * * string thread_spec_name = 1; * @return The threadSpecName. */ @@ -422,6 +448,10 @@ public java.lang.String getThreadSpecName() { } } /** + *
+     * The thread_spec_name of the child thread_runs.
+     * 
+ * * string thread_spec_name = 1; * @return The bytes for threadSpecName. */ @@ -439,6 +469,10 @@ public java.lang.String getThreadSpecName() { } } /** + *
+     * The thread_spec_name of the child thread_runs.
+     * 
+ * * string thread_spec_name = 1; * @param value The threadSpecName to set. * @return This builder for chaining. @@ -452,6 +486,10 @@ public Builder setThreadSpecName( return this; } /** + *
+     * The thread_spec_name of the child thread_runs.
+     * 
+ * * string thread_spec_name = 1; * @return This builder for chaining. */ @@ -462,6 +500,10 @@ public Builder clearThreadSpecName() { return this; } /** + *
+     * The thread_spec_name of the child thread_runs.
+     * 
+ * * string thread_spec_name = 1; * @param value The bytes for threadSpecName to set. * @return This builder for chaining. diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/StartMultipleThreadsRunOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/StartMultipleThreadsRunOrBuilder.java index 42daa846e..46d010d46 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/StartMultipleThreadsRunOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/StartMultipleThreadsRunOrBuilder.java @@ -8,11 +8,19 @@ public interface StartMultipleThreadsRunOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The thread_spec_name of the child thread_runs.
+   * 
+ * * string thread_spec_name = 1; * @return The threadSpecName. */ java.lang.String getThreadSpecName(); /** + *
+   * The thread_spec_name of the child thread_runs.
+   * 
+ * * string thread_spec_name = 1; * @return The bytes for threadSpecName. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/StartThreadRun.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/StartThreadRun.java index 461b5109c..cd738e01f 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/StartThreadRun.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/StartThreadRun.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * The sub-node structure for a START_THREAD NodeRun.
+ * 
+ * * Protobuf type {@code littlehorse.StartThreadRun} */ public final class StartThreadRun extends @@ -43,6 +47,11 @@ protected java.lang.Object newInstance( public static final int CHILD_THREAD_ID_FIELD_NUMBER = 1; private int childThreadId_ = 0; /** + *
+   * Contains the thread_run_number of the created Child ThreadRun, if it has
+   * been created already.
+   * 
+ * * optional int32 child_thread_id = 1; * @return Whether the childThreadId field is set. */ @@ -51,6 +60,11 @@ public boolean hasChildThreadId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+   * Contains the thread_run_number of the created Child ThreadRun, if it has
+   * been created already.
+   * 
+ * * optional int32 child_thread_id = 1; * @return The childThreadId. */ @@ -63,6 +77,10 @@ public int getChildThreadId() { @SuppressWarnings("serial") private volatile java.lang.Object threadSpecName_ = ""; /** + *
+   * The thread_spec_name of the child thread_run.
+   * 
+ * * string thread_spec_name = 2; * @return The threadSpecName. */ @@ -80,6 +98,10 @@ public java.lang.String getThreadSpecName() { } } /** + *
+   * The thread_spec_name of the child thread_run.
+   * 
+ * * string thread_spec_name = 2; * @return The bytes for threadSpecName. */ @@ -271,6 +293,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * The sub-node structure for a START_THREAD NodeRun.
+   * 
+ * * Protobuf type {@code littlehorse.StartThreadRun} */ public static final class Builder extends @@ -457,6 +483,11 @@ public Builder mergeFrom( private int childThreadId_ ; /** + *
+     * Contains the thread_run_number of the created Child ThreadRun, if it has
+     * been created already.
+     * 
+ * * optional int32 child_thread_id = 1; * @return Whether the childThreadId field is set. */ @@ -465,6 +496,11 @@ public boolean hasChildThreadId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * Contains the thread_run_number of the created Child ThreadRun, if it has
+     * been created already.
+     * 
+ * * optional int32 child_thread_id = 1; * @return The childThreadId. */ @@ -473,6 +509,11 @@ public int getChildThreadId() { return childThreadId_; } /** + *
+     * Contains the thread_run_number of the created Child ThreadRun, if it has
+     * been created already.
+     * 
+ * * optional int32 child_thread_id = 1; * @param value The childThreadId to set. * @return This builder for chaining. @@ -485,6 +526,11 @@ public Builder setChildThreadId(int value) { return this; } /** + *
+     * Contains the thread_run_number of the created Child ThreadRun, if it has
+     * been created already.
+     * 
+ * * optional int32 child_thread_id = 1; * @return This builder for chaining. */ @@ -497,6 +543,10 @@ public Builder clearChildThreadId() { private java.lang.Object threadSpecName_ = ""; /** + *
+     * The thread_spec_name of the child thread_run.
+     * 
+ * * string thread_spec_name = 2; * @return The threadSpecName. */ @@ -513,6 +563,10 @@ public java.lang.String getThreadSpecName() { } } /** + *
+     * The thread_spec_name of the child thread_run.
+     * 
+ * * string thread_spec_name = 2; * @return The bytes for threadSpecName. */ @@ -530,6 +584,10 @@ public java.lang.String getThreadSpecName() { } } /** + *
+     * The thread_spec_name of the child thread_run.
+     * 
+ * * string thread_spec_name = 2; * @param value The threadSpecName to set. * @return This builder for chaining. @@ -543,6 +601,10 @@ public Builder setThreadSpecName( return this; } /** + *
+     * The thread_spec_name of the child thread_run.
+     * 
+ * * string thread_spec_name = 2; * @return This builder for chaining. */ @@ -553,6 +615,10 @@ public Builder clearThreadSpecName() { return this; } /** + *
+     * The thread_spec_name of the child thread_run.
+     * 
+ * * string thread_spec_name = 2; * @param value The bytes for threadSpecName to set. * @return This builder for chaining. diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/StartThreadRunOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/StartThreadRunOrBuilder.java index e2c180c6d..bd3af1e09 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/StartThreadRunOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/StartThreadRunOrBuilder.java @@ -8,22 +8,40 @@ public interface StartThreadRunOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * Contains the thread_run_number of the created Child ThreadRun, if it has
+   * been created already.
+   * 
+ * * optional int32 child_thread_id = 1; * @return Whether the childThreadId field is set. */ boolean hasChildThreadId(); /** + *
+   * Contains the thread_run_number of the created Child ThreadRun, if it has
+   * been created already.
+   * 
+ * * optional int32 child_thread_id = 1; * @return The childThreadId. */ int getChildThreadId(); /** + *
+   * The thread_spec_name of the child thread_run.
+   * 
+ * * string thread_spec_name = 2; * @return The threadSpecName. */ java.lang.String getThreadSpecName(); /** + *
+   * The thread_spec_name of the child thread_run.
+   * 
+ * * string thread_spec_name = 2; * @return The bytes for threadSpecName. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskAttempt.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskAttempt.java index 521fa2c60..8947b7cc3 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskAttempt.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskAttempt.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * A single time that a TaskRun was scheduled for execution on a Task Queue.
+ * 
+ * * Protobuf type {@code littlehorse.TaskAttempt} */ public final class TaskAttempt extends @@ -89,6 +93,11 @@ public int getNumber() { public static final int LOG_OUTPUT_FIELD_NUMBER = 2; private io.littlehorse.sdk.common.proto.VariableValue logOutput_; /** + *
+   * Optional information provided by the Task Worker SDK for debugging. Usually, if set
+   * it contains a stacktrace or it contains information logged via `WorkerContext#log()`.
+   * 
+ * * optional .littlehorse.VariableValue log_output = 2; * @return Whether the logOutput field is set. */ @@ -97,6 +106,11 @@ public boolean hasLogOutput() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+   * Optional information provided by the Task Worker SDK for debugging. Usually, if set
+   * it contains a stacktrace or it contains information logged via `WorkerContext#log()`.
+   * 
+ * * optional .littlehorse.VariableValue log_output = 2; * @return The logOutput. */ @@ -105,6 +119,11 @@ public io.littlehorse.sdk.common.proto.VariableValue getLogOutput() { return logOutput_ == null ? io.littlehorse.sdk.common.proto.VariableValue.getDefaultInstance() : logOutput_; } /** + *
+   * Optional information provided by the Task Worker SDK for debugging. Usually, if set
+   * it contains a stacktrace or it contains information logged via `WorkerContext#log()`.
+   * 
+ * * optional .littlehorse.VariableValue log_output = 2; */ @java.lang.Override @@ -115,6 +134,10 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getLogOutputOrBuil public static final int SCHEDULE_TIME_FIELD_NUMBER = 3; private com.google.protobuf.Timestamp scheduleTime_; /** + *
+   * The time the TaskAttempt was scheduled on the Task Queue.
+   * 
+ * * optional .google.protobuf.Timestamp schedule_time = 3; * @return Whether the scheduleTime field is set. */ @@ -123,6 +146,10 @@ public boolean hasScheduleTime() { return ((bitField0_ & 0x00000002) != 0); } /** + *
+   * The time the TaskAttempt was scheduled on the Task Queue.
+   * 
+ * * optional .google.protobuf.Timestamp schedule_time = 3; * @return The scheduleTime. */ @@ -131,6 +158,10 @@ public com.google.protobuf.Timestamp getScheduleTime() { return scheduleTime_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : scheduleTime_; } /** + *
+   * The time the TaskAttempt was scheduled on the Task Queue.
+   * 
+ * * optional .google.protobuf.Timestamp schedule_time = 3; */ @java.lang.Override @@ -141,6 +172,10 @@ public com.google.protobuf.TimestampOrBuilder getScheduleTimeOrBuilder() { public static final int START_TIME_FIELD_NUMBER = 4; private com.google.protobuf.Timestamp startTime_; /** + *
+   * The time the TaskAttempt was pulled off the queue and sent to a TaskWorker.
+   * 
+ * * optional .google.protobuf.Timestamp start_time = 4; * @return Whether the startTime field is set. */ @@ -149,6 +184,10 @@ public boolean hasStartTime() { return ((bitField0_ & 0x00000004) != 0); } /** + *
+   * The time the TaskAttempt was pulled off the queue and sent to a TaskWorker.
+   * 
+ * * optional .google.protobuf.Timestamp start_time = 4; * @return The startTime. */ @@ -157,6 +196,10 @@ public com.google.protobuf.Timestamp getStartTime() { return startTime_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : startTime_; } /** + *
+   * The time the TaskAttempt was pulled off the queue and sent to a TaskWorker.
+   * 
+ * * optional .google.protobuf.Timestamp start_time = 4; */ @java.lang.Override @@ -167,6 +210,11 @@ public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder() { public static final int END_TIME_FIELD_NUMBER = 5; private com.google.protobuf.Timestamp endTime_; /** + *
+   * The time the TaskAttempt was finished (either completed, reported as failed, or
+   * timed out)
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 5; * @return Whether the endTime field is set. */ @@ -175,6 +223,11 @@ public boolean hasEndTime() { return ((bitField0_ & 0x00000008) != 0); } /** + *
+   * The time the TaskAttempt was finished (either completed, reported as failed, or
+   * timed out)
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 5; * @return The endTime. */ @@ -183,6 +236,11 @@ public com.google.protobuf.Timestamp getEndTime() { return endTime_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : endTime_; } /** + *
+   * The time the TaskAttempt was finished (either completed, reported as failed, or
+   * timed out)
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 5; */ @java.lang.Override @@ -194,6 +252,10 @@ public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder() { @SuppressWarnings("serial") private volatile java.lang.Object taskWorkerId_ = ""; /** + *
+   * EXPERIMENTAL: the ID of the Task Worker who executed this TaskRun.
+   * 
+ * * string task_worker_id = 7; * @return The taskWorkerId. */ @@ -211,6 +273,10 @@ public java.lang.String getTaskWorkerId() { } } /** + *
+   * EXPERIMENTAL: the ID of the Task Worker who executed this TaskRun.
+   * 
+ * * string task_worker_id = 7; * @return The bytes for taskWorkerId. */ @@ -233,6 +299,10 @@ public java.lang.String getTaskWorkerId() { @SuppressWarnings("serial") private volatile java.lang.Object taskWorkerVersion_ = ""; /** + *
+   * The version of the Task Worker that executed the TaskAttempt.
+   * 
+ * * optional string task_worker_version = 8; * @return Whether the taskWorkerVersion field is set. */ @@ -241,6 +311,10 @@ public boolean hasTaskWorkerVersion() { return ((bitField0_ & 0x00000010) != 0); } /** + *
+   * The version of the Task Worker that executed the TaskAttempt.
+   * 
+ * * optional string task_worker_version = 8; * @return The taskWorkerVersion. */ @@ -258,6 +332,10 @@ public java.lang.String getTaskWorkerVersion() { } } /** + *
+   * The version of the Task Worker that executed the TaskAttempt.
+   * 
+ * * optional string task_worker_version = 8; * @return The bytes for taskWorkerVersion. */ @@ -279,6 +357,10 @@ public java.lang.String getTaskWorkerVersion() { public static final int STATUS_FIELD_NUMBER = 9; private int status_ = 0; /** + *
+   * The status of this TaskAttempt.
+   * 
+ * * .littlehorse.TaskStatus status = 9; * @return The enum numeric value on the wire for status. */ @@ -286,6 +368,10 @@ public java.lang.String getTaskWorkerVersion() { return status_; } /** + *
+   * The status of this TaskAttempt.
+   * 
+ * * .littlehorse.TaskStatus status = 9; * @return The status. */ @@ -296,6 +382,10 @@ public java.lang.String getTaskWorkerVersion() { public static final int OUTPUT_FIELD_NUMBER = 1; /** + *
+   * Denotes the Task Function executed properly and returned an output.
+   * 
+ * * .littlehorse.VariableValue output = 1; * @return Whether the output field is set. */ @@ -304,6 +394,10 @@ public boolean hasOutput() { return resultCase_ == 1; } /** + *
+   * Denotes the Task Function executed properly and returned an output.
+   * 
+ * * .littlehorse.VariableValue output = 1; * @return The output. */ @@ -315,6 +409,10 @@ public io.littlehorse.sdk.common.proto.VariableValue getOutput() { return io.littlehorse.sdk.common.proto.VariableValue.getDefaultInstance(); } /** + *
+   * Denotes the Task Function executed properly and returned an output.
+   * 
+ * * .littlehorse.VariableValue output = 1; */ @java.lang.Override @@ -327,6 +425,10 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getOutputOrBuilder public static final int ERROR_FIELD_NUMBER = 10; /** + *
+   * An unexpected technical error was encountered. May or may not be retriable.
+   * 
+ * * .littlehorse.LHTaskError error = 10; * @return Whether the error field is set. */ @@ -335,6 +437,10 @@ public boolean hasError() { return resultCase_ == 10; } /** + *
+   * An unexpected technical error was encountered. May or may not be retriable.
+   * 
+ * * .littlehorse.LHTaskError error = 10; * @return The error. */ @@ -346,6 +452,10 @@ public io.littlehorse.sdk.common.proto.LHTaskError getError() { return io.littlehorse.sdk.common.proto.LHTaskError.getDefaultInstance(); } /** + *
+   * An unexpected technical error was encountered. May or may not be retriable.
+   * 
+ * * .littlehorse.LHTaskError error = 10; */ @java.lang.Override @@ -358,6 +468,10 @@ public io.littlehorse.sdk.common.proto.LHTaskErrorOrBuilder getErrorOrBuilder() public static final int EXCEPTION_FIELD_NUMBER = 11; /** + *
+   * The Task Function encountered a business problem and threw a technical exception.
+   * 
+ * * .littlehorse.LHTaskException exception = 11; * @return Whether the exception field is set. */ @@ -366,6 +480,10 @@ public boolean hasException() { return resultCase_ == 11; } /** + *
+   * The Task Function encountered a business problem and threw a technical exception.
+   * 
+ * * .littlehorse.LHTaskException exception = 11; * @return The exception. */ @@ -377,6 +495,10 @@ public io.littlehorse.sdk.common.proto.LHTaskException getException() { return io.littlehorse.sdk.common.proto.LHTaskException.getDefaultInstance(); } /** + *
+   * The Task Function encountered a business problem and threw a technical exception.
+   * 
+ * * .littlehorse.LHTaskException exception = 11; */ @java.lang.Override @@ -687,6 +809,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * A single time that a TaskRun was scheduled for execution on a Task Queue.
+   * 
+ * * Protobuf type {@code littlehorse.TaskAttempt} */ public static final class Builder extends @@ -1064,6 +1190,11 @@ public Builder clearResult() { private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.VariableValue, io.littlehorse.sdk.common.proto.VariableValue.Builder, io.littlehorse.sdk.common.proto.VariableValueOrBuilder> logOutputBuilder_; /** + *
+     * Optional information provided by the Task Worker SDK for debugging. Usually, if set
+     * it contains a stacktrace or it contains information logged via `WorkerContext#log()`.
+     * 
+ * * optional .littlehorse.VariableValue log_output = 2; * @return Whether the logOutput field is set. */ @@ -1071,6 +1202,11 @@ public boolean hasLogOutput() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * Optional information provided by the Task Worker SDK for debugging. Usually, if set
+     * it contains a stacktrace or it contains information logged via `WorkerContext#log()`.
+     * 
+ * * optional .littlehorse.VariableValue log_output = 2; * @return The logOutput. */ @@ -1082,6 +1218,11 @@ public io.littlehorse.sdk.common.proto.VariableValue getLogOutput() { } } /** + *
+     * Optional information provided by the Task Worker SDK for debugging. Usually, if set
+     * it contains a stacktrace or it contains information logged via `WorkerContext#log()`.
+     * 
+ * * optional .littlehorse.VariableValue log_output = 2; */ public Builder setLogOutput(io.littlehorse.sdk.common.proto.VariableValue value) { @@ -1098,6 +1239,11 @@ public Builder setLogOutput(io.littlehorse.sdk.common.proto.VariableValue value) return this; } /** + *
+     * Optional information provided by the Task Worker SDK for debugging. Usually, if set
+     * it contains a stacktrace or it contains information logged via `WorkerContext#log()`.
+     * 
+ * * optional .littlehorse.VariableValue log_output = 2; */ public Builder setLogOutput( @@ -1112,6 +1258,11 @@ public Builder setLogOutput( return this; } /** + *
+     * Optional information provided by the Task Worker SDK for debugging. Usually, if set
+     * it contains a stacktrace or it contains information logged via `WorkerContext#log()`.
+     * 
+ * * optional .littlehorse.VariableValue log_output = 2; */ public Builder mergeLogOutput(io.littlehorse.sdk.common.proto.VariableValue value) { @@ -1131,6 +1282,11 @@ public Builder mergeLogOutput(io.littlehorse.sdk.common.proto.VariableValue valu return this; } /** + *
+     * Optional information provided by the Task Worker SDK for debugging. Usually, if set
+     * it contains a stacktrace or it contains information logged via `WorkerContext#log()`.
+     * 
+ * * optional .littlehorse.VariableValue log_output = 2; */ public Builder clearLogOutput() { @@ -1144,6 +1300,11 @@ public Builder clearLogOutput() { return this; } /** + *
+     * Optional information provided by the Task Worker SDK for debugging. Usually, if set
+     * it contains a stacktrace or it contains information logged via `WorkerContext#log()`.
+     * 
+ * * optional .littlehorse.VariableValue log_output = 2; */ public io.littlehorse.sdk.common.proto.VariableValue.Builder getLogOutputBuilder() { @@ -1152,6 +1313,11 @@ public io.littlehorse.sdk.common.proto.VariableValue.Builder getLogOutputBuilder return getLogOutputFieldBuilder().getBuilder(); } /** + *
+     * Optional information provided by the Task Worker SDK for debugging. Usually, if set
+     * it contains a stacktrace or it contains information logged via `WorkerContext#log()`.
+     * 
+ * * optional .littlehorse.VariableValue log_output = 2; */ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getLogOutputOrBuilder() { @@ -1163,6 +1329,11 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getLogOutputOrBuil } } /** + *
+     * Optional information provided by the Task Worker SDK for debugging. Usually, if set
+     * it contains a stacktrace or it contains information logged via `WorkerContext#log()`.
+     * 
+ * * optional .littlehorse.VariableValue log_output = 2; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1183,6 +1354,10 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getLogOutputOrBuil private com.google.protobuf.SingleFieldBuilderV3< com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> scheduleTimeBuilder_; /** + *
+     * The time the TaskAttempt was scheduled on the Task Queue.
+     * 
+ * * optional .google.protobuf.Timestamp schedule_time = 3; * @return Whether the scheduleTime field is set. */ @@ -1190,6 +1365,10 @@ public boolean hasScheduleTime() { return ((bitField0_ & 0x00000002) != 0); } /** + *
+     * The time the TaskAttempt was scheduled on the Task Queue.
+     * 
+ * * optional .google.protobuf.Timestamp schedule_time = 3; * @return The scheduleTime. */ @@ -1201,6 +1380,10 @@ public com.google.protobuf.Timestamp getScheduleTime() { } } /** + *
+     * The time the TaskAttempt was scheduled on the Task Queue.
+     * 
+ * * optional .google.protobuf.Timestamp schedule_time = 3; */ public Builder setScheduleTime(com.google.protobuf.Timestamp value) { @@ -1217,6 +1400,10 @@ public Builder setScheduleTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the TaskAttempt was scheduled on the Task Queue.
+     * 
+ * * optional .google.protobuf.Timestamp schedule_time = 3; */ public Builder setScheduleTime( @@ -1231,6 +1418,10 @@ public Builder setScheduleTime( return this; } /** + *
+     * The time the TaskAttempt was scheduled on the Task Queue.
+     * 
+ * * optional .google.protobuf.Timestamp schedule_time = 3; */ public Builder mergeScheduleTime(com.google.protobuf.Timestamp value) { @@ -1250,6 +1441,10 @@ public Builder mergeScheduleTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the TaskAttempt was scheduled on the Task Queue.
+     * 
+ * * optional .google.protobuf.Timestamp schedule_time = 3; */ public Builder clearScheduleTime() { @@ -1263,6 +1458,10 @@ public Builder clearScheduleTime() { return this; } /** + *
+     * The time the TaskAttempt was scheduled on the Task Queue.
+     * 
+ * * optional .google.protobuf.Timestamp schedule_time = 3; */ public com.google.protobuf.Timestamp.Builder getScheduleTimeBuilder() { @@ -1271,6 +1470,10 @@ public com.google.protobuf.Timestamp.Builder getScheduleTimeBuilder() { return getScheduleTimeFieldBuilder().getBuilder(); } /** + *
+     * The time the TaskAttempt was scheduled on the Task Queue.
+     * 
+ * * optional .google.protobuf.Timestamp schedule_time = 3; */ public com.google.protobuf.TimestampOrBuilder getScheduleTimeOrBuilder() { @@ -1282,6 +1485,10 @@ public com.google.protobuf.TimestampOrBuilder getScheduleTimeOrBuilder() { } } /** + *
+     * The time the TaskAttempt was scheduled on the Task Queue.
+     * 
+ * * optional .google.protobuf.Timestamp schedule_time = 3; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1302,6 +1509,10 @@ public com.google.protobuf.TimestampOrBuilder getScheduleTimeOrBuilder() { private com.google.protobuf.SingleFieldBuilderV3< com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> startTimeBuilder_; /** + *
+     * The time the TaskAttempt was pulled off the queue and sent to a TaskWorker.
+     * 
+ * * optional .google.protobuf.Timestamp start_time = 4; * @return Whether the startTime field is set. */ @@ -1309,6 +1520,10 @@ public boolean hasStartTime() { return ((bitField0_ & 0x00000004) != 0); } /** + *
+     * The time the TaskAttempt was pulled off the queue and sent to a TaskWorker.
+     * 
+ * * optional .google.protobuf.Timestamp start_time = 4; * @return The startTime. */ @@ -1320,6 +1535,10 @@ public com.google.protobuf.Timestamp getStartTime() { } } /** + *
+     * The time the TaskAttempt was pulled off the queue and sent to a TaskWorker.
+     * 
+ * * optional .google.protobuf.Timestamp start_time = 4; */ public Builder setStartTime(com.google.protobuf.Timestamp value) { @@ -1336,6 +1555,10 @@ public Builder setStartTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the TaskAttempt was pulled off the queue and sent to a TaskWorker.
+     * 
+ * * optional .google.protobuf.Timestamp start_time = 4; */ public Builder setStartTime( @@ -1350,6 +1573,10 @@ public Builder setStartTime( return this; } /** + *
+     * The time the TaskAttempt was pulled off the queue and sent to a TaskWorker.
+     * 
+ * * optional .google.protobuf.Timestamp start_time = 4; */ public Builder mergeStartTime(com.google.protobuf.Timestamp value) { @@ -1369,6 +1596,10 @@ public Builder mergeStartTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the TaskAttempt was pulled off the queue and sent to a TaskWorker.
+     * 
+ * * optional .google.protobuf.Timestamp start_time = 4; */ public Builder clearStartTime() { @@ -1382,6 +1613,10 @@ public Builder clearStartTime() { return this; } /** + *
+     * The time the TaskAttempt was pulled off the queue and sent to a TaskWorker.
+     * 
+ * * optional .google.protobuf.Timestamp start_time = 4; */ public com.google.protobuf.Timestamp.Builder getStartTimeBuilder() { @@ -1390,6 +1625,10 @@ public com.google.protobuf.Timestamp.Builder getStartTimeBuilder() { return getStartTimeFieldBuilder().getBuilder(); } /** + *
+     * The time the TaskAttempt was pulled off the queue and sent to a TaskWorker.
+     * 
+ * * optional .google.protobuf.Timestamp start_time = 4; */ public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder() { @@ -1401,6 +1640,10 @@ public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder() { } } /** + *
+     * The time the TaskAttempt was pulled off the queue and sent to a TaskWorker.
+     * 
+ * * optional .google.protobuf.Timestamp start_time = 4; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1421,6 +1664,11 @@ public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder() { private com.google.protobuf.SingleFieldBuilderV3< com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> endTimeBuilder_; /** + *
+     * The time the TaskAttempt was finished (either completed, reported as failed, or
+     * timed out)
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 5; * @return Whether the endTime field is set. */ @@ -1428,6 +1676,11 @@ public boolean hasEndTime() { return ((bitField0_ & 0x00000008) != 0); } /** + *
+     * The time the TaskAttempt was finished (either completed, reported as failed, or
+     * timed out)
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 5; * @return The endTime. */ @@ -1439,6 +1692,11 @@ public com.google.protobuf.Timestamp getEndTime() { } } /** + *
+     * The time the TaskAttempt was finished (either completed, reported as failed, or
+     * timed out)
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 5; */ public Builder setEndTime(com.google.protobuf.Timestamp value) { @@ -1455,6 +1713,11 @@ public Builder setEndTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the TaskAttempt was finished (either completed, reported as failed, or
+     * timed out)
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 5; */ public Builder setEndTime( @@ -1469,6 +1732,11 @@ public Builder setEndTime( return this; } /** + *
+     * The time the TaskAttempt was finished (either completed, reported as failed, or
+     * timed out)
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 5; */ public Builder mergeEndTime(com.google.protobuf.Timestamp value) { @@ -1488,6 +1756,11 @@ public Builder mergeEndTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the TaskAttempt was finished (either completed, reported as failed, or
+     * timed out)
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 5; */ public Builder clearEndTime() { @@ -1501,6 +1774,11 @@ public Builder clearEndTime() { return this; } /** + *
+     * The time the TaskAttempt was finished (either completed, reported as failed, or
+     * timed out)
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 5; */ public com.google.protobuf.Timestamp.Builder getEndTimeBuilder() { @@ -1509,6 +1787,11 @@ public com.google.protobuf.Timestamp.Builder getEndTimeBuilder() { return getEndTimeFieldBuilder().getBuilder(); } /** + *
+     * The time the TaskAttempt was finished (either completed, reported as failed, or
+     * timed out)
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 5; */ public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder() { @@ -1520,6 +1803,11 @@ public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder() { } } /** + *
+     * The time the TaskAttempt was finished (either completed, reported as failed, or
+     * timed out)
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 5; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1538,6 +1826,10 @@ public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder() { private java.lang.Object taskWorkerId_ = ""; /** + *
+     * EXPERIMENTAL: the ID of the Task Worker who executed this TaskRun.
+     * 
+ * * string task_worker_id = 7; * @return The taskWorkerId. */ @@ -1554,6 +1846,10 @@ public java.lang.String getTaskWorkerId() { } } /** + *
+     * EXPERIMENTAL: the ID of the Task Worker who executed this TaskRun.
+     * 
+ * * string task_worker_id = 7; * @return The bytes for taskWorkerId. */ @@ -1571,6 +1867,10 @@ public java.lang.String getTaskWorkerId() { } } /** + *
+     * EXPERIMENTAL: the ID of the Task Worker who executed this TaskRun.
+     * 
+ * * string task_worker_id = 7; * @param value The taskWorkerId to set. * @return This builder for chaining. @@ -1584,6 +1884,10 @@ public Builder setTaskWorkerId( return this; } /** + *
+     * EXPERIMENTAL: the ID of the Task Worker who executed this TaskRun.
+     * 
+ * * string task_worker_id = 7; * @return This builder for chaining. */ @@ -1594,6 +1898,10 @@ public Builder clearTaskWorkerId() { return this; } /** + *
+     * EXPERIMENTAL: the ID of the Task Worker who executed this TaskRun.
+     * 
+ * * string task_worker_id = 7; * @param value The bytes for taskWorkerId to set. * @return This builder for chaining. @@ -1610,6 +1918,10 @@ public Builder setTaskWorkerIdBytes( private java.lang.Object taskWorkerVersion_ = ""; /** + *
+     * The version of the Task Worker that executed the TaskAttempt.
+     * 
+ * * optional string task_worker_version = 8; * @return Whether the taskWorkerVersion field is set. */ @@ -1617,6 +1929,10 @@ public boolean hasTaskWorkerVersion() { return ((bitField0_ & 0x00000020) != 0); } /** + *
+     * The version of the Task Worker that executed the TaskAttempt.
+     * 
+ * * optional string task_worker_version = 8; * @return The taskWorkerVersion. */ @@ -1633,6 +1949,10 @@ public java.lang.String getTaskWorkerVersion() { } } /** + *
+     * The version of the Task Worker that executed the TaskAttempt.
+     * 
+ * * optional string task_worker_version = 8; * @return The bytes for taskWorkerVersion. */ @@ -1650,6 +1970,10 @@ public java.lang.String getTaskWorkerVersion() { } } /** + *
+     * The version of the Task Worker that executed the TaskAttempt.
+     * 
+ * * optional string task_worker_version = 8; * @param value The taskWorkerVersion to set. * @return This builder for chaining. @@ -1663,6 +1987,10 @@ public Builder setTaskWorkerVersion( return this; } /** + *
+     * The version of the Task Worker that executed the TaskAttempt.
+     * 
+ * * optional string task_worker_version = 8; * @return This builder for chaining. */ @@ -1673,6 +2001,10 @@ public Builder clearTaskWorkerVersion() { return this; } /** + *
+     * The version of the Task Worker that executed the TaskAttempt.
+     * 
+ * * optional string task_worker_version = 8; * @param value The bytes for taskWorkerVersion to set. * @return This builder for chaining. @@ -1689,6 +2021,10 @@ public Builder setTaskWorkerVersionBytes( private int status_ = 0; /** + *
+     * The status of this TaskAttempt.
+     * 
+ * * .littlehorse.TaskStatus status = 9; * @return The enum numeric value on the wire for status. */ @@ -1696,6 +2032,10 @@ public Builder setTaskWorkerVersionBytes( return status_; } /** + *
+     * The status of this TaskAttempt.
+     * 
+ * * .littlehorse.TaskStatus status = 9; * @param value The enum numeric value on the wire for status to set. * @return This builder for chaining. @@ -1707,6 +2047,10 @@ public Builder setStatusValue(int value) { return this; } /** + *
+     * The status of this TaskAttempt.
+     * 
+ * * .littlehorse.TaskStatus status = 9; * @return The status. */ @@ -1716,6 +2060,10 @@ public io.littlehorse.sdk.common.proto.TaskStatus getStatus() { return result == null ? io.littlehorse.sdk.common.proto.TaskStatus.UNRECOGNIZED : result; } /** + *
+     * The status of this TaskAttempt.
+     * 
+ * * .littlehorse.TaskStatus status = 9; * @param value The status to set. * @return This builder for chaining. @@ -1730,6 +2078,10 @@ public Builder setStatus(io.littlehorse.sdk.common.proto.TaskStatus value) { return this; } /** + *
+     * The status of this TaskAttempt.
+     * 
+ * * .littlehorse.TaskStatus status = 9; * @return This builder for chaining. */ @@ -1743,6 +2095,10 @@ public Builder clearStatus() { private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.VariableValue, io.littlehorse.sdk.common.proto.VariableValue.Builder, io.littlehorse.sdk.common.proto.VariableValueOrBuilder> outputBuilder_; /** + *
+     * Denotes the Task Function executed properly and returned an output.
+     * 
+ * * .littlehorse.VariableValue output = 1; * @return Whether the output field is set. */ @@ -1751,6 +2107,10 @@ public boolean hasOutput() { return resultCase_ == 1; } /** + *
+     * Denotes the Task Function executed properly and returned an output.
+     * 
+ * * .littlehorse.VariableValue output = 1; * @return The output. */ @@ -1769,6 +2129,10 @@ public io.littlehorse.sdk.common.proto.VariableValue getOutput() { } } /** + *
+     * Denotes the Task Function executed properly and returned an output.
+     * 
+ * * .littlehorse.VariableValue output = 1; */ public Builder setOutput(io.littlehorse.sdk.common.proto.VariableValue value) { @@ -1785,6 +2149,10 @@ public Builder setOutput(io.littlehorse.sdk.common.proto.VariableValue value) { return this; } /** + *
+     * Denotes the Task Function executed properly and returned an output.
+     * 
+ * * .littlehorse.VariableValue output = 1; */ public Builder setOutput( @@ -1799,6 +2167,10 @@ public Builder setOutput( return this; } /** + *
+     * Denotes the Task Function executed properly and returned an output.
+     * 
+ * * .littlehorse.VariableValue output = 1; */ public Builder mergeOutput(io.littlehorse.sdk.common.proto.VariableValue value) { @@ -1822,6 +2194,10 @@ public Builder mergeOutput(io.littlehorse.sdk.common.proto.VariableValue value) return this; } /** + *
+     * Denotes the Task Function executed properly and returned an output.
+     * 
+ * * .littlehorse.VariableValue output = 1; */ public Builder clearOutput() { @@ -1841,12 +2217,20 @@ public Builder clearOutput() { return this; } /** + *
+     * Denotes the Task Function executed properly and returned an output.
+     * 
+ * * .littlehorse.VariableValue output = 1; */ public io.littlehorse.sdk.common.proto.VariableValue.Builder getOutputBuilder() { return getOutputFieldBuilder().getBuilder(); } /** + *
+     * Denotes the Task Function executed properly and returned an output.
+     * 
+ * * .littlehorse.VariableValue output = 1; */ @java.lang.Override @@ -1861,6 +2245,10 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getOutputOrBuilder } } /** + *
+     * Denotes the Task Function executed properly and returned an output.
+     * 
+ * * .littlehorse.VariableValue output = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1885,6 +2273,10 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getOutputOrBuilder private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.LHTaskError, io.littlehorse.sdk.common.proto.LHTaskError.Builder, io.littlehorse.sdk.common.proto.LHTaskErrorOrBuilder> errorBuilder_; /** + *
+     * An unexpected technical error was encountered. May or may not be retriable.
+     * 
+ * * .littlehorse.LHTaskError error = 10; * @return Whether the error field is set. */ @@ -1893,6 +2285,10 @@ public boolean hasError() { return resultCase_ == 10; } /** + *
+     * An unexpected technical error was encountered. May or may not be retriable.
+     * 
+ * * .littlehorse.LHTaskError error = 10; * @return The error. */ @@ -1911,6 +2307,10 @@ public io.littlehorse.sdk.common.proto.LHTaskError getError() { } } /** + *
+     * An unexpected technical error was encountered. May or may not be retriable.
+     * 
+ * * .littlehorse.LHTaskError error = 10; */ public Builder setError(io.littlehorse.sdk.common.proto.LHTaskError value) { @@ -1927,6 +2327,10 @@ public Builder setError(io.littlehorse.sdk.common.proto.LHTaskError value) { return this; } /** + *
+     * An unexpected technical error was encountered. May or may not be retriable.
+     * 
+ * * .littlehorse.LHTaskError error = 10; */ public Builder setError( @@ -1941,6 +2345,10 @@ public Builder setError( return this; } /** + *
+     * An unexpected technical error was encountered. May or may not be retriable.
+     * 
+ * * .littlehorse.LHTaskError error = 10; */ public Builder mergeError(io.littlehorse.sdk.common.proto.LHTaskError value) { @@ -1964,6 +2372,10 @@ public Builder mergeError(io.littlehorse.sdk.common.proto.LHTaskError value) { return this; } /** + *
+     * An unexpected technical error was encountered. May or may not be retriable.
+     * 
+ * * .littlehorse.LHTaskError error = 10; */ public Builder clearError() { @@ -1983,12 +2395,20 @@ public Builder clearError() { return this; } /** + *
+     * An unexpected technical error was encountered. May or may not be retriable.
+     * 
+ * * .littlehorse.LHTaskError error = 10; */ public io.littlehorse.sdk.common.proto.LHTaskError.Builder getErrorBuilder() { return getErrorFieldBuilder().getBuilder(); } /** + *
+     * An unexpected technical error was encountered. May or may not be retriable.
+     * 
+ * * .littlehorse.LHTaskError error = 10; */ @java.lang.Override @@ -2003,6 +2423,10 @@ public io.littlehorse.sdk.common.proto.LHTaskErrorOrBuilder getErrorOrBuilder() } } /** + *
+     * An unexpected technical error was encountered. May or may not be retriable.
+     * 
+ * * .littlehorse.LHTaskError error = 10; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -2027,6 +2451,10 @@ public io.littlehorse.sdk.common.proto.LHTaskErrorOrBuilder getErrorOrBuilder() private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.LHTaskException, io.littlehorse.sdk.common.proto.LHTaskException.Builder, io.littlehorse.sdk.common.proto.LHTaskExceptionOrBuilder> exceptionBuilder_; /** + *
+     * The Task Function encountered a business problem and threw a technical exception.
+     * 
+ * * .littlehorse.LHTaskException exception = 11; * @return Whether the exception field is set. */ @@ -2035,6 +2463,10 @@ public boolean hasException() { return resultCase_ == 11; } /** + *
+     * The Task Function encountered a business problem and threw a technical exception.
+     * 
+ * * .littlehorse.LHTaskException exception = 11; * @return The exception. */ @@ -2053,6 +2485,10 @@ public io.littlehorse.sdk.common.proto.LHTaskException getException() { } } /** + *
+     * The Task Function encountered a business problem and threw a technical exception.
+     * 
+ * * .littlehorse.LHTaskException exception = 11; */ public Builder setException(io.littlehorse.sdk.common.proto.LHTaskException value) { @@ -2069,6 +2505,10 @@ public Builder setException(io.littlehorse.sdk.common.proto.LHTaskException valu return this; } /** + *
+     * The Task Function encountered a business problem and threw a technical exception.
+     * 
+ * * .littlehorse.LHTaskException exception = 11; */ public Builder setException( @@ -2083,6 +2523,10 @@ public Builder setException( return this; } /** + *
+     * The Task Function encountered a business problem and threw a technical exception.
+     * 
+ * * .littlehorse.LHTaskException exception = 11; */ public Builder mergeException(io.littlehorse.sdk.common.proto.LHTaskException value) { @@ -2106,6 +2550,10 @@ public Builder mergeException(io.littlehorse.sdk.common.proto.LHTaskException va return this; } /** + *
+     * The Task Function encountered a business problem and threw a technical exception.
+     * 
+ * * .littlehorse.LHTaskException exception = 11; */ public Builder clearException() { @@ -2125,12 +2573,20 @@ public Builder clearException() { return this; } /** + *
+     * The Task Function encountered a business problem and threw a technical exception.
+     * 
+ * * .littlehorse.LHTaskException exception = 11; */ public io.littlehorse.sdk.common.proto.LHTaskException.Builder getExceptionBuilder() { return getExceptionFieldBuilder().getBuilder(); } /** + *
+     * The Task Function encountered a business problem and threw a technical exception.
+     * 
+ * * .littlehorse.LHTaskException exception = 11; */ @java.lang.Override @@ -2145,6 +2601,10 @@ public io.littlehorse.sdk.common.proto.LHTaskExceptionOrBuilder getExceptionOrBu } } /** + *
+     * The Task Function encountered a business problem and threw a technical exception.
+     * 
+ * * .littlehorse.LHTaskException exception = 11; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskAttemptOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskAttemptOrBuilder.java index 39e64a3d1..19be35e19 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskAttemptOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskAttemptOrBuilder.java @@ -8,71 +8,133 @@ public interface TaskAttemptOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * Optional information provided by the Task Worker SDK for debugging. Usually, if set
+   * it contains a stacktrace or it contains information logged via `WorkerContext#log()`.
+   * 
+ * * optional .littlehorse.VariableValue log_output = 2; * @return Whether the logOutput field is set. */ boolean hasLogOutput(); /** + *
+   * Optional information provided by the Task Worker SDK for debugging. Usually, if set
+   * it contains a stacktrace or it contains information logged via `WorkerContext#log()`.
+   * 
+ * * optional .littlehorse.VariableValue log_output = 2; * @return The logOutput. */ io.littlehorse.sdk.common.proto.VariableValue getLogOutput(); /** + *
+   * Optional information provided by the Task Worker SDK for debugging. Usually, if set
+   * it contains a stacktrace or it contains information logged via `WorkerContext#log()`.
+   * 
+ * * optional .littlehorse.VariableValue log_output = 2; */ io.littlehorse.sdk.common.proto.VariableValueOrBuilder getLogOutputOrBuilder(); /** + *
+   * The time the TaskAttempt was scheduled on the Task Queue.
+   * 
+ * * optional .google.protobuf.Timestamp schedule_time = 3; * @return Whether the scheduleTime field is set. */ boolean hasScheduleTime(); /** + *
+   * The time the TaskAttempt was scheduled on the Task Queue.
+   * 
+ * * optional .google.protobuf.Timestamp schedule_time = 3; * @return The scheduleTime. */ com.google.protobuf.Timestamp getScheduleTime(); /** + *
+   * The time the TaskAttempt was scheduled on the Task Queue.
+   * 
+ * * optional .google.protobuf.Timestamp schedule_time = 3; */ com.google.protobuf.TimestampOrBuilder getScheduleTimeOrBuilder(); /** + *
+   * The time the TaskAttempt was pulled off the queue and sent to a TaskWorker.
+   * 
+ * * optional .google.protobuf.Timestamp start_time = 4; * @return Whether the startTime field is set. */ boolean hasStartTime(); /** + *
+   * The time the TaskAttempt was pulled off the queue and sent to a TaskWorker.
+   * 
+ * * optional .google.protobuf.Timestamp start_time = 4; * @return The startTime. */ com.google.protobuf.Timestamp getStartTime(); /** + *
+   * The time the TaskAttempt was pulled off the queue and sent to a TaskWorker.
+   * 
+ * * optional .google.protobuf.Timestamp start_time = 4; */ com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder(); /** + *
+   * The time the TaskAttempt was finished (either completed, reported as failed, or
+   * timed out)
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 5; * @return Whether the endTime field is set. */ boolean hasEndTime(); /** + *
+   * The time the TaskAttempt was finished (either completed, reported as failed, or
+   * timed out)
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 5; * @return The endTime. */ com.google.protobuf.Timestamp getEndTime(); /** + *
+   * The time the TaskAttempt was finished (either completed, reported as failed, or
+   * timed out)
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 5; */ com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder(); /** + *
+   * EXPERIMENTAL: the ID of the Task Worker who executed this TaskRun.
+   * 
+ * * string task_worker_id = 7; * @return The taskWorkerId. */ java.lang.String getTaskWorkerId(); /** + *
+   * EXPERIMENTAL: the ID of the Task Worker who executed this TaskRun.
+   * 
+ * * string task_worker_id = 7; * @return The bytes for taskWorkerId. */ @@ -80,16 +142,28 @@ public interface TaskAttemptOrBuilder extends getTaskWorkerIdBytes(); /** + *
+   * The version of the Task Worker that executed the TaskAttempt.
+   * 
+ * * optional string task_worker_version = 8; * @return Whether the taskWorkerVersion field is set. */ boolean hasTaskWorkerVersion(); /** + *
+   * The version of the Task Worker that executed the TaskAttempt.
+   * 
+ * * optional string task_worker_version = 8; * @return The taskWorkerVersion. */ java.lang.String getTaskWorkerVersion(); /** + *
+   * The version of the Task Worker that executed the TaskAttempt.
+   * 
+ * * optional string task_worker_version = 8; * @return The bytes for taskWorkerVersion. */ @@ -97,57 +171,101 @@ public interface TaskAttemptOrBuilder extends getTaskWorkerVersionBytes(); /** + *
+   * The status of this TaskAttempt.
+   * 
+ * * .littlehorse.TaskStatus status = 9; * @return The enum numeric value on the wire for status. */ int getStatusValue(); /** + *
+   * The status of this TaskAttempt.
+   * 
+ * * .littlehorse.TaskStatus status = 9; * @return The status. */ io.littlehorse.sdk.common.proto.TaskStatus getStatus(); /** + *
+   * Denotes the Task Function executed properly and returned an output.
+   * 
+ * * .littlehorse.VariableValue output = 1; * @return Whether the output field is set. */ boolean hasOutput(); /** + *
+   * Denotes the Task Function executed properly and returned an output.
+   * 
+ * * .littlehorse.VariableValue output = 1; * @return The output. */ io.littlehorse.sdk.common.proto.VariableValue getOutput(); /** + *
+   * Denotes the Task Function executed properly and returned an output.
+   * 
+ * * .littlehorse.VariableValue output = 1; */ io.littlehorse.sdk.common.proto.VariableValueOrBuilder getOutputOrBuilder(); /** + *
+   * An unexpected technical error was encountered. May or may not be retriable.
+   * 
+ * * .littlehorse.LHTaskError error = 10; * @return Whether the error field is set. */ boolean hasError(); /** + *
+   * An unexpected technical error was encountered. May or may not be retriable.
+   * 
+ * * .littlehorse.LHTaskError error = 10; * @return The error. */ io.littlehorse.sdk.common.proto.LHTaskError getError(); /** + *
+   * An unexpected technical error was encountered. May or may not be retriable.
+   * 
+ * * .littlehorse.LHTaskError error = 10; */ io.littlehorse.sdk.common.proto.LHTaskErrorOrBuilder getErrorOrBuilder(); /** + *
+   * The Task Function encountered a business problem and threw a technical exception.
+   * 
+ * * .littlehorse.LHTaskException exception = 11; * @return Whether the exception field is set. */ boolean hasException(); /** + *
+   * The Task Function encountered a business problem and threw a technical exception.
+   * 
+ * * .littlehorse.LHTaskException exception = 11; * @return The exception. */ io.littlehorse.sdk.common.proto.LHTaskException getException(); /** + *
+   * The Task Function encountered a business problem and threw a technical exception.
+   * 
+ * * .littlehorse.LHTaskException exception = 11; */ io.littlehorse.sdk.common.proto.LHTaskExceptionOrBuilder getExceptionOrBuilder(); diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDef.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDef.java index 2325a0abf..c713fe5ea 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDef.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDef.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * A TaskDef defines a blueprint for a TaskRun that can be dispatched to Task Workers.
+ * 
+ * * Protobuf type {@code littlehorse.TaskDef} */ public final class TaskDef extends @@ -42,6 +46,10 @@ protected java.lang.Object newInstance( public static final int ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.TaskDefId id_; /** + *
+   * The ID of this TaskDef.
+   * 
+ * * .littlehorse.TaskDefId id = 1; * @return Whether the id field is set. */ @@ -50,6 +58,10 @@ public boolean hasId() { return id_ != null; } /** + *
+   * The ID of this TaskDef.
+   * 
+ * * .littlehorse.TaskDefId id = 1; * @return The id. */ @@ -58,6 +70,10 @@ public io.littlehorse.sdk.common.proto.TaskDefId getId() { return id_ == null ? io.littlehorse.sdk.common.proto.TaskDefId.getDefaultInstance() : id_; } /** + *
+   * The ID of this TaskDef.
+   * 
+ * * .littlehorse.TaskDefId id = 1; */ @java.lang.Override @@ -69,6 +85,10 @@ public io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder getIdOrBuilder() { @SuppressWarnings("serial") private java.util.List inputVars_; /** + *
+   * The input variables required to execute this TaskDef.
+   * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ @java.lang.Override @@ -76,6 +96,10 @@ public java.util.List getInputVarsL return inputVars_; } /** + *
+   * The input variables required to execute this TaskDef.
+   * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ @java.lang.Override @@ -84,6 +108,10 @@ public java.util.List getInputVarsL return inputVars_; } /** + *
+   * The input variables required to execute this TaskDef.
+   * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ @java.lang.Override @@ -91,6 +119,10 @@ public int getInputVarsCount() { return inputVars_.size(); } /** + *
+   * The input variables required to execute this TaskDef.
+   * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ @java.lang.Override @@ -98,6 +130,10 @@ public io.littlehorse.sdk.common.proto.VariableDef getInputVars(int index) { return inputVars_.get(index); } /** + *
+   * The input variables required to execute this TaskDef.
+   * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ @java.lang.Override @@ -109,6 +145,10 @@ public io.littlehorse.sdk.common.proto.VariableDefOrBuilder getInputVarsOrBuilde public static final int CREATED_AT_FIELD_NUMBER = 3; private com.google.protobuf.Timestamp createdAt_; /** + *
+   * The time at which this TaskDef was created.
+   * 
+ * * .google.protobuf.Timestamp created_at = 3; * @return Whether the createdAt field is set. */ @@ -117,6 +157,10 @@ public boolean hasCreatedAt() { return createdAt_ != null; } /** + *
+   * The time at which this TaskDef was created.
+   * 
+ * * .google.protobuf.Timestamp created_at = 3; * @return The createdAt. */ @@ -125,6 +169,10 @@ public com.google.protobuf.Timestamp getCreatedAt() { return createdAt_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : createdAt_; } /** + *
+   * The time at which this TaskDef was created.
+   * 
+ * * .google.protobuf.Timestamp created_at = 3; */ @java.lang.Override @@ -324,6 +372,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * A TaskDef defines a blueprint for a TaskRun that can be dispatched to Task Workers.
+   * 
+ * * Protobuf type {@code littlehorse.TaskDef} */ public static final class Builder extends @@ -582,6 +634,10 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.TaskDefId, io.littlehorse.sdk.common.proto.TaskDefId.Builder, io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder> idBuilder_; /** + *
+     * The ID of this TaskDef.
+     * 
+ * * .littlehorse.TaskDefId id = 1; * @return Whether the id field is set. */ @@ -589,6 +645,10 @@ public boolean hasId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * The ID of this TaskDef.
+     * 
+ * * .littlehorse.TaskDefId id = 1; * @return The id. */ @@ -600,6 +660,10 @@ public io.littlehorse.sdk.common.proto.TaskDefId getId() { } } /** + *
+     * The ID of this TaskDef.
+     * 
+ * * .littlehorse.TaskDefId id = 1; */ public Builder setId(io.littlehorse.sdk.common.proto.TaskDefId value) { @@ -616,6 +680,10 @@ public Builder setId(io.littlehorse.sdk.common.proto.TaskDefId value) { return this; } /** + *
+     * The ID of this TaskDef.
+     * 
+ * * .littlehorse.TaskDefId id = 1; */ public Builder setId( @@ -630,6 +698,10 @@ public Builder setId( return this; } /** + *
+     * The ID of this TaskDef.
+     * 
+ * * .littlehorse.TaskDefId id = 1; */ public Builder mergeId(io.littlehorse.sdk.common.proto.TaskDefId value) { @@ -649,6 +721,10 @@ public Builder mergeId(io.littlehorse.sdk.common.proto.TaskDefId value) { return this; } /** + *
+     * The ID of this TaskDef.
+     * 
+ * * .littlehorse.TaskDefId id = 1; */ public Builder clearId() { @@ -662,6 +738,10 @@ public Builder clearId() { return this; } /** + *
+     * The ID of this TaskDef.
+     * 
+ * * .littlehorse.TaskDefId id = 1; */ public io.littlehorse.sdk.common.proto.TaskDefId.Builder getIdBuilder() { @@ -670,6 +750,10 @@ public io.littlehorse.sdk.common.proto.TaskDefId.Builder getIdBuilder() { return getIdFieldBuilder().getBuilder(); } /** + *
+     * The ID of this TaskDef.
+     * 
+ * * .littlehorse.TaskDefId id = 1; */ public io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder getIdOrBuilder() { @@ -681,6 +765,10 @@ public io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder getIdOrBuilder() { } } /** + *
+     * The ID of this TaskDef.
+     * 
+ * * .littlehorse.TaskDefId id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -710,6 +798,10 @@ private void ensureInputVarsIsMutable() { io.littlehorse.sdk.common.proto.VariableDef, io.littlehorse.sdk.common.proto.VariableDef.Builder, io.littlehorse.sdk.common.proto.VariableDefOrBuilder> inputVarsBuilder_; /** + *
+     * The input variables required to execute this TaskDef.
+     * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ public java.util.List getInputVarsList() { @@ -720,6 +812,10 @@ public java.util.List getInputVarsL } } /** + *
+     * The input variables required to execute this TaskDef.
+     * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ public int getInputVarsCount() { @@ -730,6 +826,10 @@ public int getInputVarsCount() { } } /** + *
+     * The input variables required to execute this TaskDef.
+     * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ public io.littlehorse.sdk.common.proto.VariableDef getInputVars(int index) { @@ -740,6 +840,10 @@ public io.littlehorse.sdk.common.proto.VariableDef getInputVars(int index) { } } /** + *
+     * The input variables required to execute this TaskDef.
+     * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ public Builder setInputVars( @@ -757,6 +861,10 @@ public Builder setInputVars( return this; } /** + *
+     * The input variables required to execute this TaskDef.
+     * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ public Builder setInputVars( @@ -771,6 +879,10 @@ public Builder setInputVars( return this; } /** + *
+     * The input variables required to execute this TaskDef.
+     * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ public Builder addInputVars(io.littlehorse.sdk.common.proto.VariableDef value) { @@ -787,6 +899,10 @@ public Builder addInputVars(io.littlehorse.sdk.common.proto.VariableDef value) { return this; } /** + *
+     * The input variables required to execute this TaskDef.
+     * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ public Builder addInputVars( @@ -804,6 +920,10 @@ public Builder addInputVars( return this; } /** + *
+     * The input variables required to execute this TaskDef.
+     * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ public Builder addInputVars( @@ -818,6 +938,10 @@ public Builder addInputVars( return this; } /** + *
+     * The input variables required to execute this TaskDef.
+     * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ public Builder addInputVars( @@ -832,6 +956,10 @@ public Builder addInputVars( return this; } /** + *
+     * The input variables required to execute this TaskDef.
+     * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ public Builder addAllInputVars( @@ -847,6 +975,10 @@ public Builder addAllInputVars( return this; } /** + *
+     * The input variables required to execute this TaskDef.
+     * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ public Builder clearInputVars() { @@ -860,6 +992,10 @@ public Builder clearInputVars() { return this; } /** + *
+     * The input variables required to execute this TaskDef.
+     * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ public Builder removeInputVars(int index) { @@ -873,6 +1009,10 @@ public Builder removeInputVars(int index) { return this; } /** + *
+     * The input variables required to execute this TaskDef.
+     * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ public io.littlehorse.sdk.common.proto.VariableDef.Builder getInputVarsBuilder( @@ -880,6 +1020,10 @@ public io.littlehorse.sdk.common.proto.VariableDef.Builder getInputVarsBuilder( return getInputVarsFieldBuilder().getBuilder(index); } /** + *
+     * The input variables required to execute this TaskDef.
+     * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ public io.littlehorse.sdk.common.proto.VariableDefOrBuilder getInputVarsOrBuilder( @@ -890,6 +1034,10 @@ public io.littlehorse.sdk.common.proto.VariableDefOrBuilder getInputVarsOrBuilde } } /** + *
+     * The input variables required to execute this TaskDef.
+     * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ public java.util.List @@ -901,6 +1049,10 @@ public io.littlehorse.sdk.common.proto.VariableDefOrBuilder getInputVarsOrBuilde } } /** + *
+     * The input variables required to execute this TaskDef.
+     * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ public io.littlehorse.sdk.common.proto.VariableDef.Builder addInputVarsBuilder() { @@ -908,6 +1060,10 @@ public io.littlehorse.sdk.common.proto.VariableDef.Builder addInputVarsBuilder() io.littlehorse.sdk.common.proto.VariableDef.getDefaultInstance()); } /** + *
+     * The input variables required to execute this TaskDef.
+     * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ public io.littlehorse.sdk.common.proto.VariableDef.Builder addInputVarsBuilder( @@ -916,6 +1072,10 @@ public io.littlehorse.sdk.common.proto.VariableDef.Builder addInputVarsBuilder( index, io.littlehorse.sdk.common.proto.VariableDef.getDefaultInstance()); } /** + *
+     * The input variables required to execute this TaskDef.
+     * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ public java.util.List @@ -941,6 +1101,10 @@ public io.littlehorse.sdk.common.proto.VariableDef.Builder addInputVarsBuilder( private com.google.protobuf.SingleFieldBuilderV3< com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> createdAtBuilder_; /** + *
+     * The time at which this TaskDef was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 3; * @return Whether the createdAt field is set. */ @@ -948,6 +1112,10 @@ public boolean hasCreatedAt() { return ((bitField0_ & 0x00000004) != 0); } /** + *
+     * The time at which this TaskDef was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 3; * @return The createdAt. */ @@ -959,6 +1127,10 @@ public com.google.protobuf.Timestamp getCreatedAt() { } } /** + *
+     * The time at which this TaskDef was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 3; */ public Builder setCreatedAt(com.google.protobuf.Timestamp value) { @@ -975,6 +1147,10 @@ public Builder setCreatedAt(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time at which this TaskDef was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 3; */ public Builder setCreatedAt( @@ -989,6 +1165,10 @@ public Builder setCreatedAt( return this; } /** + *
+     * The time at which this TaskDef was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 3; */ public Builder mergeCreatedAt(com.google.protobuf.Timestamp value) { @@ -1008,6 +1188,10 @@ public Builder mergeCreatedAt(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time at which this TaskDef was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 3; */ public Builder clearCreatedAt() { @@ -1021,6 +1205,10 @@ public Builder clearCreatedAt() { return this; } /** + *
+     * The time at which this TaskDef was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 3; */ public com.google.protobuf.Timestamp.Builder getCreatedAtBuilder() { @@ -1029,6 +1217,10 @@ public com.google.protobuf.Timestamp.Builder getCreatedAtBuilder() { return getCreatedAtFieldBuilder().getBuilder(); } /** + *
+     * The time at which this TaskDef was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 3; */ public com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder() { @@ -1040,6 +1232,10 @@ public com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder() { } } /** + *
+     * The time at which this TaskDef was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 3; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefId.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefId.java index 765b9de30..b41763a0c 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefId.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefId.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * ID for a TaskDef.
+ * 
+ * * Protobuf type {@code littlehorse.TaskDefId} */ public final class TaskDefId extends @@ -43,6 +47,10 @@ protected java.lang.Object newInstance( @SuppressWarnings("serial") private volatile java.lang.Object name_ = ""; /** + *
+   * TaskDef's are uniquely identified by their name.
+   * 
+ * * string name = 1; * @return The name. */ @@ -60,6 +68,10 @@ public java.lang.String getName() { } } /** + *
+   * TaskDef's are uniquely identified by their name.
+   * 
+ * * string name = 1; * @return The bytes for name. */ @@ -235,6 +247,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * ID for a TaskDef.
+   * 
+ * * Protobuf type {@code littlehorse.TaskDefId} */ public static final class Builder extends @@ -406,6 +422,10 @@ public Builder mergeFrom( private java.lang.Object name_ = ""; /** + *
+     * TaskDef's are uniquely identified by their name.
+     * 
+ * * string name = 1; * @return The name. */ @@ -422,6 +442,10 @@ public java.lang.String getName() { } } /** + *
+     * TaskDef's are uniquely identified by their name.
+     * 
+ * * string name = 1; * @return The bytes for name. */ @@ -439,6 +463,10 @@ public java.lang.String getName() { } } /** + *
+     * TaskDef's are uniquely identified by their name.
+     * 
+ * * string name = 1; * @param value The name to set. * @return This builder for chaining. @@ -452,6 +480,10 @@ public Builder setName( return this; } /** + *
+     * TaskDef's are uniquely identified by their name.
+     * 
+ * * string name = 1; * @return This builder for chaining. */ @@ -462,6 +494,10 @@ public Builder clearName() { return this; } /** + *
+     * TaskDef's are uniquely identified by their name.
+     * 
+ * * string name = 1; * @param value The bytes for name to set. * @return This builder for chaining. diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefIdOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefIdOrBuilder.java index ad986f004..04e2641e4 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefIdOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefIdOrBuilder.java @@ -8,11 +8,19 @@ public interface TaskDefIdOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * TaskDef's are uniquely identified by their name.
+   * 
+ * * string name = 1; * @return The name. */ java.lang.String getName(); /** + *
+   * TaskDef's are uniquely identified by their name.
+   * 
+ * * string name = 1; * @return The bytes for name. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefMetricsId.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefMetricsId.java index fdbbcede2..8110d401d 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefMetricsId.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefMetricsId.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * ID for a specific window of TaskDef metrics.
+ * 
+ * * Protobuf type {@code littlehorse.TaskDefMetricsId} */ public final class TaskDefMetricsId extends @@ -42,6 +46,10 @@ protected java.lang.Object newInstance( public static final int WINDOW_START_FIELD_NUMBER = 1; private com.google.protobuf.Timestamp windowStart_; /** + *
+   * The timestamp at which this metrics window starts.
+   * 
+ * * .google.protobuf.Timestamp window_start = 1; * @return Whether the windowStart field is set. */ @@ -50,6 +58,10 @@ public boolean hasWindowStart() { return windowStart_ != null; } /** + *
+   * The timestamp at which this metrics window starts.
+   * 
+ * * .google.protobuf.Timestamp window_start = 1; * @return The windowStart. */ @@ -58,6 +70,10 @@ public com.google.protobuf.Timestamp getWindowStart() { return windowStart_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : windowStart_; } /** + *
+   * The timestamp at which this metrics window starts.
+   * 
+ * * .google.protobuf.Timestamp window_start = 1; */ @java.lang.Override @@ -68,6 +84,10 @@ public com.google.protobuf.TimestampOrBuilder getWindowStartOrBuilder() { public static final int WINDOW_TYPE_FIELD_NUMBER = 2; private int windowType_ = 0; /** + *
+   * The length of this window.
+   * 
+ * * .littlehorse.MetricsWindowLength window_type = 2; * @return The enum numeric value on the wire for windowType. */ @@ -75,6 +95,10 @@ public com.google.protobuf.TimestampOrBuilder getWindowStartOrBuilder() { return windowType_; } /** + *
+   * The length of this window.
+   * 
+ * * .littlehorse.MetricsWindowLength window_type = 2; * @return The windowType. */ @@ -86,6 +110,10 @@ public com.google.protobuf.TimestampOrBuilder getWindowStartOrBuilder() { public static final int TASK_DEF_ID_FIELD_NUMBER = 3; private io.littlehorse.sdk.common.proto.TaskDefId taskDefId_; /** + *
+   * The TaskDefId that this metrics window reports on.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 3; * @return Whether the taskDefId field is set. */ @@ -94,6 +122,10 @@ public boolean hasTaskDefId() { return taskDefId_ != null; } /** + *
+   * The TaskDefId that this metrics window reports on.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 3; * @return The taskDefId. */ @@ -102,6 +134,10 @@ public io.littlehorse.sdk.common.proto.TaskDefId getTaskDefId() { return taskDefId_ == null ? io.littlehorse.sdk.common.proto.TaskDefId.getDefaultInstance() : taskDefId_; } /** + *
+   * The TaskDefId that this metrics window reports on.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 3; */ @java.lang.Override @@ -298,6 +334,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * ID for a specific window of TaskDef metrics.
+   * 
+ * * Protobuf type {@code littlehorse.TaskDefMetricsId} */ public static final class Builder extends @@ -509,6 +549,10 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> windowStartBuilder_; /** + *
+     * The timestamp at which this metrics window starts.
+     * 
+ * * .google.protobuf.Timestamp window_start = 1; * @return Whether the windowStart field is set. */ @@ -516,6 +560,10 @@ public boolean hasWindowStart() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * The timestamp at which this metrics window starts.
+     * 
+ * * .google.protobuf.Timestamp window_start = 1; * @return The windowStart. */ @@ -527,6 +575,10 @@ public com.google.protobuf.Timestamp getWindowStart() { } } /** + *
+     * The timestamp at which this metrics window starts.
+     * 
+ * * .google.protobuf.Timestamp window_start = 1; */ public Builder setWindowStart(com.google.protobuf.Timestamp value) { @@ -543,6 +595,10 @@ public Builder setWindowStart(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The timestamp at which this metrics window starts.
+     * 
+ * * .google.protobuf.Timestamp window_start = 1; */ public Builder setWindowStart( @@ -557,6 +613,10 @@ public Builder setWindowStart( return this; } /** + *
+     * The timestamp at which this metrics window starts.
+     * 
+ * * .google.protobuf.Timestamp window_start = 1; */ public Builder mergeWindowStart(com.google.protobuf.Timestamp value) { @@ -576,6 +636,10 @@ public Builder mergeWindowStart(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The timestamp at which this metrics window starts.
+     * 
+ * * .google.protobuf.Timestamp window_start = 1; */ public Builder clearWindowStart() { @@ -589,6 +653,10 @@ public Builder clearWindowStart() { return this; } /** + *
+     * The timestamp at which this metrics window starts.
+     * 
+ * * .google.protobuf.Timestamp window_start = 1; */ public com.google.protobuf.Timestamp.Builder getWindowStartBuilder() { @@ -597,6 +665,10 @@ public com.google.protobuf.Timestamp.Builder getWindowStartBuilder() { return getWindowStartFieldBuilder().getBuilder(); } /** + *
+     * The timestamp at which this metrics window starts.
+     * 
+ * * .google.protobuf.Timestamp window_start = 1; */ public com.google.protobuf.TimestampOrBuilder getWindowStartOrBuilder() { @@ -608,6 +680,10 @@ public com.google.protobuf.TimestampOrBuilder getWindowStartOrBuilder() { } } /** + *
+     * The timestamp at which this metrics window starts.
+     * 
+ * * .google.protobuf.Timestamp window_start = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -626,6 +702,10 @@ public com.google.protobuf.TimestampOrBuilder getWindowStartOrBuilder() { private int windowType_ = 0; /** + *
+     * The length of this window.
+     * 
+ * * .littlehorse.MetricsWindowLength window_type = 2; * @return The enum numeric value on the wire for windowType. */ @@ -633,6 +713,10 @@ public com.google.protobuf.TimestampOrBuilder getWindowStartOrBuilder() { return windowType_; } /** + *
+     * The length of this window.
+     * 
+ * * .littlehorse.MetricsWindowLength window_type = 2; * @param value The enum numeric value on the wire for windowType to set. * @return This builder for chaining. @@ -644,6 +728,10 @@ public Builder setWindowTypeValue(int value) { return this; } /** + *
+     * The length of this window.
+     * 
+ * * .littlehorse.MetricsWindowLength window_type = 2; * @return The windowType. */ @@ -653,6 +741,10 @@ public io.littlehorse.sdk.common.proto.MetricsWindowLength getWindowType() { return result == null ? io.littlehorse.sdk.common.proto.MetricsWindowLength.UNRECOGNIZED : result; } /** + *
+     * The length of this window.
+     * 
+ * * .littlehorse.MetricsWindowLength window_type = 2; * @param value The windowType to set. * @return This builder for chaining. @@ -667,6 +759,10 @@ public Builder setWindowType(io.littlehorse.sdk.common.proto.MetricsWindowLength return this; } /** + *
+     * The length of this window.
+     * 
+ * * .littlehorse.MetricsWindowLength window_type = 2; * @return This builder for chaining. */ @@ -681,6 +777,10 @@ public Builder clearWindowType() { private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.TaskDefId, io.littlehorse.sdk.common.proto.TaskDefId.Builder, io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder> taskDefIdBuilder_; /** + *
+     * The TaskDefId that this metrics window reports on.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 3; * @return Whether the taskDefId field is set. */ @@ -688,6 +788,10 @@ public boolean hasTaskDefId() { return ((bitField0_ & 0x00000004) != 0); } /** + *
+     * The TaskDefId that this metrics window reports on.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 3; * @return The taskDefId. */ @@ -699,6 +803,10 @@ public io.littlehorse.sdk.common.proto.TaskDefId getTaskDefId() { } } /** + *
+     * The TaskDefId that this metrics window reports on.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 3; */ public Builder setTaskDefId(io.littlehorse.sdk.common.proto.TaskDefId value) { @@ -715,6 +823,10 @@ public Builder setTaskDefId(io.littlehorse.sdk.common.proto.TaskDefId value) { return this; } /** + *
+     * The TaskDefId that this metrics window reports on.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 3; */ public Builder setTaskDefId( @@ -729,6 +841,10 @@ public Builder setTaskDefId( return this; } /** + *
+     * The TaskDefId that this metrics window reports on.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 3; */ public Builder mergeTaskDefId(io.littlehorse.sdk.common.proto.TaskDefId value) { @@ -748,6 +864,10 @@ public Builder mergeTaskDefId(io.littlehorse.sdk.common.proto.TaskDefId value) { return this; } /** + *
+     * The TaskDefId that this metrics window reports on.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 3; */ public Builder clearTaskDefId() { @@ -761,6 +881,10 @@ public Builder clearTaskDefId() { return this; } /** + *
+     * The TaskDefId that this metrics window reports on.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 3; */ public io.littlehorse.sdk.common.proto.TaskDefId.Builder getTaskDefIdBuilder() { @@ -769,6 +893,10 @@ public io.littlehorse.sdk.common.proto.TaskDefId.Builder getTaskDefIdBuilder() { return getTaskDefIdFieldBuilder().getBuilder(); } /** + *
+     * The TaskDefId that this metrics window reports on.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 3; */ public io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder getTaskDefIdOrBuilder() { @@ -780,6 +908,10 @@ public io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder getTaskDefIdOrBuilder( } } /** + *
+     * The TaskDefId that this metrics window reports on.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 3; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefMetricsIdOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefMetricsIdOrBuilder.java index 9329d21e0..097b8c099 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefMetricsIdOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefMetricsIdOrBuilder.java @@ -8,42 +8,74 @@ public interface TaskDefMetricsIdOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The timestamp at which this metrics window starts.
+   * 
+ * * .google.protobuf.Timestamp window_start = 1; * @return Whether the windowStart field is set. */ boolean hasWindowStart(); /** + *
+   * The timestamp at which this metrics window starts.
+   * 
+ * * .google.protobuf.Timestamp window_start = 1; * @return The windowStart. */ com.google.protobuf.Timestamp getWindowStart(); /** + *
+   * The timestamp at which this metrics window starts.
+   * 
+ * * .google.protobuf.Timestamp window_start = 1; */ com.google.protobuf.TimestampOrBuilder getWindowStartOrBuilder(); /** + *
+   * The length of this window.
+   * 
+ * * .littlehorse.MetricsWindowLength window_type = 2; * @return The enum numeric value on the wire for windowType. */ int getWindowTypeValue(); /** + *
+   * The length of this window.
+   * 
+ * * .littlehorse.MetricsWindowLength window_type = 2; * @return The windowType. */ io.littlehorse.sdk.common.proto.MetricsWindowLength getWindowType(); /** + *
+   * The TaskDefId that this metrics window reports on.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 3; * @return Whether the taskDefId field is set. */ boolean hasTaskDefId(); /** + *
+   * The TaskDefId that this metrics window reports on.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 3; * @return The taskDefId. */ io.littlehorse.sdk.common.proto.TaskDefId getTaskDefId(); /** + *
+   * The TaskDefId that this metrics window reports on.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 3; */ io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder getTaskDefIdOrBuilder(); diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefOrBuilder.java index 6ad323c65..afcc1de3a 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskDefOrBuilder.java @@ -8,55 +8,99 @@ public interface TaskDefOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The ID of this TaskDef.
+   * 
+ * * .littlehorse.TaskDefId id = 1; * @return Whether the id field is set. */ boolean hasId(); /** + *
+   * The ID of this TaskDef.
+   * 
+ * * .littlehorse.TaskDefId id = 1; * @return The id. */ io.littlehorse.sdk.common.proto.TaskDefId getId(); /** + *
+   * The ID of this TaskDef.
+   * 
+ * * .littlehorse.TaskDefId id = 1; */ io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder getIdOrBuilder(); /** + *
+   * The input variables required to execute this TaskDef.
+   * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ java.util.List getInputVarsList(); /** + *
+   * The input variables required to execute this TaskDef.
+   * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ io.littlehorse.sdk.common.proto.VariableDef getInputVars(int index); /** + *
+   * The input variables required to execute this TaskDef.
+   * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ int getInputVarsCount(); /** + *
+   * The input variables required to execute this TaskDef.
+   * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ java.util.List getInputVarsOrBuilderList(); /** + *
+   * The input variables required to execute this TaskDef.
+   * 
+ * * repeated .littlehorse.VariableDef input_vars = 2; */ io.littlehorse.sdk.common.proto.VariableDefOrBuilder getInputVarsOrBuilder( int index); /** + *
+   * The time at which this TaskDef was created.
+   * 
+ * * .google.protobuf.Timestamp created_at = 3; * @return Whether the createdAt field is set. */ boolean hasCreatedAt(); /** + *
+   * The time at which this TaskDef was created.
+   * 
+ * * .google.protobuf.Timestamp created_at = 3; * @return The createdAt. */ com.google.protobuf.Timestamp getCreatedAt(); /** + *
+   * The time at which this TaskDef was created.
+   * 
+ * * .google.protobuf.Timestamp created_at = 3; */ com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder(); diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNode.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNode.java index 4608023f9..100b7186a 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNode.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNode.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * Defines a TaskRun execution. Used in a Node and also in the UserTask Trigger Actions.
+ * 
+ * * Protobuf type {@code littlehorse.TaskNode} */ public final class TaskNode extends @@ -42,6 +46,10 @@ protected java.lang.Object newInstance( public static final int TASK_DEF_ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.TaskDefId taskDefId_; /** + *
+   * The type of TaskRun to schedule.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 1; * @return Whether the taskDefId field is set. */ @@ -50,6 +58,10 @@ public boolean hasTaskDefId() { return taskDefId_ != null; } /** + *
+   * The type of TaskRun to schedule.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 1; * @return The taskDefId. */ @@ -58,6 +70,10 @@ public io.littlehorse.sdk.common.proto.TaskDefId getTaskDefId() { return taskDefId_ == null ? io.littlehorse.sdk.common.proto.TaskDefId.getDefaultInstance() : taskDefId_; } /** + *
+   * The type of TaskRun to schedule.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 1; */ @java.lang.Override @@ -68,6 +84,11 @@ public io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder getTaskDefIdOrBuilder( public static final int TIMEOUT_SECONDS_FIELD_NUMBER = 2; private int timeoutSeconds_ = 0; /** + *
+   * How long until LittleHorse determines that the Task Worker had a technical ERROR if
+   * the worker does not yet reply to the Server.
+   * 
+ * * int32 timeout_seconds = 2; * @return The timeoutSeconds. */ @@ -79,6 +100,12 @@ public int getTimeoutSeconds() { public static final int RETRIES_FIELD_NUMBER = 3; private int retries_ = 0; /** + *
+   * EXPERIMENTAL: How many times we should retry on retryable ERROR's.
+   * Please note that this API may change before version 1.0.0, as we are going to
+   * add significant functionality including backoff policies.
+   * 
+ * * int32 retries = 3; * @return The retries. */ @@ -91,6 +118,10 @@ public int getRetries() { @SuppressWarnings("serial") private java.util.List variables_; /** + *
+   * Input variables into the TaskDef.
+   * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ @java.lang.Override @@ -98,6 +129,10 @@ public java.util.List getVar return variables_; } /** + *
+   * Input variables into the TaskDef.
+   * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ @java.lang.Override @@ -106,6 +141,10 @@ public java.util.List getVar return variables_; } /** + *
+   * Input variables into the TaskDef.
+   * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ @java.lang.Override @@ -113,6 +152,10 @@ public int getVariablesCount() { return variables_.size(); } /** + *
+   * Input variables into the TaskDef.
+   * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ @java.lang.Override @@ -120,6 +163,10 @@ public io.littlehorse.sdk.common.proto.VariableAssignment getVariables(int index return variables_.get(index); } /** + *
+   * Input variables into the TaskDef.
+   * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ @java.lang.Override @@ -326,6 +373,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * Defines a TaskRun execution. Used in a Node and also in the UserTask Trigger Actions.
+   * 
+ * * Protobuf type {@code littlehorse.TaskNode} */ public static final class Builder extends @@ -588,6 +639,10 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.TaskDefId, io.littlehorse.sdk.common.proto.TaskDefId.Builder, io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder> taskDefIdBuilder_; /** + *
+     * The type of TaskRun to schedule.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 1; * @return Whether the taskDefId field is set. */ @@ -595,6 +650,10 @@ public boolean hasTaskDefId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * The type of TaskRun to schedule.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 1; * @return The taskDefId. */ @@ -606,6 +665,10 @@ public io.littlehorse.sdk.common.proto.TaskDefId getTaskDefId() { } } /** + *
+     * The type of TaskRun to schedule.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 1; */ public Builder setTaskDefId(io.littlehorse.sdk.common.proto.TaskDefId value) { @@ -622,6 +685,10 @@ public Builder setTaskDefId(io.littlehorse.sdk.common.proto.TaskDefId value) { return this; } /** + *
+     * The type of TaskRun to schedule.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 1; */ public Builder setTaskDefId( @@ -636,6 +703,10 @@ public Builder setTaskDefId( return this; } /** + *
+     * The type of TaskRun to schedule.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 1; */ public Builder mergeTaskDefId(io.littlehorse.sdk.common.proto.TaskDefId value) { @@ -655,6 +726,10 @@ public Builder mergeTaskDefId(io.littlehorse.sdk.common.proto.TaskDefId value) { return this; } /** + *
+     * The type of TaskRun to schedule.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 1; */ public Builder clearTaskDefId() { @@ -668,6 +743,10 @@ public Builder clearTaskDefId() { return this; } /** + *
+     * The type of TaskRun to schedule.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 1; */ public io.littlehorse.sdk.common.proto.TaskDefId.Builder getTaskDefIdBuilder() { @@ -676,6 +755,10 @@ public io.littlehorse.sdk.common.proto.TaskDefId.Builder getTaskDefIdBuilder() { return getTaskDefIdFieldBuilder().getBuilder(); } /** + *
+     * The type of TaskRun to schedule.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 1; */ public io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder getTaskDefIdOrBuilder() { @@ -687,6 +770,10 @@ public io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder getTaskDefIdOrBuilder( } } /** + *
+     * The type of TaskRun to schedule.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -705,6 +792,11 @@ public io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder getTaskDefIdOrBuilder( private int timeoutSeconds_ ; /** + *
+     * How long until LittleHorse determines that the Task Worker had a technical ERROR if
+     * the worker does not yet reply to the Server.
+     * 
+ * * int32 timeout_seconds = 2; * @return The timeoutSeconds. */ @@ -713,6 +805,11 @@ public int getTimeoutSeconds() { return timeoutSeconds_; } /** + *
+     * How long until LittleHorse determines that the Task Worker had a technical ERROR if
+     * the worker does not yet reply to the Server.
+     * 
+ * * int32 timeout_seconds = 2; * @param value The timeoutSeconds to set. * @return This builder for chaining. @@ -725,6 +822,11 @@ public Builder setTimeoutSeconds(int value) { return this; } /** + *
+     * How long until LittleHorse determines that the Task Worker had a technical ERROR if
+     * the worker does not yet reply to the Server.
+     * 
+ * * int32 timeout_seconds = 2; * @return This builder for chaining. */ @@ -737,6 +839,12 @@ public Builder clearTimeoutSeconds() { private int retries_ ; /** + *
+     * EXPERIMENTAL: How many times we should retry on retryable ERROR's.
+     * Please note that this API may change before version 1.0.0, as we are going to
+     * add significant functionality including backoff policies.
+     * 
+ * * int32 retries = 3; * @return The retries. */ @@ -745,6 +853,12 @@ public int getRetries() { return retries_; } /** + *
+     * EXPERIMENTAL: How many times we should retry on retryable ERROR's.
+     * Please note that this API may change before version 1.0.0, as we are going to
+     * add significant functionality including backoff policies.
+     * 
+ * * int32 retries = 3; * @param value The retries to set. * @return This builder for chaining. @@ -757,6 +871,12 @@ public Builder setRetries(int value) { return this; } /** + *
+     * EXPERIMENTAL: How many times we should retry on retryable ERROR's.
+     * Please note that this API may change before version 1.0.0, as we are going to
+     * add significant functionality including backoff policies.
+     * 
+ * * int32 retries = 3; * @return This builder for chaining. */ @@ -780,6 +900,10 @@ private void ensureVariablesIsMutable() { io.littlehorse.sdk.common.proto.VariableAssignment, io.littlehorse.sdk.common.proto.VariableAssignment.Builder, io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder> variablesBuilder_; /** + *
+     * Input variables into the TaskDef.
+     * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ public java.util.List getVariablesList() { @@ -790,6 +914,10 @@ public java.util.List getVar } } /** + *
+     * Input variables into the TaskDef.
+     * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ public int getVariablesCount() { @@ -800,6 +928,10 @@ public int getVariablesCount() { } } /** + *
+     * Input variables into the TaskDef.
+     * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ public io.littlehorse.sdk.common.proto.VariableAssignment getVariables(int index) { @@ -810,6 +942,10 @@ public io.littlehorse.sdk.common.proto.VariableAssignment getVariables(int index } } /** + *
+     * Input variables into the TaskDef.
+     * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ public Builder setVariables( @@ -827,6 +963,10 @@ public Builder setVariables( return this; } /** + *
+     * Input variables into the TaskDef.
+     * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ public Builder setVariables( @@ -841,6 +981,10 @@ public Builder setVariables( return this; } /** + *
+     * Input variables into the TaskDef.
+     * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ public Builder addVariables(io.littlehorse.sdk.common.proto.VariableAssignment value) { @@ -857,6 +1001,10 @@ public Builder addVariables(io.littlehorse.sdk.common.proto.VariableAssignment v return this; } /** + *
+     * Input variables into the TaskDef.
+     * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ public Builder addVariables( @@ -874,6 +1022,10 @@ public Builder addVariables( return this; } /** + *
+     * Input variables into the TaskDef.
+     * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ public Builder addVariables( @@ -888,6 +1040,10 @@ public Builder addVariables( return this; } /** + *
+     * Input variables into the TaskDef.
+     * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ public Builder addVariables( @@ -902,6 +1058,10 @@ public Builder addVariables( return this; } /** + *
+     * Input variables into the TaskDef.
+     * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ public Builder addAllVariables( @@ -917,6 +1077,10 @@ public Builder addAllVariables( return this; } /** + *
+     * Input variables into the TaskDef.
+     * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ public Builder clearVariables() { @@ -930,6 +1094,10 @@ public Builder clearVariables() { return this; } /** + *
+     * Input variables into the TaskDef.
+     * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ public Builder removeVariables(int index) { @@ -943,6 +1111,10 @@ public Builder removeVariables(int index) { return this; } /** + *
+     * Input variables into the TaskDef.
+     * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ public io.littlehorse.sdk.common.proto.VariableAssignment.Builder getVariablesBuilder( @@ -950,6 +1122,10 @@ public io.littlehorse.sdk.common.proto.VariableAssignment.Builder getVariablesBu return getVariablesFieldBuilder().getBuilder(index); } /** + *
+     * Input variables into the TaskDef.
+     * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ public io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getVariablesOrBuilder( @@ -960,6 +1136,10 @@ public io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getVariablesO } } /** + *
+     * Input variables into the TaskDef.
+     * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ public java.util.List @@ -971,6 +1151,10 @@ public io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getVariablesO } } /** + *
+     * Input variables into the TaskDef.
+     * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ public io.littlehorse.sdk.common.proto.VariableAssignment.Builder addVariablesBuilder() { @@ -978,6 +1162,10 @@ public io.littlehorse.sdk.common.proto.VariableAssignment.Builder addVariablesBu io.littlehorse.sdk.common.proto.VariableAssignment.getDefaultInstance()); } /** + *
+     * Input variables into the TaskDef.
+     * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ public io.littlehorse.sdk.common.proto.VariableAssignment.Builder addVariablesBuilder( @@ -986,6 +1174,10 @@ public io.littlehorse.sdk.common.proto.VariableAssignment.Builder addVariablesBu index, io.littlehorse.sdk.common.proto.VariableAssignment.getDefaultInstance()); } /** + *
+     * Input variables into the TaskDef.
+     * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ public java.util.List diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeOrBuilder.java index 0fe9597a9..34824cf46 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeOrBuilder.java @@ -8,51 +8,94 @@ public interface TaskNodeOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The type of TaskRun to schedule.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 1; * @return Whether the taskDefId field is set. */ boolean hasTaskDefId(); /** + *
+   * The type of TaskRun to schedule.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 1; * @return The taskDefId. */ io.littlehorse.sdk.common.proto.TaskDefId getTaskDefId(); /** + *
+   * The type of TaskRun to schedule.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 1; */ io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder getTaskDefIdOrBuilder(); /** + *
+   * How long until LittleHorse determines that the Task Worker had a technical ERROR if
+   * the worker does not yet reply to the Server.
+   * 
+ * * int32 timeout_seconds = 2; * @return The timeoutSeconds. */ int getTimeoutSeconds(); /** + *
+   * EXPERIMENTAL: How many times we should retry on retryable ERROR's.
+   * Please note that this API may change before version 1.0.0, as we are going to
+   * add significant functionality including backoff policies.
+   * 
+ * * int32 retries = 3; * @return The retries. */ int getRetries(); /** + *
+   * Input variables into the TaskDef.
+   * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ java.util.List getVariablesList(); /** + *
+   * Input variables into the TaskDef.
+   * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ io.littlehorse.sdk.common.proto.VariableAssignment getVariables(int index); /** + *
+   * Input variables into the TaskDef.
+   * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ int getVariablesCount(); /** + *
+   * Input variables into the TaskDef.
+   * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ java.util.List getVariablesOrBuilderList(); /** + *
+   * Input variables into the TaskDef.
+   * 
+ * * repeated .littlehorse.VariableAssignment variables = 4; */ io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getVariablesOrBuilder( diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeReference.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeReference.java index f69376e03..f094484a9 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeReference.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeReference.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * Reference to a NodeRun of type TASK which caused a TaskRun to be scheduled.
+ * 
+ * * Protobuf type {@code littlehorse.TaskNodeReference} */ public final class TaskNodeReference extends @@ -41,6 +45,10 @@ protected java.lang.Object newInstance( public static final int NODE_RUN_ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.NodeRunId nodeRunId_; /** + *
+   * The ID of the NodeRun which caused this TASK to be scheduled.
+   * 
+ * * .littlehorse.NodeRunId node_run_id = 1; * @return Whether the nodeRunId field is set. */ @@ -49,6 +57,10 @@ public boolean hasNodeRunId() { return nodeRunId_ != null; } /** + *
+   * The ID of the NodeRun which caused this TASK to be scheduled.
+   * 
+ * * .littlehorse.NodeRunId node_run_id = 1; * @return The nodeRunId. */ @@ -57,6 +69,10 @@ public io.littlehorse.sdk.common.proto.NodeRunId getNodeRunId() { return nodeRunId_ == null ? io.littlehorse.sdk.common.proto.NodeRunId.getDefaultInstance() : nodeRunId_; } /** + *
+   * The ID of the NodeRun which caused this TASK to be scheduled.
+   * 
+ * * .littlehorse.NodeRunId node_run_id = 1; */ @java.lang.Override @@ -227,6 +243,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * Reference to a NodeRun of type TASK which caused a TaskRun to be scheduled.
+   * 
+ * * Protobuf type {@code littlehorse.TaskNodeReference} */ public static final class Builder extends @@ -406,6 +426,10 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.NodeRunId, io.littlehorse.sdk.common.proto.NodeRunId.Builder, io.littlehorse.sdk.common.proto.NodeRunIdOrBuilder> nodeRunIdBuilder_; /** + *
+     * The ID of the NodeRun which caused this TASK to be scheduled.
+     * 
+ * * .littlehorse.NodeRunId node_run_id = 1; * @return Whether the nodeRunId field is set. */ @@ -413,6 +437,10 @@ public boolean hasNodeRunId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * The ID of the NodeRun which caused this TASK to be scheduled.
+     * 
+ * * .littlehorse.NodeRunId node_run_id = 1; * @return The nodeRunId. */ @@ -424,6 +452,10 @@ public io.littlehorse.sdk.common.proto.NodeRunId getNodeRunId() { } } /** + *
+     * The ID of the NodeRun which caused this TASK to be scheduled.
+     * 
+ * * .littlehorse.NodeRunId node_run_id = 1; */ public Builder setNodeRunId(io.littlehorse.sdk.common.proto.NodeRunId value) { @@ -440,6 +472,10 @@ public Builder setNodeRunId(io.littlehorse.sdk.common.proto.NodeRunId value) { return this; } /** + *
+     * The ID of the NodeRun which caused this TASK to be scheduled.
+     * 
+ * * .littlehorse.NodeRunId node_run_id = 1; */ public Builder setNodeRunId( @@ -454,6 +490,10 @@ public Builder setNodeRunId( return this; } /** + *
+     * The ID of the NodeRun which caused this TASK to be scheduled.
+     * 
+ * * .littlehorse.NodeRunId node_run_id = 1; */ public Builder mergeNodeRunId(io.littlehorse.sdk.common.proto.NodeRunId value) { @@ -473,6 +513,10 @@ public Builder mergeNodeRunId(io.littlehorse.sdk.common.proto.NodeRunId value) { return this; } /** + *
+     * The ID of the NodeRun which caused this TASK to be scheduled.
+     * 
+ * * .littlehorse.NodeRunId node_run_id = 1; */ public Builder clearNodeRunId() { @@ -486,6 +530,10 @@ public Builder clearNodeRunId() { return this; } /** + *
+     * The ID of the NodeRun which caused this TASK to be scheduled.
+     * 
+ * * .littlehorse.NodeRunId node_run_id = 1; */ public io.littlehorse.sdk.common.proto.NodeRunId.Builder getNodeRunIdBuilder() { @@ -494,6 +542,10 @@ public io.littlehorse.sdk.common.proto.NodeRunId.Builder getNodeRunIdBuilder() { return getNodeRunIdFieldBuilder().getBuilder(); } /** + *
+     * The ID of the NodeRun which caused this TASK to be scheduled.
+     * 
+ * * .littlehorse.NodeRunId node_run_id = 1; */ public io.littlehorse.sdk.common.proto.NodeRunIdOrBuilder getNodeRunIdOrBuilder() { @@ -505,6 +557,10 @@ public io.littlehorse.sdk.common.proto.NodeRunIdOrBuilder getNodeRunIdOrBuilder( } } /** + *
+     * The ID of the NodeRun which caused this TASK to be scheduled.
+     * 
+ * * .littlehorse.NodeRunId node_run_id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeReferenceOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeReferenceOrBuilder.java index 20b187d39..e295a0dfe 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeReferenceOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeReferenceOrBuilder.java @@ -8,16 +8,28 @@ public interface TaskNodeReferenceOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The ID of the NodeRun which caused this TASK to be scheduled.
+   * 
+ * * .littlehorse.NodeRunId node_run_id = 1; * @return Whether the nodeRunId field is set. */ boolean hasNodeRunId(); /** + *
+   * The ID of the NodeRun which caused this TASK to be scheduled.
+   * 
+ * * .littlehorse.NodeRunId node_run_id = 1; * @return The nodeRunId. */ io.littlehorse.sdk.common.proto.NodeRunId getNodeRunId(); /** + *
+   * The ID of the NodeRun which caused this TASK to be scheduled.
+   * 
+ * * .littlehorse.NodeRunId node_run_id = 1; */ io.littlehorse.sdk.common.proto.NodeRunIdOrBuilder getNodeRunIdOrBuilder(); diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeRun.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeRun.java index 826150ab4..7d2484d3e 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeRun.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeRun.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * The sub-node structure for a TASK NodeRun.
+ * 
+ * * Protobuf type {@code littlehorse.TaskNodeRun} */ public final class TaskNodeRun extends @@ -42,6 +46,11 @@ protected java.lang.Object newInstance( public static final int TASK_RUN_ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.TaskRunId taskRunId_; /** + *
+   * The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived
+   * at this TASK Node, then the task_run_id will be unset.
+   * 
+ * * optional .littlehorse.TaskRunId task_run_id = 1; * @return Whether the taskRunId field is set. */ @@ -50,6 +59,11 @@ public boolean hasTaskRunId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+   * The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived
+   * at this TASK Node, then the task_run_id will be unset.
+   * 
+ * * optional .littlehorse.TaskRunId task_run_id = 1; * @return The taskRunId. */ @@ -58,6 +72,11 @@ public io.littlehorse.sdk.common.proto.TaskRunId getTaskRunId() { return taskRunId_ == null ? io.littlehorse.sdk.common.proto.TaskRunId.getDefaultInstance() : taskRunId_; } /** + *
+   * The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived
+   * at this TASK Node, then the task_run_id will be unset.
+   * 
+ * * optional .littlehorse.TaskRunId task_run_id = 1; */ @java.lang.Override @@ -228,6 +247,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * The sub-node structure for a TASK NodeRun.
+   * 
+ * * Protobuf type {@code littlehorse.TaskNodeRun} */ public static final class Builder extends @@ -416,6 +439,11 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.TaskRunId, io.littlehorse.sdk.common.proto.TaskRunId.Builder, io.littlehorse.sdk.common.proto.TaskRunIdOrBuilder> taskRunIdBuilder_; /** + *
+     * The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived
+     * at this TASK Node, then the task_run_id will be unset.
+     * 
+ * * optional .littlehorse.TaskRunId task_run_id = 1; * @return Whether the taskRunId field is set. */ @@ -423,6 +451,11 @@ public boolean hasTaskRunId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived
+     * at this TASK Node, then the task_run_id will be unset.
+     * 
+ * * optional .littlehorse.TaskRunId task_run_id = 1; * @return The taskRunId. */ @@ -434,6 +467,11 @@ public io.littlehorse.sdk.common.proto.TaskRunId getTaskRunId() { } } /** + *
+     * The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived
+     * at this TASK Node, then the task_run_id will be unset.
+     * 
+ * * optional .littlehorse.TaskRunId task_run_id = 1; */ public Builder setTaskRunId(io.littlehorse.sdk.common.proto.TaskRunId value) { @@ -450,6 +488,11 @@ public Builder setTaskRunId(io.littlehorse.sdk.common.proto.TaskRunId value) { return this; } /** + *
+     * The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived
+     * at this TASK Node, then the task_run_id will be unset.
+     * 
+ * * optional .littlehorse.TaskRunId task_run_id = 1; */ public Builder setTaskRunId( @@ -464,6 +507,11 @@ public Builder setTaskRunId( return this; } /** + *
+     * The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived
+     * at this TASK Node, then the task_run_id will be unset.
+     * 
+ * * optional .littlehorse.TaskRunId task_run_id = 1; */ public Builder mergeTaskRunId(io.littlehorse.sdk.common.proto.TaskRunId value) { @@ -483,6 +531,11 @@ public Builder mergeTaskRunId(io.littlehorse.sdk.common.proto.TaskRunId value) { return this; } /** + *
+     * The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived
+     * at this TASK Node, then the task_run_id will be unset.
+     * 
+ * * optional .littlehorse.TaskRunId task_run_id = 1; */ public Builder clearTaskRunId() { @@ -496,6 +549,11 @@ public Builder clearTaskRunId() { return this; } /** + *
+     * The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived
+     * at this TASK Node, then the task_run_id will be unset.
+     * 
+ * * optional .littlehorse.TaskRunId task_run_id = 1; */ public io.littlehorse.sdk.common.proto.TaskRunId.Builder getTaskRunIdBuilder() { @@ -504,6 +562,11 @@ public io.littlehorse.sdk.common.proto.TaskRunId.Builder getTaskRunIdBuilder() { return getTaskRunIdFieldBuilder().getBuilder(); } /** + *
+     * The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived
+     * at this TASK Node, then the task_run_id will be unset.
+     * 
+ * * optional .littlehorse.TaskRunId task_run_id = 1; */ public io.littlehorse.sdk.common.proto.TaskRunIdOrBuilder getTaskRunIdOrBuilder() { @@ -515,6 +578,11 @@ public io.littlehorse.sdk.common.proto.TaskRunIdOrBuilder getTaskRunIdOrBuilder( } } /** + *
+     * The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived
+     * at this TASK Node, then the task_run_id will be unset.
+     * 
+ * * optional .littlehorse.TaskRunId task_run_id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeRunOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeRunOrBuilder.java index a71502540..53bde1e04 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeRunOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskNodeRunOrBuilder.java @@ -8,16 +8,31 @@ public interface TaskNodeRunOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived
+   * at this TASK Node, then the task_run_id will be unset.
+   * 
+ * * optional .littlehorse.TaskRunId task_run_id = 1; * @return Whether the taskRunId field is set. */ boolean hasTaskRunId(); /** + *
+   * The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived
+   * at this TASK Node, then the task_run_id will be unset.
+   * 
+ * * optional .littlehorse.TaskRunId task_run_id = 1; * @return The taskRunId. */ io.littlehorse.sdk.common.proto.TaskRunId getTaskRunId(); /** + *
+   * The ID of the TaskRun. Note that if the ThreadRun was halted when it arrived
+   * at this TASK Node, then the task_run_id will be unset.
+   * 
+ * * optional .littlehorse.TaskRunId task_run_id = 1; */ io.littlehorse.sdk.common.proto.TaskRunIdOrBuilder getTaskRunIdOrBuilder(); diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRun.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRun.java index c7fb8cd50..1feb832f0 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRun.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRun.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * A TaskRun resents a single instance of a TaskDef being executed.
+ * 
+ * * Protobuf type {@code littlehorse.TaskRun} */ public final class TaskRun extends @@ -44,6 +48,10 @@ protected java.lang.Object newInstance( public static final int ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.TaskRunId id_; /** + *
+   * The ID of the TaskRun. Note that the TaskRunId contains the WfRunId.
+   * 
+ * * .littlehorse.TaskRunId id = 1; * @return Whether the id field is set. */ @@ -52,6 +60,10 @@ public boolean hasId() { return id_ != null; } /** + *
+   * The ID of the TaskRun. Note that the TaskRunId contains the WfRunId.
+   * 
+ * * .littlehorse.TaskRunId id = 1; * @return The id. */ @@ -60,6 +72,10 @@ public io.littlehorse.sdk.common.proto.TaskRunId getId() { return id_ == null ? io.littlehorse.sdk.common.proto.TaskRunId.getDefaultInstance() : id_; } /** + *
+   * The ID of the TaskRun. Note that the TaskRunId contains the WfRunId.
+   * 
+ * * .littlehorse.TaskRunId id = 1; */ @java.lang.Override @@ -70,6 +86,10 @@ public io.littlehorse.sdk.common.proto.TaskRunIdOrBuilder getIdOrBuilder() { public static final int TASK_DEF_ID_FIELD_NUMBER = 2; private io.littlehorse.sdk.common.proto.TaskDefId taskDefId_; /** + *
+   * The ID of the TaskDef being executed.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 2; * @return Whether the taskDefId field is set. */ @@ -78,6 +98,10 @@ public boolean hasTaskDefId() { return taskDefId_ != null; } /** + *
+   * The ID of the TaskDef being executed.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 2; * @return The taskDefId. */ @@ -86,6 +110,10 @@ public io.littlehorse.sdk.common.proto.TaskDefId getTaskDefId() { return taskDefId_ == null ? io.littlehorse.sdk.common.proto.TaskDefId.getDefaultInstance() : taskDefId_; } /** + *
+   * The ID of the TaskDef being executed.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 2; */ @java.lang.Override @@ -97,6 +125,11 @@ public io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder getTaskDefIdOrBuilder( @SuppressWarnings("serial") private java.util.List attempts_; /** + *
+   * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+   * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+   * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ @java.lang.Override @@ -104,6 +137,11 @@ public java.util.List getAttemptsLi return attempts_; } /** + *
+   * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+   * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+   * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ @java.lang.Override @@ -112,6 +150,11 @@ public java.util.List getAttemptsLi return attempts_; } /** + *
+   * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+   * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+   * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ @java.lang.Override @@ -119,6 +162,11 @@ public int getAttemptsCount() { return attempts_.size(); } /** + *
+   * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+   * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+   * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ @java.lang.Override @@ -126,6 +174,11 @@ public io.littlehorse.sdk.common.proto.TaskAttempt getAttempts(int index) { return attempts_.get(index); } /** + *
+   * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+   * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+   * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ @java.lang.Override @@ -137,6 +190,10 @@ public io.littlehorse.sdk.common.proto.TaskAttemptOrBuilder getAttemptsOrBuilder public static final int MAX_ATTEMPTS_FIELD_NUMBER = 4; private int maxAttempts_ = 0; /** + *
+   * The maximum number of attempts that may be scheduled for this TaskRun.
+   * 
+ * * int32 max_attempts = 4; * @return The maxAttempts. */ @@ -149,6 +206,13 @@ public int getMaxAttempts() { @SuppressWarnings("serial") private java.util.List inputVariables_; /** + *
+   * The input variables to pass into this TaskRun. Note that this is a list and not
+   * a map, because ordering matters. Depending on the language implementation, not
+   * every LittleHorse Task Worker SDK has the ability to determine the names of the
+   * variables from the method signature, so we provide both names and ordering.
+   * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ @java.lang.Override @@ -156,6 +220,13 @@ public java.util.List getInputVar return inputVariables_; } /** + *
+   * The input variables to pass into this TaskRun. Note that this is a list and not
+   * a map, because ordering matters. Depending on the language implementation, not
+   * every LittleHorse Task Worker SDK has the ability to determine the names of the
+   * variables from the method signature, so we provide both names and ordering.
+   * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ @java.lang.Override @@ -164,6 +235,13 @@ public java.util.List getInputVar return inputVariables_; } /** + *
+   * The input variables to pass into this TaskRun. Note that this is a list and not
+   * a map, because ordering matters. Depending on the language implementation, not
+   * every LittleHorse Task Worker SDK has the ability to determine the names of the
+   * variables from the method signature, so we provide both names and ordering.
+   * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ @java.lang.Override @@ -171,6 +249,13 @@ public int getInputVariablesCount() { return inputVariables_.size(); } /** + *
+   * The input variables to pass into this TaskRun. Note that this is a list and not
+   * a map, because ordering matters. Depending on the language implementation, not
+   * every LittleHorse Task Worker SDK has the ability to determine the names of the
+   * variables from the method signature, so we provide both names and ordering.
+   * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ @java.lang.Override @@ -178,6 +263,13 @@ public io.littlehorse.sdk.common.proto.VarNameAndVal getInputVariables(int index return inputVariables_.get(index); } /** + *
+   * The input variables to pass into this TaskRun. Note that this is a list and not
+   * a map, because ordering matters. Depending on the language implementation, not
+   * every LittleHorse Task Worker SDK has the ability to determine the names of the
+   * variables from the method signature, so we provide both names and ordering.
+   * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ @java.lang.Override @@ -189,6 +281,12 @@ public io.littlehorse.sdk.common.proto.VarNameAndValOrBuilder getInputVariablesO public static final int SOURCE_FIELD_NUMBER = 6; private io.littlehorse.sdk.common.proto.TaskRunSource source_; /** + *
+   * The source (in the WfRun) that caused this TaskRun to be created. Currently, this
+   * can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such
+   * as a task used to send reminders).
+   * 
+ * * .littlehorse.TaskRunSource source = 6; * @return Whether the source field is set. */ @@ -197,6 +295,12 @@ public boolean hasSource() { return source_ != null; } /** + *
+   * The source (in the WfRun) that caused this TaskRun to be created. Currently, this
+   * can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such
+   * as a task used to send reminders).
+   * 
+ * * .littlehorse.TaskRunSource source = 6; * @return The source. */ @@ -205,6 +309,12 @@ public io.littlehorse.sdk.common.proto.TaskRunSource getSource() { return source_ == null ? io.littlehorse.sdk.common.proto.TaskRunSource.getDefaultInstance() : source_; } /** + *
+   * The source (in the WfRun) that caused this TaskRun to be created. Currently, this
+   * can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such
+   * as a task used to send reminders).
+   * 
+ * * .littlehorse.TaskRunSource source = 6; */ @java.lang.Override @@ -215,6 +325,10 @@ public io.littlehorse.sdk.common.proto.TaskRunSourceOrBuilder getSourceOrBuilder public static final int SCHEDULED_AT_FIELD_NUMBER = 7; private com.google.protobuf.Timestamp scheduledAt_; /** + *
+   * When the TaskRun was scheduled.
+   * 
+ * * .google.protobuf.Timestamp scheduled_at = 7; * @return Whether the scheduledAt field is set. */ @@ -223,6 +337,10 @@ public boolean hasScheduledAt() { return scheduledAt_ != null; } /** + *
+   * When the TaskRun was scheduled.
+   * 
+ * * .google.protobuf.Timestamp scheduled_at = 7; * @return The scheduledAt. */ @@ -231,6 +349,10 @@ public com.google.protobuf.Timestamp getScheduledAt() { return scheduledAt_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : scheduledAt_; } /** + *
+   * When the TaskRun was scheduled.
+   * 
+ * * .google.protobuf.Timestamp scheduled_at = 7; */ @java.lang.Override @@ -241,6 +363,10 @@ public com.google.protobuf.TimestampOrBuilder getScheduledAtOrBuilder() { public static final int STATUS_FIELD_NUMBER = 8; private int status_ = 0; /** + *
+   * The status of the TaskRun.
+   * 
+ * * .littlehorse.TaskStatus status = 8; * @return The enum numeric value on the wire for status. */ @@ -248,6 +374,10 @@ public com.google.protobuf.TimestampOrBuilder getScheduledAtOrBuilder() { return status_; } /** + *
+   * The status of the TaskRun.
+   * 
+ * * .littlehorse.TaskStatus status = 8; * @return The status. */ @@ -259,6 +389,10 @@ public com.google.protobuf.TimestampOrBuilder getScheduledAtOrBuilder() { public static final int TIMEOUT_SECONDS_FIELD_NUMBER = 9; private int timeoutSeconds_ = 0; /** + *
+   * The timeout before LH considers a TaskAttempt to be timed out.
+   * 
+ * * int32 timeout_seconds = 9; * @return The timeoutSeconds. */ @@ -536,6 +670,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * A TaskRun resents a single instance of a TaskDef being executed.
+   * 
+ * * Protobuf type {@code littlehorse.TaskRun} */ public static final class Builder extends @@ -925,6 +1063,10 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.TaskRunId, io.littlehorse.sdk.common.proto.TaskRunId.Builder, io.littlehorse.sdk.common.proto.TaskRunIdOrBuilder> idBuilder_; /** + *
+     * The ID of the TaskRun. Note that the TaskRunId contains the WfRunId.
+     * 
+ * * .littlehorse.TaskRunId id = 1; * @return Whether the id field is set. */ @@ -932,6 +1074,10 @@ public boolean hasId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * The ID of the TaskRun. Note that the TaskRunId contains the WfRunId.
+     * 
+ * * .littlehorse.TaskRunId id = 1; * @return The id. */ @@ -943,6 +1089,10 @@ public io.littlehorse.sdk.common.proto.TaskRunId getId() { } } /** + *
+     * The ID of the TaskRun. Note that the TaskRunId contains the WfRunId.
+     * 
+ * * .littlehorse.TaskRunId id = 1; */ public Builder setId(io.littlehorse.sdk.common.proto.TaskRunId value) { @@ -959,6 +1109,10 @@ public Builder setId(io.littlehorse.sdk.common.proto.TaskRunId value) { return this; } /** + *
+     * The ID of the TaskRun. Note that the TaskRunId contains the WfRunId.
+     * 
+ * * .littlehorse.TaskRunId id = 1; */ public Builder setId( @@ -973,6 +1127,10 @@ public Builder setId( return this; } /** + *
+     * The ID of the TaskRun. Note that the TaskRunId contains the WfRunId.
+     * 
+ * * .littlehorse.TaskRunId id = 1; */ public Builder mergeId(io.littlehorse.sdk.common.proto.TaskRunId value) { @@ -992,6 +1150,10 @@ public Builder mergeId(io.littlehorse.sdk.common.proto.TaskRunId value) { return this; } /** + *
+     * The ID of the TaskRun. Note that the TaskRunId contains the WfRunId.
+     * 
+ * * .littlehorse.TaskRunId id = 1; */ public Builder clearId() { @@ -1005,6 +1167,10 @@ public Builder clearId() { return this; } /** + *
+     * The ID of the TaskRun. Note that the TaskRunId contains the WfRunId.
+     * 
+ * * .littlehorse.TaskRunId id = 1; */ public io.littlehorse.sdk.common.proto.TaskRunId.Builder getIdBuilder() { @@ -1013,6 +1179,10 @@ public io.littlehorse.sdk.common.proto.TaskRunId.Builder getIdBuilder() { return getIdFieldBuilder().getBuilder(); } /** + *
+     * The ID of the TaskRun. Note that the TaskRunId contains the WfRunId.
+     * 
+ * * .littlehorse.TaskRunId id = 1; */ public io.littlehorse.sdk.common.proto.TaskRunIdOrBuilder getIdOrBuilder() { @@ -1024,6 +1194,10 @@ public io.littlehorse.sdk.common.proto.TaskRunIdOrBuilder getIdOrBuilder() { } } /** + *
+     * The ID of the TaskRun. Note that the TaskRunId contains the WfRunId.
+     * 
+ * * .littlehorse.TaskRunId id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1044,6 +1218,10 @@ public io.littlehorse.sdk.common.proto.TaskRunIdOrBuilder getIdOrBuilder() { private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.TaskDefId, io.littlehorse.sdk.common.proto.TaskDefId.Builder, io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder> taskDefIdBuilder_; /** + *
+     * The ID of the TaskDef being executed.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 2; * @return Whether the taskDefId field is set. */ @@ -1051,6 +1229,10 @@ public boolean hasTaskDefId() { return ((bitField0_ & 0x00000002) != 0); } /** + *
+     * The ID of the TaskDef being executed.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 2; * @return The taskDefId. */ @@ -1062,6 +1244,10 @@ public io.littlehorse.sdk.common.proto.TaskDefId getTaskDefId() { } } /** + *
+     * The ID of the TaskDef being executed.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 2; */ public Builder setTaskDefId(io.littlehorse.sdk.common.proto.TaskDefId value) { @@ -1078,6 +1264,10 @@ public Builder setTaskDefId(io.littlehorse.sdk.common.proto.TaskDefId value) { return this; } /** + *
+     * The ID of the TaskDef being executed.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 2; */ public Builder setTaskDefId( @@ -1092,6 +1282,10 @@ public Builder setTaskDefId( return this; } /** + *
+     * The ID of the TaskDef being executed.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 2; */ public Builder mergeTaskDefId(io.littlehorse.sdk.common.proto.TaskDefId value) { @@ -1111,6 +1305,10 @@ public Builder mergeTaskDefId(io.littlehorse.sdk.common.proto.TaskDefId value) { return this; } /** + *
+     * The ID of the TaskDef being executed.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 2; */ public Builder clearTaskDefId() { @@ -1124,6 +1322,10 @@ public Builder clearTaskDefId() { return this; } /** + *
+     * The ID of the TaskDef being executed.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 2; */ public io.littlehorse.sdk.common.proto.TaskDefId.Builder getTaskDefIdBuilder() { @@ -1132,6 +1334,10 @@ public io.littlehorse.sdk.common.proto.TaskDefId.Builder getTaskDefIdBuilder() { return getTaskDefIdFieldBuilder().getBuilder(); } /** + *
+     * The ID of the TaskDef being executed.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 2; */ public io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder getTaskDefIdOrBuilder() { @@ -1143,6 +1349,10 @@ public io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder getTaskDefIdOrBuilder( } } /** + *
+     * The ID of the TaskDef being executed.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 2; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1172,6 +1382,11 @@ private void ensureAttemptsIsMutable() { io.littlehorse.sdk.common.proto.TaskAttempt, io.littlehorse.sdk.common.proto.TaskAttempt.Builder, io.littlehorse.sdk.common.proto.TaskAttemptOrBuilder> attemptsBuilder_; /** + *
+     * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+     * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+     * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ public java.util.List getAttemptsList() { @@ -1182,6 +1397,11 @@ public java.util.List getAttemptsLi } } /** + *
+     * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+     * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+     * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ public int getAttemptsCount() { @@ -1192,6 +1412,11 @@ public int getAttemptsCount() { } } /** + *
+     * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+     * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+     * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ public io.littlehorse.sdk.common.proto.TaskAttempt getAttempts(int index) { @@ -1202,6 +1427,11 @@ public io.littlehorse.sdk.common.proto.TaskAttempt getAttempts(int index) { } } /** + *
+     * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+     * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+     * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ public Builder setAttempts( @@ -1219,6 +1449,11 @@ public Builder setAttempts( return this; } /** + *
+     * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+     * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+     * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ public Builder setAttempts( @@ -1233,6 +1468,11 @@ public Builder setAttempts( return this; } /** + *
+     * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+     * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+     * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ public Builder addAttempts(io.littlehorse.sdk.common.proto.TaskAttempt value) { @@ -1249,6 +1489,11 @@ public Builder addAttempts(io.littlehorse.sdk.common.proto.TaskAttempt value) { return this; } /** + *
+     * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+     * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+     * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ public Builder addAttempts( @@ -1266,6 +1511,11 @@ public Builder addAttempts( return this; } /** + *
+     * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+     * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+     * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ public Builder addAttempts( @@ -1280,6 +1530,11 @@ public Builder addAttempts( return this; } /** + *
+     * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+     * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+     * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ public Builder addAttempts( @@ -1294,6 +1549,11 @@ public Builder addAttempts( return this; } /** + *
+     * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+     * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+     * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ public Builder addAllAttempts( @@ -1309,6 +1569,11 @@ public Builder addAllAttempts( return this; } /** + *
+     * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+     * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+     * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ public Builder clearAttempts() { @@ -1322,6 +1587,11 @@ public Builder clearAttempts() { return this; } /** + *
+     * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+     * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+     * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ public Builder removeAttempts(int index) { @@ -1335,6 +1605,11 @@ public Builder removeAttempts(int index) { return this; } /** + *
+     * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+     * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+     * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ public io.littlehorse.sdk.common.proto.TaskAttempt.Builder getAttemptsBuilder( @@ -1342,6 +1617,11 @@ public io.littlehorse.sdk.common.proto.TaskAttempt.Builder getAttemptsBuilder( return getAttemptsFieldBuilder().getBuilder(index); } /** + *
+     * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+     * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+     * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ public io.littlehorse.sdk.common.proto.TaskAttemptOrBuilder getAttemptsOrBuilder( @@ -1352,6 +1632,11 @@ public io.littlehorse.sdk.common.proto.TaskAttemptOrBuilder getAttemptsOrBuilder } } /** + *
+     * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+     * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+     * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ public java.util.List @@ -1363,6 +1648,11 @@ public io.littlehorse.sdk.common.proto.TaskAttemptOrBuilder getAttemptsOrBuilder } } /** + *
+     * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+     * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+     * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ public io.littlehorse.sdk.common.proto.TaskAttempt.Builder addAttemptsBuilder() { @@ -1370,6 +1660,11 @@ public io.littlehorse.sdk.common.proto.TaskAttempt.Builder addAttemptsBuilder() io.littlehorse.sdk.common.proto.TaskAttempt.getDefaultInstance()); } /** + *
+     * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+     * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+     * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ public io.littlehorse.sdk.common.proto.TaskAttempt.Builder addAttemptsBuilder( @@ -1378,6 +1673,11 @@ public io.littlehorse.sdk.common.proto.TaskAttempt.Builder addAttemptsBuilder( index, io.littlehorse.sdk.common.proto.TaskAttempt.getDefaultInstance()); } /** + *
+     * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+     * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+     * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ public java.util.List @@ -1401,6 +1701,10 @@ public io.littlehorse.sdk.common.proto.TaskAttempt.Builder addAttemptsBuilder( private int maxAttempts_ ; /** + *
+     * The maximum number of attempts that may be scheduled for this TaskRun.
+     * 
+ * * int32 max_attempts = 4; * @return The maxAttempts. */ @@ -1409,6 +1713,10 @@ public int getMaxAttempts() { return maxAttempts_; } /** + *
+     * The maximum number of attempts that may be scheduled for this TaskRun.
+     * 
+ * * int32 max_attempts = 4; * @param value The maxAttempts to set. * @return This builder for chaining. @@ -1421,6 +1729,10 @@ public Builder setMaxAttempts(int value) { return this; } /** + *
+     * The maximum number of attempts that may be scheduled for this TaskRun.
+     * 
+ * * int32 max_attempts = 4; * @return This builder for chaining. */ @@ -1444,6 +1756,13 @@ private void ensureInputVariablesIsMutable() { io.littlehorse.sdk.common.proto.VarNameAndVal, io.littlehorse.sdk.common.proto.VarNameAndVal.Builder, io.littlehorse.sdk.common.proto.VarNameAndValOrBuilder> inputVariablesBuilder_; /** + *
+     * The input variables to pass into this TaskRun. Note that this is a list and not
+     * a map, because ordering matters. Depending on the language implementation, not
+     * every LittleHorse Task Worker SDK has the ability to determine the names of the
+     * variables from the method signature, so we provide both names and ordering.
+     * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ public java.util.List getInputVariablesList() { @@ -1454,6 +1773,13 @@ public java.util.List getInputVar } } /** + *
+     * The input variables to pass into this TaskRun. Note that this is a list and not
+     * a map, because ordering matters. Depending on the language implementation, not
+     * every LittleHorse Task Worker SDK has the ability to determine the names of the
+     * variables from the method signature, so we provide both names and ordering.
+     * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ public int getInputVariablesCount() { @@ -1464,6 +1790,13 @@ public int getInputVariablesCount() { } } /** + *
+     * The input variables to pass into this TaskRun. Note that this is a list and not
+     * a map, because ordering matters. Depending on the language implementation, not
+     * every LittleHorse Task Worker SDK has the ability to determine the names of the
+     * variables from the method signature, so we provide both names and ordering.
+     * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ public io.littlehorse.sdk.common.proto.VarNameAndVal getInputVariables(int index) { @@ -1474,6 +1807,13 @@ public io.littlehorse.sdk.common.proto.VarNameAndVal getInputVariables(int index } } /** + *
+     * The input variables to pass into this TaskRun. Note that this is a list and not
+     * a map, because ordering matters. Depending on the language implementation, not
+     * every LittleHorse Task Worker SDK has the ability to determine the names of the
+     * variables from the method signature, so we provide both names and ordering.
+     * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ public Builder setInputVariables( @@ -1491,6 +1831,13 @@ public Builder setInputVariables( return this; } /** + *
+     * The input variables to pass into this TaskRun. Note that this is a list and not
+     * a map, because ordering matters. Depending on the language implementation, not
+     * every LittleHorse Task Worker SDK has the ability to determine the names of the
+     * variables from the method signature, so we provide both names and ordering.
+     * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ public Builder setInputVariables( @@ -1505,6 +1852,13 @@ public Builder setInputVariables( return this; } /** + *
+     * The input variables to pass into this TaskRun. Note that this is a list and not
+     * a map, because ordering matters. Depending on the language implementation, not
+     * every LittleHorse Task Worker SDK has the ability to determine the names of the
+     * variables from the method signature, so we provide both names and ordering.
+     * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ public Builder addInputVariables(io.littlehorse.sdk.common.proto.VarNameAndVal value) { @@ -1521,6 +1875,13 @@ public Builder addInputVariables(io.littlehorse.sdk.common.proto.VarNameAndVal v return this; } /** + *
+     * The input variables to pass into this TaskRun. Note that this is a list and not
+     * a map, because ordering matters. Depending on the language implementation, not
+     * every LittleHorse Task Worker SDK has the ability to determine the names of the
+     * variables from the method signature, so we provide both names and ordering.
+     * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ public Builder addInputVariables( @@ -1538,6 +1899,13 @@ public Builder addInputVariables( return this; } /** + *
+     * The input variables to pass into this TaskRun. Note that this is a list and not
+     * a map, because ordering matters. Depending on the language implementation, not
+     * every LittleHorse Task Worker SDK has the ability to determine the names of the
+     * variables from the method signature, so we provide both names and ordering.
+     * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ public Builder addInputVariables( @@ -1552,6 +1920,13 @@ public Builder addInputVariables( return this; } /** + *
+     * The input variables to pass into this TaskRun. Note that this is a list and not
+     * a map, because ordering matters. Depending on the language implementation, not
+     * every LittleHorse Task Worker SDK has the ability to determine the names of the
+     * variables from the method signature, so we provide both names and ordering.
+     * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ public Builder addInputVariables( @@ -1566,6 +1941,13 @@ public Builder addInputVariables( return this; } /** + *
+     * The input variables to pass into this TaskRun. Note that this is a list and not
+     * a map, because ordering matters. Depending on the language implementation, not
+     * every LittleHorse Task Worker SDK has the ability to determine the names of the
+     * variables from the method signature, so we provide both names and ordering.
+     * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ public Builder addAllInputVariables( @@ -1581,6 +1963,13 @@ public Builder addAllInputVariables( return this; } /** + *
+     * The input variables to pass into this TaskRun. Note that this is a list and not
+     * a map, because ordering matters. Depending on the language implementation, not
+     * every LittleHorse Task Worker SDK has the ability to determine the names of the
+     * variables from the method signature, so we provide both names and ordering.
+     * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ public Builder clearInputVariables() { @@ -1594,6 +1983,13 @@ public Builder clearInputVariables() { return this; } /** + *
+     * The input variables to pass into this TaskRun. Note that this is a list and not
+     * a map, because ordering matters. Depending on the language implementation, not
+     * every LittleHorse Task Worker SDK has the ability to determine the names of the
+     * variables from the method signature, so we provide both names and ordering.
+     * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ public Builder removeInputVariables(int index) { @@ -1607,6 +2003,13 @@ public Builder removeInputVariables(int index) { return this; } /** + *
+     * The input variables to pass into this TaskRun. Note that this is a list and not
+     * a map, because ordering matters. Depending on the language implementation, not
+     * every LittleHorse Task Worker SDK has the ability to determine the names of the
+     * variables from the method signature, so we provide both names and ordering.
+     * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ public io.littlehorse.sdk.common.proto.VarNameAndVal.Builder getInputVariablesBuilder( @@ -1614,6 +2017,13 @@ public io.littlehorse.sdk.common.proto.VarNameAndVal.Builder getInputVariablesBu return getInputVariablesFieldBuilder().getBuilder(index); } /** + *
+     * The input variables to pass into this TaskRun. Note that this is a list and not
+     * a map, because ordering matters. Depending on the language implementation, not
+     * every LittleHorse Task Worker SDK has the ability to determine the names of the
+     * variables from the method signature, so we provide both names and ordering.
+     * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ public io.littlehorse.sdk.common.proto.VarNameAndValOrBuilder getInputVariablesOrBuilder( @@ -1624,6 +2034,13 @@ public io.littlehorse.sdk.common.proto.VarNameAndValOrBuilder getInputVariablesO } } /** + *
+     * The input variables to pass into this TaskRun. Note that this is a list and not
+     * a map, because ordering matters. Depending on the language implementation, not
+     * every LittleHorse Task Worker SDK has the ability to determine the names of the
+     * variables from the method signature, so we provide both names and ordering.
+     * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ public java.util.List @@ -1635,6 +2052,13 @@ public io.littlehorse.sdk.common.proto.VarNameAndValOrBuilder getInputVariablesO } } /** + *
+     * The input variables to pass into this TaskRun. Note that this is a list and not
+     * a map, because ordering matters. Depending on the language implementation, not
+     * every LittleHorse Task Worker SDK has the ability to determine the names of the
+     * variables from the method signature, so we provide both names and ordering.
+     * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ public io.littlehorse.sdk.common.proto.VarNameAndVal.Builder addInputVariablesBuilder() { @@ -1642,6 +2066,13 @@ public io.littlehorse.sdk.common.proto.VarNameAndVal.Builder addInputVariablesBu io.littlehorse.sdk.common.proto.VarNameAndVal.getDefaultInstance()); } /** + *
+     * The input variables to pass into this TaskRun. Note that this is a list and not
+     * a map, because ordering matters. Depending on the language implementation, not
+     * every LittleHorse Task Worker SDK has the ability to determine the names of the
+     * variables from the method signature, so we provide both names and ordering.
+     * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ public io.littlehorse.sdk.common.proto.VarNameAndVal.Builder addInputVariablesBuilder( @@ -1650,6 +2081,13 @@ public io.littlehorse.sdk.common.proto.VarNameAndVal.Builder addInputVariablesBu index, io.littlehorse.sdk.common.proto.VarNameAndVal.getDefaultInstance()); } /** + *
+     * The input variables to pass into this TaskRun. Note that this is a list and not
+     * a map, because ordering matters. Depending on the language implementation, not
+     * every LittleHorse Task Worker SDK has the ability to determine the names of the
+     * variables from the method signature, so we provide both names and ordering.
+     * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ public java.util.List @@ -1675,6 +2113,12 @@ public io.littlehorse.sdk.common.proto.VarNameAndVal.Builder addInputVariablesBu private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.TaskRunSource, io.littlehorse.sdk.common.proto.TaskRunSource.Builder, io.littlehorse.sdk.common.proto.TaskRunSourceOrBuilder> sourceBuilder_; /** + *
+     * The source (in the WfRun) that caused this TaskRun to be created. Currently, this
+     * can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such
+     * as a task used to send reminders).
+     * 
+ * * .littlehorse.TaskRunSource source = 6; * @return Whether the source field is set. */ @@ -1682,6 +2126,12 @@ public boolean hasSource() { return ((bitField0_ & 0x00000020) != 0); } /** + *
+     * The source (in the WfRun) that caused this TaskRun to be created. Currently, this
+     * can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such
+     * as a task used to send reminders).
+     * 
+ * * .littlehorse.TaskRunSource source = 6; * @return The source. */ @@ -1693,6 +2143,12 @@ public io.littlehorse.sdk.common.proto.TaskRunSource getSource() { } } /** + *
+     * The source (in the WfRun) that caused this TaskRun to be created. Currently, this
+     * can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such
+     * as a task used to send reminders).
+     * 
+ * * .littlehorse.TaskRunSource source = 6; */ public Builder setSource(io.littlehorse.sdk.common.proto.TaskRunSource value) { @@ -1709,6 +2165,12 @@ public Builder setSource(io.littlehorse.sdk.common.proto.TaskRunSource value) { return this; } /** + *
+     * The source (in the WfRun) that caused this TaskRun to be created. Currently, this
+     * can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such
+     * as a task used to send reminders).
+     * 
+ * * .littlehorse.TaskRunSource source = 6; */ public Builder setSource( @@ -1723,6 +2185,12 @@ public Builder setSource( return this; } /** + *
+     * The source (in the WfRun) that caused this TaskRun to be created. Currently, this
+     * can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such
+     * as a task used to send reminders).
+     * 
+ * * .littlehorse.TaskRunSource source = 6; */ public Builder mergeSource(io.littlehorse.sdk.common.proto.TaskRunSource value) { @@ -1742,6 +2210,12 @@ public Builder mergeSource(io.littlehorse.sdk.common.proto.TaskRunSource value) return this; } /** + *
+     * The source (in the WfRun) that caused this TaskRun to be created. Currently, this
+     * can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such
+     * as a task used to send reminders).
+     * 
+ * * .littlehorse.TaskRunSource source = 6; */ public Builder clearSource() { @@ -1755,6 +2229,12 @@ public Builder clearSource() { return this; } /** + *
+     * The source (in the WfRun) that caused this TaskRun to be created. Currently, this
+     * can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such
+     * as a task used to send reminders).
+     * 
+ * * .littlehorse.TaskRunSource source = 6; */ public io.littlehorse.sdk.common.proto.TaskRunSource.Builder getSourceBuilder() { @@ -1763,6 +2243,12 @@ public io.littlehorse.sdk.common.proto.TaskRunSource.Builder getSourceBuilder() return getSourceFieldBuilder().getBuilder(); } /** + *
+     * The source (in the WfRun) that caused this TaskRun to be created. Currently, this
+     * can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such
+     * as a task used to send reminders).
+     * 
+ * * .littlehorse.TaskRunSource source = 6; */ public io.littlehorse.sdk.common.proto.TaskRunSourceOrBuilder getSourceOrBuilder() { @@ -1774,6 +2260,12 @@ public io.littlehorse.sdk.common.proto.TaskRunSourceOrBuilder getSourceOrBuilder } } /** + *
+     * The source (in the WfRun) that caused this TaskRun to be created. Currently, this
+     * can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such
+     * as a task used to send reminders).
+     * 
+ * * .littlehorse.TaskRunSource source = 6; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1794,6 +2286,10 @@ public io.littlehorse.sdk.common.proto.TaskRunSourceOrBuilder getSourceOrBuilder private com.google.protobuf.SingleFieldBuilderV3< com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> scheduledAtBuilder_; /** + *
+     * When the TaskRun was scheduled.
+     * 
+ * * .google.protobuf.Timestamp scheduled_at = 7; * @return Whether the scheduledAt field is set. */ @@ -1801,6 +2297,10 @@ public boolean hasScheduledAt() { return ((bitField0_ & 0x00000040) != 0); } /** + *
+     * When the TaskRun was scheduled.
+     * 
+ * * .google.protobuf.Timestamp scheduled_at = 7; * @return The scheduledAt. */ @@ -1812,6 +2312,10 @@ public com.google.protobuf.Timestamp getScheduledAt() { } } /** + *
+     * When the TaskRun was scheduled.
+     * 
+ * * .google.protobuf.Timestamp scheduled_at = 7; */ public Builder setScheduledAt(com.google.protobuf.Timestamp value) { @@ -1828,6 +2332,10 @@ public Builder setScheduledAt(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * When the TaskRun was scheduled.
+     * 
+ * * .google.protobuf.Timestamp scheduled_at = 7; */ public Builder setScheduledAt( @@ -1842,6 +2350,10 @@ public Builder setScheduledAt( return this; } /** + *
+     * When the TaskRun was scheduled.
+     * 
+ * * .google.protobuf.Timestamp scheduled_at = 7; */ public Builder mergeScheduledAt(com.google.protobuf.Timestamp value) { @@ -1861,6 +2373,10 @@ public Builder mergeScheduledAt(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * When the TaskRun was scheduled.
+     * 
+ * * .google.protobuf.Timestamp scheduled_at = 7; */ public Builder clearScheduledAt() { @@ -1874,6 +2390,10 @@ public Builder clearScheduledAt() { return this; } /** + *
+     * When the TaskRun was scheduled.
+     * 
+ * * .google.protobuf.Timestamp scheduled_at = 7; */ public com.google.protobuf.Timestamp.Builder getScheduledAtBuilder() { @@ -1882,6 +2402,10 @@ public com.google.protobuf.Timestamp.Builder getScheduledAtBuilder() { return getScheduledAtFieldBuilder().getBuilder(); } /** + *
+     * When the TaskRun was scheduled.
+     * 
+ * * .google.protobuf.Timestamp scheduled_at = 7; */ public com.google.protobuf.TimestampOrBuilder getScheduledAtOrBuilder() { @@ -1893,6 +2417,10 @@ public com.google.protobuf.TimestampOrBuilder getScheduledAtOrBuilder() { } } /** + *
+     * When the TaskRun was scheduled.
+     * 
+ * * .google.protobuf.Timestamp scheduled_at = 7; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1911,6 +2439,10 @@ public com.google.protobuf.TimestampOrBuilder getScheduledAtOrBuilder() { private int status_ = 0; /** + *
+     * The status of the TaskRun.
+     * 
+ * * .littlehorse.TaskStatus status = 8; * @return The enum numeric value on the wire for status. */ @@ -1918,6 +2450,10 @@ public com.google.protobuf.TimestampOrBuilder getScheduledAtOrBuilder() { return status_; } /** + *
+     * The status of the TaskRun.
+     * 
+ * * .littlehorse.TaskStatus status = 8; * @param value The enum numeric value on the wire for status to set. * @return This builder for chaining. @@ -1929,6 +2465,10 @@ public Builder setStatusValue(int value) { return this; } /** + *
+     * The status of the TaskRun.
+     * 
+ * * .littlehorse.TaskStatus status = 8; * @return The status. */ @@ -1938,6 +2478,10 @@ public io.littlehorse.sdk.common.proto.TaskStatus getStatus() { return result == null ? io.littlehorse.sdk.common.proto.TaskStatus.UNRECOGNIZED : result; } /** + *
+     * The status of the TaskRun.
+     * 
+ * * .littlehorse.TaskStatus status = 8; * @param value The status to set. * @return This builder for chaining. @@ -1952,6 +2496,10 @@ public Builder setStatus(io.littlehorse.sdk.common.proto.TaskStatus value) { return this; } /** + *
+     * The status of the TaskRun.
+     * 
+ * * .littlehorse.TaskStatus status = 8; * @return This builder for chaining. */ @@ -1964,6 +2512,10 @@ public Builder clearStatus() { private int timeoutSeconds_ ; /** + *
+     * The timeout before LH considers a TaskAttempt to be timed out.
+     * 
+ * * int32 timeout_seconds = 9; * @return The timeoutSeconds. */ @@ -1972,6 +2524,10 @@ public int getTimeoutSeconds() { return timeoutSeconds_; } /** + *
+     * The timeout before LH considers a TaskAttempt to be timed out.
+     * 
+ * * int32 timeout_seconds = 9; * @param value The timeoutSeconds to set. * @return This builder for chaining. @@ -1984,6 +2540,10 @@ public Builder setTimeoutSeconds(int value) { return this; } /** + *
+     * The timeout before LH considers a TaskAttempt to be timed out.
+     * 
+ * * int32 timeout_seconds = 9; * @return This builder for chaining. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunId.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunId.java index 1822ba1ab..1457acd3f 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunId.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunId.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * ID for a TaskRun.
+ * 
+ * * Protobuf type {@code littlehorse.TaskRunId} */ public final class TaskRunId extends @@ -42,6 +46,11 @@ protected java.lang.Object newInstance( public static final int WF_RUN_ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.WfRunId wfRunId_; /** + *
+   * WfRunId for this TaskRun. Note that every TaskRun is associated with
+   * a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return Whether the wfRunId field is set. */ @@ -50,6 +59,11 @@ public boolean hasWfRunId() { return wfRunId_ != null; } /** + *
+   * WfRunId for this TaskRun. Note that every TaskRun is associated with
+   * a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return The wfRunId. */ @@ -58,6 +72,11 @@ public io.littlehorse.sdk.common.proto.WfRunId getWfRunId() { return wfRunId_ == null ? io.littlehorse.sdk.common.proto.WfRunId.getDefaultInstance() : wfRunId_; } /** + *
+   * WfRunId for this TaskRun. Note that every TaskRun is associated with
+   * a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ @java.lang.Override @@ -69,6 +88,10 @@ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { @SuppressWarnings("serial") private volatile java.lang.Object taskGuid_ = ""; /** + *
+   * Unique identifier for this TaskRun. Unique among the WfRun.
+   * 
+ * * string task_guid = 2; * @return The taskGuid. */ @@ -86,6 +109,10 @@ public java.lang.String getTaskGuid() { } } /** + *
+   * Unique identifier for this TaskRun. Unique among the WfRun.
+   * 
+ * * string task_guid = 2; * @return The bytes for taskGuid. */ @@ -277,6 +304,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * ID for a TaskRun.
+   * 
+ * * Protobuf type {@code littlehorse.TaskRunId} */ public static final class Builder extends @@ -470,6 +501,11 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.WfRunId, io.littlehorse.sdk.common.proto.WfRunId.Builder, io.littlehorse.sdk.common.proto.WfRunIdOrBuilder> wfRunIdBuilder_; /** + *
+     * WfRunId for this TaskRun. Note that every TaskRun is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return Whether the wfRunId field is set. */ @@ -477,6 +513,11 @@ public boolean hasWfRunId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * WfRunId for this TaskRun. Note that every TaskRun is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return The wfRunId. */ @@ -488,6 +529,11 @@ public io.littlehorse.sdk.common.proto.WfRunId getWfRunId() { } } /** + *
+     * WfRunId for this TaskRun. Note that every TaskRun is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder setWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { @@ -504,6 +550,11 @@ public Builder setWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { return this; } /** + *
+     * WfRunId for this TaskRun. Note that every TaskRun is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder setWfRunId( @@ -518,6 +569,11 @@ public Builder setWfRunId( return this; } /** + *
+     * WfRunId for this TaskRun. Note that every TaskRun is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder mergeWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { @@ -537,6 +593,11 @@ public Builder mergeWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { return this; } /** + *
+     * WfRunId for this TaskRun. Note that every TaskRun is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder clearWfRunId() { @@ -550,6 +611,11 @@ public Builder clearWfRunId() { return this; } /** + *
+     * WfRunId for this TaskRun. Note that every TaskRun is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public io.littlehorse.sdk.common.proto.WfRunId.Builder getWfRunIdBuilder() { @@ -558,6 +624,11 @@ public io.littlehorse.sdk.common.proto.WfRunId.Builder getWfRunIdBuilder() { return getWfRunIdFieldBuilder().getBuilder(); } /** + *
+     * WfRunId for this TaskRun. Note that every TaskRun is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { @@ -569,6 +640,11 @@ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { } } /** + *
+     * WfRunId for this TaskRun. Note that every TaskRun is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -587,6 +663,10 @@ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { private java.lang.Object taskGuid_ = ""; /** + *
+     * Unique identifier for this TaskRun. Unique among the WfRun.
+     * 
+ * * string task_guid = 2; * @return The taskGuid. */ @@ -603,6 +683,10 @@ public java.lang.String getTaskGuid() { } } /** + *
+     * Unique identifier for this TaskRun. Unique among the WfRun.
+     * 
+ * * string task_guid = 2; * @return The bytes for taskGuid. */ @@ -620,6 +704,10 @@ public java.lang.String getTaskGuid() { } } /** + *
+     * Unique identifier for this TaskRun. Unique among the WfRun.
+     * 
+ * * string task_guid = 2; * @param value The taskGuid to set. * @return This builder for chaining. @@ -633,6 +721,10 @@ public Builder setTaskGuid( return this; } /** + *
+     * Unique identifier for this TaskRun. Unique among the WfRun.
+     * 
+ * * string task_guid = 2; * @return This builder for chaining. */ @@ -643,6 +735,10 @@ public Builder clearTaskGuid() { return this; } /** + *
+     * Unique identifier for this TaskRun. Unique among the WfRun.
+     * 
+ * * string task_guid = 2; * @param value The bytes for taskGuid to set. * @return This builder for chaining. diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunIdOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunIdOrBuilder.java index b1b3c27a6..9b62bb15d 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunIdOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunIdOrBuilder.java @@ -8,26 +8,49 @@ public interface TaskRunIdOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * WfRunId for this TaskRun. Note that every TaskRun is associated with
+   * a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return Whether the wfRunId field is set. */ boolean hasWfRunId(); /** + *
+   * WfRunId for this TaskRun. Note that every TaskRun is associated with
+   * a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return The wfRunId. */ io.littlehorse.sdk.common.proto.WfRunId getWfRunId(); /** + *
+   * WfRunId for this TaskRun. Note that every TaskRun is associated with
+   * a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder(); /** + *
+   * Unique identifier for this TaskRun. Unique among the WfRun.
+   * 
+ * * string task_guid = 2; * @return The taskGuid. */ java.lang.String getTaskGuid(); /** + *
+   * Unique identifier for this TaskRun. Unique among the WfRun.
+   * 
+ * * string task_guid = 2; * @return The bytes for taskGuid. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunOrBuilder.java index 5e1adc65a..5e5f0e708 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunOrBuilder.java @@ -8,131 +8,261 @@ public interface TaskRunOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The ID of the TaskRun. Note that the TaskRunId contains the WfRunId.
+   * 
+ * * .littlehorse.TaskRunId id = 1; * @return Whether the id field is set. */ boolean hasId(); /** + *
+   * The ID of the TaskRun. Note that the TaskRunId contains the WfRunId.
+   * 
+ * * .littlehorse.TaskRunId id = 1; * @return The id. */ io.littlehorse.sdk.common.proto.TaskRunId getId(); /** + *
+   * The ID of the TaskRun. Note that the TaskRunId contains the WfRunId.
+   * 
+ * * .littlehorse.TaskRunId id = 1; */ io.littlehorse.sdk.common.proto.TaskRunIdOrBuilder getIdOrBuilder(); /** + *
+   * The ID of the TaskDef being executed.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 2; * @return Whether the taskDefId field is set. */ boolean hasTaskDefId(); /** + *
+   * The ID of the TaskDef being executed.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 2; * @return The taskDefId. */ io.littlehorse.sdk.common.proto.TaskDefId getTaskDefId(); /** + *
+   * The ID of the TaskDef being executed.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 2; */ io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder getTaskDefIdOrBuilder(); /** + *
+   * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+   * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+   * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ java.util.List getAttemptsList(); /** + *
+   * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+   * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+   * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ io.littlehorse.sdk.common.proto.TaskAttempt getAttempts(int index); /** + *
+   * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+   * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+   * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ int getAttemptsCount(); /** + *
+   * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+   * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+   * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ java.util.List getAttemptsOrBuilderList(); /** + *
+   * All attempts scheduled for this TaskRun. A TaskAttempt represents an occurrence of
+   * the TaskRun being put on a Task Queue to be executed by the Task Workers.
+   * 
+ * * repeated .littlehorse.TaskAttempt attempts = 3; */ io.littlehorse.sdk.common.proto.TaskAttemptOrBuilder getAttemptsOrBuilder( int index); /** + *
+   * The maximum number of attempts that may be scheduled for this TaskRun.
+   * 
+ * * int32 max_attempts = 4; * @return The maxAttempts. */ int getMaxAttempts(); /** + *
+   * The input variables to pass into this TaskRun. Note that this is a list and not
+   * a map, because ordering matters. Depending on the language implementation, not
+   * every LittleHorse Task Worker SDK has the ability to determine the names of the
+   * variables from the method signature, so we provide both names and ordering.
+   * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ java.util.List getInputVariablesList(); /** + *
+   * The input variables to pass into this TaskRun. Note that this is a list and not
+   * a map, because ordering matters. Depending on the language implementation, not
+   * every LittleHorse Task Worker SDK has the ability to determine the names of the
+   * variables from the method signature, so we provide both names and ordering.
+   * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ io.littlehorse.sdk.common.proto.VarNameAndVal getInputVariables(int index); /** + *
+   * The input variables to pass into this TaskRun. Note that this is a list and not
+   * a map, because ordering matters. Depending on the language implementation, not
+   * every LittleHorse Task Worker SDK has the ability to determine the names of the
+   * variables from the method signature, so we provide both names and ordering.
+   * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ int getInputVariablesCount(); /** + *
+   * The input variables to pass into this TaskRun. Note that this is a list and not
+   * a map, because ordering matters. Depending on the language implementation, not
+   * every LittleHorse Task Worker SDK has the ability to determine the names of the
+   * variables from the method signature, so we provide both names and ordering.
+   * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ java.util.List getInputVariablesOrBuilderList(); /** + *
+   * The input variables to pass into this TaskRun. Note that this is a list and not
+   * a map, because ordering matters. Depending on the language implementation, not
+   * every LittleHorse Task Worker SDK has the ability to determine the names of the
+   * variables from the method signature, so we provide both names and ordering.
+   * 
+ * * repeated .littlehorse.VarNameAndVal input_variables = 5; */ io.littlehorse.sdk.common.proto.VarNameAndValOrBuilder getInputVariablesOrBuilder( int index); /** + *
+   * The source (in the WfRun) that caused this TaskRun to be created. Currently, this
+   * can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such
+   * as a task used to send reminders).
+   * 
+ * * .littlehorse.TaskRunSource source = 6; * @return Whether the source field is set. */ boolean hasSource(); /** + *
+   * The source (in the WfRun) that caused this TaskRun to be created. Currently, this
+   * can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such
+   * as a task used to send reminders).
+   * 
+ * * .littlehorse.TaskRunSource source = 6; * @return The source. */ io.littlehorse.sdk.common.proto.TaskRunSource getSource(); /** + *
+   * The source (in the WfRun) that caused this TaskRun to be created. Currently, this
+   * can be either a TASK node, or a User Task Action Task Trigger in a USER_TASK node (such
+   * as a task used to send reminders).
+   * 
+ * * .littlehorse.TaskRunSource source = 6; */ io.littlehorse.sdk.common.proto.TaskRunSourceOrBuilder getSourceOrBuilder(); /** + *
+   * When the TaskRun was scheduled.
+   * 
+ * * .google.protobuf.Timestamp scheduled_at = 7; * @return Whether the scheduledAt field is set. */ boolean hasScheduledAt(); /** + *
+   * When the TaskRun was scheduled.
+   * 
+ * * .google.protobuf.Timestamp scheduled_at = 7; * @return The scheduledAt. */ com.google.protobuf.Timestamp getScheduledAt(); /** + *
+   * When the TaskRun was scheduled.
+   * 
+ * * .google.protobuf.Timestamp scheduled_at = 7; */ com.google.protobuf.TimestampOrBuilder getScheduledAtOrBuilder(); /** + *
+   * The status of the TaskRun.
+   * 
+ * * .littlehorse.TaskStatus status = 8; * @return The enum numeric value on the wire for status. */ int getStatusValue(); /** + *
+   * The status of the TaskRun.
+   * 
+ * * .littlehorse.TaskStatus status = 8; * @return The status. */ io.littlehorse.sdk.common.proto.TaskStatus getStatus(); /** + *
+   * The timeout before LH considers a TaskAttempt to be timed out.
+   * 
+ * * int32 timeout_seconds = 9; * @return The timeoutSeconds. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunSource.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunSource.java index 880b1eb78..c36972056 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunSource.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunSource.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * The source of a TaskRun; i.e. why it was scheduled.
+ * 
+ * * Protobuf type {@code littlehorse.TaskRunSource} */ public final class TaskRunSource extends @@ -83,6 +87,10 @@ public int getNumber() { public static final int TASK_NODE_FIELD_NUMBER = 1; /** + *
+   * Reference to a NodeRun of type TASK which scheduled this TaskRun.
+   * 
+ * * .littlehorse.TaskNodeReference task_node = 1; * @return Whether the taskNode field is set. */ @@ -91,6 +99,10 @@ public boolean hasTaskNode() { return taskRunSourceCase_ == 1; } /** + *
+   * Reference to a NodeRun of type TASK which scheduled this TaskRun.
+   * 
+ * * .littlehorse.TaskNodeReference task_node = 1; * @return The taskNode. */ @@ -102,6 +114,10 @@ public io.littlehorse.sdk.common.proto.TaskNodeReference getTaskNode() { return io.littlehorse.sdk.common.proto.TaskNodeReference.getDefaultInstance(); } /** + *
+   * Reference to a NodeRun of type TASK which scheduled this TaskRun.
+   * 
+ * * .littlehorse.TaskNodeReference task_node = 1; */ @java.lang.Override @@ -114,6 +130,10 @@ public io.littlehorse.sdk.common.proto.TaskNodeReferenceOrBuilder getTaskNodeOrB public static final int USER_TASK_TRIGGER_FIELD_NUMBER = 2; /** + *
+   * Reference to the specific UserTaskRun trigger action which scheduled this TaskRun
+   * 
+ * * .littlehorse.UserTaskTriggerReference user_task_trigger = 2; * @return Whether the userTaskTrigger field is set. */ @@ -122,6 +142,10 @@ public boolean hasUserTaskTrigger() { return taskRunSourceCase_ == 2; } /** + *
+   * Reference to the specific UserTaskRun trigger action which scheduled this TaskRun
+   * 
+ * * .littlehorse.UserTaskTriggerReference user_task_trigger = 2; * @return The userTaskTrigger. */ @@ -133,6 +157,10 @@ public io.littlehorse.sdk.common.proto.UserTaskTriggerReference getUserTaskTrigg return io.littlehorse.sdk.common.proto.UserTaskTriggerReference.getDefaultInstance(); } /** + *
+   * Reference to the specific UserTaskRun trigger action which scheduled this TaskRun
+   * 
+ * * .littlehorse.UserTaskTriggerReference user_task_trigger = 2; */ @java.lang.Override @@ -146,6 +174,11 @@ public io.littlehorse.sdk.common.proto.UserTaskTriggerReferenceOrBuilder getUser public static final int WF_SPEC_ID_FIELD_NUMBER = 3; private io.littlehorse.sdk.common.proto.WfSpecId wfSpecId_; /** + *
+   * The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so
+   * that the WorkerContext can know this information.
+   * 
+ * * optional .littlehorse.WfSpecId wf_spec_id = 3; * @return Whether the wfSpecId field is set. */ @@ -154,6 +187,11 @@ public boolean hasWfSpecId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+   * The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so
+   * that the WorkerContext can know this information.
+   * 
+ * * optional .littlehorse.WfSpecId wf_spec_id = 3; * @return The wfSpecId. */ @@ -162,6 +200,11 @@ public io.littlehorse.sdk.common.proto.WfSpecId getWfSpecId() { return wfSpecId_ == null ? io.littlehorse.sdk.common.proto.WfSpecId.getDefaultInstance() : wfSpecId_; } /** + *
+   * The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so
+   * that the WorkerContext can know this information.
+   * 
+ * * optional .littlehorse.WfSpecId wf_spec_id = 3; */ @java.lang.Override @@ -371,6 +414,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * The source of a TaskRun; i.e. why it was scheduled.
+   * 
+ * * Protobuf type {@code littlehorse.TaskRunSource} */ public static final class Builder extends @@ -622,6 +669,10 @@ public Builder clearTaskRunSource() { private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.TaskNodeReference, io.littlehorse.sdk.common.proto.TaskNodeReference.Builder, io.littlehorse.sdk.common.proto.TaskNodeReferenceOrBuilder> taskNodeBuilder_; /** + *
+     * Reference to a NodeRun of type TASK which scheduled this TaskRun.
+     * 
+ * * .littlehorse.TaskNodeReference task_node = 1; * @return Whether the taskNode field is set. */ @@ -630,6 +681,10 @@ public boolean hasTaskNode() { return taskRunSourceCase_ == 1; } /** + *
+     * Reference to a NodeRun of type TASK which scheduled this TaskRun.
+     * 
+ * * .littlehorse.TaskNodeReference task_node = 1; * @return The taskNode. */ @@ -648,6 +703,10 @@ public io.littlehorse.sdk.common.proto.TaskNodeReference getTaskNode() { } } /** + *
+     * Reference to a NodeRun of type TASK which scheduled this TaskRun.
+     * 
+ * * .littlehorse.TaskNodeReference task_node = 1; */ public Builder setTaskNode(io.littlehorse.sdk.common.proto.TaskNodeReference value) { @@ -664,6 +723,10 @@ public Builder setTaskNode(io.littlehorse.sdk.common.proto.TaskNodeReference val return this; } /** + *
+     * Reference to a NodeRun of type TASK which scheduled this TaskRun.
+     * 
+ * * .littlehorse.TaskNodeReference task_node = 1; */ public Builder setTaskNode( @@ -678,6 +741,10 @@ public Builder setTaskNode( return this; } /** + *
+     * Reference to a NodeRun of type TASK which scheduled this TaskRun.
+     * 
+ * * .littlehorse.TaskNodeReference task_node = 1; */ public Builder mergeTaskNode(io.littlehorse.sdk.common.proto.TaskNodeReference value) { @@ -701,6 +768,10 @@ public Builder mergeTaskNode(io.littlehorse.sdk.common.proto.TaskNodeReference v return this; } /** + *
+     * Reference to a NodeRun of type TASK which scheduled this TaskRun.
+     * 
+ * * .littlehorse.TaskNodeReference task_node = 1; */ public Builder clearTaskNode() { @@ -720,12 +791,20 @@ public Builder clearTaskNode() { return this; } /** + *
+     * Reference to a NodeRun of type TASK which scheduled this TaskRun.
+     * 
+ * * .littlehorse.TaskNodeReference task_node = 1; */ public io.littlehorse.sdk.common.proto.TaskNodeReference.Builder getTaskNodeBuilder() { return getTaskNodeFieldBuilder().getBuilder(); } /** + *
+     * Reference to a NodeRun of type TASK which scheduled this TaskRun.
+     * 
+ * * .littlehorse.TaskNodeReference task_node = 1; */ @java.lang.Override @@ -740,6 +819,10 @@ public io.littlehorse.sdk.common.proto.TaskNodeReferenceOrBuilder getTaskNodeOrB } } /** + *
+     * Reference to a NodeRun of type TASK which scheduled this TaskRun.
+     * 
+ * * .littlehorse.TaskNodeReference task_node = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -764,6 +847,10 @@ public io.littlehorse.sdk.common.proto.TaskNodeReferenceOrBuilder getTaskNodeOrB private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.UserTaskTriggerReference, io.littlehorse.sdk.common.proto.UserTaskTriggerReference.Builder, io.littlehorse.sdk.common.proto.UserTaskTriggerReferenceOrBuilder> userTaskTriggerBuilder_; /** + *
+     * Reference to the specific UserTaskRun trigger action which scheduled this TaskRun
+     * 
+ * * .littlehorse.UserTaskTriggerReference user_task_trigger = 2; * @return Whether the userTaskTrigger field is set. */ @@ -772,6 +859,10 @@ public boolean hasUserTaskTrigger() { return taskRunSourceCase_ == 2; } /** + *
+     * Reference to the specific UserTaskRun trigger action which scheduled this TaskRun
+     * 
+ * * .littlehorse.UserTaskTriggerReference user_task_trigger = 2; * @return The userTaskTrigger. */ @@ -790,6 +881,10 @@ public io.littlehorse.sdk.common.proto.UserTaskTriggerReference getUserTaskTrigg } } /** + *
+     * Reference to the specific UserTaskRun trigger action which scheduled this TaskRun
+     * 
+ * * .littlehorse.UserTaskTriggerReference user_task_trigger = 2; */ public Builder setUserTaskTrigger(io.littlehorse.sdk.common.proto.UserTaskTriggerReference value) { @@ -806,6 +901,10 @@ public Builder setUserTaskTrigger(io.littlehorse.sdk.common.proto.UserTaskTrigge return this; } /** + *
+     * Reference to the specific UserTaskRun trigger action which scheduled this TaskRun
+     * 
+ * * .littlehorse.UserTaskTriggerReference user_task_trigger = 2; */ public Builder setUserTaskTrigger( @@ -820,6 +919,10 @@ public Builder setUserTaskTrigger( return this; } /** + *
+     * Reference to the specific UserTaskRun trigger action which scheduled this TaskRun
+     * 
+ * * .littlehorse.UserTaskTriggerReference user_task_trigger = 2; */ public Builder mergeUserTaskTrigger(io.littlehorse.sdk.common.proto.UserTaskTriggerReference value) { @@ -843,6 +946,10 @@ public Builder mergeUserTaskTrigger(io.littlehorse.sdk.common.proto.UserTaskTrig return this; } /** + *
+     * Reference to the specific UserTaskRun trigger action which scheduled this TaskRun
+     * 
+ * * .littlehorse.UserTaskTriggerReference user_task_trigger = 2; */ public Builder clearUserTaskTrigger() { @@ -862,12 +969,20 @@ public Builder clearUserTaskTrigger() { return this; } /** + *
+     * Reference to the specific UserTaskRun trigger action which scheduled this TaskRun
+     * 
+ * * .littlehorse.UserTaskTriggerReference user_task_trigger = 2; */ public io.littlehorse.sdk.common.proto.UserTaskTriggerReference.Builder getUserTaskTriggerBuilder() { return getUserTaskTriggerFieldBuilder().getBuilder(); } /** + *
+     * Reference to the specific UserTaskRun trigger action which scheduled this TaskRun
+     * 
+ * * .littlehorse.UserTaskTriggerReference user_task_trigger = 2; */ @java.lang.Override @@ -882,6 +997,10 @@ public io.littlehorse.sdk.common.proto.UserTaskTriggerReferenceOrBuilder getUser } } /** + *
+     * Reference to the specific UserTaskRun trigger action which scheduled this TaskRun
+     * 
+ * * .littlehorse.UserTaskTriggerReference user_task_trigger = 2; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -907,6 +1026,11 @@ public io.littlehorse.sdk.common.proto.UserTaskTriggerReferenceOrBuilder getUser private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.WfSpecId, io.littlehorse.sdk.common.proto.WfSpecId.Builder, io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder> wfSpecIdBuilder_; /** + *
+     * The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so
+     * that the WorkerContext can know this information.
+     * 
+ * * optional .littlehorse.WfSpecId wf_spec_id = 3; * @return Whether the wfSpecId field is set. */ @@ -914,6 +1038,11 @@ public boolean hasWfSpecId() { return ((bitField0_ & 0x00000004) != 0); } /** + *
+     * The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so
+     * that the WorkerContext can know this information.
+     * 
+ * * optional .littlehorse.WfSpecId wf_spec_id = 3; * @return The wfSpecId. */ @@ -925,6 +1054,11 @@ public io.littlehorse.sdk.common.proto.WfSpecId getWfSpecId() { } } /** + *
+     * The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so
+     * that the WorkerContext can know this information.
+     * 
+ * * optional .littlehorse.WfSpecId wf_spec_id = 3; */ public Builder setWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { @@ -941,6 +1075,11 @@ public Builder setWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { return this; } /** + *
+     * The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so
+     * that the WorkerContext can know this information.
+     * 
+ * * optional .littlehorse.WfSpecId wf_spec_id = 3; */ public Builder setWfSpecId( @@ -955,6 +1094,11 @@ public Builder setWfSpecId( return this; } /** + *
+     * The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so
+     * that the WorkerContext can know this information.
+     * 
+ * * optional .littlehorse.WfSpecId wf_spec_id = 3; */ public Builder mergeWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { @@ -974,6 +1118,11 @@ public Builder mergeWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { return this; } /** + *
+     * The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so
+     * that the WorkerContext can know this information.
+     * 
+ * * optional .littlehorse.WfSpecId wf_spec_id = 3; */ public Builder clearWfSpecId() { @@ -987,6 +1136,11 @@ public Builder clearWfSpecId() { return this; } /** + *
+     * The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so
+     * that the WorkerContext can know this information.
+     * 
+ * * optional .littlehorse.WfSpecId wf_spec_id = 3; */ public io.littlehorse.sdk.common.proto.WfSpecId.Builder getWfSpecIdBuilder() { @@ -995,6 +1149,11 @@ public io.littlehorse.sdk.common.proto.WfSpecId.Builder getWfSpecIdBuilder() { return getWfSpecIdFieldBuilder().getBuilder(); } /** + *
+     * The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so
+     * that the WorkerContext can know this information.
+     * 
+ * * optional .littlehorse.WfSpecId wf_spec_id = 3; */ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder() { @@ -1006,6 +1165,11 @@ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder() } } /** + *
+     * The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so
+     * that the WorkerContext can know this information.
+     * 
+ * * optional .littlehorse.WfSpecId wf_spec_id = 3; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunSourceOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunSourceOrBuilder.java index 0bb52b2b2..216067a4f 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunSourceOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskRunSourceOrBuilder.java @@ -8,46 +8,85 @@ public interface TaskRunSourceOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * Reference to a NodeRun of type TASK which scheduled this TaskRun.
+   * 
+ * * .littlehorse.TaskNodeReference task_node = 1; * @return Whether the taskNode field is set. */ boolean hasTaskNode(); /** + *
+   * Reference to a NodeRun of type TASK which scheduled this TaskRun.
+   * 
+ * * .littlehorse.TaskNodeReference task_node = 1; * @return The taskNode. */ io.littlehorse.sdk.common.proto.TaskNodeReference getTaskNode(); /** + *
+   * Reference to a NodeRun of type TASK which scheduled this TaskRun.
+   * 
+ * * .littlehorse.TaskNodeReference task_node = 1; */ io.littlehorse.sdk.common.proto.TaskNodeReferenceOrBuilder getTaskNodeOrBuilder(); /** + *
+   * Reference to the specific UserTaskRun trigger action which scheduled this TaskRun
+   * 
+ * * .littlehorse.UserTaskTriggerReference user_task_trigger = 2; * @return Whether the userTaskTrigger field is set. */ boolean hasUserTaskTrigger(); /** + *
+   * Reference to the specific UserTaskRun trigger action which scheduled this TaskRun
+   * 
+ * * .littlehorse.UserTaskTriggerReference user_task_trigger = 2; * @return The userTaskTrigger. */ io.littlehorse.sdk.common.proto.UserTaskTriggerReference getUserTaskTrigger(); /** + *
+   * Reference to the specific UserTaskRun trigger action which scheduled this TaskRun
+   * 
+ * * .littlehorse.UserTaskTriggerReference user_task_trigger = 2; */ io.littlehorse.sdk.common.proto.UserTaskTriggerReferenceOrBuilder getUserTaskTriggerOrBuilder(); /** + *
+   * The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so
+   * that the WorkerContext can know this information.
+   * 
+ * * optional .littlehorse.WfSpecId wf_spec_id = 3; * @return Whether the wfSpecId field is set. */ boolean hasWfSpecId(); /** + *
+   * The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so
+   * that the WorkerContext can know this information.
+   * 
+ * * optional .littlehorse.WfSpecId wf_spec_id = 3; * @return The wfSpecId. */ io.littlehorse.sdk.common.proto.WfSpecId getWfSpecId(); /** + *
+   * The ID of the WfSpec that is being executed. Always set in ScheduledTask.source so
+   * that the WorkerContext can know this information.
+   * 
+ * * optional .littlehorse.WfSpecId wf_spec_id = 3; */ io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder(); diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskWorkerGroupId.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskWorkerGroupId.java index fd9550827..b7dd2a9c0 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskWorkerGroupId.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskWorkerGroupId.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * ID for a TaskWorkerGroup.
+ * 
+ * * Protobuf type {@code littlehorse.TaskWorkerGroupId} */ public final class TaskWorkerGroupId extends @@ -41,6 +45,10 @@ protected java.lang.Object newInstance( public static final int TASK_DEF_ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.TaskDefId taskDefId_; /** + *
+   * TaskWorkerGroups are uniquely identified by their TaskDefId.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 1; * @return Whether the taskDefId field is set. */ @@ -49,6 +57,10 @@ public boolean hasTaskDefId() { return taskDefId_ != null; } /** + *
+   * TaskWorkerGroups are uniquely identified by their TaskDefId.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 1; * @return The taskDefId. */ @@ -57,6 +69,10 @@ public io.littlehorse.sdk.common.proto.TaskDefId getTaskDefId() { return taskDefId_ == null ? io.littlehorse.sdk.common.proto.TaskDefId.getDefaultInstance() : taskDefId_; } /** + *
+   * TaskWorkerGroups are uniquely identified by their TaskDefId.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 1; */ @java.lang.Override @@ -227,6 +243,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * ID for a TaskWorkerGroup.
+   * 
+ * * Protobuf type {@code littlehorse.TaskWorkerGroupId} */ public static final class Builder extends @@ -406,6 +426,10 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.TaskDefId, io.littlehorse.sdk.common.proto.TaskDefId.Builder, io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder> taskDefIdBuilder_; /** + *
+     * TaskWorkerGroups are uniquely identified by their TaskDefId.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 1; * @return Whether the taskDefId field is set. */ @@ -413,6 +437,10 @@ public boolean hasTaskDefId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * TaskWorkerGroups are uniquely identified by their TaskDefId.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 1; * @return The taskDefId. */ @@ -424,6 +452,10 @@ public io.littlehorse.sdk.common.proto.TaskDefId getTaskDefId() { } } /** + *
+     * TaskWorkerGroups are uniquely identified by their TaskDefId.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 1; */ public Builder setTaskDefId(io.littlehorse.sdk.common.proto.TaskDefId value) { @@ -440,6 +472,10 @@ public Builder setTaskDefId(io.littlehorse.sdk.common.proto.TaskDefId value) { return this; } /** + *
+     * TaskWorkerGroups are uniquely identified by their TaskDefId.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 1; */ public Builder setTaskDefId( @@ -454,6 +490,10 @@ public Builder setTaskDefId( return this; } /** + *
+     * TaskWorkerGroups are uniquely identified by their TaskDefId.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 1; */ public Builder mergeTaskDefId(io.littlehorse.sdk.common.proto.TaskDefId value) { @@ -473,6 +513,10 @@ public Builder mergeTaskDefId(io.littlehorse.sdk.common.proto.TaskDefId value) { return this; } /** + *
+     * TaskWorkerGroups are uniquely identified by their TaskDefId.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 1; */ public Builder clearTaskDefId() { @@ -486,6 +530,10 @@ public Builder clearTaskDefId() { return this; } /** + *
+     * TaskWorkerGroups are uniquely identified by their TaskDefId.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 1; */ public io.littlehorse.sdk.common.proto.TaskDefId.Builder getTaskDefIdBuilder() { @@ -494,6 +542,10 @@ public io.littlehorse.sdk.common.proto.TaskDefId.Builder getTaskDefIdBuilder() { return getTaskDefIdFieldBuilder().getBuilder(); } /** + *
+     * TaskWorkerGroups are uniquely identified by their TaskDefId.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 1; */ public io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder getTaskDefIdOrBuilder() { @@ -505,6 +557,10 @@ public io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder getTaskDefIdOrBuilder( } } /** + *
+     * TaskWorkerGroups are uniquely identified by their TaskDefId.
+     * 
+ * * .littlehorse.TaskDefId task_def_id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskWorkerGroupIdOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskWorkerGroupIdOrBuilder.java index 35dfdc24b..768442af0 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskWorkerGroupIdOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TaskWorkerGroupIdOrBuilder.java @@ -8,16 +8,28 @@ public interface TaskWorkerGroupIdOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * TaskWorkerGroups are uniquely identified by their TaskDefId.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 1; * @return Whether the taskDefId field is set. */ boolean hasTaskDefId(); /** + *
+   * TaskWorkerGroups are uniquely identified by their TaskDefId.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 1; * @return The taskDefId. */ io.littlehorse.sdk.common.proto.TaskDefId getTaskDefId(); /** + *
+   * TaskWorkerGroups are uniquely identified by their TaskDefId.
+   * 
+ * * .littlehorse.TaskDefId task_def_id = 1; */ io.littlehorse.sdk.common.proto.TaskDefIdOrBuilder getTaskDefIdOrBuilder(); diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TenantId.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TenantId.java index 4a873d2b8..1de95d266 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TenantId.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TenantId.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * ID for a Tenant.
+ * 
+ * * Protobuf type {@code littlehorse.TenantId} */ public final class TenantId extends @@ -43,6 +47,10 @@ protected java.lang.Object newInstance( @SuppressWarnings("serial") private volatile java.lang.Object id_ = ""; /** + *
+   * The Tenant ID.
+   * 
+ * * string id = 1; * @return The id. */ @@ -60,6 +68,10 @@ public java.lang.String getId() { } } /** + *
+   * The Tenant ID.
+   * 
+ * * string id = 1; * @return The bytes for id. */ @@ -235,6 +247,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * ID for a Tenant.
+   * 
+ * * Protobuf type {@code littlehorse.TenantId} */ public static final class Builder extends @@ -406,6 +422,10 @@ public Builder mergeFrom( private java.lang.Object id_ = ""; /** + *
+     * The Tenant ID.
+     * 
+ * * string id = 1; * @return The id. */ @@ -422,6 +442,10 @@ public java.lang.String getId() { } } /** + *
+     * The Tenant ID.
+     * 
+ * * string id = 1; * @return The bytes for id. */ @@ -439,6 +463,10 @@ public java.lang.String getId() { } } /** + *
+     * The Tenant ID.
+     * 
+ * * string id = 1; * @param value The id to set. * @return This builder for chaining. @@ -452,6 +480,10 @@ public Builder setId( return this; } /** + *
+     * The Tenant ID.
+     * 
+ * * string id = 1; * @return This builder for chaining. */ @@ -462,6 +494,10 @@ public Builder clearId() { return this; } /** + *
+     * The Tenant ID.
+     * 
+ * * string id = 1; * @param value The bytes for id to set. * @return This builder for chaining. diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TenantIdOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TenantIdOrBuilder.java index 5b010cfaf..1105be739 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TenantIdOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/TenantIdOrBuilder.java @@ -8,11 +8,19 @@ public interface TenantIdOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The Tenant ID.
+   * 
+ * * string id = 1; * @return The id. */ java.lang.String getId(); /** + *
+   * The Tenant ID.
+   * 
+ * * string id = 1; * @return The bytes for id. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadHaltReason.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadHaltReason.java index 168fb1e2a..b88d6d4cc 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadHaltReason.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadHaltReason.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * Denotes a reason why a ThreadRun is halted. See `ThreadRun.halt_reasons` for context.
+ * 
+ * * Protobuf type {@code littlehorse.ThreadHaltReason} */ public final class ThreadHaltReason extends @@ -90,6 +94,10 @@ public int getNumber() { public static final int PARENT_HALTED_FIELD_NUMBER = 1; /** + *
+   * Parent threadRun halted.
+   * 
+ * * .littlehorse.ParentHalted parent_halted = 1; * @return Whether the parentHalted field is set. */ @@ -98,6 +106,10 @@ public boolean hasParentHalted() { return reasonCase_ == 1; } /** + *
+   * Parent threadRun halted.
+   * 
+ * * .littlehorse.ParentHalted parent_halted = 1; * @return The parentHalted. */ @@ -109,6 +121,10 @@ public io.littlehorse.sdk.common.proto.ParentHalted getParentHalted() { return io.littlehorse.sdk.common.proto.ParentHalted.getDefaultInstance(); } /** + *
+   * Parent threadRun halted.
+   * 
+ * * .littlehorse.ParentHalted parent_halted = 1; */ @java.lang.Override @@ -121,6 +137,10 @@ public io.littlehorse.sdk.common.proto.ParentHaltedOrBuilder getParentHaltedOrBu public static final int INTERRUPTED_FIELD_NUMBER = 2; /** + *
+   * Handling an Interrupt.
+   * 
+ * * .littlehorse.Interrupted interrupted = 2; * @return Whether the interrupted field is set. */ @@ -129,6 +149,10 @@ public boolean hasInterrupted() { return reasonCase_ == 2; } /** + *
+   * Handling an Interrupt.
+   * 
+ * * .littlehorse.Interrupted interrupted = 2; * @return The interrupted. */ @@ -140,6 +164,10 @@ public io.littlehorse.sdk.common.proto.Interrupted getInterrupted() { return io.littlehorse.sdk.common.proto.Interrupted.getDefaultInstance(); } /** + *
+   * Handling an Interrupt.
+   * 
+ * * .littlehorse.Interrupted interrupted = 2; */ @java.lang.Override @@ -152,6 +180,10 @@ public io.littlehorse.sdk.common.proto.InterruptedOrBuilder getInterruptedOrBuil public static final int PENDING_INTERRUPT_FIELD_NUMBER = 3; /** + *
+   * Waiting to handle Interrupt.
+   * 
+ * * .littlehorse.PendingInterruptHaltReason pending_interrupt = 3; * @return Whether the pendingInterrupt field is set. */ @@ -160,6 +192,10 @@ public boolean hasPendingInterrupt() { return reasonCase_ == 3; } /** + *
+   * Waiting to handle Interrupt.
+   * 
+ * * .littlehorse.PendingInterruptHaltReason pending_interrupt = 3; * @return The pendingInterrupt. */ @@ -171,6 +207,10 @@ public io.littlehorse.sdk.common.proto.PendingInterruptHaltReason getPendingInte return io.littlehorse.sdk.common.proto.PendingInterruptHaltReason.getDefaultInstance(); } /** + *
+   * Waiting to handle Interrupt.
+   * 
+ * * .littlehorse.PendingInterruptHaltReason pending_interrupt = 3; */ @java.lang.Override @@ -183,6 +223,10 @@ public io.littlehorse.sdk.common.proto.PendingInterruptHaltReasonOrBuilder getPe public static final int PENDING_FAILURE_FIELD_NUMBER = 4; /** + *
+   * Waiting to handle a failure.
+   * 
+ * * .littlehorse.PendingFailureHandlerHaltReason pending_failure = 4; * @return Whether the pendingFailure field is set. */ @@ -191,6 +235,10 @@ public boolean hasPendingFailure() { return reasonCase_ == 4; } /** + *
+   * Waiting to handle a failure.
+   * 
+ * * .littlehorse.PendingFailureHandlerHaltReason pending_failure = 4; * @return The pendingFailure. */ @@ -202,6 +250,10 @@ public io.littlehorse.sdk.common.proto.PendingFailureHandlerHaltReason getPendin return io.littlehorse.sdk.common.proto.PendingFailureHandlerHaltReason.getDefaultInstance(); } /** + *
+   * Waiting to handle a failure.
+   * 
+ * * .littlehorse.PendingFailureHandlerHaltReason pending_failure = 4; */ @java.lang.Override @@ -214,6 +266,10 @@ public io.littlehorse.sdk.common.proto.PendingFailureHandlerHaltReasonOrBuilder public static final int HANDLING_FAILURE_FIELD_NUMBER = 5; /** + *
+   * Handling a failure.
+   * 
+ * * .littlehorse.HandlingFailureHaltReason handling_failure = 5; * @return Whether the handlingFailure field is set. */ @@ -222,6 +278,10 @@ public boolean hasHandlingFailure() { return reasonCase_ == 5; } /** + *
+   * Handling a failure.
+   * 
+ * * .littlehorse.HandlingFailureHaltReason handling_failure = 5; * @return The handlingFailure. */ @@ -233,6 +293,10 @@ public io.littlehorse.sdk.common.proto.HandlingFailureHaltReason getHandlingFail return io.littlehorse.sdk.common.proto.HandlingFailureHaltReason.getDefaultInstance(); } /** + *
+   * Handling a failure.
+   * 
+ * * .littlehorse.HandlingFailureHaltReason handling_failure = 5; */ @java.lang.Override @@ -245,6 +309,10 @@ public io.littlehorse.sdk.common.proto.HandlingFailureHaltReasonOrBuilder getHan public static final int MANUAL_HALT_FIELD_NUMBER = 6; /** + *
+   * Manually stopped the WfRun.
+   * 
+ * * .littlehorse.ManualHalt manual_halt = 6; * @return Whether the manualHalt field is set. */ @@ -253,6 +321,10 @@ public boolean hasManualHalt() { return reasonCase_ == 6; } /** + *
+   * Manually stopped the WfRun.
+   * 
+ * * .littlehorse.ManualHalt manual_halt = 6; * @return The manualHalt. */ @@ -264,6 +336,10 @@ public io.littlehorse.sdk.common.proto.ManualHalt getManualHalt() { return io.littlehorse.sdk.common.proto.ManualHalt.getDefaultInstance(); } /** + *
+   * Manually stopped the WfRun.
+   * 
+ * * .littlehorse.ManualHalt manual_halt = 6; */ @java.lang.Override @@ -520,6 +596,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * Denotes a reason why a ThreadRun is halted. See `ThreadRun.halt_reasons` for context.
+   * 
+ * * Protobuf type {@code littlehorse.ThreadHaltReason} */ public static final class Builder extends @@ -814,6 +894,10 @@ public Builder clearReason() { private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.ParentHalted, io.littlehorse.sdk.common.proto.ParentHalted.Builder, io.littlehorse.sdk.common.proto.ParentHaltedOrBuilder> parentHaltedBuilder_; /** + *
+     * Parent threadRun halted.
+     * 
+ * * .littlehorse.ParentHalted parent_halted = 1; * @return Whether the parentHalted field is set. */ @@ -822,6 +906,10 @@ public boolean hasParentHalted() { return reasonCase_ == 1; } /** + *
+     * Parent threadRun halted.
+     * 
+ * * .littlehorse.ParentHalted parent_halted = 1; * @return The parentHalted. */ @@ -840,6 +928,10 @@ public io.littlehorse.sdk.common.proto.ParentHalted getParentHalted() { } } /** + *
+     * Parent threadRun halted.
+     * 
+ * * .littlehorse.ParentHalted parent_halted = 1; */ public Builder setParentHalted(io.littlehorse.sdk.common.proto.ParentHalted value) { @@ -856,6 +948,10 @@ public Builder setParentHalted(io.littlehorse.sdk.common.proto.ParentHalted valu return this; } /** + *
+     * Parent threadRun halted.
+     * 
+ * * .littlehorse.ParentHalted parent_halted = 1; */ public Builder setParentHalted( @@ -870,6 +966,10 @@ public Builder setParentHalted( return this; } /** + *
+     * Parent threadRun halted.
+     * 
+ * * .littlehorse.ParentHalted parent_halted = 1; */ public Builder mergeParentHalted(io.littlehorse.sdk.common.proto.ParentHalted value) { @@ -893,6 +993,10 @@ public Builder mergeParentHalted(io.littlehorse.sdk.common.proto.ParentHalted va return this; } /** + *
+     * Parent threadRun halted.
+     * 
+ * * .littlehorse.ParentHalted parent_halted = 1; */ public Builder clearParentHalted() { @@ -912,12 +1016,20 @@ public Builder clearParentHalted() { return this; } /** + *
+     * Parent threadRun halted.
+     * 
+ * * .littlehorse.ParentHalted parent_halted = 1; */ public io.littlehorse.sdk.common.proto.ParentHalted.Builder getParentHaltedBuilder() { return getParentHaltedFieldBuilder().getBuilder(); } /** + *
+     * Parent threadRun halted.
+     * 
+ * * .littlehorse.ParentHalted parent_halted = 1; */ @java.lang.Override @@ -932,6 +1044,10 @@ public io.littlehorse.sdk.common.proto.ParentHaltedOrBuilder getParentHaltedOrBu } } /** + *
+     * Parent threadRun halted.
+     * 
+ * * .littlehorse.ParentHalted parent_halted = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -956,6 +1072,10 @@ public io.littlehorse.sdk.common.proto.ParentHaltedOrBuilder getParentHaltedOrBu private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.Interrupted, io.littlehorse.sdk.common.proto.Interrupted.Builder, io.littlehorse.sdk.common.proto.InterruptedOrBuilder> interruptedBuilder_; /** + *
+     * Handling an Interrupt.
+     * 
+ * * .littlehorse.Interrupted interrupted = 2; * @return Whether the interrupted field is set. */ @@ -964,6 +1084,10 @@ public boolean hasInterrupted() { return reasonCase_ == 2; } /** + *
+     * Handling an Interrupt.
+     * 
+ * * .littlehorse.Interrupted interrupted = 2; * @return The interrupted. */ @@ -982,6 +1106,10 @@ public io.littlehorse.sdk.common.proto.Interrupted getInterrupted() { } } /** + *
+     * Handling an Interrupt.
+     * 
+ * * .littlehorse.Interrupted interrupted = 2; */ public Builder setInterrupted(io.littlehorse.sdk.common.proto.Interrupted value) { @@ -998,6 +1126,10 @@ public Builder setInterrupted(io.littlehorse.sdk.common.proto.Interrupted value) return this; } /** + *
+     * Handling an Interrupt.
+     * 
+ * * .littlehorse.Interrupted interrupted = 2; */ public Builder setInterrupted( @@ -1012,6 +1144,10 @@ public Builder setInterrupted( return this; } /** + *
+     * Handling an Interrupt.
+     * 
+ * * .littlehorse.Interrupted interrupted = 2; */ public Builder mergeInterrupted(io.littlehorse.sdk.common.proto.Interrupted value) { @@ -1035,6 +1171,10 @@ public Builder mergeInterrupted(io.littlehorse.sdk.common.proto.Interrupted valu return this; } /** + *
+     * Handling an Interrupt.
+     * 
+ * * .littlehorse.Interrupted interrupted = 2; */ public Builder clearInterrupted() { @@ -1054,12 +1194,20 @@ public Builder clearInterrupted() { return this; } /** + *
+     * Handling an Interrupt.
+     * 
+ * * .littlehorse.Interrupted interrupted = 2; */ public io.littlehorse.sdk.common.proto.Interrupted.Builder getInterruptedBuilder() { return getInterruptedFieldBuilder().getBuilder(); } /** + *
+     * Handling an Interrupt.
+     * 
+ * * .littlehorse.Interrupted interrupted = 2; */ @java.lang.Override @@ -1074,6 +1222,10 @@ public io.littlehorse.sdk.common.proto.InterruptedOrBuilder getInterruptedOrBuil } } /** + *
+     * Handling an Interrupt.
+     * 
+ * * .littlehorse.Interrupted interrupted = 2; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1098,6 +1250,10 @@ public io.littlehorse.sdk.common.proto.InterruptedOrBuilder getInterruptedOrBuil private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.PendingInterruptHaltReason, io.littlehorse.sdk.common.proto.PendingInterruptHaltReason.Builder, io.littlehorse.sdk.common.proto.PendingInterruptHaltReasonOrBuilder> pendingInterruptBuilder_; /** + *
+     * Waiting to handle Interrupt.
+     * 
+ * * .littlehorse.PendingInterruptHaltReason pending_interrupt = 3; * @return Whether the pendingInterrupt field is set. */ @@ -1106,6 +1262,10 @@ public boolean hasPendingInterrupt() { return reasonCase_ == 3; } /** + *
+     * Waiting to handle Interrupt.
+     * 
+ * * .littlehorse.PendingInterruptHaltReason pending_interrupt = 3; * @return The pendingInterrupt. */ @@ -1124,6 +1284,10 @@ public io.littlehorse.sdk.common.proto.PendingInterruptHaltReason getPendingInte } } /** + *
+     * Waiting to handle Interrupt.
+     * 
+ * * .littlehorse.PendingInterruptHaltReason pending_interrupt = 3; */ public Builder setPendingInterrupt(io.littlehorse.sdk.common.proto.PendingInterruptHaltReason value) { @@ -1140,6 +1304,10 @@ public Builder setPendingInterrupt(io.littlehorse.sdk.common.proto.PendingInterr return this; } /** + *
+     * Waiting to handle Interrupt.
+     * 
+ * * .littlehorse.PendingInterruptHaltReason pending_interrupt = 3; */ public Builder setPendingInterrupt( @@ -1154,6 +1322,10 @@ public Builder setPendingInterrupt( return this; } /** + *
+     * Waiting to handle Interrupt.
+     * 
+ * * .littlehorse.PendingInterruptHaltReason pending_interrupt = 3; */ public Builder mergePendingInterrupt(io.littlehorse.sdk.common.proto.PendingInterruptHaltReason value) { @@ -1177,6 +1349,10 @@ public Builder mergePendingInterrupt(io.littlehorse.sdk.common.proto.PendingInte return this; } /** + *
+     * Waiting to handle Interrupt.
+     * 
+ * * .littlehorse.PendingInterruptHaltReason pending_interrupt = 3; */ public Builder clearPendingInterrupt() { @@ -1196,12 +1372,20 @@ public Builder clearPendingInterrupt() { return this; } /** + *
+     * Waiting to handle Interrupt.
+     * 
+ * * .littlehorse.PendingInterruptHaltReason pending_interrupt = 3; */ public io.littlehorse.sdk.common.proto.PendingInterruptHaltReason.Builder getPendingInterruptBuilder() { return getPendingInterruptFieldBuilder().getBuilder(); } /** + *
+     * Waiting to handle Interrupt.
+     * 
+ * * .littlehorse.PendingInterruptHaltReason pending_interrupt = 3; */ @java.lang.Override @@ -1216,6 +1400,10 @@ public io.littlehorse.sdk.common.proto.PendingInterruptHaltReasonOrBuilder getPe } } /** + *
+     * Waiting to handle Interrupt.
+     * 
+ * * .littlehorse.PendingInterruptHaltReason pending_interrupt = 3; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1240,6 +1428,10 @@ public io.littlehorse.sdk.common.proto.PendingInterruptHaltReasonOrBuilder getPe private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.PendingFailureHandlerHaltReason, io.littlehorse.sdk.common.proto.PendingFailureHandlerHaltReason.Builder, io.littlehorse.sdk.common.proto.PendingFailureHandlerHaltReasonOrBuilder> pendingFailureBuilder_; /** + *
+     * Waiting to handle a failure.
+     * 
+ * * .littlehorse.PendingFailureHandlerHaltReason pending_failure = 4; * @return Whether the pendingFailure field is set. */ @@ -1248,6 +1440,10 @@ public boolean hasPendingFailure() { return reasonCase_ == 4; } /** + *
+     * Waiting to handle a failure.
+     * 
+ * * .littlehorse.PendingFailureHandlerHaltReason pending_failure = 4; * @return The pendingFailure. */ @@ -1266,6 +1462,10 @@ public io.littlehorse.sdk.common.proto.PendingFailureHandlerHaltReason getPendin } } /** + *
+     * Waiting to handle a failure.
+     * 
+ * * .littlehorse.PendingFailureHandlerHaltReason pending_failure = 4; */ public Builder setPendingFailure(io.littlehorse.sdk.common.proto.PendingFailureHandlerHaltReason value) { @@ -1282,6 +1482,10 @@ public Builder setPendingFailure(io.littlehorse.sdk.common.proto.PendingFailureH return this; } /** + *
+     * Waiting to handle a failure.
+     * 
+ * * .littlehorse.PendingFailureHandlerHaltReason pending_failure = 4; */ public Builder setPendingFailure( @@ -1296,6 +1500,10 @@ public Builder setPendingFailure( return this; } /** + *
+     * Waiting to handle a failure.
+     * 
+ * * .littlehorse.PendingFailureHandlerHaltReason pending_failure = 4; */ public Builder mergePendingFailure(io.littlehorse.sdk.common.proto.PendingFailureHandlerHaltReason value) { @@ -1319,6 +1527,10 @@ public Builder mergePendingFailure(io.littlehorse.sdk.common.proto.PendingFailur return this; } /** + *
+     * Waiting to handle a failure.
+     * 
+ * * .littlehorse.PendingFailureHandlerHaltReason pending_failure = 4; */ public Builder clearPendingFailure() { @@ -1338,12 +1550,20 @@ public Builder clearPendingFailure() { return this; } /** + *
+     * Waiting to handle a failure.
+     * 
+ * * .littlehorse.PendingFailureHandlerHaltReason pending_failure = 4; */ public io.littlehorse.sdk.common.proto.PendingFailureHandlerHaltReason.Builder getPendingFailureBuilder() { return getPendingFailureFieldBuilder().getBuilder(); } /** + *
+     * Waiting to handle a failure.
+     * 
+ * * .littlehorse.PendingFailureHandlerHaltReason pending_failure = 4; */ @java.lang.Override @@ -1358,6 +1578,10 @@ public io.littlehorse.sdk.common.proto.PendingFailureHandlerHaltReasonOrBuilder } } /** + *
+     * Waiting to handle a failure.
+     * 
+ * * .littlehorse.PendingFailureHandlerHaltReason pending_failure = 4; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1382,6 +1606,10 @@ public io.littlehorse.sdk.common.proto.PendingFailureHandlerHaltReasonOrBuilder private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.HandlingFailureHaltReason, io.littlehorse.sdk.common.proto.HandlingFailureHaltReason.Builder, io.littlehorse.sdk.common.proto.HandlingFailureHaltReasonOrBuilder> handlingFailureBuilder_; /** + *
+     * Handling a failure.
+     * 
+ * * .littlehorse.HandlingFailureHaltReason handling_failure = 5; * @return Whether the handlingFailure field is set. */ @@ -1390,6 +1618,10 @@ public boolean hasHandlingFailure() { return reasonCase_ == 5; } /** + *
+     * Handling a failure.
+     * 
+ * * .littlehorse.HandlingFailureHaltReason handling_failure = 5; * @return The handlingFailure. */ @@ -1408,6 +1640,10 @@ public io.littlehorse.sdk.common.proto.HandlingFailureHaltReason getHandlingFail } } /** + *
+     * Handling a failure.
+     * 
+ * * .littlehorse.HandlingFailureHaltReason handling_failure = 5; */ public Builder setHandlingFailure(io.littlehorse.sdk.common.proto.HandlingFailureHaltReason value) { @@ -1424,6 +1660,10 @@ public Builder setHandlingFailure(io.littlehorse.sdk.common.proto.HandlingFailur return this; } /** + *
+     * Handling a failure.
+     * 
+ * * .littlehorse.HandlingFailureHaltReason handling_failure = 5; */ public Builder setHandlingFailure( @@ -1438,6 +1678,10 @@ public Builder setHandlingFailure( return this; } /** + *
+     * Handling a failure.
+     * 
+ * * .littlehorse.HandlingFailureHaltReason handling_failure = 5; */ public Builder mergeHandlingFailure(io.littlehorse.sdk.common.proto.HandlingFailureHaltReason value) { @@ -1461,6 +1705,10 @@ public Builder mergeHandlingFailure(io.littlehorse.sdk.common.proto.HandlingFail return this; } /** + *
+     * Handling a failure.
+     * 
+ * * .littlehorse.HandlingFailureHaltReason handling_failure = 5; */ public Builder clearHandlingFailure() { @@ -1480,12 +1728,20 @@ public Builder clearHandlingFailure() { return this; } /** + *
+     * Handling a failure.
+     * 
+ * * .littlehorse.HandlingFailureHaltReason handling_failure = 5; */ public io.littlehorse.sdk.common.proto.HandlingFailureHaltReason.Builder getHandlingFailureBuilder() { return getHandlingFailureFieldBuilder().getBuilder(); } /** + *
+     * Handling a failure.
+     * 
+ * * .littlehorse.HandlingFailureHaltReason handling_failure = 5; */ @java.lang.Override @@ -1500,6 +1756,10 @@ public io.littlehorse.sdk.common.proto.HandlingFailureHaltReasonOrBuilder getHan } } /** + *
+     * Handling a failure.
+     * 
+ * * .littlehorse.HandlingFailureHaltReason handling_failure = 5; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1524,6 +1784,10 @@ public io.littlehorse.sdk.common.proto.HandlingFailureHaltReasonOrBuilder getHan private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.ManualHalt, io.littlehorse.sdk.common.proto.ManualHalt.Builder, io.littlehorse.sdk.common.proto.ManualHaltOrBuilder> manualHaltBuilder_; /** + *
+     * Manually stopped the WfRun.
+     * 
+ * * .littlehorse.ManualHalt manual_halt = 6; * @return Whether the manualHalt field is set. */ @@ -1532,6 +1796,10 @@ public boolean hasManualHalt() { return reasonCase_ == 6; } /** + *
+     * Manually stopped the WfRun.
+     * 
+ * * .littlehorse.ManualHalt manual_halt = 6; * @return The manualHalt. */ @@ -1550,6 +1818,10 @@ public io.littlehorse.sdk.common.proto.ManualHalt getManualHalt() { } } /** + *
+     * Manually stopped the WfRun.
+     * 
+ * * .littlehorse.ManualHalt manual_halt = 6; */ public Builder setManualHalt(io.littlehorse.sdk.common.proto.ManualHalt value) { @@ -1566,6 +1838,10 @@ public Builder setManualHalt(io.littlehorse.sdk.common.proto.ManualHalt value) { return this; } /** + *
+     * Manually stopped the WfRun.
+     * 
+ * * .littlehorse.ManualHalt manual_halt = 6; */ public Builder setManualHalt( @@ -1580,6 +1856,10 @@ public Builder setManualHalt( return this; } /** + *
+     * Manually stopped the WfRun.
+     * 
+ * * .littlehorse.ManualHalt manual_halt = 6; */ public Builder mergeManualHalt(io.littlehorse.sdk.common.proto.ManualHalt value) { @@ -1603,6 +1883,10 @@ public Builder mergeManualHalt(io.littlehorse.sdk.common.proto.ManualHalt value) return this; } /** + *
+     * Manually stopped the WfRun.
+     * 
+ * * .littlehorse.ManualHalt manual_halt = 6; */ public Builder clearManualHalt() { @@ -1622,12 +1906,20 @@ public Builder clearManualHalt() { return this; } /** + *
+     * Manually stopped the WfRun.
+     * 
+ * * .littlehorse.ManualHalt manual_halt = 6; */ public io.littlehorse.sdk.common.proto.ManualHalt.Builder getManualHaltBuilder() { return getManualHaltFieldBuilder().getBuilder(); } /** + *
+     * Manually stopped the WfRun.
+     * 
+ * * .littlehorse.ManualHalt manual_halt = 6; */ @java.lang.Override @@ -1642,6 +1934,10 @@ public io.littlehorse.sdk.common.proto.ManualHaltOrBuilder getManualHaltOrBuilde } } /** + *
+     * Manually stopped the WfRun.
+     * 
+ * * .littlehorse.ManualHalt manual_halt = 6; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadHaltReasonOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadHaltReasonOrBuilder.java index 3bbf1cbaa..cc139e270 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadHaltReasonOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadHaltReasonOrBuilder.java @@ -8,91 +8,163 @@ public interface ThreadHaltReasonOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * Parent threadRun halted.
+   * 
+ * * .littlehorse.ParentHalted parent_halted = 1; * @return Whether the parentHalted field is set. */ boolean hasParentHalted(); /** + *
+   * Parent threadRun halted.
+   * 
+ * * .littlehorse.ParentHalted parent_halted = 1; * @return The parentHalted. */ io.littlehorse.sdk.common.proto.ParentHalted getParentHalted(); /** + *
+   * Parent threadRun halted.
+   * 
+ * * .littlehorse.ParentHalted parent_halted = 1; */ io.littlehorse.sdk.common.proto.ParentHaltedOrBuilder getParentHaltedOrBuilder(); /** + *
+   * Handling an Interrupt.
+   * 
+ * * .littlehorse.Interrupted interrupted = 2; * @return Whether the interrupted field is set. */ boolean hasInterrupted(); /** + *
+   * Handling an Interrupt.
+   * 
+ * * .littlehorse.Interrupted interrupted = 2; * @return The interrupted. */ io.littlehorse.sdk.common.proto.Interrupted getInterrupted(); /** + *
+   * Handling an Interrupt.
+   * 
+ * * .littlehorse.Interrupted interrupted = 2; */ io.littlehorse.sdk.common.proto.InterruptedOrBuilder getInterruptedOrBuilder(); /** + *
+   * Waiting to handle Interrupt.
+   * 
+ * * .littlehorse.PendingInterruptHaltReason pending_interrupt = 3; * @return Whether the pendingInterrupt field is set. */ boolean hasPendingInterrupt(); /** + *
+   * Waiting to handle Interrupt.
+   * 
+ * * .littlehorse.PendingInterruptHaltReason pending_interrupt = 3; * @return The pendingInterrupt. */ io.littlehorse.sdk.common.proto.PendingInterruptHaltReason getPendingInterrupt(); /** + *
+   * Waiting to handle Interrupt.
+   * 
+ * * .littlehorse.PendingInterruptHaltReason pending_interrupt = 3; */ io.littlehorse.sdk.common.proto.PendingInterruptHaltReasonOrBuilder getPendingInterruptOrBuilder(); /** + *
+   * Waiting to handle a failure.
+   * 
+ * * .littlehorse.PendingFailureHandlerHaltReason pending_failure = 4; * @return Whether the pendingFailure field is set. */ boolean hasPendingFailure(); /** + *
+   * Waiting to handle a failure.
+   * 
+ * * .littlehorse.PendingFailureHandlerHaltReason pending_failure = 4; * @return The pendingFailure. */ io.littlehorse.sdk.common.proto.PendingFailureHandlerHaltReason getPendingFailure(); /** + *
+   * Waiting to handle a failure.
+   * 
+ * * .littlehorse.PendingFailureHandlerHaltReason pending_failure = 4; */ io.littlehorse.sdk.common.proto.PendingFailureHandlerHaltReasonOrBuilder getPendingFailureOrBuilder(); /** + *
+   * Handling a failure.
+   * 
+ * * .littlehorse.HandlingFailureHaltReason handling_failure = 5; * @return Whether the handlingFailure field is set. */ boolean hasHandlingFailure(); /** + *
+   * Handling a failure.
+   * 
+ * * .littlehorse.HandlingFailureHaltReason handling_failure = 5; * @return The handlingFailure. */ io.littlehorse.sdk.common.proto.HandlingFailureHaltReason getHandlingFailure(); /** + *
+   * Handling a failure.
+   * 
+ * * .littlehorse.HandlingFailureHaltReason handling_failure = 5; */ io.littlehorse.sdk.common.proto.HandlingFailureHaltReasonOrBuilder getHandlingFailureOrBuilder(); /** + *
+   * Manually stopped the WfRun.
+   * 
+ * * .littlehorse.ManualHalt manual_halt = 6; * @return Whether the manualHalt field is set. */ boolean hasManualHalt(); /** + *
+   * Manually stopped the WfRun.
+   * 
+ * * .littlehorse.ManualHalt manual_halt = 6; * @return The manualHalt. */ io.littlehorse.sdk.common.proto.ManualHalt getManualHalt(); /** + *
+   * Manually stopped the WfRun.
+   * 
+ * * .littlehorse.ManualHalt manual_halt = 6; */ io.littlehorse.sdk.common.proto.ManualHaltOrBuilder getManualHaltOrBuilder(); diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadRun.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadRun.java index d7b6d35d9..082537c20 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadRun.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadRun.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * A ThreadRun is a running thread of execution within a WfRun.
+ * 
+ * * Protobuf type {@code littlehorse.ThreadRun} */ public final class ThreadRun extends @@ -49,6 +53,12 @@ protected java.lang.Object newInstance( public static final int WF_SPEC_ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.WfSpecId wfSpecId_; /** + *
+   * The current WfSpecId of this ThreadRun. This must be set explicitly because
+   * during a WfSpec Version Migration, it is possible for different ThreadSpec's to
+   * have different WfSpec versions.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 1; * @return Whether the wfSpecId field is set. */ @@ -57,6 +67,12 @@ public boolean hasWfSpecId() { return wfSpecId_ != null; } /** + *
+   * The current WfSpecId of this ThreadRun. This must be set explicitly because
+   * during a WfSpec Version Migration, it is possible for different ThreadSpec's to
+   * have different WfSpec versions.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 1; * @return The wfSpecId. */ @@ -65,6 +81,12 @@ public io.littlehorse.sdk.common.proto.WfSpecId getWfSpecId() { return wfSpecId_ == null ? io.littlehorse.sdk.common.proto.WfSpecId.getDefaultInstance() : wfSpecId_; } /** + *
+   * The current WfSpecId of this ThreadRun. This must be set explicitly because
+   * during a WfSpec Version Migration, it is possible for different ThreadSpec's to
+   * have different WfSpec versions.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 1; */ @java.lang.Override @@ -75,6 +97,14 @@ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder() public static final int NUMBER_FIELD_NUMBER = 2; private int number_ = 0; /** + *
+   * The number of the ThreadRun. This is an auto-incremented integer corresponding to
+   * the chronological ordering of when the ThreadRun's were created. If you have not
+   * configured any retention policy for the ThreadRun's (i.e. never clean them up), then
+   * this also corresponds to the position of the ThreadRun in the WfRun's `thread_runs`
+   * list.
+   * 
+ * * int32 number = 2; * @return The number. */ @@ -86,6 +116,10 @@ public int getNumber() { public static final int STATUS_FIELD_NUMBER = 3; private int status_ = 0; /** + *
+   * The status of the ThreadRun.
+   * 
+ * * .littlehorse.LHStatus status = 3; * @return The enum numeric value on the wire for status. */ @@ -93,6 +127,10 @@ public int getNumber() { return status_; } /** + *
+   * The status of the ThreadRun.
+   * 
+ * * .littlehorse.LHStatus status = 3; * @return The status. */ @@ -105,6 +143,10 @@ public int getNumber() { @SuppressWarnings("serial") private volatile java.lang.Object threadSpecName_ = ""; /** + *
+   * The name of the ThreadSpec being run.
+   * 
+ * * string thread_spec_name = 4; * @return The threadSpecName. */ @@ -122,6 +164,10 @@ public java.lang.String getThreadSpecName() { } } /** + *
+   * The name of the ThreadSpec being run.
+   * 
+ * * string thread_spec_name = 4; * @return The bytes for threadSpecName. */ @@ -143,6 +189,10 @@ public java.lang.String getThreadSpecName() { public static final int START_TIME_FIELD_NUMBER = 5; private com.google.protobuf.Timestamp startTime_; /** + *
+   * The time the ThreadRun was started.
+   * 
+ * * .google.protobuf.Timestamp start_time = 5; * @return Whether the startTime field is set. */ @@ -151,6 +201,10 @@ public boolean hasStartTime() { return startTime_ != null; } /** + *
+   * The time the ThreadRun was started.
+   * 
+ * * .google.protobuf.Timestamp start_time = 5; * @return The startTime. */ @@ -159,6 +213,10 @@ public com.google.protobuf.Timestamp getStartTime() { return startTime_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : startTime_; } /** + *
+   * The time the ThreadRun was started.
+   * 
+ * * .google.protobuf.Timestamp start_time = 5; */ @java.lang.Override @@ -169,6 +227,10 @@ public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder() { public static final int END_TIME_FIELD_NUMBER = 6; private com.google.protobuf.Timestamp endTime_; /** + *
+   * The time the ThreadRun was completed or failed. Unset if still active.
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 6; * @return Whether the endTime field is set. */ @@ -177,6 +239,10 @@ public boolean hasEndTime() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+   * The time the ThreadRun was completed or failed. Unset if still active.
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 6; * @return The endTime. */ @@ -185,6 +251,10 @@ public com.google.protobuf.Timestamp getEndTime() { return endTime_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : endTime_; } /** + *
+   * The time the ThreadRun was completed or failed. Unset if still active.
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 6; */ @java.lang.Override @@ -196,6 +266,10 @@ public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder() { @SuppressWarnings("serial") private volatile java.lang.Object errorMessage_ = ""; /** + *
+   * Human-readable error message detailing what went wrong in the case of a failure.
+   * 
+ * * optional string error_message = 7; * @return Whether the errorMessage field is set. */ @@ -204,6 +278,10 @@ public boolean hasErrorMessage() { return ((bitField0_ & 0x00000002) != 0); } /** + *
+   * Human-readable error message detailing what went wrong in the case of a failure.
+   * 
+ * * optional string error_message = 7; * @return The errorMessage. */ @@ -221,6 +299,10 @@ public java.lang.String getErrorMessage() { } } /** + *
+   * Human-readable error message detailing what went wrong in the case of a failure.
+   * 
+ * * optional string error_message = 7; * @return The bytes for errorMessage. */ @@ -243,6 +325,10 @@ public java.lang.String getErrorMessage() { @SuppressWarnings("serial") private com.google.protobuf.Internal.IntList childThreadIds_; /** + *
+   * List of thread_run_number's for all child thread_runs.
+   * 
+ * * repeated int32 child_thread_ids = 8; * @return A list containing the childThreadIds. */ @@ -252,6 +338,10 @@ public java.lang.String getErrorMessage() { return childThreadIds_; } /** + *
+   * List of thread_run_number's for all child thread_runs.
+   * 
+ * * repeated int32 child_thread_ids = 8; * @return The count of childThreadIds. */ @@ -259,6 +349,10 @@ public int getChildThreadIdsCount() { return childThreadIds_.size(); } /** + *
+   * List of thread_run_number's for all child thread_runs.
+   * 
+ * * repeated int32 child_thread_ids = 8; * @param index The index of the element to return. * @return The childThreadIds at the given index. @@ -271,6 +365,10 @@ public int getChildThreadIds(int index) { public static final int PARENT_THREAD_ID_FIELD_NUMBER = 9; private int parentThreadId_ = 0; /** + *
+   * Set for every ThreadRun except the ENTRYPOINT. This is the id of the parent thread.
+   * 
+ * * optional int32 parent_thread_id = 9; * @return Whether the parentThreadId field is set. */ @@ -279,6 +377,10 @@ public boolean hasParentThreadId() { return ((bitField0_ & 0x00000004) != 0); } /** + *
+   * Set for every ThreadRun except the ENTRYPOINT. This is the id of the parent thread.
+   * 
+ * * optional int32 parent_thread_id = 9; * @return The parentThreadId. */ @@ -291,6 +393,12 @@ public int getParentThreadId() { @SuppressWarnings("serial") private java.util.List haltReasons_; /** + *
+   * If the ThreadRun is HALTED, this contains a list of every reason for which the
+   * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+   * then the ThreadRun will return to the RUNNING state.
+   * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ @java.lang.Override @@ -298,6 +406,12 @@ public java.util.List getHaltR return haltReasons_; } /** + *
+   * If the ThreadRun is HALTED, this contains a list of every reason for which the
+   * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+   * then the ThreadRun will return to the RUNNING state.
+   * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ @java.lang.Override @@ -306,6 +420,12 @@ public java.util.List getHaltR return haltReasons_; } /** + *
+   * If the ThreadRun is HALTED, this contains a list of every reason for which the
+   * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+   * then the ThreadRun will return to the RUNNING state.
+   * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ @java.lang.Override @@ -313,6 +433,12 @@ public int getHaltReasonsCount() { return haltReasons_.size(); } /** + *
+   * If the ThreadRun is HALTED, this contains a list of every reason for which the
+   * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+   * then the ThreadRun will return to the RUNNING state.
+   * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ @java.lang.Override @@ -320,6 +446,12 @@ public io.littlehorse.sdk.common.proto.ThreadHaltReason getHaltReasons(int index return haltReasons_.get(index); } /** + *
+   * If the ThreadRun is HALTED, this contains a list of every reason for which the
+   * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+   * then the ThreadRun will return to the RUNNING state.
+   * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ @java.lang.Override @@ -331,6 +463,11 @@ public io.littlehorse.sdk.common.proto.ThreadHaltReasonOrBuilder getHaltReasonsO public static final int INTERRUPT_TRIGGER_ID_FIELD_NUMBER = 11; private io.littlehorse.sdk.common.proto.ExternalEventId interruptTriggerId_; /** + *
+   * If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the
+   * ExternalEvent that caused the Interrupt.
+   * 
+ * * optional .littlehorse.ExternalEventId interrupt_trigger_id = 11; * @return Whether the interruptTriggerId field is set. */ @@ -339,6 +476,11 @@ public boolean hasInterruptTriggerId() { return ((bitField0_ & 0x00000008) != 0); } /** + *
+   * If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the
+   * ExternalEvent that caused the Interrupt.
+   * 
+ * * optional .littlehorse.ExternalEventId interrupt_trigger_id = 11; * @return The interruptTriggerId. */ @@ -347,6 +489,11 @@ public io.littlehorse.sdk.common.proto.ExternalEventId getInterruptTriggerId() { return interruptTriggerId_ == null ? io.littlehorse.sdk.common.proto.ExternalEventId.getDefaultInstance() : interruptTriggerId_; } /** + *
+   * If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the
+   * ExternalEvent that caused the Interrupt.
+   * 
+ * * optional .littlehorse.ExternalEventId interrupt_trigger_id = 11; */ @java.lang.Override @@ -357,6 +504,11 @@ public io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getInterruptTrig public static final int FAILURE_BEING_HANDLED_FIELD_NUMBER = 12; private io.littlehorse.sdk.common.proto.FailureBeingHandled failureBeingHandled_; /** + *
+   * If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure
+   * that is being handled by this ThreadRun.
+   * 
+ * * optional .littlehorse.FailureBeingHandled failure_being_handled = 12; * @return Whether the failureBeingHandled field is set. */ @@ -365,6 +517,11 @@ public boolean hasFailureBeingHandled() { return ((bitField0_ & 0x00000010) != 0); } /** + *
+   * If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure
+   * that is being handled by this ThreadRun.
+   * 
+ * * optional .littlehorse.FailureBeingHandled failure_being_handled = 12; * @return The failureBeingHandled. */ @@ -373,6 +530,11 @@ public io.littlehorse.sdk.common.proto.FailureBeingHandled getFailureBeingHandle return failureBeingHandled_ == null ? io.littlehorse.sdk.common.proto.FailureBeingHandled.getDefaultInstance() : failureBeingHandled_; } /** + *
+   * If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure
+   * that is being handled by this ThreadRun.
+   * 
+ * * optional .littlehorse.FailureBeingHandled failure_being_handled = 12; */ @java.lang.Override @@ -383,6 +545,11 @@ public io.littlehorse.sdk.common.proto.FailureBeingHandledOrBuilder getFailureBe public static final int CURRENT_NODE_POSITION_FIELD_NUMBER = 13; private int currentNodePosition_ = 0; /** + *
+   * This is the current `position` of the current NodeRun being run. This is an
+   * auto-incremented field that gets incremented every time we run a new NodeRun.
+   * 
+ * * int32 current_node_position = 13; * @return The currentNodePosition. */ @@ -395,6 +562,16 @@ public int getCurrentNodePosition() { @SuppressWarnings("serial") private com.google.protobuf.Internal.IntList handledFailedChildren_; /** + *
+   * List of every child ThreadRun which both a) failed, and b) was properly handled by a
+   * Failure Handler.
+   *
+   * This is important because at the EXIT node, if a Child ThreadRun was discovered to have
+   * failed, then this ThreadRun (the parent) also fails with the same failure as the child.
+   * If, however, a Failure Handler had previously "handled" the Child Failure, that ThreadRun's
+   * number is appended to this list, and then the EXIT node ignores that ThreadRun.
+   * 
+ * * repeated int32 handled_failed_children = 14; * @return A list containing the handledFailedChildren. */ @@ -404,6 +581,16 @@ public int getCurrentNodePosition() { return handledFailedChildren_; } /** + *
+   * List of every child ThreadRun which both a) failed, and b) was properly handled by a
+   * Failure Handler.
+   *
+   * This is important because at the EXIT node, if a Child ThreadRun was discovered to have
+   * failed, then this ThreadRun (the parent) also fails with the same failure as the child.
+   * If, however, a Failure Handler had previously "handled" the Child Failure, that ThreadRun's
+   * number is appended to this list, and then the EXIT node ignores that ThreadRun.
+   * 
+ * * repeated int32 handled_failed_children = 14; * @return The count of handledFailedChildren. */ @@ -411,6 +598,16 @@ public int getHandledFailedChildrenCount() { return handledFailedChildren_.size(); } /** + *
+   * List of every child ThreadRun which both a) failed, and b) was properly handled by a
+   * Failure Handler.
+   *
+   * This is important because at the EXIT node, if a Child ThreadRun was discovered to have
+   * failed, then this ThreadRun (the parent) also fails with the same failure as the child.
+   * If, however, a Failure Handler had previously "handled" the Child Failure, that ThreadRun's
+   * number is appended to this list, and then the EXIT node ignores that ThreadRun.
+   * 
+ * * repeated int32 handled_failed_children = 14; * @param index The index of the element to return. * @return The handledFailedChildren at the given index. @@ -423,6 +620,10 @@ public int getHandledFailedChildren(int index) { public static final int TYPE_FIELD_NUMBER = 15; private int type_ = 0; /** + *
+   * The Type of this ThreadRun.
+   * 
+ * * .littlehorse.ThreadType type = 15; * @return The enum numeric value on the wire for type. */ @@ -430,6 +631,10 @@ public int getHandledFailedChildren(int index) { return type_; } /** + *
+   * The Type of this ThreadRun.
+   * 
+ * * .littlehorse.ThreadType type = 15; * @return The type. */ @@ -816,6 +1021,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * A ThreadRun is a running thread of execution within a WfRun.
+   * 
+ * * Protobuf type {@code littlehorse.ThreadRun} */ public static final class Builder extends @@ -1304,6 +1513,12 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.WfSpecId, io.littlehorse.sdk.common.proto.WfSpecId.Builder, io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder> wfSpecIdBuilder_; /** + *
+     * The current WfSpecId of this ThreadRun. This must be set explicitly because
+     * during a WfSpec Version Migration, it is possible for different ThreadSpec's to
+     * have different WfSpec versions.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 1; * @return Whether the wfSpecId field is set. */ @@ -1311,6 +1526,12 @@ public boolean hasWfSpecId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * The current WfSpecId of this ThreadRun. This must be set explicitly because
+     * during a WfSpec Version Migration, it is possible for different ThreadSpec's to
+     * have different WfSpec versions.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 1; * @return The wfSpecId. */ @@ -1322,6 +1543,12 @@ public io.littlehorse.sdk.common.proto.WfSpecId getWfSpecId() { } } /** + *
+     * The current WfSpecId of this ThreadRun. This must be set explicitly because
+     * during a WfSpec Version Migration, it is possible for different ThreadSpec's to
+     * have different WfSpec versions.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 1; */ public Builder setWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { @@ -1338,6 +1565,12 @@ public Builder setWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { return this; } /** + *
+     * The current WfSpecId of this ThreadRun. This must be set explicitly because
+     * during a WfSpec Version Migration, it is possible for different ThreadSpec's to
+     * have different WfSpec versions.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 1; */ public Builder setWfSpecId( @@ -1352,6 +1585,12 @@ public Builder setWfSpecId( return this; } /** + *
+     * The current WfSpecId of this ThreadRun. This must be set explicitly because
+     * during a WfSpec Version Migration, it is possible for different ThreadSpec's to
+     * have different WfSpec versions.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 1; */ public Builder mergeWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { @@ -1371,6 +1610,12 @@ public Builder mergeWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { return this; } /** + *
+     * The current WfSpecId of this ThreadRun. This must be set explicitly because
+     * during a WfSpec Version Migration, it is possible for different ThreadSpec's to
+     * have different WfSpec versions.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 1; */ public Builder clearWfSpecId() { @@ -1384,6 +1629,12 @@ public Builder clearWfSpecId() { return this; } /** + *
+     * The current WfSpecId of this ThreadRun. This must be set explicitly because
+     * during a WfSpec Version Migration, it is possible for different ThreadSpec's to
+     * have different WfSpec versions.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 1; */ public io.littlehorse.sdk.common.proto.WfSpecId.Builder getWfSpecIdBuilder() { @@ -1392,6 +1643,12 @@ public io.littlehorse.sdk.common.proto.WfSpecId.Builder getWfSpecIdBuilder() { return getWfSpecIdFieldBuilder().getBuilder(); } /** + *
+     * The current WfSpecId of this ThreadRun. This must be set explicitly because
+     * during a WfSpec Version Migration, it is possible for different ThreadSpec's to
+     * have different WfSpec versions.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 1; */ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder() { @@ -1403,6 +1660,12 @@ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder() } } /** + *
+     * The current WfSpecId of this ThreadRun. This must be set explicitly because
+     * during a WfSpec Version Migration, it is possible for different ThreadSpec's to
+     * have different WfSpec versions.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1421,6 +1684,14 @@ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder() private int number_ ; /** + *
+     * The number of the ThreadRun. This is an auto-incremented integer corresponding to
+     * the chronological ordering of when the ThreadRun's were created. If you have not
+     * configured any retention policy for the ThreadRun's (i.e. never clean them up), then
+     * this also corresponds to the position of the ThreadRun in the WfRun's `thread_runs`
+     * list.
+     * 
+ * * int32 number = 2; * @return The number. */ @@ -1429,6 +1700,14 @@ public int getNumber() { return number_; } /** + *
+     * The number of the ThreadRun. This is an auto-incremented integer corresponding to
+     * the chronological ordering of when the ThreadRun's were created. If you have not
+     * configured any retention policy for the ThreadRun's (i.e. never clean them up), then
+     * this also corresponds to the position of the ThreadRun in the WfRun's `thread_runs`
+     * list.
+     * 
+ * * int32 number = 2; * @param value The number to set. * @return This builder for chaining. @@ -1441,6 +1720,14 @@ public Builder setNumber(int value) { return this; } /** + *
+     * The number of the ThreadRun. This is an auto-incremented integer corresponding to
+     * the chronological ordering of when the ThreadRun's were created. If you have not
+     * configured any retention policy for the ThreadRun's (i.e. never clean them up), then
+     * this also corresponds to the position of the ThreadRun in the WfRun's `thread_runs`
+     * list.
+     * 
+ * * int32 number = 2; * @return This builder for chaining. */ @@ -1453,6 +1740,10 @@ public Builder clearNumber() { private int status_ = 0; /** + *
+     * The status of the ThreadRun.
+     * 
+ * * .littlehorse.LHStatus status = 3; * @return The enum numeric value on the wire for status. */ @@ -1460,6 +1751,10 @@ public Builder clearNumber() { return status_; } /** + *
+     * The status of the ThreadRun.
+     * 
+ * * .littlehorse.LHStatus status = 3; * @param value The enum numeric value on the wire for status to set. * @return This builder for chaining. @@ -1471,6 +1766,10 @@ public Builder setStatusValue(int value) { return this; } /** + *
+     * The status of the ThreadRun.
+     * 
+ * * .littlehorse.LHStatus status = 3; * @return The status. */ @@ -1480,6 +1779,10 @@ public io.littlehorse.sdk.common.proto.LHStatus getStatus() { return result == null ? io.littlehorse.sdk.common.proto.LHStatus.UNRECOGNIZED : result; } /** + *
+     * The status of the ThreadRun.
+     * 
+ * * .littlehorse.LHStatus status = 3; * @param value The status to set. * @return This builder for chaining. @@ -1494,6 +1797,10 @@ public Builder setStatus(io.littlehorse.sdk.common.proto.LHStatus value) { return this; } /** + *
+     * The status of the ThreadRun.
+     * 
+ * * .littlehorse.LHStatus status = 3; * @return This builder for chaining. */ @@ -1506,6 +1813,10 @@ public Builder clearStatus() { private java.lang.Object threadSpecName_ = ""; /** + *
+     * The name of the ThreadSpec being run.
+     * 
+ * * string thread_spec_name = 4; * @return The threadSpecName. */ @@ -1522,6 +1833,10 @@ public java.lang.String getThreadSpecName() { } } /** + *
+     * The name of the ThreadSpec being run.
+     * 
+ * * string thread_spec_name = 4; * @return The bytes for threadSpecName. */ @@ -1539,6 +1854,10 @@ public java.lang.String getThreadSpecName() { } } /** + *
+     * The name of the ThreadSpec being run.
+     * 
+ * * string thread_spec_name = 4; * @param value The threadSpecName to set. * @return This builder for chaining. @@ -1552,6 +1871,10 @@ public Builder setThreadSpecName( return this; } /** + *
+     * The name of the ThreadSpec being run.
+     * 
+ * * string thread_spec_name = 4; * @return This builder for chaining. */ @@ -1562,6 +1885,10 @@ public Builder clearThreadSpecName() { return this; } /** + *
+     * The name of the ThreadSpec being run.
+     * 
+ * * string thread_spec_name = 4; * @param value The bytes for threadSpecName to set. * @return This builder for chaining. @@ -1580,6 +1907,10 @@ public Builder setThreadSpecNameBytes( private com.google.protobuf.SingleFieldBuilderV3< com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> startTimeBuilder_; /** + *
+     * The time the ThreadRun was started.
+     * 
+ * * .google.protobuf.Timestamp start_time = 5; * @return Whether the startTime field is set. */ @@ -1587,6 +1918,10 @@ public boolean hasStartTime() { return ((bitField0_ & 0x00000010) != 0); } /** + *
+     * The time the ThreadRun was started.
+     * 
+ * * .google.protobuf.Timestamp start_time = 5; * @return The startTime. */ @@ -1598,6 +1933,10 @@ public com.google.protobuf.Timestamp getStartTime() { } } /** + *
+     * The time the ThreadRun was started.
+     * 
+ * * .google.protobuf.Timestamp start_time = 5; */ public Builder setStartTime(com.google.protobuf.Timestamp value) { @@ -1614,6 +1953,10 @@ public Builder setStartTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the ThreadRun was started.
+     * 
+ * * .google.protobuf.Timestamp start_time = 5; */ public Builder setStartTime( @@ -1628,6 +1971,10 @@ public Builder setStartTime( return this; } /** + *
+     * The time the ThreadRun was started.
+     * 
+ * * .google.protobuf.Timestamp start_time = 5; */ public Builder mergeStartTime(com.google.protobuf.Timestamp value) { @@ -1647,6 +1994,10 @@ public Builder mergeStartTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the ThreadRun was started.
+     * 
+ * * .google.protobuf.Timestamp start_time = 5; */ public Builder clearStartTime() { @@ -1660,6 +2011,10 @@ public Builder clearStartTime() { return this; } /** + *
+     * The time the ThreadRun was started.
+     * 
+ * * .google.protobuf.Timestamp start_time = 5; */ public com.google.protobuf.Timestamp.Builder getStartTimeBuilder() { @@ -1668,6 +2023,10 @@ public com.google.protobuf.Timestamp.Builder getStartTimeBuilder() { return getStartTimeFieldBuilder().getBuilder(); } /** + *
+     * The time the ThreadRun was started.
+     * 
+ * * .google.protobuf.Timestamp start_time = 5; */ public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder() { @@ -1679,6 +2038,10 @@ public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder() { } } /** + *
+     * The time the ThreadRun was started.
+     * 
+ * * .google.protobuf.Timestamp start_time = 5; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1699,6 +2062,10 @@ public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder() { private com.google.protobuf.SingleFieldBuilderV3< com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> endTimeBuilder_; /** + *
+     * The time the ThreadRun was completed or failed. Unset if still active.
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 6; * @return Whether the endTime field is set. */ @@ -1706,6 +2073,10 @@ public boolean hasEndTime() { return ((bitField0_ & 0x00000020) != 0); } /** + *
+     * The time the ThreadRun was completed or failed. Unset if still active.
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 6; * @return The endTime. */ @@ -1717,6 +2088,10 @@ public com.google.protobuf.Timestamp getEndTime() { } } /** + *
+     * The time the ThreadRun was completed or failed. Unset if still active.
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 6; */ public Builder setEndTime(com.google.protobuf.Timestamp value) { @@ -1733,6 +2108,10 @@ public Builder setEndTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the ThreadRun was completed or failed. Unset if still active.
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 6; */ public Builder setEndTime( @@ -1747,6 +2126,10 @@ public Builder setEndTime( return this; } /** + *
+     * The time the ThreadRun was completed or failed. Unset if still active.
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 6; */ public Builder mergeEndTime(com.google.protobuf.Timestamp value) { @@ -1766,6 +2149,10 @@ public Builder mergeEndTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the ThreadRun was completed or failed. Unset if still active.
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 6; */ public Builder clearEndTime() { @@ -1779,6 +2166,10 @@ public Builder clearEndTime() { return this; } /** + *
+     * The time the ThreadRun was completed or failed. Unset if still active.
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 6; */ public com.google.protobuf.Timestamp.Builder getEndTimeBuilder() { @@ -1787,6 +2178,10 @@ public com.google.protobuf.Timestamp.Builder getEndTimeBuilder() { return getEndTimeFieldBuilder().getBuilder(); } /** + *
+     * The time the ThreadRun was completed or failed. Unset if still active.
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 6; */ public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder() { @@ -1798,6 +2193,10 @@ public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder() { } } /** + *
+     * The time the ThreadRun was completed or failed. Unset if still active.
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 6; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1816,6 +2215,10 @@ public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder() { private java.lang.Object errorMessage_ = ""; /** + *
+     * Human-readable error message detailing what went wrong in the case of a failure.
+     * 
+ * * optional string error_message = 7; * @return Whether the errorMessage field is set. */ @@ -1823,6 +2226,10 @@ public boolean hasErrorMessage() { return ((bitField0_ & 0x00000040) != 0); } /** + *
+     * Human-readable error message detailing what went wrong in the case of a failure.
+     * 
+ * * optional string error_message = 7; * @return The errorMessage. */ @@ -1839,6 +2246,10 @@ public java.lang.String getErrorMessage() { } } /** + *
+     * Human-readable error message detailing what went wrong in the case of a failure.
+     * 
+ * * optional string error_message = 7; * @return The bytes for errorMessage. */ @@ -1856,6 +2267,10 @@ public java.lang.String getErrorMessage() { } } /** + *
+     * Human-readable error message detailing what went wrong in the case of a failure.
+     * 
+ * * optional string error_message = 7; * @param value The errorMessage to set. * @return This builder for chaining. @@ -1869,6 +2284,10 @@ public Builder setErrorMessage( return this; } /** + *
+     * Human-readable error message detailing what went wrong in the case of a failure.
+     * 
+ * * optional string error_message = 7; * @return This builder for chaining. */ @@ -1879,6 +2298,10 @@ public Builder clearErrorMessage() { return this; } /** + *
+     * Human-readable error message detailing what went wrong in the case of a failure.
+     * 
+ * * optional string error_message = 7; * @param value The bytes for errorMessage to set. * @return This builder for chaining. @@ -1901,6 +2324,10 @@ private void ensureChildThreadIdsIsMutable() { } } /** + *
+     * List of thread_run_number's for all child thread_runs.
+     * 
+ * * repeated int32 child_thread_ids = 8; * @return A list containing the childThreadIds. */ @@ -1910,6 +2337,10 @@ private void ensureChildThreadIdsIsMutable() { java.util.Collections.unmodifiableList(childThreadIds_) : childThreadIds_; } /** + *
+     * List of thread_run_number's for all child thread_runs.
+     * 
+ * * repeated int32 child_thread_ids = 8; * @return The count of childThreadIds. */ @@ -1917,6 +2348,10 @@ public int getChildThreadIdsCount() { return childThreadIds_.size(); } /** + *
+     * List of thread_run_number's for all child thread_runs.
+     * 
+ * * repeated int32 child_thread_ids = 8; * @param index The index of the element to return. * @return The childThreadIds at the given index. @@ -1925,6 +2360,10 @@ public int getChildThreadIds(int index) { return childThreadIds_.getInt(index); } /** + *
+     * List of thread_run_number's for all child thread_runs.
+     * 
+ * * repeated int32 child_thread_ids = 8; * @param index The index to set the value at. * @param value The childThreadIds to set. @@ -1939,6 +2378,10 @@ public Builder setChildThreadIds( return this; } /** + *
+     * List of thread_run_number's for all child thread_runs.
+     * 
+ * * repeated int32 child_thread_ids = 8; * @param value The childThreadIds to add. * @return This builder for chaining. @@ -1951,6 +2394,10 @@ public Builder addChildThreadIds(int value) { return this; } /** + *
+     * List of thread_run_number's for all child thread_runs.
+     * 
+ * * repeated int32 child_thread_ids = 8; * @param values The childThreadIds to add. * @return This builder for chaining. @@ -1964,6 +2411,10 @@ public Builder addAllChildThreadIds( return this; } /** + *
+     * List of thread_run_number's for all child thread_runs.
+     * 
+ * * repeated int32 child_thread_ids = 8; * @return This builder for chaining. */ @@ -1976,6 +2427,10 @@ public Builder clearChildThreadIds() { private int parentThreadId_ ; /** + *
+     * Set for every ThreadRun except the ENTRYPOINT. This is the id of the parent thread.
+     * 
+ * * optional int32 parent_thread_id = 9; * @return Whether the parentThreadId field is set. */ @@ -1984,6 +2439,10 @@ public boolean hasParentThreadId() { return ((bitField0_ & 0x00000100) != 0); } /** + *
+     * Set for every ThreadRun except the ENTRYPOINT. This is the id of the parent thread.
+     * 
+ * * optional int32 parent_thread_id = 9; * @return The parentThreadId. */ @@ -1992,6 +2451,10 @@ public int getParentThreadId() { return parentThreadId_; } /** + *
+     * Set for every ThreadRun except the ENTRYPOINT. This is the id of the parent thread.
+     * 
+ * * optional int32 parent_thread_id = 9; * @param value The parentThreadId to set. * @return This builder for chaining. @@ -2004,6 +2467,10 @@ public Builder setParentThreadId(int value) { return this; } /** + *
+     * Set for every ThreadRun except the ENTRYPOINT. This is the id of the parent thread.
+     * 
+ * * optional int32 parent_thread_id = 9; * @return This builder for chaining. */ @@ -2027,6 +2494,12 @@ private void ensureHaltReasonsIsMutable() { io.littlehorse.sdk.common.proto.ThreadHaltReason, io.littlehorse.sdk.common.proto.ThreadHaltReason.Builder, io.littlehorse.sdk.common.proto.ThreadHaltReasonOrBuilder> haltReasonsBuilder_; /** + *
+     * If the ThreadRun is HALTED, this contains a list of every reason for which the
+     * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+     * then the ThreadRun will return to the RUNNING state.
+     * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ public java.util.List getHaltReasonsList() { @@ -2037,6 +2510,12 @@ public java.util.List getHaltR } } /** + *
+     * If the ThreadRun is HALTED, this contains a list of every reason for which the
+     * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+     * then the ThreadRun will return to the RUNNING state.
+     * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ public int getHaltReasonsCount() { @@ -2047,6 +2526,12 @@ public int getHaltReasonsCount() { } } /** + *
+     * If the ThreadRun is HALTED, this contains a list of every reason for which the
+     * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+     * then the ThreadRun will return to the RUNNING state.
+     * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ public io.littlehorse.sdk.common.proto.ThreadHaltReason getHaltReasons(int index) { @@ -2057,6 +2542,12 @@ public io.littlehorse.sdk.common.proto.ThreadHaltReason getHaltReasons(int index } } /** + *
+     * If the ThreadRun is HALTED, this contains a list of every reason for which the
+     * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+     * then the ThreadRun will return to the RUNNING state.
+     * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ public Builder setHaltReasons( @@ -2074,6 +2565,12 @@ public Builder setHaltReasons( return this; } /** + *
+     * If the ThreadRun is HALTED, this contains a list of every reason for which the
+     * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+     * then the ThreadRun will return to the RUNNING state.
+     * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ public Builder setHaltReasons( @@ -2088,6 +2585,12 @@ public Builder setHaltReasons( return this; } /** + *
+     * If the ThreadRun is HALTED, this contains a list of every reason for which the
+     * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+     * then the ThreadRun will return to the RUNNING state.
+     * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ public Builder addHaltReasons(io.littlehorse.sdk.common.proto.ThreadHaltReason value) { @@ -2104,6 +2607,12 @@ public Builder addHaltReasons(io.littlehorse.sdk.common.proto.ThreadHaltReason v return this; } /** + *
+     * If the ThreadRun is HALTED, this contains a list of every reason for which the
+     * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+     * then the ThreadRun will return to the RUNNING state.
+     * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ public Builder addHaltReasons( @@ -2121,6 +2630,12 @@ public Builder addHaltReasons( return this; } /** + *
+     * If the ThreadRun is HALTED, this contains a list of every reason for which the
+     * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+     * then the ThreadRun will return to the RUNNING state.
+     * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ public Builder addHaltReasons( @@ -2135,6 +2650,12 @@ public Builder addHaltReasons( return this; } /** + *
+     * If the ThreadRun is HALTED, this contains a list of every reason for which the
+     * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+     * then the ThreadRun will return to the RUNNING state.
+     * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ public Builder addHaltReasons( @@ -2149,6 +2670,12 @@ public Builder addHaltReasons( return this; } /** + *
+     * If the ThreadRun is HALTED, this contains a list of every reason for which the
+     * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+     * then the ThreadRun will return to the RUNNING state.
+     * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ public Builder addAllHaltReasons( @@ -2164,6 +2691,12 @@ public Builder addAllHaltReasons( return this; } /** + *
+     * If the ThreadRun is HALTED, this contains a list of every reason for which the
+     * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+     * then the ThreadRun will return to the RUNNING state.
+     * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ public Builder clearHaltReasons() { @@ -2177,6 +2710,12 @@ public Builder clearHaltReasons() { return this; } /** + *
+     * If the ThreadRun is HALTED, this contains a list of every reason for which the
+     * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+     * then the ThreadRun will return to the RUNNING state.
+     * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ public Builder removeHaltReasons(int index) { @@ -2190,6 +2729,12 @@ public Builder removeHaltReasons(int index) { return this; } /** + *
+     * If the ThreadRun is HALTED, this contains a list of every reason for which the
+     * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+     * then the ThreadRun will return to the RUNNING state.
+     * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ public io.littlehorse.sdk.common.proto.ThreadHaltReason.Builder getHaltReasonsBuilder( @@ -2197,6 +2742,12 @@ public io.littlehorse.sdk.common.proto.ThreadHaltReason.Builder getHaltReasonsBu return getHaltReasonsFieldBuilder().getBuilder(index); } /** + *
+     * If the ThreadRun is HALTED, this contains a list of every reason for which the
+     * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+     * then the ThreadRun will return to the RUNNING state.
+     * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ public io.littlehorse.sdk.common.proto.ThreadHaltReasonOrBuilder getHaltReasonsOrBuilder( @@ -2207,6 +2758,12 @@ public io.littlehorse.sdk.common.proto.ThreadHaltReasonOrBuilder getHaltReasonsO } } /** + *
+     * If the ThreadRun is HALTED, this contains a list of every reason for which the
+     * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+     * then the ThreadRun will return to the RUNNING state.
+     * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ public java.util.List @@ -2218,6 +2775,12 @@ public io.littlehorse.sdk.common.proto.ThreadHaltReasonOrBuilder getHaltReasonsO } } /** + *
+     * If the ThreadRun is HALTED, this contains a list of every reason for which the
+     * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+     * then the ThreadRun will return to the RUNNING state.
+     * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ public io.littlehorse.sdk.common.proto.ThreadHaltReason.Builder addHaltReasonsBuilder() { @@ -2225,6 +2788,12 @@ public io.littlehorse.sdk.common.proto.ThreadHaltReason.Builder addHaltReasonsBu io.littlehorse.sdk.common.proto.ThreadHaltReason.getDefaultInstance()); } /** + *
+     * If the ThreadRun is HALTED, this contains a list of every reason for which the
+     * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+     * then the ThreadRun will return to the RUNNING state.
+     * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ public io.littlehorse.sdk.common.proto.ThreadHaltReason.Builder addHaltReasonsBuilder( @@ -2233,6 +2802,12 @@ public io.littlehorse.sdk.common.proto.ThreadHaltReason.Builder addHaltReasonsBu index, io.littlehorse.sdk.common.proto.ThreadHaltReason.getDefaultInstance()); } /** + *
+     * If the ThreadRun is HALTED, this contains a list of every reason for which the
+     * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+     * then the ThreadRun will return to the RUNNING state.
+     * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ public java.util.List @@ -2258,6 +2833,11 @@ public io.littlehorse.sdk.common.proto.ThreadHaltReason.Builder addHaltReasonsBu private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.ExternalEventId, io.littlehorse.sdk.common.proto.ExternalEventId.Builder, io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder> interruptTriggerIdBuilder_; /** + *
+     * If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the
+     * ExternalEvent that caused the Interrupt.
+     * 
+ * * optional .littlehorse.ExternalEventId interrupt_trigger_id = 11; * @return Whether the interruptTriggerId field is set. */ @@ -2265,6 +2845,11 @@ public boolean hasInterruptTriggerId() { return ((bitField0_ & 0x00000400) != 0); } /** + *
+     * If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the
+     * ExternalEvent that caused the Interrupt.
+     * 
+ * * optional .littlehorse.ExternalEventId interrupt_trigger_id = 11; * @return The interruptTriggerId. */ @@ -2276,6 +2861,11 @@ public io.littlehorse.sdk.common.proto.ExternalEventId getInterruptTriggerId() { } } /** + *
+     * If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the
+     * ExternalEvent that caused the Interrupt.
+     * 
+ * * optional .littlehorse.ExternalEventId interrupt_trigger_id = 11; */ public Builder setInterruptTriggerId(io.littlehorse.sdk.common.proto.ExternalEventId value) { @@ -2292,6 +2882,11 @@ public Builder setInterruptTriggerId(io.littlehorse.sdk.common.proto.ExternalEve return this; } /** + *
+     * If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the
+     * ExternalEvent that caused the Interrupt.
+     * 
+ * * optional .littlehorse.ExternalEventId interrupt_trigger_id = 11; */ public Builder setInterruptTriggerId( @@ -2306,6 +2901,11 @@ public Builder setInterruptTriggerId( return this; } /** + *
+     * If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the
+     * ExternalEvent that caused the Interrupt.
+     * 
+ * * optional .littlehorse.ExternalEventId interrupt_trigger_id = 11; */ public Builder mergeInterruptTriggerId(io.littlehorse.sdk.common.proto.ExternalEventId value) { @@ -2325,6 +2925,11 @@ public Builder mergeInterruptTriggerId(io.littlehorse.sdk.common.proto.ExternalE return this; } /** + *
+     * If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the
+     * ExternalEvent that caused the Interrupt.
+     * 
+ * * optional .littlehorse.ExternalEventId interrupt_trigger_id = 11; */ public Builder clearInterruptTriggerId() { @@ -2338,6 +2943,11 @@ public Builder clearInterruptTriggerId() { return this; } /** + *
+     * If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the
+     * ExternalEvent that caused the Interrupt.
+     * 
+ * * optional .littlehorse.ExternalEventId interrupt_trigger_id = 11; */ public io.littlehorse.sdk.common.proto.ExternalEventId.Builder getInterruptTriggerIdBuilder() { @@ -2346,6 +2956,11 @@ public io.littlehorse.sdk.common.proto.ExternalEventId.Builder getInterruptTrigg return getInterruptTriggerIdFieldBuilder().getBuilder(); } /** + *
+     * If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the
+     * ExternalEvent that caused the Interrupt.
+     * 
+ * * optional .littlehorse.ExternalEventId interrupt_trigger_id = 11; */ public io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getInterruptTriggerIdOrBuilder() { @@ -2357,6 +2972,11 @@ public io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getInterruptTrig } } /** + *
+     * If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the
+     * ExternalEvent that caused the Interrupt.
+     * 
+ * * optional .littlehorse.ExternalEventId interrupt_trigger_id = 11; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -2377,6 +2997,11 @@ public io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getInterruptTrig private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.FailureBeingHandled, io.littlehorse.sdk.common.proto.FailureBeingHandled.Builder, io.littlehorse.sdk.common.proto.FailureBeingHandledOrBuilder> failureBeingHandledBuilder_; /** + *
+     * If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure
+     * that is being handled by this ThreadRun.
+     * 
+ * * optional .littlehorse.FailureBeingHandled failure_being_handled = 12; * @return Whether the failureBeingHandled field is set. */ @@ -2384,6 +3009,11 @@ public boolean hasFailureBeingHandled() { return ((bitField0_ & 0x00000800) != 0); } /** + *
+     * If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure
+     * that is being handled by this ThreadRun.
+     * 
+ * * optional .littlehorse.FailureBeingHandled failure_being_handled = 12; * @return The failureBeingHandled. */ @@ -2395,6 +3025,11 @@ public io.littlehorse.sdk.common.proto.FailureBeingHandled getFailureBeingHandle } } /** + *
+     * If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure
+     * that is being handled by this ThreadRun.
+     * 
+ * * optional .littlehorse.FailureBeingHandled failure_being_handled = 12; */ public Builder setFailureBeingHandled(io.littlehorse.sdk.common.proto.FailureBeingHandled value) { @@ -2411,6 +3046,11 @@ public Builder setFailureBeingHandled(io.littlehorse.sdk.common.proto.FailureBei return this; } /** + *
+     * If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure
+     * that is being handled by this ThreadRun.
+     * 
+ * * optional .littlehorse.FailureBeingHandled failure_being_handled = 12; */ public Builder setFailureBeingHandled( @@ -2425,6 +3065,11 @@ public Builder setFailureBeingHandled( return this; } /** + *
+     * If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure
+     * that is being handled by this ThreadRun.
+     * 
+ * * optional .littlehorse.FailureBeingHandled failure_being_handled = 12; */ public Builder mergeFailureBeingHandled(io.littlehorse.sdk.common.proto.FailureBeingHandled value) { @@ -2444,6 +3089,11 @@ public Builder mergeFailureBeingHandled(io.littlehorse.sdk.common.proto.FailureB return this; } /** + *
+     * If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure
+     * that is being handled by this ThreadRun.
+     * 
+ * * optional .littlehorse.FailureBeingHandled failure_being_handled = 12; */ public Builder clearFailureBeingHandled() { @@ -2457,6 +3107,11 @@ public Builder clearFailureBeingHandled() { return this; } /** + *
+     * If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure
+     * that is being handled by this ThreadRun.
+     * 
+ * * optional .littlehorse.FailureBeingHandled failure_being_handled = 12; */ public io.littlehorse.sdk.common.proto.FailureBeingHandled.Builder getFailureBeingHandledBuilder() { @@ -2465,6 +3120,11 @@ public io.littlehorse.sdk.common.proto.FailureBeingHandled.Builder getFailureBei return getFailureBeingHandledFieldBuilder().getBuilder(); } /** + *
+     * If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure
+     * that is being handled by this ThreadRun.
+     * 
+ * * optional .littlehorse.FailureBeingHandled failure_being_handled = 12; */ public io.littlehorse.sdk.common.proto.FailureBeingHandledOrBuilder getFailureBeingHandledOrBuilder() { @@ -2476,6 +3136,11 @@ public io.littlehorse.sdk.common.proto.FailureBeingHandledOrBuilder getFailureBe } } /** + *
+     * If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure
+     * that is being handled by this ThreadRun.
+     * 
+ * * optional .littlehorse.FailureBeingHandled failure_being_handled = 12; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -2494,6 +3159,11 @@ public io.littlehorse.sdk.common.proto.FailureBeingHandledOrBuilder getFailureBe private int currentNodePosition_ ; /** + *
+     * This is the current `position` of the current NodeRun being run. This is an
+     * auto-incremented field that gets incremented every time we run a new NodeRun.
+     * 
+ * * int32 current_node_position = 13; * @return The currentNodePosition. */ @@ -2502,6 +3172,11 @@ public int getCurrentNodePosition() { return currentNodePosition_; } /** + *
+     * This is the current `position` of the current NodeRun being run. This is an
+     * auto-incremented field that gets incremented every time we run a new NodeRun.
+     * 
+ * * int32 current_node_position = 13; * @param value The currentNodePosition to set. * @return This builder for chaining. @@ -2514,6 +3189,11 @@ public Builder setCurrentNodePosition(int value) { return this; } /** + *
+     * This is the current `position` of the current NodeRun being run. This is an
+     * auto-incremented field that gets incremented every time we run a new NodeRun.
+     * 
+ * * int32 current_node_position = 13; * @return This builder for chaining. */ @@ -2532,6 +3212,16 @@ private void ensureHandledFailedChildrenIsMutable() { } } /** + *
+     * List of every child ThreadRun which both a) failed, and b) was properly handled by a
+     * Failure Handler.
+     *
+     * This is important because at the EXIT node, if a Child ThreadRun was discovered to have
+     * failed, then this ThreadRun (the parent) also fails with the same failure as the child.
+     * If, however, a Failure Handler had previously "handled" the Child Failure, that ThreadRun's
+     * number is appended to this list, and then the EXIT node ignores that ThreadRun.
+     * 
+ * * repeated int32 handled_failed_children = 14; * @return A list containing the handledFailedChildren. */ @@ -2541,6 +3231,16 @@ private void ensureHandledFailedChildrenIsMutable() { java.util.Collections.unmodifiableList(handledFailedChildren_) : handledFailedChildren_; } /** + *
+     * List of every child ThreadRun which both a) failed, and b) was properly handled by a
+     * Failure Handler.
+     *
+     * This is important because at the EXIT node, if a Child ThreadRun was discovered to have
+     * failed, then this ThreadRun (the parent) also fails with the same failure as the child.
+     * If, however, a Failure Handler had previously "handled" the Child Failure, that ThreadRun's
+     * number is appended to this list, and then the EXIT node ignores that ThreadRun.
+     * 
+ * * repeated int32 handled_failed_children = 14; * @return The count of handledFailedChildren. */ @@ -2548,6 +3248,16 @@ public int getHandledFailedChildrenCount() { return handledFailedChildren_.size(); } /** + *
+     * List of every child ThreadRun which both a) failed, and b) was properly handled by a
+     * Failure Handler.
+     *
+     * This is important because at the EXIT node, if a Child ThreadRun was discovered to have
+     * failed, then this ThreadRun (the parent) also fails with the same failure as the child.
+     * If, however, a Failure Handler had previously "handled" the Child Failure, that ThreadRun's
+     * number is appended to this list, and then the EXIT node ignores that ThreadRun.
+     * 
+ * * repeated int32 handled_failed_children = 14; * @param index The index of the element to return. * @return The handledFailedChildren at the given index. @@ -2556,6 +3266,16 @@ public int getHandledFailedChildren(int index) { return handledFailedChildren_.getInt(index); } /** + *
+     * List of every child ThreadRun which both a) failed, and b) was properly handled by a
+     * Failure Handler.
+     *
+     * This is important because at the EXIT node, if a Child ThreadRun was discovered to have
+     * failed, then this ThreadRun (the parent) also fails with the same failure as the child.
+     * If, however, a Failure Handler had previously "handled" the Child Failure, that ThreadRun's
+     * number is appended to this list, and then the EXIT node ignores that ThreadRun.
+     * 
+ * * repeated int32 handled_failed_children = 14; * @param index The index to set the value at. * @param value The handledFailedChildren to set. @@ -2570,6 +3290,16 @@ public Builder setHandledFailedChildren( return this; } /** + *
+     * List of every child ThreadRun which both a) failed, and b) was properly handled by a
+     * Failure Handler.
+     *
+     * This is important because at the EXIT node, if a Child ThreadRun was discovered to have
+     * failed, then this ThreadRun (the parent) also fails with the same failure as the child.
+     * If, however, a Failure Handler had previously "handled" the Child Failure, that ThreadRun's
+     * number is appended to this list, and then the EXIT node ignores that ThreadRun.
+     * 
+ * * repeated int32 handled_failed_children = 14; * @param value The handledFailedChildren to add. * @return This builder for chaining. @@ -2582,6 +3312,16 @@ public Builder addHandledFailedChildren(int value) { return this; } /** + *
+     * List of every child ThreadRun which both a) failed, and b) was properly handled by a
+     * Failure Handler.
+     *
+     * This is important because at the EXIT node, if a Child ThreadRun was discovered to have
+     * failed, then this ThreadRun (the parent) also fails with the same failure as the child.
+     * If, however, a Failure Handler had previously "handled" the Child Failure, that ThreadRun's
+     * number is appended to this list, and then the EXIT node ignores that ThreadRun.
+     * 
+ * * repeated int32 handled_failed_children = 14; * @param values The handledFailedChildren to add. * @return This builder for chaining. @@ -2595,6 +3335,16 @@ public Builder addAllHandledFailedChildren( return this; } /** + *
+     * List of every child ThreadRun which both a) failed, and b) was properly handled by a
+     * Failure Handler.
+     *
+     * This is important because at the EXIT node, if a Child ThreadRun was discovered to have
+     * failed, then this ThreadRun (the parent) also fails with the same failure as the child.
+     * If, however, a Failure Handler had previously "handled" the Child Failure, that ThreadRun's
+     * number is appended to this list, and then the EXIT node ignores that ThreadRun.
+     * 
+ * * repeated int32 handled_failed_children = 14; * @return This builder for chaining. */ @@ -2607,6 +3357,10 @@ public Builder clearHandledFailedChildren() { private int type_ = 0; /** + *
+     * The Type of this ThreadRun.
+     * 
+ * * .littlehorse.ThreadType type = 15; * @return The enum numeric value on the wire for type. */ @@ -2614,6 +3368,10 @@ public Builder clearHandledFailedChildren() { return type_; } /** + *
+     * The Type of this ThreadRun.
+     * 
+ * * .littlehorse.ThreadType type = 15; * @param value The enum numeric value on the wire for type to set. * @return This builder for chaining. @@ -2625,6 +3383,10 @@ public Builder setTypeValue(int value) { return this; } /** + *
+     * The Type of this ThreadRun.
+     * 
+ * * .littlehorse.ThreadType type = 15; * @return The type. */ @@ -2634,6 +3396,10 @@ public io.littlehorse.sdk.common.proto.ThreadType getType() { return result == null ? io.littlehorse.sdk.common.proto.ThreadType.UNRECOGNIZED : result; } /** + *
+     * The Type of this ThreadRun.
+     * 
+ * * .littlehorse.ThreadType type = 15; * @param value The type to set. * @return This builder for chaining. @@ -2648,6 +3414,10 @@ public Builder setType(io.littlehorse.sdk.common.proto.ThreadType value) { return this; } /** + *
+     * The Type of this ThreadRun.
+     * 
+ * * .littlehorse.ThreadType type = 15; * @return This builder for chaining. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadRunOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadRunOrBuilder.java index f1c4b4175..b0c07c445 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadRunOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadRunOrBuilder.java @@ -8,43 +8,85 @@ public interface ThreadRunOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The current WfSpecId of this ThreadRun. This must be set explicitly because
+   * during a WfSpec Version Migration, it is possible for different ThreadSpec's to
+   * have different WfSpec versions.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 1; * @return Whether the wfSpecId field is set. */ boolean hasWfSpecId(); /** + *
+   * The current WfSpecId of this ThreadRun. This must be set explicitly because
+   * during a WfSpec Version Migration, it is possible for different ThreadSpec's to
+   * have different WfSpec versions.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 1; * @return The wfSpecId. */ io.littlehorse.sdk.common.proto.WfSpecId getWfSpecId(); /** + *
+   * The current WfSpecId of this ThreadRun. This must be set explicitly because
+   * during a WfSpec Version Migration, it is possible for different ThreadSpec's to
+   * have different WfSpec versions.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 1; */ io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder(); /** + *
+   * The number of the ThreadRun. This is an auto-incremented integer corresponding to
+   * the chronological ordering of when the ThreadRun's were created. If you have not
+   * configured any retention policy for the ThreadRun's (i.e. never clean them up), then
+   * this also corresponds to the position of the ThreadRun in the WfRun's `thread_runs`
+   * list.
+   * 
+ * * int32 number = 2; * @return The number. */ int getNumber(); /** + *
+   * The status of the ThreadRun.
+   * 
+ * * .littlehorse.LHStatus status = 3; * @return The enum numeric value on the wire for status. */ int getStatusValue(); /** + *
+   * The status of the ThreadRun.
+   * 
+ * * .littlehorse.LHStatus status = 3; * @return The status. */ io.littlehorse.sdk.common.proto.LHStatus getStatus(); /** + *
+   * The name of the ThreadSpec being run.
+   * 
+ * * string thread_spec_name = 4; * @return The threadSpecName. */ java.lang.String getThreadSpecName(); /** + *
+   * The name of the ThreadSpec being run.
+   * 
+ * * string thread_spec_name = 4; * @return The bytes for threadSpecName. */ @@ -52,46 +94,82 @@ public interface ThreadRunOrBuilder extends getThreadSpecNameBytes(); /** + *
+   * The time the ThreadRun was started.
+   * 
+ * * .google.protobuf.Timestamp start_time = 5; * @return Whether the startTime field is set. */ boolean hasStartTime(); /** + *
+   * The time the ThreadRun was started.
+   * 
+ * * .google.protobuf.Timestamp start_time = 5; * @return The startTime. */ com.google.protobuf.Timestamp getStartTime(); /** + *
+   * The time the ThreadRun was started.
+   * 
+ * * .google.protobuf.Timestamp start_time = 5; */ com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder(); /** + *
+   * The time the ThreadRun was completed or failed. Unset if still active.
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 6; * @return Whether the endTime field is set. */ boolean hasEndTime(); /** + *
+   * The time the ThreadRun was completed or failed. Unset if still active.
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 6; * @return The endTime. */ com.google.protobuf.Timestamp getEndTime(); /** + *
+   * The time the ThreadRun was completed or failed. Unset if still active.
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 6; */ com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder(); /** + *
+   * Human-readable error message detailing what went wrong in the case of a failure.
+   * 
+ * * optional string error_message = 7; * @return Whether the errorMessage field is set. */ boolean hasErrorMessage(); /** + *
+   * Human-readable error message detailing what went wrong in the case of a failure.
+   * 
+ * * optional string error_message = 7; * @return The errorMessage. */ java.lang.String getErrorMessage(); /** + *
+   * Human-readable error message detailing what went wrong in the case of a failure.
+   * 
+ * * optional string error_message = 7; * @return The bytes for errorMessage. */ @@ -99,16 +177,28 @@ public interface ThreadRunOrBuilder extends getErrorMessageBytes(); /** + *
+   * List of thread_run_number's for all child thread_runs.
+   * 
+ * * repeated int32 child_thread_ids = 8; * @return A list containing the childThreadIds. */ java.util.List getChildThreadIdsList(); /** + *
+   * List of thread_run_number's for all child thread_runs.
+   * 
+ * * repeated int32 child_thread_ids = 8; * @return The count of childThreadIds. */ int getChildThreadIdsCount(); /** + *
+   * List of thread_run_number's for all child thread_runs.
+   * 
+ * * repeated int32 child_thread_ids = 8; * @param index The index of the element to return. * @return The childThreadIds at the given index. @@ -116,87 +206,190 @@ public interface ThreadRunOrBuilder extends int getChildThreadIds(int index); /** + *
+   * Set for every ThreadRun except the ENTRYPOINT. This is the id of the parent thread.
+   * 
+ * * optional int32 parent_thread_id = 9; * @return Whether the parentThreadId field is set. */ boolean hasParentThreadId(); /** + *
+   * Set for every ThreadRun except the ENTRYPOINT. This is the id of the parent thread.
+   * 
+ * * optional int32 parent_thread_id = 9; * @return The parentThreadId. */ int getParentThreadId(); /** + *
+   * If the ThreadRun is HALTED, this contains a list of every reason for which the
+   * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+   * then the ThreadRun will return to the RUNNING state.
+   * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ java.util.List getHaltReasonsList(); /** + *
+   * If the ThreadRun is HALTED, this contains a list of every reason for which the
+   * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+   * then the ThreadRun will return to the RUNNING state.
+   * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ io.littlehorse.sdk.common.proto.ThreadHaltReason getHaltReasons(int index); /** + *
+   * If the ThreadRun is HALTED, this contains a list of every reason for which the
+   * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+   * then the ThreadRun will return to the RUNNING state.
+   * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ int getHaltReasonsCount(); /** + *
+   * If the ThreadRun is HALTED, this contains a list of every reason for which the
+   * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+   * then the ThreadRun will return to the RUNNING state.
+   * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ java.util.List getHaltReasonsOrBuilderList(); /** + *
+   * If the ThreadRun is HALTED, this contains a list of every reason for which the
+   * ThreadRun is HALTED. Once every reason is "resolved" (and thus removed from the list),
+   * then the ThreadRun will return to the RUNNING state.
+   * 
+ * * repeated .littlehorse.ThreadHaltReason halt_reasons = 10; */ io.littlehorse.sdk.common.proto.ThreadHaltReasonOrBuilder getHaltReasonsOrBuilder( int index); /** + *
+   * If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the
+   * ExternalEvent that caused the Interrupt.
+   * 
+ * * optional .littlehorse.ExternalEventId interrupt_trigger_id = 11; * @return Whether the interruptTriggerId field is set. */ boolean hasInterruptTriggerId(); /** + *
+   * If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the
+   * ExternalEvent that caused the Interrupt.
+   * 
+ * * optional .littlehorse.ExternalEventId interrupt_trigger_id = 11; * @return The interruptTriggerId. */ io.littlehorse.sdk.common.proto.ExternalEventId getInterruptTriggerId(); /** + *
+   * If this ThreadRun is of type INTERRUPT_HANDLER, this field is set to the ID of the
+   * ExternalEvent that caused the Interrupt.
+   * 
+ * * optional .littlehorse.ExternalEventId interrupt_trigger_id = 11; */ io.littlehorse.sdk.common.proto.ExternalEventIdOrBuilder getInterruptTriggerIdOrBuilder(); /** + *
+   * If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure
+   * that is being handled by this ThreadRun.
+   * 
+ * * optional .littlehorse.FailureBeingHandled failure_being_handled = 12; * @return Whether the failureBeingHandled field is set. */ boolean hasFailureBeingHandled(); /** + *
+   * If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure
+   * that is being handled by this ThreadRun.
+   * 
+ * * optional .littlehorse.FailureBeingHandled failure_being_handled = 12; * @return The failureBeingHandled. */ io.littlehorse.sdk.common.proto.FailureBeingHandled getFailureBeingHandled(); /** + *
+   * If this ThreadRun is of type FAILURE_HANDLER, this field is set to the exact Failure
+   * that is being handled by this ThreadRun.
+   * 
+ * * optional .littlehorse.FailureBeingHandled failure_being_handled = 12; */ io.littlehorse.sdk.common.proto.FailureBeingHandledOrBuilder getFailureBeingHandledOrBuilder(); /** + *
+   * This is the current `position` of the current NodeRun being run. This is an
+   * auto-incremented field that gets incremented every time we run a new NodeRun.
+   * 
+ * * int32 current_node_position = 13; * @return The currentNodePosition. */ int getCurrentNodePosition(); /** + *
+   * List of every child ThreadRun which both a) failed, and b) was properly handled by a
+   * Failure Handler.
+   *
+   * This is important because at the EXIT node, if a Child ThreadRun was discovered to have
+   * failed, then this ThreadRun (the parent) also fails with the same failure as the child.
+   * If, however, a Failure Handler had previously "handled" the Child Failure, that ThreadRun's
+   * number is appended to this list, and then the EXIT node ignores that ThreadRun.
+   * 
+ * * repeated int32 handled_failed_children = 14; * @return A list containing the handledFailedChildren. */ java.util.List getHandledFailedChildrenList(); /** + *
+   * List of every child ThreadRun which both a) failed, and b) was properly handled by a
+   * Failure Handler.
+   *
+   * This is important because at the EXIT node, if a Child ThreadRun was discovered to have
+   * failed, then this ThreadRun (the parent) also fails with the same failure as the child.
+   * If, however, a Failure Handler had previously "handled" the Child Failure, that ThreadRun's
+   * number is appended to this list, and then the EXIT node ignores that ThreadRun.
+   * 
+ * * repeated int32 handled_failed_children = 14; * @return The count of handledFailedChildren. */ int getHandledFailedChildrenCount(); /** + *
+   * List of every child ThreadRun which both a) failed, and b) was properly handled by a
+   * Failure Handler.
+   *
+   * This is important because at the EXIT node, if a Child ThreadRun was discovered to have
+   * failed, then this ThreadRun (the parent) also fails with the same failure as the child.
+   * If, however, a Failure Handler had previously "handled" the Child Failure, that ThreadRun's
+   * number is appended to this list, and then the EXIT node ignores that ThreadRun.
+   * 
+ * * repeated int32 handled_failed_children = 14; * @param index The index of the element to return. * @return The handledFailedChildren at the given index. @@ -204,11 +397,19 @@ io.littlehorse.sdk.common.proto.ThreadHaltReasonOrBuilder getHaltReasonsOrBuilde int getHandledFailedChildren(int index); /** + *
+   * The Type of this ThreadRun.
+   * 
+ * * .littlehorse.ThreadType type = 15; * @return The enum numeric value on the wire for type. */ int getTypeValue(); /** + *
+   * The Type of this ThreadRun.
+   * 
+ * * .littlehorse.ThreadType type = 15; * @return The type. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadType.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadType.java index 031b29556..6d14e0d93 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadType.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/ThreadType.java @@ -4,23 +4,44 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * The type of a ThreadRUn.
+ * 
+ * * Protobuf enum {@code littlehorse.ThreadType} */ public enum ThreadType implements com.google.protobuf.ProtocolMessageEnum { /** + *
+   * The ENTRYPOINT ThreadRun. Exactly one per WfRun. Always has number == 0.
+   * 
+ * * ENTRYPOINT = 0; */ ENTRYPOINT(0), /** + *
+   * A ThreadRun explicitly created by another ThreadRun via a START_THREAD or START_MULTIPLE_THREADS
+   * NodeRun.
+   * 
+ * * CHILD = 1; */ CHILD(1), /** + *
+   * A ThreadRun that was created to handle an Interrupt.
+   * 
+ * * INTERRUPT = 2; */ INTERRUPT(2), /** + *
+   * A ThreadRun that was created to handle a Failure.
+   * 
+ * * FAILURE_HANDLER = 3; */ FAILURE_HANDLER(3), @@ -28,18 +49,35 @@ public enum ThreadType ; /** + *
+   * The ENTRYPOINT ThreadRun. Exactly one per WfRun. Always has number == 0.
+   * 
+ * * ENTRYPOINT = 0; */ public static final int ENTRYPOINT_VALUE = 0; /** + *
+   * A ThreadRun explicitly created by another ThreadRun via a START_THREAD or START_MULTIPLE_THREADS
+   * NodeRun.
+   * 
+ * * CHILD = 1; */ public static final int CHILD_VALUE = 1; /** + *
+   * A ThreadRun that was created to handle an Interrupt.
+   * 
+ * * INTERRUPT = 2; */ public static final int INTERRUPT_VALUE = 2; /** + *
+   * A ThreadRun that was created to handle a Failure.
+   * 
+ * * FAILURE_HANDLER = 3; */ public static final int FAILURE_HANDLER_VALUE = 3; diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UTActionTrigger.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UTActionTrigger.java index acca931ce..fd7c86940 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UTActionTrigger.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UTActionTrigger.java @@ -52,15 +52,32 @@ protected java.lang.Object newInstance( } /** + *
+   * Enumerates the different lifecycle hooks that can cause the timer to start running.
+   * 
+ * * Protobuf enum {@code littlehorse.UTActionTrigger.UTHook} */ public enum UTHook implements com.google.protobuf.ProtocolMessageEnum { /** + *
+     * The hook should be scheduled `delay_seconds` after the UserTaskRun is created. This
+     * hook only causes the action to be scheduled once.
+     * 
+ * * ON_ARRIVAL = 0; */ ON_ARRIVAL(0), /** + *
+     * The hook should be scheduled `delay_seconds` after the ownership of the UserTaskRun
+     * changes. This hook causes the Action to be scheduled one or more times. The first
+     * time is scheduled when the UserTaskRun is created, since we treat the change from
+     * "UserTaskRun is nonexistent" to "UserTaskRun is owned by a userId or userGroup" as
+     * a change in ownership.
+     * 
+ * * ON_TASK_ASSIGNED = 1; */ ON_TASK_ASSIGNED(1), @@ -68,10 +85,23 @@ public enum UTHook ; /** + *
+     * The hook should be scheduled `delay_seconds` after the UserTaskRun is created. This
+     * hook only causes the action to be scheduled once.
+     * 
+ * * ON_ARRIVAL = 0; */ public static final int ON_ARRIVAL_VALUE = 0; /** + *
+     * The hook should be scheduled `delay_seconds` after the ownership of the UserTaskRun
+     * changes. This hook causes the Action to be scheduled one or more times. The first
+     * time is scheduled when the UserTaskRun is created, since we treat the change from
+     * "UserTaskRun is nonexistent" to "UserTaskRun is owned by a userId or userGroup" as
+     * a change in ownership.
+     * 
+ * * ON_TASK_ASSIGNED = 1; */ public static final int ON_TASK_ASSIGNED_VALUE = 1; @@ -164,6 +194,10 @@ public interface UTACancelOrBuilder extends com.google.protobuf.MessageOrBuilder { } /** + *
+   * A UserTaskAction that causes a UserTaskRun to be CANCELLED when it fires.
+   * 
+ * * Protobuf type {@code littlehorse.UTActionTrigger.UTACancel} */ public static final class UTACancel extends @@ -345,6 +379,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+     * A UserTaskAction that causes a UserTaskRun to be CANCELLED when it fires.
+     * 
+ * * Protobuf type {@code littlehorse.UTActionTrigger.UTACancel} */ public static final class Builder extends @@ -561,45 +599,81 @@ public interface UTATaskOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+     * The specification of the Task to schedule.
+     * 
+ * * .littlehorse.TaskNode task = 1; * @return Whether the task field is set. */ boolean hasTask(); /** + *
+     * The specification of the Task to schedule.
+     * 
+ * * .littlehorse.TaskNode task = 1; * @return The task. */ io.littlehorse.sdk.common.proto.TaskNode getTask(); /** + *
+     * The specification of the Task to schedule.
+     * 
+ * * .littlehorse.TaskNode task = 1; */ io.littlehorse.sdk.common.proto.TaskNodeOrBuilder getTaskOrBuilder(); /** + *
+     * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+     * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ java.util.List getMutationsList(); /** + *
+     * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+     * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ io.littlehorse.sdk.common.proto.VariableMutation getMutations(int index); /** + *
+     * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+     * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ int getMutationsCount(); /** + *
+     * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+     * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ java.util.List getMutationsOrBuilderList(); /** + *
+     * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+     * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ io.littlehorse.sdk.common.proto.VariableMutationOrBuilder getMutationsOrBuilder( int index); } /** + *
+   * A UserTaskAction that causes a TaskRun to be scheduled when it fires.
+   * 
+ * * Protobuf type {@code littlehorse.UTActionTrigger.UTATask} */ public static final class UTATask extends @@ -638,6 +712,10 @@ protected java.lang.Object newInstance( public static final int TASK_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.TaskNode task_; /** + *
+     * The specification of the Task to schedule.
+     * 
+ * * .littlehorse.TaskNode task = 1; * @return Whether the task field is set. */ @@ -646,6 +724,10 @@ public boolean hasTask() { return task_ != null; } /** + *
+     * The specification of the Task to schedule.
+     * 
+ * * .littlehorse.TaskNode task = 1; * @return The task. */ @@ -654,6 +736,10 @@ public io.littlehorse.sdk.common.proto.TaskNode getTask() { return task_ == null ? io.littlehorse.sdk.common.proto.TaskNode.getDefaultInstance() : task_; } /** + *
+     * The specification of the Task to schedule.
+     * 
+ * * .littlehorse.TaskNode task = 1; */ @java.lang.Override @@ -665,6 +751,10 @@ public io.littlehorse.sdk.common.proto.TaskNodeOrBuilder getTaskOrBuilder() { @SuppressWarnings("serial") private java.util.List mutations_; /** + *
+     * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+     * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ @java.lang.Override @@ -672,6 +762,10 @@ public java.util.List getMutat return mutations_; } /** + *
+     * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+     * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ @java.lang.Override @@ -680,6 +774,10 @@ public java.util.List getMutat return mutations_; } /** + *
+     * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+     * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ @java.lang.Override @@ -687,6 +785,10 @@ public int getMutationsCount() { return mutations_.size(); } /** + *
+     * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+     * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ @java.lang.Override @@ -694,6 +796,10 @@ public io.littlehorse.sdk.common.proto.VariableMutation getMutations(int index) return mutations_.get(index); } /** + *
+     * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+     * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ @java.lang.Override @@ -878,6 +984,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+     * A UserTaskAction that causes a TaskRun to be scheduled when it fires.
+     * 
+ * * Protobuf type {@code littlehorse.UTActionTrigger.UTATask} */ public static final class Builder extends @@ -1116,6 +1226,10 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.TaskNode, io.littlehorse.sdk.common.proto.TaskNode.Builder, io.littlehorse.sdk.common.proto.TaskNodeOrBuilder> taskBuilder_; /** + *
+       * The specification of the Task to schedule.
+       * 
+ * * .littlehorse.TaskNode task = 1; * @return Whether the task field is set. */ @@ -1123,6 +1237,10 @@ public boolean hasTask() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+       * The specification of the Task to schedule.
+       * 
+ * * .littlehorse.TaskNode task = 1; * @return The task. */ @@ -1134,6 +1252,10 @@ public io.littlehorse.sdk.common.proto.TaskNode getTask() { } } /** + *
+       * The specification of the Task to schedule.
+       * 
+ * * .littlehorse.TaskNode task = 1; */ public Builder setTask(io.littlehorse.sdk.common.proto.TaskNode value) { @@ -1150,6 +1272,10 @@ public Builder setTask(io.littlehorse.sdk.common.proto.TaskNode value) { return this; } /** + *
+       * The specification of the Task to schedule.
+       * 
+ * * .littlehorse.TaskNode task = 1; */ public Builder setTask( @@ -1164,6 +1290,10 @@ public Builder setTask( return this; } /** + *
+       * The specification of the Task to schedule.
+       * 
+ * * .littlehorse.TaskNode task = 1; */ public Builder mergeTask(io.littlehorse.sdk.common.proto.TaskNode value) { @@ -1183,6 +1313,10 @@ public Builder mergeTask(io.littlehorse.sdk.common.proto.TaskNode value) { return this; } /** + *
+       * The specification of the Task to schedule.
+       * 
+ * * .littlehorse.TaskNode task = 1; */ public Builder clearTask() { @@ -1196,6 +1330,10 @@ public Builder clearTask() { return this; } /** + *
+       * The specification of the Task to schedule.
+       * 
+ * * .littlehorse.TaskNode task = 1; */ public io.littlehorse.sdk.common.proto.TaskNode.Builder getTaskBuilder() { @@ -1204,6 +1342,10 @@ public io.littlehorse.sdk.common.proto.TaskNode.Builder getTaskBuilder() { return getTaskFieldBuilder().getBuilder(); } /** + *
+       * The specification of the Task to schedule.
+       * 
+ * * .littlehorse.TaskNode task = 1; */ public io.littlehorse.sdk.common.proto.TaskNodeOrBuilder getTaskOrBuilder() { @@ -1215,6 +1357,10 @@ public io.littlehorse.sdk.common.proto.TaskNodeOrBuilder getTaskOrBuilder() { } } /** + *
+       * The specification of the Task to schedule.
+       * 
+ * * .littlehorse.TaskNode task = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1244,6 +1390,10 @@ private void ensureMutationsIsMutable() { io.littlehorse.sdk.common.proto.VariableMutation, io.littlehorse.sdk.common.proto.VariableMutation.Builder, io.littlehorse.sdk.common.proto.VariableMutationOrBuilder> mutationsBuilder_; /** + *
+       * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+       * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ public java.util.List getMutationsList() { @@ -1254,6 +1404,10 @@ public java.util.List getMutat } } /** + *
+       * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+       * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ public int getMutationsCount() { @@ -1264,6 +1418,10 @@ public int getMutationsCount() { } } /** + *
+       * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+       * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ public io.littlehorse.sdk.common.proto.VariableMutation getMutations(int index) { @@ -1274,6 +1432,10 @@ public io.littlehorse.sdk.common.proto.VariableMutation getMutations(int index) } } /** + *
+       * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+       * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ public Builder setMutations( @@ -1291,6 +1453,10 @@ public Builder setMutations( return this; } /** + *
+       * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+       * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ public Builder setMutations( @@ -1305,6 +1471,10 @@ public Builder setMutations( return this; } /** + *
+       * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+       * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ public Builder addMutations(io.littlehorse.sdk.common.proto.VariableMutation value) { @@ -1321,6 +1491,10 @@ public Builder addMutations(io.littlehorse.sdk.common.proto.VariableMutation val return this; } /** + *
+       * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+       * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ public Builder addMutations( @@ -1338,6 +1512,10 @@ public Builder addMutations( return this; } /** + *
+       * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+       * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ public Builder addMutations( @@ -1352,6 +1530,10 @@ public Builder addMutations( return this; } /** + *
+       * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+       * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ public Builder addMutations( @@ -1366,6 +1548,10 @@ public Builder addMutations( return this; } /** + *
+       * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+       * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ public Builder addAllMutations( @@ -1381,6 +1567,10 @@ public Builder addAllMutations( return this; } /** + *
+       * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+       * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ public Builder clearMutations() { @@ -1394,6 +1584,10 @@ public Builder clearMutations() { return this; } /** + *
+       * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+       * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ public Builder removeMutations(int index) { @@ -1407,6 +1601,10 @@ public Builder removeMutations(int index) { return this; } /** + *
+       * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+       * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ public io.littlehorse.sdk.common.proto.VariableMutation.Builder getMutationsBuilder( @@ -1414,6 +1612,10 @@ public io.littlehorse.sdk.common.proto.VariableMutation.Builder getMutationsBuil return getMutationsFieldBuilder().getBuilder(index); } /** + *
+       * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+       * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ public io.littlehorse.sdk.common.proto.VariableMutationOrBuilder getMutationsOrBuilder( @@ -1424,6 +1626,10 @@ public io.littlehorse.sdk.common.proto.VariableMutationOrBuilder getMutationsOrB } } /** + *
+       * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+       * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ public java.util.List @@ -1435,6 +1641,10 @@ public io.littlehorse.sdk.common.proto.VariableMutationOrBuilder getMutationsOrB } } /** + *
+       * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+       * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ public io.littlehorse.sdk.common.proto.VariableMutation.Builder addMutationsBuilder() { @@ -1442,6 +1652,10 @@ public io.littlehorse.sdk.common.proto.VariableMutation.Builder addMutationsBuil io.littlehorse.sdk.common.proto.VariableMutation.getDefaultInstance()); } /** + *
+       * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+       * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ public io.littlehorse.sdk.common.proto.VariableMutation.Builder addMutationsBuilder( @@ -1450,6 +1664,10 @@ public io.littlehorse.sdk.common.proto.VariableMutation.Builder addMutationsBuil index, io.littlehorse.sdk.common.proto.VariableMutation.getDefaultInstance()); } /** + *
+       * EXPERIMENTAL: Any variables in the ThreadRun which we should mutate.
+       * 
+ * * repeated .littlehorse.VariableMutation mutations = 2; */ public java.util.List @@ -1539,36 +1757,70 @@ public interface UTAReassignOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+     * A variable assignment that resolves to a STR representing the new user_id. If
+     * not set, the user_id of the UserTaskRun will be un-set.
+     * 
+ * * optional .littlehorse.VariableAssignment user_id = 1; * @return Whether the userId field is set. */ boolean hasUserId(); /** + *
+     * A variable assignment that resolves to a STR representing the new user_id. If
+     * not set, the user_id of the UserTaskRun will be un-set.
+     * 
+ * * optional .littlehorse.VariableAssignment user_id = 1; * @return The userId. */ io.littlehorse.sdk.common.proto.VariableAssignment getUserId(); /** + *
+     * A variable assignment that resolves to a STR representing the new user_id. If
+     * not set, the user_id of the UserTaskRun will be un-set.
+     * 
+ * * optional .littlehorse.VariableAssignment user_id = 1; */ io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getUserIdOrBuilder(); /** + *
+     * A variable assignment that resolves to a STR representing the new user_group. If
+     * not set, the user_group of the UserTaskRun will be un-set.
+     * 
+ * * optional .littlehorse.VariableAssignment user_group = 2; * @return Whether the userGroup field is set. */ boolean hasUserGroup(); /** + *
+     * A variable assignment that resolves to a STR representing the new user_group. If
+     * not set, the user_group of the UserTaskRun will be un-set.
+     * 
+ * * optional .littlehorse.VariableAssignment user_group = 2; * @return The userGroup. */ io.littlehorse.sdk.common.proto.VariableAssignment getUserGroup(); /** + *
+     * A variable assignment that resolves to a STR representing the new user_group. If
+     * not set, the user_group of the UserTaskRun will be un-set.
+     * 
+ * * optional .littlehorse.VariableAssignment user_group = 2; */ io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getUserGroupOrBuilder(); } /** + *
+   * A UserTaskAction that causes a UserTaskRun to be reassigned when it fires.
+   * 
+ * * Protobuf type {@code littlehorse.UTActionTrigger.UTAReassign} */ public static final class UTAReassign extends @@ -1607,6 +1859,11 @@ protected java.lang.Object newInstance( public static final int USER_ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.VariableAssignment userId_; /** + *
+     * A variable assignment that resolves to a STR representing the new user_id. If
+     * not set, the user_id of the UserTaskRun will be un-set.
+     * 
+ * * optional .littlehorse.VariableAssignment user_id = 1; * @return Whether the userId field is set. */ @@ -1615,6 +1872,11 @@ public boolean hasUserId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * A variable assignment that resolves to a STR representing the new user_id. If
+     * not set, the user_id of the UserTaskRun will be un-set.
+     * 
+ * * optional .littlehorse.VariableAssignment user_id = 1; * @return The userId. */ @@ -1623,6 +1885,11 @@ public io.littlehorse.sdk.common.proto.VariableAssignment getUserId() { return userId_ == null ? io.littlehorse.sdk.common.proto.VariableAssignment.getDefaultInstance() : userId_; } /** + *
+     * A variable assignment that resolves to a STR representing the new user_id. If
+     * not set, the user_id of the UserTaskRun will be un-set.
+     * 
+ * * optional .littlehorse.VariableAssignment user_id = 1; */ @java.lang.Override @@ -1633,6 +1900,11 @@ public io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getUserIdOrBu public static final int USER_GROUP_FIELD_NUMBER = 2; private io.littlehorse.sdk.common.proto.VariableAssignment userGroup_; /** + *
+     * A variable assignment that resolves to a STR representing the new user_group. If
+     * not set, the user_group of the UserTaskRun will be un-set.
+     * 
+ * * optional .littlehorse.VariableAssignment user_group = 2; * @return Whether the userGroup field is set. */ @@ -1641,6 +1913,11 @@ public boolean hasUserGroup() { return ((bitField0_ & 0x00000002) != 0); } /** + *
+     * A variable assignment that resolves to a STR representing the new user_group. If
+     * not set, the user_group of the UserTaskRun will be un-set.
+     * 
+ * * optional .littlehorse.VariableAssignment user_group = 2; * @return The userGroup. */ @@ -1649,6 +1926,11 @@ public io.littlehorse.sdk.common.proto.VariableAssignment getUserGroup() { return userGroup_ == null ? io.littlehorse.sdk.common.proto.VariableAssignment.getDefaultInstance() : userGroup_; } /** + *
+     * A variable assignment that resolves to a STR representing the new user_group. If
+     * not set, the user_group of the UserTaskRun will be un-set.
+     * 
+ * * optional .littlehorse.VariableAssignment user_group = 2; */ @java.lang.Override @@ -1835,6 +2117,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+     * A UserTaskAction that causes a UserTaskRun to be reassigned when it fires.
+     * 
+ * * Protobuf type {@code littlehorse.UTActionTrigger.UTAReassign} */ public static final class Builder extends @@ -2045,6 +2331,11 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.VariableAssignment, io.littlehorse.sdk.common.proto.VariableAssignment.Builder, io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder> userIdBuilder_; /** + *
+       * A variable assignment that resolves to a STR representing the new user_id. If
+       * not set, the user_id of the UserTaskRun will be un-set.
+       * 
+ * * optional .littlehorse.VariableAssignment user_id = 1; * @return Whether the userId field is set. */ @@ -2052,6 +2343,11 @@ public boolean hasUserId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+       * A variable assignment that resolves to a STR representing the new user_id. If
+       * not set, the user_id of the UserTaskRun will be un-set.
+       * 
+ * * optional .littlehorse.VariableAssignment user_id = 1; * @return The userId. */ @@ -2063,6 +2359,11 @@ public io.littlehorse.sdk.common.proto.VariableAssignment getUserId() { } } /** + *
+       * A variable assignment that resolves to a STR representing the new user_id. If
+       * not set, the user_id of the UserTaskRun will be un-set.
+       * 
+ * * optional .littlehorse.VariableAssignment user_id = 1; */ public Builder setUserId(io.littlehorse.sdk.common.proto.VariableAssignment value) { @@ -2079,6 +2380,11 @@ public Builder setUserId(io.littlehorse.sdk.common.proto.VariableAssignment valu return this; } /** + *
+       * A variable assignment that resolves to a STR representing the new user_id. If
+       * not set, the user_id of the UserTaskRun will be un-set.
+       * 
+ * * optional .littlehorse.VariableAssignment user_id = 1; */ public Builder setUserId( @@ -2093,6 +2399,11 @@ public Builder setUserId( return this; } /** + *
+       * A variable assignment that resolves to a STR representing the new user_id. If
+       * not set, the user_id of the UserTaskRun will be un-set.
+       * 
+ * * optional .littlehorse.VariableAssignment user_id = 1; */ public Builder mergeUserId(io.littlehorse.sdk.common.proto.VariableAssignment value) { @@ -2112,6 +2423,11 @@ public Builder mergeUserId(io.littlehorse.sdk.common.proto.VariableAssignment va return this; } /** + *
+       * A variable assignment that resolves to a STR representing the new user_id. If
+       * not set, the user_id of the UserTaskRun will be un-set.
+       * 
+ * * optional .littlehorse.VariableAssignment user_id = 1; */ public Builder clearUserId() { @@ -2125,6 +2441,11 @@ public Builder clearUserId() { return this; } /** + *
+       * A variable assignment that resolves to a STR representing the new user_id. If
+       * not set, the user_id of the UserTaskRun will be un-set.
+       * 
+ * * optional .littlehorse.VariableAssignment user_id = 1; */ public io.littlehorse.sdk.common.proto.VariableAssignment.Builder getUserIdBuilder() { @@ -2133,6 +2454,11 @@ public io.littlehorse.sdk.common.proto.VariableAssignment.Builder getUserIdBuild return getUserIdFieldBuilder().getBuilder(); } /** + *
+       * A variable assignment that resolves to a STR representing the new user_id. If
+       * not set, the user_id of the UserTaskRun will be un-set.
+       * 
+ * * optional .littlehorse.VariableAssignment user_id = 1; */ public io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getUserIdOrBuilder() { @@ -2144,6 +2470,11 @@ public io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getUserIdOrBu } } /** + *
+       * A variable assignment that resolves to a STR representing the new user_id. If
+       * not set, the user_id of the UserTaskRun will be un-set.
+       * 
+ * * optional .littlehorse.VariableAssignment user_id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -2164,6 +2495,11 @@ public io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getUserIdOrBu private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.VariableAssignment, io.littlehorse.sdk.common.proto.VariableAssignment.Builder, io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder> userGroupBuilder_; /** + *
+       * A variable assignment that resolves to a STR representing the new user_group. If
+       * not set, the user_group of the UserTaskRun will be un-set.
+       * 
+ * * optional .littlehorse.VariableAssignment user_group = 2; * @return Whether the userGroup field is set. */ @@ -2171,6 +2507,11 @@ public boolean hasUserGroup() { return ((bitField0_ & 0x00000002) != 0); } /** + *
+       * A variable assignment that resolves to a STR representing the new user_group. If
+       * not set, the user_group of the UserTaskRun will be un-set.
+       * 
+ * * optional .littlehorse.VariableAssignment user_group = 2; * @return The userGroup. */ @@ -2182,6 +2523,11 @@ public io.littlehorse.sdk.common.proto.VariableAssignment getUserGroup() { } } /** + *
+       * A variable assignment that resolves to a STR representing the new user_group. If
+       * not set, the user_group of the UserTaskRun will be un-set.
+       * 
+ * * optional .littlehorse.VariableAssignment user_group = 2; */ public Builder setUserGroup(io.littlehorse.sdk.common.proto.VariableAssignment value) { @@ -2198,6 +2544,11 @@ public Builder setUserGroup(io.littlehorse.sdk.common.proto.VariableAssignment v return this; } /** + *
+       * A variable assignment that resolves to a STR representing the new user_group. If
+       * not set, the user_group of the UserTaskRun will be un-set.
+       * 
+ * * optional .littlehorse.VariableAssignment user_group = 2; */ public Builder setUserGroup( @@ -2212,6 +2563,11 @@ public Builder setUserGroup( return this; } /** + *
+       * A variable assignment that resolves to a STR representing the new user_group. If
+       * not set, the user_group of the UserTaskRun will be un-set.
+       * 
+ * * optional .littlehorse.VariableAssignment user_group = 2; */ public Builder mergeUserGroup(io.littlehorse.sdk.common.proto.VariableAssignment value) { @@ -2231,6 +2587,11 @@ public Builder mergeUserGroup(io.littlehorse.sdk.common.proto.VariableAssignment return this; } /** + *
+       * A variable assignment that resolves to a STR representing the new user_group. If
+       * not set, the user_group of the UserTaskRun will be un-set.
+       * 
+ * * optional .littlehorse.VariableAssignment user_group = 2; */ public Builder clearUserGroup() { @@ -2244,6 +2605,11 @@ public Builder clearUserGroup() { return this; } /** + *
+       * A variable assignment that resolves to a STR representing the new user_group. If
+       * not set, the user_group of the UserTaskRun will be un-set.
+       * 
+ * * optional .littlehorse.VariableAssignment user_group = 2; */ public io.littlehorse.sdk.common.proto.VariableAssignment.Builder getUserGroupBuilder() { @@ -2252,6 +2618,11 @@ public io.littlehorse.sdk.common.proto.VariableAssignment.Builder getUserGroupBu return getUserGroupFieldBuilder().getBuilder(); } /** + *
+       * A variable assignment that resolves to a STR representing the new user_group. If
+       * not set, the user_group of the UserTaskRun will be un-set.
+       * 
+ * * optional .littlehorse.VariableAssignment user_group = 2; */ public io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getUserGroupOrBuilder() { @@ -2263,6 +2634,11 @@ public io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getUserGroupO } } /** + *
+       * A variable assignment that resolves to a STR representing the new user_group. If
+       * not set, the user_group of the UserTaskRun will be un-set.
+       * 
+ * * optional .littlehorse.VariableAssignment user_group = 2; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -2495,7 +2871,8 @@ public io.littlehorse.sdk.common.proto.UTActionTrigger.UTAReassignOrBuilder getR private io.littlehorse.sdk.common.proto.VariableAssignment delaySeconds_; /** *
-   *Action's delay
+   * The Action is triggered some time after the Hook matures. The delay is controlled
+   * by this field.
    * 
* * .littlehorse.VariableAssignment delay_seconds = 5; @@ -2507,7 +2884,8 @@ public boolean hasDelaySeconds() { } /** *
-   *Action's delay
+   * The Action is triggered some time after the Hook matures. The delay is controlled
+   * by this field.
    * 
* * .littlehorse.VariableAssignment delay_seconds = 5; @@ -2519,7 +2897,8 @@ public io.littlehorse.sdk.common.proto.VariableAssignment getDelaySeconds() { } /** *
-   *Action's delay
+   * The Action is triggered some time after the Hook matures. The delay is controlled
+   * by this field.
    * 
* * .littlehorse.VariableAssignment delay_seconds = 5; @@ -2532,6 +2911,10 @@ public io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getDelaySecon public static final int HOOK_FIELD_NUMBER = 6; private int hook_ = 0; /** + *
+   * The hook on which this UserTaskAction is scheduled.
+   * 
+ * * .littlehorse.UTActionTrigger.UTHook hook = 6; * @return The enum numeric value on the wire for hook. */ @@ -2539,6 +2922,10 @@ public io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getDelaySecon return hook_; } /** + *
+   * The hook on which this UserTaskAction is scheduled.
+   * 
+ * * .littlehorse.UTActionTrigger.UTHook hook = 6; * @return The hook. */ @@ -3522,7 +3909,8 @@ public io.littlehorse.sdk.common.proto.UTActionTrigger.UTAReassignOrBuilder getR io.littlehorse.sdk.common.proto.VariableAssignment, io.littlehorse.sdk.common.proto.VariableAssignment.Builder, io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder> delaySecondsBuilder_; /** *
-     *Action's delay
+     * The Action is triggered some time after the Hook matures. The delay is controlled
+     * by this field.
      * 
* * .littlehorse.VariableAssignment delay_seconds = 5; @@ -3533,7 +3921,8 @@ public boolean hasDelaySeconds() { } /** *
-     *Action's delay
+     * The Action is triggered some time after the Hook matures. The delay is controlled
+     * by this field.
      * 
* * .littlehorse.VariableAssignment delay_seconds = 5; @@ -3548,7 +3937,8 @@ public io.littlehorse.sdk.common.proto.VariableAssignment getDelaySeconds() { } /** *
-     *Action's delay
+     * The Action is triggered some time after the Hook matures. The delay is controlled
+     * by this field.
      * 
* * .littlehorse.VariableAssignment delay_seconds = 5; @@ -3568,7 +3958,8 @@ public Builder setDelaySeconds(io.littlehorse.sdk.common.proto.VariableAssignmen } /** *
-     *Action's delay
+     * The Action is triggered some time after the Hook matures. The delay is controlled
+     * by this field.
      * 
* * .littlehorse.VariableAssignment delay_seconds = 5; @@ -3586,7 +3977,8 @@ public Builder setDelaySeconds( } /** *
-     *Action's delay
+     * The Action is triggered some time after the Hook matures. The delay is controlled
+     * by this field.
      * 
* * .littlehorse.VariableAssignment delay_seconds = 5; @@ -3609,7 +4001,8 @@ public Builder mergeDelaySeconds(io.littlehorse.sdk.common.proto.VariableAssignm } /** *
-     *Action's delay
+     * The Action is triggered some time after the Hook matures. The delay is controlled
+     * by this field.
      * 
* * .littlehorse.VariableAssignment delay_seconds = 5; @@ -3626,7 +4019,8 @@ public Builder clearDelaySeconds() { } /** *
-     *Action's delay
+     * The Action is triggered some time after the Hook matures. The delay is controlled
+     * by this field.
      * 
* * .littlehorse.VariableAssignment delay_seconds = 5; @@ -3638,7 +4032,8 @@ public io.littlehorse.sdk.common.proto.VariableAssignment.Builder getDelaySecond } /** *
-     *Action's delay
+     * The Action is triggered some time after the Hook matures. The delay is controlled
+     * by this field.
      * 
* * .littlehorse.VariableAssignment delay_seconds = 5; @@ -3653,7 +4048,8 @@ public io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getDelaySecon } /** *
-     *Action's delay
+     * The Action is triggered some time after the Hook matures. The delay is controlled
+     * by this field.
      * 
* * .littlehorse.VariableAssignment delay_seconds = 5; @@ -3674,6 +4070,10 @@ public io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getDelaySecon private int hook_ = 0; /** + *
+     * The hook on which this UserTaskAction is scheduled.
+     * 
+ * * .littlehorse.UTActionTrigger.UTHook hook = 6; * @return The enum numeric value on the wire for hook. */ @@ -3681,6 +4081,10 @@ public io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getDelaySecon return hook_; } /** + *
+     * The hook on which this UserTaskAction is scheduled.
+     * 
+ * * .littlehorse.UTActionTrigger.UTHook hook = 6; * @param value The enum numeric value on the wire for hook to set. * @return This builder for chaining. @@ -3692,6 +4096,10 @@ public Builder setHookValue(int value) { return this; } /** + *
+     * The hook on which this UserTaskAction is scheduled.
+     * 
+ * * .littlehorse.UTActionTrigger.UTHook hook = 6; * @return The hook. */ @@ -3701,6 +4109,10 @@ public io.littlehorse.sdk.common.proto.UTActionTrigger.UTHook getHook() { return result == null ? io.littlehorse.sdk.common.proto.UTActionTrigger.UTHook.UNRECOGNIZED : result; } /** + *
+     * The hook on which this UserTaskAction is scheduled.
+     * 
+ * * .littlehorse.UTActionTrigger.UTHook hook = 6; * @param value The hook to set. * @return This builder for chaining. @@ -3715,6 +4127,10 @@ public Builder setHook(io.littlehorse.sdk.common.proto.UTActionTrigger.UTHook va return this; } /** + *
+     * The hook on which this UserTaskAction is scheduled.
+     * 
+ * * .littlehorse.UTActionTrigger.UTHook hook = 6; * @return This builder for chaining. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UTActionTriggerOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UTActionTriggerOrBuilder.java index 2c55be8ae..75eda6641 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UTActionTriggerOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UTActionTriggerOrBuilder.java @@ -66,7 +66,8 @@ public interface UTActionTriggerOrBuilder extends /** *
-   *Action's delay
+   * The Action is triggered some time after the Hook matures. The delay is controlled
+   * by this field.
    * 
* * .littlehorse.VariableAssignment delay_seconds = 5; @@ -75,7 +76,8 @@ public interface UTActionTriggerOrBuilder extends boolean hasDelaySeconds(); /** *
-   *Action's delay
+   * The Action is triggered some time after the Hook matures. The delay is controlled
+   * by this field.
    * 
* * .littlehorse.VariableAssignment delay_seconds = 5; @@ -84,7 +86,8 @@ public interface UTActionTriggerOrBuilder extends io.littlehorse.sdk.common.proto.VariableAssignment getDelaySeconds(); /** *
-   *Action's delay
+   * The Action is triggered some time after the Hook matures. The delay is controlled
+   * by this field.
    * 
* * .littlehorse.VariableAssignment delay_seconds = 5; @@ -92,11 +95,19 @@ public interface UTActionTriggerOrBuilder extends io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getDelaySecondsOrBuilder(); /** + *
+   * The hook on which this UserTaskAction is scheduled.
+   * 
+ * * .littlehorse.UTActionTrigger.UTHook hook = 6; * @return The enum numeric value on the wire for hook. */ int getHookValue(); /** + *
+   * The hook on which this UserTaskAction is scheduled.
+   * 
+ * * .littlehorse.UTActionTrigger.UTHook hook = 6; * @return The hook. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskDefId.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskDefId.java index 7cbe358b9..206baef2c 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskDefId.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskDefId.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * ID for a UserTaskDef
+ * 
+ * * Protobuf type {@code littlehorse.UserTaskDefId} */ public final class UserTaskDefId extends @@ -43,6 +47,10 @@ protected java.lang.Object newInstance( @SuppressWarnings("serial") private volatile java.lang.Object name_ = ""; /** + *
+   * The name of a UserTaskDef
+   * 
+ * * string name = 1; * @return The name. */ @@ -60,6 +68,10 @@ public java.lang.String getName() { } } /** + *
+   * The name of a UserTaskDef
+   * 
+ * * string name = 1; * @return The bytes for name. */ @@ -81,6 +93,10 @@ public java.lang.String getName() { public static final int VERSION_FIELD_NUMBER = 2; private int version_ = 0; /** + *
+   * Note that UserTaskDef's use simple versioning.
+   * 
+ * * int32 version = 2; * @return The version. */ @@ -257,6 +273,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * ID for a UserTaskDef
+   * 
+ * * Protobuf type {@code littlehorse.UserTaskDefId} */ public static final class Builder extends @@ -440,6 +460,10 @@ public Builder mergeFrom( private java.lang.Object name_ = ""; /** + *
+     * The name of a UserTaskDef
+     * 
+ * * string name = 1; * @return The name. */ @@ -456,6 +480,10 @@ public java.lang.String getName() { } } /** + *
+     * The name of a UserTaskDef
+     * 
+ * * string name = 1; * @return The bytes for name. */ @@ -473,6 +501,10 @@ public java.lang.String getName() { } } /** + *
+     * The name of a UserTaskDef
+     * 
+ * * string name = 1; * @param value The name to set. * @return This builder for chaining. @@ -486,6 +518,10 @@ public Builder setName( return this; } /** + *
+     * The name of a UserTaskDef
+     * 
+ * * string name = 1; * @return This builder for chaining. */ @@ -496,6 +532,10 @@ public Builder clearName() { return this; } /** + *
+     * The name of a UserTaskDef
+     * 
+ * * string name = 1; * @param value The bytes for name to set. * @return This builder for chaining. @@ -512,6 +552,10 @@ public Builder setNameBytes( private int version_ ; /** + *
+     * Note that UserTaskDef's use simple versioning.
+     * 
+ * * int32 version = 2; * @return The version. */ @@ -520,6 +564,10 @@ public int getVersion() { return version_; } /** + *
+     * Note that UserTaskDef's use simple versioning.
+     * 
+ * * int32 version = 2; * @param value The version to set. * @return This builder for chaining. @@ -532,6 +580,10 @@ public Builder setVersion(int value) { return this; } /** + *
+     * Note that UserTaskDef's use simple versioning.
+     * 
+ * * int32 version = 2; * @return This builder for chaining. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskDefIdOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskDefIdOrBuilder.java index 0256b7b60..8d7636977 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskDefIdOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskDefIdOrBuilder.java @@ -8,11 +8,19 @@ public interface UserTaskDefIdOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The name of a UserTaskDef
+   * 
+ * * string name = 1; * @return The name. */ java.lang.String getName(); /** + *
+   * The name of a UserTaskDef
+   * 
+ * * string name = 1; * @return The bytes for name. */ @@ -20,6 +28,10 @@ public interface UserTaskDefIdOrBuilder extends getNameBytes(); /** + *
+   * Note that UserTaskDef's use simple versioning.
+   * 
+ * * int32 version = 2; * @return The version. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskNodeRun.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskNodeRun.java index f375cdaa9..6a9ea3819 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskNodeRun.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskNodeRun.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * The sub-node structure for a USER_TASK NodeRun.
+ * 
+ * * Protobuf type {@code littlehorse.UserTaskNodeRun} */ public final class UserTaskNodeRun extends @@ -42,6 +46,11 @@ protected java.lang.Object newInstance( public static final int USER_TASK_RUN_ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.UserTaskRunId userTaskRunId_; /** + *
+   * The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived
+   * at this USER_TASK node, then the user_task_run_id will be unset.
+   * 
+ * * optional .littlehorse.UserTaskRunId user_task_run_id = 1; * @return Whether the userTaskRunId field is set. */ @@ -50,6 +59,11 @@ public boolean hasUserTaskRunId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+   * The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived
+   * at this USER_TASK node, then the user_task_run_id will be unset.
+   * 
+ * * optional .littlehorse.UserTaskRunId user_task_run_id = 1; * @return The userTaskRunId. */ @@ -58,6 +72,11 @@ public io.littlehorse.sdk.common.proto.UserTaskRunId getUserTaskRunId() { return userTaskRunId_ == null ? io.littlehorse.sdk.common.proto.UserTaskRunId.getDefaultInstance() : userTaskRunId_; } /** + *
+   * The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived
+   * at this USER_TASK node, then the user_task_run_id will be unset.
+   * 
+ * * optional .littlehorse.UserTaskRunId user_task_run_id = 1; */ @java.lang.Override @@ -228,6 +247,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * The sub-node structure for a USER_TASK NodeRun.
+   * 
+ * * Protobuf type {@code littlehorse.UserTaskNodeRun} */ public static final class Builder extends @@ -416,6 +439,11 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.UserTaskRunId, io.littlehorse.sdk.common.proto.UserTaskRunId.Builder, io.littlehorse.sdk.common.proto.UserTaskRunIdOrBuilder> userTaskRunIdBuilder_; /** + *
+     * The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived
+     * at this USER_TASK node, then the user_task_run_id will be unset.
+     * 
+ * * optional .littlehorse.UserTaskRunId user_task_run_id = 1; * @return Whether the userTaskRunId field is set. */ @@ -423,6 +451,11 @@ public boolean hasUserTaskRunId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived
+     * at this USER_TASK node, then the user_task_run_id will be unset.
+     * 
+ * * optional .littlehorse.UserTaskRunId user_task_run_id = 1; * @return The userTaskRunId. */ @@ -434,6 +467,11 @@ public io.littlehorse.sdk.common.proto.UserTaskRunId getUserTaskRunId() { } } /** + *
+     * The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived
+     * at this USER_TASK node, then the user_task_run_id will be unset.
+     * 
+ * * optional .littlehorse.UserTaskRunId user_task_run_id = 1; */ public Builder setUserTaskRunId(io.littlehorse.sdk.common.proto.UserTaskRunId value) { @@ -450,6 +488,11 @@ public Builder setUserTaskRunId(io.littlehorse.sdk.common.proto.UserTaskRunId va return this; } /** + *
+     * The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived
+     * at this USER_TASK node, then the user_task_run_id will be unset.
+     * 
+ * * optional .littlehorse.UserTaskRunId user_task_run_id = 1; */ public Builder setUserTaskRunId( @@ -464,6 +507,11 @@ public Builder setUserTaskRunId( return this; } /** + *
+     * The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived
+     * at this USER_TASK node, then the user_task_run_id will be unset.
+     * 
+ * * optional .littlehorse.UserTaskRunId user_task_run_id = 1; */ public Builder mergeUserTaskRunId(io.littlehorse.sdk.common.proto.UserTaskRunId value) { @@ -483,6 +531,11 @@ public Builder mergeUserTaskRunId(io.littlehorse.sdk.common.proto.UserTaskRunId return this; } /** + *
+     * The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived
+     * at this USER_TASK node, then the user_task_run_id will be unset.
+     * 
+ * * optional .littlehorse.UserTaskRunId user_task_run_id = 1; */ public Builder clearUserTaskRunId() { @@ -496,6 +549,11 @@ public Builder clearUserTaskRunId() { return this; } /** + *
+     * The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived
+     * at this USER_TASK node, then the user_task_run_id will be unset.
+     * 
+ * * optional .littlehorse.UserTaskRunId user_task_run_id = 1; */ public io.littlehorse.sdk.common.proto.UserTaskRunId.Builder getUserTaskRunIdBuilder() { @@ -504,6 +562,11 @@ public io.littlehorse.sdk.common.proto.UserTaskRunId.Builder getUserTaskRunIdBui return getUserTaskRunIdFieldBuilder().getBuilder(); } /** + *
+     * The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived
+     * at this USER_TASK node, then the user_task_run_id will be unset.
+     * 
+ * * optional .littlehorse.UserTaskRunId user_task_run_id = 1; */ public io.littlehorse.sdk.common.proto.UserTaskRunIdOrBuilder getUserTaskRunIdOrBuilder() { @@ -515,6 +578,11 @@ public io.littlehorse.sdk.common.proto.UserTaskRunIdOrBuilder getUserTaskRunIdOr } } /** + *
+     * The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived
+     * at this USER_TASK node, then the user_task_run_id will be unset.
+     * 
+ * * optional .littlehorse.UserTaskRunId user_task_run_id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskNodeRunOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskNodeRunOrBuilder.java index 57bd0c716..bdd36d82a 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskNodeRunOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskNodeRunOrBuilder.java @@ -8,16 +8,31 @@ public interface UserTaskNodeRunOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived
+   * at this USER_TASK node, then the user_task_run_id will be unset.
+   * 
+ * * optional .littlehorse.UserTaskRunId user_task_run_id = 1; * @return Whether the userTaskRunId field is set. */ boolean hasUserTaskRunId(); /** + *
+   * The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived
+   * at this USER_TASK node, then the user_task_run_id will be unset.
+   * 
+ * * optional .littlehorse.UserTaskRunId user_task_run_id = 1; * @return The userTaskRunId. */ io.littlehorse.sdk.common.proto.UserTaskRunId getUserTaskRunId(); /** + *
+   * The ID of the UserTaskRun. Note that if the ThreadRun was halted when it arrived
+   * at this USER_TASK node, then the user_task_run_id will be unset.
+   * 
+ * * optional .littlehorse.UserTaskRunId user_task_run_id = 1; */ io.littlehorse.sdk.common.proto.UserTaskRunIdOrBuilder getUserTaskRunIdOrBuilder(); diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskRunId.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskRunId.java index db0c2bc71..5baaec031 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskRunId.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskRunId.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * ID for a UserTaskRun
+ * 
+ * * Protobuf type {@code littlehorse.UserTaskRunId} */ public final class UserTaskRunId extends @@ -42,6 +46,11 @@ protected java.lang.Object newInstance( public static final int WF_RUN_ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.WfRunId wfRunId_; /** + *
+   * WfRunId for this UserTaskRun. Note that every UserTaskRun is associated
+   * with a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return Whether the wfRunId field is set. */ @@ -50,6 +59,11 @@ public boolean hasWfRunId() { return wfRunId_ != null; } /** + *
+   * WfRunId for this UserTaskRun. Note that every UserTaskRun is associated
+   * with a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return The wfRunId. */ @@ -58,6 +72,11 @@ public io.littlehorse.sdk.common.proto.WfRunId getWfRunId() { return wfRunId_ == null ? io.littlehorse.sdk.common.proto.WfRunId.getDefaultInstance() : wfRunId_; } /** + *
+   * WfRunId for this UserTaskRun. Note that every UserTaskRun is associated
+   * with a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ @java.lang.Override @@ -69,6 +88,10 @@ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { @SuppressWarnings("serial") private volatile java.lang.Object userTaskGuid_ = ""; /** + *
+   * Unique identifier for this UserTaskRun.
+   * 
+ * * string user_task_guid = 2; * @return The userTaskGuid. */ @@ -86,6 +109,10 @@ public java.lang.String getUserTaskGuid() { } } /** + *
+   * Unique identifier for this UserTaskRun.
+   * 
+ * * string user_task_guid = 2; * @return The bytes for userTaskGuid. */ @@ -277,6 +304,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * ID for a UserTaskRun
+   * 
+ * * Protobuf type {@code littlehorse.UserTaskRunId} */ public static final class Builder extends @@ -470,6 +501,11 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.WfRunId, io.littlehorse.sdk.common.proto.WfRunId.Builder, io.littlehorse.sdk.common.proto.WfRunIdOrBuilder> wfRunIdBuilder_; /** + *
+     * WfRunId for this UserTaskRun. Note that every UserTaskRun is associated
+     * with a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return Whether the wfRunId field is set. */ @@ -477,6 +513,11 @@ public boolean hasWfRunId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * WfRunId for this UserTaskRun. Note that every UserTaskRun is associated
+     * with a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return The wfRunId. */ @@ -488,6 +529,11 @@ public io.littlehorse.sdk.common.proto.WfRunId getWfRunId() { } } /** + *
+     * WfRunId for this UserTaskRun. Note that every UserTaskRun is associated
+     * with a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder setWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { @@ -504,6 +550,11 @@ public Builder setWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { return this; } /** + *
+     * WfRunId for this UserTaskRun. Note that every UserTaskRun is associated
+     * with a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder setWfRunId( @@ -518,6 +569,11 @@ public Builder setWfRunId( return this; } /** + *
+     * WfRunId for this UserTaskRun. Note that every UserTaskRun is associated
+     * with a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder mergeWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { @@ -537,6 +593,11 @@ public Builder mergeWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { return this; } /** + *
+     * WfRunId for this UserTaskRun. Note that every UserTaskRun is associated
+     * with a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder clearWfRunId() { @@ -550,6 +611,11 @@ public Builder clearWfRunId() { return this; } /** + *
+     * WfRunId for this UserTaskRun. Note that every UserTaskRun is associated
+     * with a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public io.littlehorse.sdk.common.proto.WfRunId.Builder getWfRunIdBuilder() { @@ -558,6 +624,11 @@ public io.littlehorse.sdk.common.proto.WfRunId.Builder getWfRunIdBuilder() { return getWfRunIdFieldBuilder().getBuilder(); } /** + *
+     * WfRunId for this UserTaskRun. Note that every UserTaskRun is associated
+     * with a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { @@ -569,6 +640,11 @@ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { } } /** + *
+     * WfRunId for this UserTaskRun. Note that every UserTaskRun is associated
+     * with a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -587,6 +663,10 @@ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { private java.lang.Object userTaskGuid_ = ""; /** + *
+     * Unique identifier for this UserTaskRun.
+     * 
+ * * string user_task_guid = 2; * @return The userTaskGuid. */ @@ -603,6 +683,10 @@ public java.lang.String getUserTaskGuid() { } } /** + *
+     * Unique identifier for this UserTaskRun.
+     * 
+ * * string user_task_guid = 2; * @return The bytes for userTaskGuid. */ @@ -620,6 +704,10 @@ public java.lang.String getUserTaskGuid() { } } /** + *
+     * Unique identifier for this UserTaskRun.
+     * 
+ * * string user_task_guid = 2; * @param value The userTaskGuid to set. * @return This builder for chaining. @@ -633,6 +721,10 @@ public Builder setUserTaskGuid( return this; } /** + *
+     * Unique identifier for this UserTaskRun.
+     * 
+ * * string user_task_guid = 2; * @return This builder for chaining. */ @@ -643,6 +735,10 @@ public Builder clearUserTaskGuid() { return this; } /** + *
+     * Unique identifier for this UserTaskRun.
+     * 
+ * * string user_task_guid = 2; * @param value The bytes for userTaskGuid to set. * @return This builder for chaining. diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskRunIdOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskRunIdOrBuilder.java index d607a45ea..a58f0d234 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskRunIdOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/UserTaskRunIdOrBuilder.java @@ -8,26 +8,49 @@ public interface UserTaskRunIdOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * WfRunId for this UserTaskRun. Note that every UserTaskRun is associated
+   * with a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return Whether the wfRunId field is set. */ boolean hasWfRunId(); /** + *
+   * WfRunId for this UserTaskRun. Note that every UserTaskRun is associated
+   * with a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return The wfRunId. */ io.littlehorse.sdk.common.proto.WfRunId getWfRunId(); /** + *
+   * WfRunId for this UserTaskRun. Note that every UserTaskRun is associated
+   * with a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder(); /** + *
+   * Unique identifier for this UserTaskRun.
+   * 
+ * * string user_task_guid = 2; * @return The userTaskGuid. */ java.lang.String getUserTaskGuid(); /** + *
+   * Unique identifier for this UserTaskRun.
+   * 
+ * * string user_task_guid = 2; * @return The bytes for userTaskGuid. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VarNameAndVal.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VarNameAndVal.java index fb757b905..c08d0c498 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VarNameAndVal.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VarNameAndVal.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * A key-value pair of variable name and value.
+ * 
+ * * Protobuf type {@code littlehorse.VarNameAndVal} */ public final class VarNameAndVal extends @@ -43,6 +47,10 @@ protected java.lang.Object newInstance( @SuppressWarnings("serial") private volatile java.lang.Object varName_ = ""; /** + *
+   * The variable name.
+   * 
+ * * string var_name = 1; * @return The varName. */ @@ -60,6 +68,10 @@ public java.lang.String getVarName() { } } /** + *
+   * The variable name.
+   * 
+ * * string var_name = 1; * @return The bytes for varName. */ @@ -81,6 +93,10 @@ public java.lang.String getVarName() { public static final int VALUE_FIELD_NUMBER = 2; private io.littlehorse.sdk.common.proto.VariableValue value_; /** + *
+   * The value of the variable for this TaskRun.
+   * 
+ * * .littlehorse.VariableValue value = 2; * @return Whether the value field is set. */ @@ -89,6 +105,10 @@ public boolean hasValue() { return value_ != null; } /** + *
+   * The value of the variable for this TaskRun.
+   * 
+ * * .littlehorse.VariableValue value = 2; * @return The value. */ @@ -97,6 +117,10 @@ public io.littlehorse.sdk.common.proto.VariableValue getValue() { return value_ == null ? io.littlehorse.sdk.common.proto.VariableValue.getDefaultInstance() : value_; } /** + *
+   * The value of the variable for this TaskRun.
+   * 
+ * * .littlehorse.VariableValue value = 2; */ @java.lang.Override @@ -277,6 +301,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * A key-value pair of variable name and value.
+   * 
+ * * Protobuf type {@code littlehorse.VarNameAndVal} */ public static final class Builder extends @@ -468,6 +496,10 @@ public Builder mergeFrom( private java.lang.Object varName_ = ""; /** + *
+     * The variable name.
+     * 
+ * * string var_name = 1; * @return The varName. */ @@ -484,6 +516,10 @@ public java.lang.String getVarName() { } } /** + *
+     * The variable name.
+     * 
+ * * string var_name = 1; * @return The bytes for varName. */ @@ -501,6 +537,10 @@ public java.lang.String getVarName() { } } /** + *
+     * The variable name.
+     * 
+ * * string var_name = 1; * @param value The varName to set. * @return This builder for chaining. @@ -514,6 +554,10 @@ public Builder setVarName( return this; } /** + *
+     * The variable name.
+     * 
+ * * string var_name = 1; * @return This builder for chaining. */ @@ -524,6 +568,10 @@ public Builder clearVarName() { return this; } /** + *
+     * The variable name.
+     * 
+ * * string var_name = 1; * @param value The bytes for varName to set. * @return This builder for chaining. @@ -542,6 +590,10 @@ public Builder setVarNameBytes( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.VariableValue, io.littlehorse.sdk.common.proto.VariableValue.Builder, io.littlehorse.sdk.common.proto.VariableValueOrBuilder> valueBuilder_; /** + *
+     * The value of the variable for this TaskRun.
+     * 
+ * * .littlehorse.VariableValue value = 2; * @return Whether the value field is set. */ @@ -549,6 +601,10 @@ public boolean hasValue() { return ((bitField0_ & 0x00000002) != 0); } /** + *
+     * The value of the variable for this TaskRun.
+     * 
+ * * .littlehorse.VariableValue value = 2; * @return The value. */ @@ -560,6 +616,10 @@ public io.littlehorse.sdk.common.proto.VariableValue getValue() { } } /** + *
+     * The value of the variable for this TaskRun.
+     * 
+ * * .littlehorse.VariableValue value = 2; */ public Builder setValue(io.littlehorse.sdk.common.proto.VariableValue value) { @@ -576,6 +636,10 @@ public Builder setValue(io.littlehorse.sdk.common.proto.VariableValue value) { return this; } /** + *
+     * The value of the variable for this TaskRun.
+     * 
+ * * .littlehorse.VariableValue value = 2; */ public Builder setValue( @@ -590,6 +654,10 @@ public Builder setValue( return this; } /** + *
+     * The value of the variable for this TaskRun.
+     * 
+ * * .littlehorse.VariableValue value = 2; */ public Builder mergeValue(io.littlehorse.sdk.common.proto.VariableValue value) { @@ -609,6 +677,10 @@ public Builder mergeValue(io.littlehorse.sdk.common.proto.VariableValue value) { return this; } /** + *
+     * The value of the variable for this TaskRun.
+     * 
+ * * .littlehorse.VariableValue value = 2; */ public Builder clearValue() { @@ -622,6 +694,10 @@ public Builder clearValue() { return this; } /** + *
+     * The value of the variable for this TaskRun.
+     * 
+ * * .littlehorse.VariableValue value = 2; */ public io.littlehorse.sdk.common.proto.VariableValue.Builder getValueBuilder() { @@ -630,6 +706,10 @@ public io.littlehorse.sdk.common.proto.VariableValue.Builder getValueBuilder() { return getValueFieldBuilder().getBuilder(); } /** + *
+     * The value of the variable for this TaskRun.
+     * 
+ * * .littlehorse.VariableValue value = 2; */ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getValueOrBuilder() { @@ -641,6 +721,10 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getValueOrBuilder( } } /** + *
+     * The value of the variable for this TaskRun.
+     * 
+ * * .littlehorse.VariableValue value = 2; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VarNameAndValOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VarNameAndValOrBuilder.java index 850d2d41a..9e343e19c 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VarNameAndValOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VarNameAndValOrBuilder.java @@ -8,11 +8,19 @@ public interface VarNameAndValOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The variable name.
+   * 
+ * * string var_name = 1; * @return The varName. */ java.lang.String getVarName(); /** + *
+   * The variable name.
+   * 
+ * * string var_name = 1; * @return The bytes for varName. */ @@ -20,16 +28,28 @@ public interface VarNameAndValOrBuilder extends getVarNameBytes(); /** + *
+   * The value of the variable for this TaskRun.
+   * 
+ * * .littlehorse.VariableValue value = 2; * @return Whether the value field is set. */ boolean hasValue(); /** + *
+   * The value of the variable for this TaskRun.
+   * 
+ * * .littlehorse.VariableValue value = 2; * @return The value. */ io.littlehorse.sdk.common.proto.VariableValue getValue(); /** + *
+   * The value of the variable for this TaskRun.
+   * 
+ * * .littlehorse.VariableValue value = 2; */ io.littlehorse.sdk.common.proto.VariableValueOrBuilder getValueOrBuilder(); diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/Variable.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/Variable.java index 7042e23b5..f9d149096 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/Variable.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/Variable.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * A Variable is an instance of a variable assigned to a WfRun.
+ * 
+ * * Protobuf type {@code littlehorse.Variable} */ public final class Variable extends @@ -41,6 +45,11 @@ protected java.lang.Object newInstance( public static final int ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.VariableId id_; /** + *
+   * ID of this Variable. Note that the VariableId contains the relevant
+   * WfRunId inside it, the threadRunNumber, and the name of the Variabe.
+   * 
+ * * .littlehorse.VariableId id = 1; * @return Whether the id field is set. */ @@ -49,6 +58,11 @@ public boolean hasId() { return id_ != null; } /** + *
+   * ID of this Variable. Note that the VariableId contains the relevant
+   * WfRunId inside it, the threadRunNumber, and the name of the Variabe.
+   * 
+ * * .littlehorse.VariableId id = 1; * @return The id. */ @@ -57,6 +71,11 @@ public io.littlehorse.sdk.common.proto.VariableId getId() { return id_ == null ? io.littlehorse.sdk.common.proto.VariableId.getDefaultInstance() : id_; } /** + *
+   * ID of this Variable. Note that the VariableId contains the relevant
+   * WfRunId inside it, the threadRunNumber, and the name of the Variabe.
+   * 
+ * * .littlehorse.VariableId id = 1; */ @java.lang.Override @@ -67,6 +86,10 @@ public io.littlehorse.sdk.common.proto.VariableIdOrBuilder getIdOrBuilder() { public static final int VALUE_FIELD_NUMBER = 2; private io.littlehorse.sdk.common.proto.VariableValue value_; /** + *
+   * The value of this Variable.
+   * 
+ * * .littlehorse.VariableValue value = 2; * @return Whether the value field is set. */ @@ -75,6 +98,10 @@ public boolean hasValue() { return value_ != null; } /** + *
+   * The value of this Variable.
+   * 
+ * * .littlehorse.VariableValue value = 2; * @return The value. */ @@ -83,6 +110,10 @@ public io.littlehorse.sdk.common.proto.VariableValue getValue() { return value_ == null ? io.littlehorse.sdk.common.proto.VariableValue.getDefaultInstance() : value_; } /** + *
+   * The value of this Variable.
+   * 
+ * * .littlehorse.VariableValue value = 2; */ @java.lang.Override @@ -93,6 +124,10 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getValueOrBuilder( public static final int CREATED_AT_FIELD_NUMBER = 3; private com.google.protobuf.Timestamp createdAt_; /** + *
+   * When the Variable was created.
+   * 
+ * * .google.protobuf.Timestamp created_at = 3; * @return Whether the createdAt field is set. */ @@ -101,6 +136,10 @@ public boolean hasCreatedAt() { return createdAt_ != null; } /** + *
+   * When the Variable was created.
+   * 
+ * * .google.protobuf.Timestamp created_at = 3; * @return The createdAt. */ @@ -109,6 +148,10 @@ public com.google.protobuf.Timestamp getCreatedAt() { return createdAt_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : createdAt_; } /** + *
+   * When the Variable was created.
+   * 
+ * * .google.protobuf.Timestamp created_at = 3; */ @java.lang.Override @@ -119,6 +162,10 @@ public com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder() { public static final int WF_SPEC_ID_FIELD_NUMBER = 4; private io.littlehorse.sdk.common.proto.WfSpecId wfSpecId_; /** + *
+   * The ID of the WfSpec that this Variable belongs to.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; * @return Whether the wfSpecId field is set. */ @@ -127,6 +174,10 @@ public boolean hasWfSpecId() { return wfSpecId_ != null; } /** + *
+   * The ID of the WfSpec that this Variable belongs to.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; * @return The wfSpecId. */ @@ -135,6 +186,10 @@ public io.littlehorse.sdk.common.proto.WfSpecId getWfSpecId() { return wfSpecId_ == null ? io.littlehorse.sdk.common.proto.WfSpecId.getDefaultInstance() : wfSpecId_; } /** + *
+   * The ID of the WfSpec that this Variable belongs to.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; */ @java.lang.Override @@ -353,6 +408,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * A Variable is an instance of a variable assigned to a WfRun.
+   * 
+ * * Protobuf type {@code littlehorse.Variable} */ public static final class Builder extends @@ -592,6 +651,11 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.VariableId, io.littlehorse.sdk.common.proto.VariableId.Builder, io.littlehorse.sdk.common.proto.VariableIdOrBuilder> idBuilder_; /** + *
+     * ID of this Variable. Note that the VariableId contains the relevant
+     * WfRunId inside it, the threadRunNumber, and the name of the Variabe.
+     * 
+ * * .littlehorse.VariableId id = 1; * @return Whether the id field is set. */ @@ -599,6 +663,11 @@ public boolean hasId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * ID of this Variable. Note that the VariableId contains the relevant
+     * WfRunId inside it, the threadRunNumber, and the name of the Variabe.
+     * 
+ * * .littlehorse.VariableId id = 1; * @return The id. */ @@ -610,6 +679,11 @@ public io.littlehorse.sdk.common.proto.VariableId getId() { } } /** + *
+     * ID of this Variable. Note that the VariableId contains the relevant
+     * WfRunId inside it, the threadRunNumber, and the name of the Variabe.
+     * 
+ * * .littlehorse.VariableId id = 1; */ public Builder setId(io.littlehorse.sdk.common.proto.VariableId value) { @@ -626,6 +700,11 @@ public Builder setId(io.littlehorse.sdk.common.proto.VariableId value) { return this; } /** + *
+     * ID of this Variable. Note that the VariableId contains the relevant
+     * WfRunId inside it, the threadRunNumber, and the name of the Variabe.
+     * 
+ * * .littlehorse.VariableId id = 1; */ public Builder setId( @@ -640,6 +719,11 @@ public Builder setId( return this; } /** + *
+     * ID of this Variable. Note that the VariableId contains the relevant
+     * WfRunId inside it, the threadRunNumber, and the name of the Variabe.
+     * 
+ * * .littlehorse.VariableId id = 1; */ public Builder mergeId(io.littlehorse.sdk.common.proto.VariableId value) { @@ -659,6 +743,11 @@ public Builder mergeId(io.littlehorse.sdk.common.proto.VariableId value) { return this; } /** + *
+     * ID of this Variable. Note that the VariableId contains the relevant
+     * WfRunId inside it, the threadRunNumber, and the name of the Variabe.
+     * 
+ * * .littlehorse.VariableId id = 1; */ public Builder clearId() { @@ -672,6 +761,11 @@ public Builder clearId() { return this; } /** + *
+     * ID of this Variable. Note that the VariableId contains the relevant
+     * WfRunId inside it, the threadRunNumber, and the name of the Variabe.
+     * 
+ * * .littlehorse.VariableId id = 1; */ public io.littlehorse.sdk.common.proto.VariableId.Builder getIdBuilder() { @@ -680,6 +774,11 @@ public io.littlehorse.sdk.common.proto.VariableId.Builder getIdBuilder() { return getIdFieldBuilder().getBuilder(); } /** + *
+     * ID of this Variable. Note that the VariableId contains the relevant
+     * WfRunId inside it, the threadRunNumber, and the name of the Variabe.
+     * 
+ * * .littlehorse.VariableId id = 1; */ public io.littlehorse.sdk.common.proto.VariableIdOrBuilder getIdOrBuilder() { @@ -691,6 +790,11 @@ public io.littlehorse.sdk.common.proto.VariableIdOrBuilder getIdOrBuilder() { } } /** + *
+     * ID of this Variable. Note that the VariableId contains the relevant
+     * WfRunId inside it, the threadRunNumber, and the name of the Variabe.
+     * 
+ * * .littlehorse.VariableId id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -711,6 +815,10 @@ public io.littlehorse.sdk.common.proto.VariableIdOrBuilder getIdOrBuilder() { private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.VariableValue, io.littlehorse.sdk.common.proto.VariableValue.Builder, io.littlehorse.sdk.common.proto.VariableValueOrBuilder> valueBuilder_; /** + *
+     * The value of this Variable.
+     * 
+ * * .littlehorse.VariableValue value = 2; * @return Whether the value field is set. */ @@ -718,6 +826,10 @@ public boolean hasValue() { return ((bitField0_ & 0x00000002) != 0); } /** + *
+     * The value of this Variable.
+     * 
+ * * .littlehorse.VariableValue value = 2; * @return The value. */ @@ -729,6 +841,10 @@ public io.littlehorse.sdk.common.proto.VariableValue getValue() { } } /** + *
+     * The value of this Variable.
+     * 
+ * * .littlehorse.VariableValue value = 2; */ public Builder setValue(io.littlehorse.sdk.common.proto.VariableValue value) { @@ -745,6 +861,10 @@ public Builder setValue(io.littlehorse.sdk.common.proto.VariableValue value) { return this; } /** + *
+     * The value of this Variable.
+     * 
+ * * .littlehorse.VariableValue value = 2; */ public Builder setValue( @@ -759,6 +879,10 @@ public Builder setValue( return this; } /** + *
+     * The value of this Variable.
+     * 
+ * * .littlehorse.VariableValue value = 2; */ public Builder mergeValue(io.littlehorse.sdk.common.proto.VariableValue value) { @@ -778,6 +902,10 @@ public Builder mergeValue(io.littlehorse.sdk.common.proto.VariableValue value) { return this; } /** + *
+     * The value of this Variable.
+     * 
+ * * .littlehorse.VariableValue value = 2; */ public Builder clearValue() { @@ -791,6 +919,10 @@ public Builder clearValue() { return this; } /** + *
+     * The value of this Variable.
+     * 
+ * * .littlehorse.VariableValue value = 2; */ public io.littlehorse.sdk.common.proto.VariableValue.Builder getValueBuilder() { @@ -799,6 +931,10 @@ public io.littlehorse.sdk.common.proto.VariableValue.Builder getValueBuilder() { return getValueFieldBuilder().getBuilder(); } /** + *
+     * The value of this Variable.
+     * 
+ * * .littlehorse.VariableValue value = 2; */ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getValueOrBuilder() { @@ -810,6 +946,10 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getValueOrBuilder( } } /** + *
+     * The value of this Variable.
+     * 
+ * * .littlehorse.VariableValue value = 2; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -830,6 +970,10 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getValueOrBuilder( private com.google.protobuf.SingleFieldBuilderV3< com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> createdAtBuilder_; /** + *
+     * When the Variable was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 3; * @return Whether the createdAt field is set. */ @@ -837,6 +981,10 @@ public boolean hasCreatedAt() { return ((bitField0_ & 0x00000004) != 0); } /** + *
+     * When the Variable was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 3; * @return The createdAt. */ @@ -848,6 +996,10 @@ public com.google.protobuf.Timestamp getCreatedAt() { } } /** + *
+     * When the Variable was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 3; */ public Builder setCreatedAt(com.google.protobuf.Timestamp value) { @@ -864,6 +1016,10 @@ public Builder setCreatedAt(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * When the Variable was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 3; */ public Builder setCreatedAt( @@ -878,6 +1034,10 @@ public Builder setCreatedAt( return this; } /** + *
+     * When the Variable was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 3; */ public Builder mergeCreatedAt(com.google.protobuf.Timestamp value) { @@ -897,6 +1057,10 @@ public Builder mergeCreatedAt(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * When the Variable was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 3; */ public Builder clearCreatedAt() { @@ -910,6 +1074,10 @@ public Builder clearCreatedAt() { return this; } /** + *
+     * When the Variable was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 3; */ public com.google.protobuf.Timestamp.Builder getCreatedAtBuilder() { @@ -918,6 +1086,10 @@ public com.google.protobuf.Timestamp.Builder getCreatedAtBuilder() { return getCreatedAtFieldBuilder().getBuilder(); } /** + *
+     * When the Variable was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 3; */ public com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder() { @@ -929,6 +1101,10 @@ public com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder() { } } /** + *
+     * When the Variable was created.
+     * 
+ * * .google.protobuf.Timestamp created_at = 3; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -949,6 +1125,10 @@ public com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder() { private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.WfSpecId, io.littlehorse.sdk.common.proto.WfSpecId.Builder, io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder> wfSpecIdBuilder_; /** + *
+     * The ID of the WfSpec that this Variable belongs to.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; * @return Whether the wfSpecId field is set. */ @@ -956,6 +1136,10 @@ public boolean hasWfSpecId() { return ((bitField0_ & 0x00000008) != 0); } /** + *
+     * The ID of the WfSpec that this Variable belongs to.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; * @return The wfSpecId. */ @@ -967,6 +1151,10 @@ public io.littlehorse.sdk.common.proto.WfSpecId getWfSpecId() { } } /** + *
+     * The ID of the WfSpec that this Variable belongs to.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; */ public Builder setWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { @@ -983,6 +1171,10 @@ public Builder setWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { return this; } /** + *
+     * The ID of the WfSpec that this Variable belongs to.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; */ public Builder setWfSpecId( @@ -997,6 +1189,10 @@ public Builder setWfSpecId( return this; } /** + *
+     * The ID of the WfSpec that this Variable belongs to.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; */ public Builder mergeWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { @@ -1016,6 +1212,10 @@ public Builder mergeWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { return this; } /** + *
+     * The ID of the WfSpec that this Variable belongs to.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; */ public Builder clearWfSpecId() { @@ -1029,6 +1229,10 @@ public Builder clearWfSpecId() { return this; } /** + *
+     * The ID of the WfSpec that this Variable belongs to.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; */ public io.littlehorse.sdk.common.proto.WfSpecId.Builder getWfSpecIdBuilder() { @@ -1037,6 +1241,10 @@ public io.littlehorse.sdk.common.proto.WfSpecId.Builder getWfSpecIdBuilder() { return getWfSpecIdFieldBuilder().getBuilder(); } /** + *
+     * The ID of the WfSpec that this Variable belongs to.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; */ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder() { @@ -1048,6 +1256,10 @@ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder() } } /** + *
+     * The ID of the WfSpec that this Variable belongs to.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableDef.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableDef.java index b9de13b16..b4b85f003 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableDef.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableDef.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * Declares a Variable.
+ * 
+ * * Protobuf type {@code littlehorse.VariableDef} */ public final class VariableDef extends @@ -44,6 +48,10 @@ protected java.lang.Object newInstance( public static final int TYPE_FIELD_NUMBER = 1; private int type_ = 0; /** + *
+   * The Type of the variable.
+   * 
+ * * .littlehorse.VariableType type = 1; * @return The enum numeric value on the wire for type. */ @@ -51,6 +59,10 @@ protected java.lang.Object newInstance( return type_; } /** + *
+   * The Type of the variable.
+   * 
+ * * .littlehorse.VariableType type = 1; * @return The type. */ @@ -63,6 +75,10 @@ protected java.lang.Object newInstance( @SuppressWarnings("serial") private volatile java.lang.Object name_ = ""; /** + *
+   * The name of the variable.
+   * 
+ * * string name = 2; * @return The name. */ @@ -80,6 +96,10 @@ public java.lang.String getName() { } } /** + *
+   * The name of the variable.
+   * 
+ * * string name = 2; * @return The bytes for name. */ @@ -101,6 +121,12 @@ public java.lang.String getName() { public static final int DEFAULT_VALUE_FIELD_NUMBER = 3; private io.littlehorse.sdk.common.proto.VariableValue defaultValue_; /** + *
+   * Optional default value if the variable isn't set; for example, in a ThreadRun
+   * if you start a ThreadRun or WfRun without passing a variable in, then this is
+   * used.
+   * 
+ * * optional .littlehorse.VariableValue default_value = 3; * @return Whether the defaultValue field is set. */ @@ -109,6 +135,12 @@ public boolean hasDefaultValue() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+   * Optional default value if the variable isn't set; for example, in a ThreadRun
+   * if you start a ThreadRun or WfRun without passing a variable in, then this is
+   * used.
+   * 
+ * * optional .littlehorse.VariableValue default_value = 3; * @return The defaultValue. */ @@ -117,6 +149,12 @@ public io.littlehorse.sdk.common.proto.VariableValue getDefaultValue() { return defaultValue_ == null ? io.littlehorse.sdk.common.proto.VariableValue.getDefaultInstance() : defaultValue_; } /** + *
+   * Optional default value if the variable isn't set; for example, in a ThreadRun
+   * if you start a ThreadRun or WfRun without passing a variable in, then this is
+   * used.
+   * 
+ * * optional .littlehorse.VariableValue default_value = 3; */ @java.lang.Override @@ -307,6 +345,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * Declares a Variable.
+   * 
+ * * Protobuf type {@code littlehorse.VariableDef} */ public static final class Builder extends @@ -519,6 +561,10 @@ public Builder mergeFrom( private int type_ = 0; /** + *
+     * The Type of the variable.
+     * 
+ * * .littlehorse.VariableType type = 1; * @return The enum numeric value on the wire for type. */ @@ -526,6 +572,10 @@ public Builder mergeFrom( return type_; } /** + *
+     * The Type of the variable.
+     * 
+ * * .littlehorse.VariableType type = 1; * @param value The enum numeric value on the wire for type to set. * @return This builder for chaining. @@ -537,6 +587,10 @@ public Builder setTypeValue(int value) { return this; } /** + *
+     * The Type of the variable.
+     * 
+ * * .littlehorse.VariableType type = 1; * @return The type. */ @@ -546,6 +600,10 @@ public io.littlehorse.sdk.common.proto.VariableType getType() { return result == null ? io.littlehorse.sdk.common.proto.VariableType.UNRECOGNIZED : result; } /** + *
+     * The Type of the variable.
+     * 
+ * * .littlehorse.VariableType type = 1; * @param value The type to set. * @return This builder for chaining. @@ -560,6 +618,10 @@ public Builder setType(io.littlehorse.sdk.common.proto.VariableType value) { return this; } /** + *
+     * The Type of the variable.
+     * 
+ * * .littlehorse.VariableType type = 1; * @return This builder for chaining. */ @@ -572,6 +634,10 @@ public Builder clearType() { private java.lang.Object name_ = ""; /** + *
+     * The name of the variable.
+     * 
+ * * string name = 2; * @return The name. */ @@ -588,6 +654,10 @@ public java.lang.String getName() { } } /** + *
+     * The name of the variable.
+     * 
+ * * string name = 2; * @return The bytes for name. */ @@ -605,6 +675,10 @@ public java.lang.String getName() { } } /** + *
+     * The name of the variable.
+     * 
+ * * string name = 2; * @param value The name to set. * @return This builder for chaining. @@ -618,6 +692,10 @@ public Builder setName( return this; } /** + *
+     * The name of the variable.
+     * 
+ * * string name = 2; * @return This builder for chaining. */ @@ -628,6 +706,10 @@ public Builder clearName() { return this; } /** + *
+     * The name of the variable.
+     * 
+ * * string name = 2; * @param value The bytes for name to set. * @return This builder for chaining. @@ -646,6 +728,12 @@ public Builder setNameBytes( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.VariableValue, io.littlehorse.sdk.common.proto.VariableValue.Builder, io.littlehorse.sdk.common.proto.VariableValueOrBuilder> defaultValueBuilder_; /** + *
+     * Optional default value if the variable isn't set; for example, in a ThreadRun
+     * if you start a ThreadRun or WfRun without passing a variable in, then this is
+     * used.
+     * 
+ * * optional .littlehorse.VariableValue default_value = 3; * @return Whether the defaultValue field is set. */ @@ -653,6 +741,12 @@ public boolean hasDefaultValue() { return ((bitField0_ & 0x00000004) != 0); } /** + *
+     * Optional default value if the variable isn't set; for example, in a ThreadRun
+     * if you start a ThreadRun or WfRun without passing a variable in, then this is
+     * used.
+     * 
+ * * optional .littlehorse.VariableValue default_value = 3; * @return The defaultValue. */ @@ -664,6 +758,12 @@ public io.littlehorse.sdk.common.proto.VariableValue getDefaultValue() { } } /** + *
+     * Optional default value if the variable isn't set; for example, in a ThreadRun
+     * if you start a ThreadRun or WfRun without passing a variable in, then this is
+     * used.
+     * 
+ * * optional .littlehorse.VariableValue default_value = 3; */ public Builder setDefaultValue(io.littlehorse.sdk.common.proto.VariableValue value) { @@ -680,6 +780,12 @@ public Builder setDefaultValue(io.littlehorse.sdk.common.proto.VariableValue val return this; } /** + *
+     * Optional default value if the variable isn't set; for example, in a ThreadRun
+     * if you start a ThreadRun or WfRun without passing a variable in, then this is
+     * used.
+     * 
+ * * optional .littlehorse.VariableValue default_value = 3; */ public Builder setDefaultValue( @@ -694,6 +800,12 @@ public Builder setDefaultValue( return this; } /** + *
+     * Optional default value if the variable isn't set; for example, in a ThreadRun
+     * if you start a ThreadRun or WfRun without passing a variable in, then this is
+     * used.
+     * 
+ * * optional .littlehorse.VariableValue default_value = 3; */ public Builder mergeDefaultValue(io.littlehorse.sdk.common.proto.VariableValue value) { @@ -713,6 +825,12 @@ public Builder mergeDefaultValue(io.littlehorse.sdk.common.proto.VariableValue v return this; } /** + *
+     * Optional default value if the variable isn't set; for example, in a ThreadRun
+     * if you start a ThreadRun or WfRun without passing a variable in, then this is
+     * used.
+     * 
+ * * optional .littlehorse.VariableValue default_value = 3; */ public Builder clearDefaultValue() { @@ -726,6 +844,12 @@ public Builder clearDefaultValue() { return this; } /** + *
+     * Optional default value if the variable isn't set; for example, in a ThreadRun
+     * if you start a ThreadRun or WfRun without passing a variable in, then this is
+     * used.
+     * 
+ * * optional .littlehorse.VariableValue default_value = 3; */ public io.littlehorse.sdk.common.proto.VariableValue.Builder getDefaultValueBuilder() { @@ -734,6 +858,12 @@ public io.littlehorse.sdk.common.proto.VariableValue.Builder getDefaultValueBuil return getDefaultValueFieldBuilder().getBuilder(); } /** + *
+     * Optional default value if the variable isn't set; for example, in a ThreadRun
+     * if you start a ThreadRun or WfRun without passing a variable in, then this is
+     * used.
+     * 
+ * * optional .littlehorse.VariableValue default_value = 3; */ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getDefaultValueOrBuilder() { @@ -745,6 +875,12 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getDefaultValueOrB } } /** + *
+     * Optional default value if the variable isn't set; for example, in a ThreadRun
+     * if you start a ThreadRun or WfRun without passing a variable in, then this is
+     * used.
+     * 
+ * * optional .littlehorse.VariableValue default_value = 3; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableDefOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableDefOrBuilder.java index e96de61f0..b0e9a948b 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableDefOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableDefOrBuilder.java @@ -8,22 +8,38 @@ public interface VariableDefOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The Type of the variable.
+   * 
+ * * .littlehorse.VariableType type = 1; * @return The enum numeric value on the wire for type. */ int getTypeValue(); /** + *
+   * The Type of the variable.
+   * 
+ * * .littlehorse.VariableType type = 1; * @return The type. */ io.littlehorse.sdk.common.proto.VariableType getType(); /** + *
+   * The name of the variable.
+   * 
+ * * string name = 2; * @return The name. */ java.lang.String getName(); /** + *
+   * The name of the variable.
+   * 
+ * * string name = 2; * @return The bytes for name. */ @@ -31,16 +47,34 @@ public interface VariableDefOrBuilder extends getNameBytes(); /** + *
+   * Optional default value if the variable isn't set; for example, in a ThreadRun
+   * if you start a ThreadRun or WfRun without passing a variable in, then this is
+   * used.
+   * 
+ * * optional .littlehorse.VariableValue default_value = 3; * @return Whether the defaultValue field is set. */ boolean hasDefaultValue(); /** + *
+   * Optional default value if the variable isn't set; for example, in a ThreadRun
+   * if you start a ThreadRun or WfRun without passing a variable in, then this is
+   * used.
+   * 
+ * * optional .littlehorse.VariableValue default_value = 3; * @return The defaultValue. */ io.littlehorse.sdk.common.proto.VariableValue getDefaultValue(); /** + *
+   * Optional default value if the variable isn't set; for example, in a ThreadRun
+   * if you start a ThreadRun or WfRun without passing a variable in, then this is
+   * used.
+   * 
+ * * optional .littlehorse.VariableValue default_value = 3; */ io.littlehorse.sdk.common.proto.VariableValueOrBuilder getDefaultValueOrBuilder(); diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableId.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableId.java index 68fb13b96..a2eb5cfcd 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableId.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableId.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * Id for a Variable.
+ * 
+ * * Protobuf type {@code littlehorse.VariableId} */ public final class VariableId extends @@ -42,6 +46,11 @@ protected java.lang.Object newInstance( public static final int WF_RUN_ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.WfRunId wfRunId_; /** + *
+   * WfRunId for the variable. Note that every Variable is associated with
+   * a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return Whether the wfRunId field is set. */ @@ -50,6 +59,11 @@ public boolean hasWfRunId() { return wfRunId_ != null; } /** + *
+   * WfRunId for the variable. Note that every Variable is associated with
+   * a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return The wfRunId. */ @@ -58,6 +72,11 @@ public io.littlehorse.sdk.common.proto.WfRunId getWfRunId() { return wfRunId_ == null ? io.littlehorse.sdk.common.proto.WfRunId.getDefaultInstance() : wfRunId_; } /** + *
+   * WfRunId for the variable. Note that every Variable is associated with
+   * a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ @java.lang.Override @@ -68,6 +87,11 @@ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { public static final int THREAD_RUN_NUMBER_FIELD_NUMBER = 2; private int threadRunNumber_ = 0; /** + *
+   * Each Variable is owned by a specific ThreadRun inside the WfRun it belongs
+   * to. This is that ThreadRun's number.
+   * 
+ * * int32 thread_run_number = 2; * @return The threadRunNumber. */ @@ -80,6 +104,10 @@ public int getThreadRunNumber() { @SuppressWarnings("serial") private volatile java.lang.Object name_ = ""; /** + *
+   * The name of the variable.
+   * 
+ * * string name = 3; * @return The name. */ @@ -97,6 +125,10 @@ public java.lang.String getName() { } } /** + *
+   * The name of the variable.
+   * 
+ * * string name = 3; * @return The bytes for name. */ @@ -299,6 +331,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * Id for a Variable.
+   * 
+ * * Protobuf type {@code littlehorse.VariableId} */ public static final class Builder extends @@ -504,6 +540,11 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.WfRunId, io.littlehorse.sdk.common.proto.WfRunId.Builder, io.littlehorse.sdk.common.proto.WfRunIdOrBuilder> wfRunIdBuilder_; /** + *
+     * WfRunId for the variable. Note that every Variable is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return Whether the wfRunId field is set. */ @@ -511,6 +552,11 @@ public boolean hasWfRunId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * WfRunId for the variable. Note that every Variable is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return The wfRunId. */ @@ -522,6 +568,11 @@ public io.littlehorse.sdk.common.proto.WfRunId getWfRunId() { } } /** + *
+     * WfRunId for the variable. Note that every Variable is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder setWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { @@ -538,6 +589,11 @@ public Builder setWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { return this; } /** + *
+     * WfRunId for the variable. Note that every Variable is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder setWfRunId( @@ -552,6 +608,11 @@ public Builder setWfRunId( return this; } /** + *
+     * WfRunId for the variable. Note that every Variable is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder mergeWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { @@ -571,6 +632,11 @@ public Builder mergeWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { return this; } /** + *
+     * WfRunId for the variable. Note that every Variable is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public Builder clearWfRunId() { @@ -584,6 +650,11 @@ public Builder clearWfRunId() { return this; } /** + *
+     * WfRunId for the variable. Note that every Variable is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public io.littlehorse.sdk.common.proto.WfRunId.Builder getWfRunIdBuilder() { @@ -592,6 +663,11 @@ public io.littlehorse.sdk.common.proto.WfRunId.Builder getWfRunIdBuilder() { return getWfRunIdFieldBuilder().getBuilder(); } /** + *
+     * WfRunId for the variable. Note that every Variable is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { @@ -603,6 +679,11 @@ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { } } /** + *
+     * WfRunId for the variable. Note that every Variable is associated with
+     * a WfRun.
+     * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -621,6 +702,11 @@ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder() { private int threadRunNumber_ ; /** + *
+     * Each Variable is owned by a specific ThreadRun inside the WfRun it belongs
+     * to. This is that ThreadRun's number.
+     * 
+ * * int32 thread_run_number = 2; * @return The threadRunNumber. */ @@ -629,6 +715,11 @@ public int getThreadRunNumber() { return threadRunNumber_; } /** + *
+     * Each Variable is owned by a specific ThreadRun inside the WfRun it belongs
+     * to. This is that ThreadRun's number.
+     * 
+ * * int32 thread_run_number = 2; * @param value The threadRunNumber to set. * @return This builder for chaining. @@ -641,6 +732,11 @@ public Builder setThreadRunNumber(int value) { return this; } /** + *
+     * Each Variable is owned by a specific ThreadRun inside the WfRun it belongs
+     * to. This is that ThreadRun's number.
+     * 
+ * * int32 thread_run_number = 2; * @return This builder for chaining. */ @@ -653,6 +749,10 @@ public Builder clearThreadRunNumber() { private java.lang.Object name_ = ""; /** + *
+     * The name of the variable.
+     * 
+ * * string name = 3; * @return The name. */ @@ -669,6 +769,10 @@ public java.lang.String getName() { } } /** + *
+     * The name of the variable.
+     * 
+ * * string name = 3; * @return The bytes for name. */ @@ -686,6 +790,10 @@ public java.lang.String getName() { } } /** + *
+     * The name of the variable.
+     * 
+ * * string name = 3; * @param value The name to set. * @return This builder for chaining. @@ -699,6 +807,10 @@ public Builder setName( return this; } /** + *
+     * The name of the variable.
+     * 
+ * * string name = 3; * @return This builder for chaining. */ @@ -709,6 +821,10 @@ public Builder clearName() { return this; } /** + *
+     * The name of the variable.
+     * 
+ * * string name = 3; * @param value The bytes for name to set. * @return This builder for chaining. diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableIdOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableIdOrBuilder.java index 2ff21e0fc..d5b56a82b 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableIdOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableIdOrBuilder.java @@ -8,32 +8,60 @@ public interface VariableIdOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * WfRunId for the variable. Note that every Variable is associated with
+   * a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return Whether the wfRunId field is set. */ boolean hasWfRunId(); /** + *
+   * WfRunId for the variable. Note that every Variable is associated with
+   * a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; * @return The wfRunId. */ io.littlehorse.sdk.common.proto.WfRunId getWfRunId(); /** + *
+   * WfRunId for the variable. Note that every Variable is associated with
+   * a WfRun.
+   * 
+ * * .littlehorse.WfRunId wf_run_id = 1; */ io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getWfRunIdOrBuilder(); /** + *
+   * Each Variable is owned by a specific ThreadRun inside the WfRun it belongs
+   * to. This is that ThreadRun's number.
+   * 
+ * * int32 thread_run_number = 2; * @return The threadRunNumber. */ int getThreadRunNumber(); /** + *
+   * The name of the variable.
+   * 
+ * * string name = 3; * @return The name. */ java.lang.String getName(); /** + *
+   * The name of the variable.
+   * 
+ * * string name = 3; * @return The bytes for name. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableMutation.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableMutation.java index b50ce2c91..ace98259d 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableMutation.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableMutation.java @@ -4,6 +4,15 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * A VariableMutation defines a modification made to one of a ThreadRun's variables.
+ * The LHS determines the variable that is modified; the operation determines how
+ * it is modified, and the RHS is the input to the operation.
+ *
+ * Day-to-day users of LittleHorse generally don't interact with this structure unless
+ * they are writing their own WfSpec SDK.
+ * 
+ * * Protobuf type {@code littlehorse.VariableMutation} */ public final class VariableMutation extends @@ -46,16 +55,28 @@ public interface NodeOutputSourceOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+     * Use this specific field from a JSON output
+     * 
+ * * optional string jsonpath = 10; * @return Whether the jsonpath field is set. */ boolean hasJsonpath(); /** + *
+     * Use this specific field from a JSON output
+     * 
+ * * optional string jsonpath = 10; * @return The jsonpath. */ java.lang.String getJsonpath(); /** + *
+     * Use this specific field from a JSON output
+     * 
+ * * optional string jsonpath = 10; * @return The bytes for jsonpath. */ @@ -63,6 +84,10 @@ public interface NodeOutputSourceOrBuilder extends getJsonpathBytes(); } /** + *
+   * Specifies to use the output of a NodeRun as the RHS.
+   * 
+ * * Protobuf type {@code littlehorse.VariableMutation.NodeOutputSource} */ public static final class NodeOutputSource extends @@ -103,6 +128,10 @@ protected java.lang.Object newInstance( @SuppressWarnings("serial") private volatile java.lang.Object jsonpath_ = ""; /** + *
+     * Use this specific field from a JSON output
+     * 
+ * * optional string jsonpath = 10; * @return Whether the jsonpath field is set. */ @@ -111,6 +140,10 @@ public boolean hasJsonpath() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * Use this specific field from a JSON output
+     * 
+ * * optional string jsonpath = 10; * @return The jsonpath. */ @@ -128,6 +161,10 @@ public java.lang.String getJsonpath() { } } /** + *
+     * Use this specific field from a JSON output
+     * 
+ * * optional string jsonpath = 10; * @return The bytes for jsonpath. */ @@ -308,6 +345,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+     * Specifies to use the output of a NodeRun as the RHS.
+     * 
+ * * Protobuf type {@code littlehorse.VariableMutation.NodeOutputSource} */ public static final class Builder extends @@ -482,6 +523,10 @@ public Builder mergeFrom( private java.lang.Object jsonpath_ = ""; /** + *
+       * Use this specific field from a JSON output
+       * 
+ * * optional string jsonpath = 10; * @return Whether the jsonpath field is set. */ @@ -489,6 +534,10 @@ public boolean hasJsonpath() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+       * Use this specific field from a JSON output
+       * 
+ * * optional string jsonpath = 10; * @return The jsonpath. */ @@ -505,6 +554,10 @@ public java.lang.String getJsonpath() { } } /** + *
+       * Use this specific field from a JSON output
+       * 
+ * * optional string jsonpath = 10; * @return The bytes for jsonpath. */ @@ -522,6 +575,10 @@ public java.lang.String getJsonpath() { } } /** + *
+       * Use this specific field from a JSON output
+       * 
+ * * optional string jsonpath = 10; * @param value The jsonpath to set. * @return This builder for chaining. @@ -535,6 +592,10 @@ public Builder setJsonpath( return this; } /** + *
+       * Use this specific field from a JSON output
+       * 
+ * * optional string jsonpath = 10; * @return This builder for chaining. */ @@ -545,6 +606,10 @@ public Builder clearJsonpath() { return this; } /** + *
+       * Use this specific field from a JSON output
+       * 
+ * * optional string jsonpath = 10; * @param value The bytes for jsonpath to set. * @return This builder for chaining. @@ -671,6 +736,10 @@ public int getNumber() { @SuppressWarnings("serial") private volatile java.lang.Object lhsName_ = ""; /** + *
+   * The name of the variable to mutate
+   * 
+ * * string lhs_name = 1; * @return The lhsName. */ @@ -688,6 +757,10 @@ public java.lang.String getLhsName() { } } /** + *
+   * The name of the variable to mutate
+   * 
+ * * string lhs_name = 1; * @return The bytes for lhsName. */ @@ -710,6 +783,11 @@ public java.lang.String getLhsName() { @SuppressWarnings("serial") private volatile java.lang.Object lhsJsonPath_ = ""; /** + *
+   * For JSON_ARR and JSON_OBJ variables, this allows you to optionally mutate
+   * a specific sub-field of the variable.
+   * 
+ * * optional string lhs_json_path = 2; * @return Whether the lhsJsonPath field is set. */ @@ -718,6 +796,11 @@ public boolean hasLhsJsonPath() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+   * For JSON_ARR and JSON_OBJ variables, this allows you to optionally mutate
+   * a specific sub-field of the variable.
+   * 
+ * * optional string lhs_json_path = 2; * @return The lhsJsonPath. */ @@ -735,6 +818,11 @@ public java.lang.String getLhsJsonPath() { } } /** + *
+   * For JSON_ARR and JSON_OBJ variables, this allows you to optionally mutate
+   * a specific sub-field of the variable.
+   * 
+ * * optional string lhs_json_path = 2; * @return The bytes for lhsJsonPath. */ @@ -756,6 +844,10 @@ public java.lang.String getLhsJsonPath() { public static final int OPERATION_FIELD_NUMBER = 3; private int operation_ = 0; /** + *
+   * Defines the operation that we are executing.
+   * 
+ * * .littlehorse.VariableMutationType operation = 3; * @return The enum numeric value on the wire for operation. */ @@ -763,6 +855,10 @@ public java.lang.String getLhsJsonPath() { return operation_; } /** + *
+   * Defines the operation that we are executing.
+   * 
+ * * .littlehorse.VariableMutationType operation = 3; * @return The operation. */ @@ -773,6 +869,11 @@ public java.lang.String getLhsJsonPath() { public static final int SOURCE_VARIABLE_FIELD_NUMBER = 4; /** + *
+   * Set the source_variable as the RHS to use another variable from the workflow to
+   * as the RHS/
+   * 
+ * * .littlehorse.VariableAssignment source_variable = 4; * @return Whether the sourceVariable field is set. */ @@ -781,6 +882,11 @@ public boolean hasSourceVariable() { return rhsValueCase_ == 4; } /** + *
+   * Set the source_variable as the RHS to use another variable from the workflow to
+   * as the RHS/
+   * 
+ * * .littlehorse.VariableAssignment source_variable = 4; * @return The sourceVariable. */ @@ -792,6 +898,11 @@ public io.littlehorse.sdk.common.proto.VariableAssignment getSourceVariable() { return io.littlehorse.sdk.common.proto.VariableAssignment.getDefaultInstance(); } /** + *
+   * Set the source_variable as the RHS to use another variable from the workflow to
+   * as the RHS/
+   * 
+ * * .littlehorse.VariableAssignment source_variable = 4; */ @java.lang.Override @@ -804,6 +915,10 @@ public io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getSourceVari public static final int LITERAL_VALUE_FIELD_NUMBER = 5; /** + *
+   * Use a literal value as the RHS.
+   * 
+ * * .littlehorse.VariableValue literal_value = 5; * @return Whether the literalValue field is set. */ @@ -812,6 +927,10 @@ public boolean hasLiteralValue() { return rhsValueCase_ == 5; } /** + *
+   * Use a literal value as the RHS.
+   * 
+ * * .littlehorse.VariableValue literal_value = 5; * @return The literalValue. */ @@ -823,6 +942,10 @@ public io.littlehorse.sdk.common.proto.VariableValue getLiteralValue() { return io.littlehorse.sdk.common.proto.VariableValue.getDefaultInstance(); } /** + *
+   * Use a literal value as the RHS.
+   * 
+ * * .littlehorse.VariableValue literal_value = 5; */ @java.lang.Override @@ -835,6 +958,10 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getLiteralValueOrB public static final int NODE_OUTPUT_FIELD_NUMBER = 6; /** + *
+   * Use the output of the current node as the RHS.
+   * 
+ * * .littlehorse.VariableMutation.NodeOutputSource node_output = 6; * @return Whether the nodeOutput field is set. */ @@ -843,6 +970,10 @@ public boolean hasNodeOutput() { return rhsValueCase_ == 6; } /** + *
+   * Use the output of the current node as the RHS.
+   * 
+ * * .littlehorse.VariableMutation.NodeOutputSource node_output = 6; * @return The nodeOutput. */ @@ -854,6 +985,10 @@ public io.littlehorse.sdk.common.proto.VariableMutation.NodeOutputSource getNode return io.littlehorse.sdk.common.proto.VariableMutation.NodeOutputSource.getDefaultInstance(); } /** + *
+   * Use the output of the current node as the RHS.
+   * 
+ * * .littlehorse.VariableMutation.NodeOutputSource node_output = 6; */ @java.lang.Override @@ -1100,6 +1235,15 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * A VariableMutation defines a modification made to one of a ThreadRun's variables.
+   * The LHS determines the variable that is modified; the operation determines how
+   * it is modified, and the RHS is the input to the operation.
+   *
+   * Day-to-day users of LittleHorse generally don't interact with this structure unless
+   * they are writing their own WfSpec SDK.
+   * 
+ * * Protobuf type {@code littlehorse.VariableMutation} */ public static final class Builder extends @@ -1382,6 +1526,10 @@ public Builder clearRhsValue() { private java.lang.Object lhsName_ = ""; /** + *
+     * The name of the variable to mutate
+     * 
+ * * string lhs_name = 1; * @return The lhsName. */ @@ -1398,6 +1546,10 @@ public java.lang.String getLhsName() { } } /** + *
+     * The name of the variable to mutate
+     * 
+ * * string lhs_name = 1; * @return The bytes for lhsName. */ @@ -1415,6 +1567,10 @@ public java.lang.String getLhsName() { } } /** + *
+     * The name of the variable to mutate
+     * 
+ * * string lhs_name = 1; * @param value The lhsName to set. * @return This builder for chaining. @@ -1428,6 +1584,10 @@ public Builder setLhsName( return this; } /** + *
+     * The name of the variable to mutate
+     * 
+ * * string lhs_name = 1; * @return This builder for chaining. */ @@ -1438,6 +1598,10 @@ public Builder clearLhsName() { return this; } /** + *
+     * The name of the variable to mutate
+     * 
+ * * string lhs_name = 1; * @param value The bytes for lhsName to set. * @return This builder for chaining. @@ -1454,6 +1618,11 @@ public Builder setLhsNameBytes( private java.lang.Object lhsJsonPath_ = ""; /** + *
+     * For JSON_ARR and JSON_OBJ variables, this allows you to optionally mutate
+     * a specific sub-field of the variable.
+     * 
+ * * optional string lhs_json_path = 2; * @return Whether the lhsJsonPath field is set. */ @@ -1461,6 +1630,11 @@ public boolean hasLhsJsonPath() { return ((bitField0_ & 0x00000002) != 0); } /** + *
+     * For JSON_ARR and JSON_OBJ variables, this allows you to optionally mutate
+     * a specific sub-field of the variable.
+     * 
+ * * optional string lhs_json_path = 2; * @return The lhsJsonPath. */ @@ -1477,6 +1651,11 @@ public java.lang.String getLhsJsonPath() { } } /** + *
+     * For JSON_ARR and JSON_OBJ variables, this allows you to optionally mutate
+     * a specific sub-field of the variable.
+     * 
+ * * optional string lhs_json_path = 2; * @return The bytes for lhsJsonPath. */ @@ -1494,6 +1673,11 @@ public java.lang.String getLhsJsonPath() { } } /** + *
+     * For JSON_ARR and JSON_OBJ variables, this allows you to optionally mutate
+     * a specific sub-field of the variable.
+     * 
+ * * optional string lhs_json_path = 2; * @param value The lhsJsonPath to set. * @return This builder for chaining. @@ -1507,6 +1691,11 @@ public Builder setLhsJsonPath( return this; } /** + *
+     * For JSON_ARR and JSON_OBJ variables, this allows you to optionally mutate
+     * a specific sub-field of the variable.
+     * 
+ * * optional string lhs_json_path = 2; * @return This builder for chaining. */ @@ -1517,6 +1706,11 @@ public Builder clearLhsJsonPath() { return this; } /** + *
+     * For JSON_ARR and JSON_OBJ variables, this allows you to optionally mutate
+     * a specific sub-field of the variable.
+     * 
+ * * optional string lhs_json_path = 2; * @param value The bytes for lhsJsonPath to set. * @return This builder for chaining. @@ -1533,6 +1727,10 @@ public Builder setLhsJsonPathBytes( private int operation_ = 0; /** + *
+     * Defines the operation that we are executing.
+     * 
+ * * .littlehorse.VariableMutationType operation = 3; * @return The enum numeric value on the wire for operation. */ @@ -1540,6 +1738,10 @@ public Builder setLhsJsonPathBytes( return operation_; } /** + *
+     * Defines the operation that we are executing.
+     * 
+ * * .littlehorse.VariableMutationType operation = 3; * @param value The enum numeric value on the wire for operation to set. * @return This builder for chaining. @@ -1551,6 +1753,10 @@ public Builder setOperationValue(int value) { return this; } /** + *
+     * Defines the operation that we are executing.
+     * 
+ * * .littlehorse.VariableMutationType operation = 3; * @return The operation. */ @@ -1560,6 +1766,10 @@ public io.littlehorse.sdk.common.proto.VariableMutationType getOperation() { return result == null ? io.littlehorse.sdk.common.proto.VariableMutationType.UNRECOGNIZED : result; } /** + *
+     * Defines the operation that we are executing.
+     * 
+ * * .littlehorse.VariableMutationType operation = 3; * @param value The operation to set. * @return This builder for chaining. @@ -1574,6 +1784,10 @@ public Builder setOperation(io.littlehorse.sdk.common.proto.VariableMutationType return this; } /** + *
+     * Defines the operation that we are executing.
+     * 
+ * * .littlehorse.VariableMutationType operation = 3; * @return This builder for chaining. */ @@ -1587,6 +1801,11 @@ public Builder clearOperation() { private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.VariableAssignment, io.littlehorse.sdk.common.proto.VariableAssignment.Builder, io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder> sourceVariableBuilder_; /** + *
+     * Set the source_variable as the RHS to use another variable from the workflow to
+     * as the RHS/
+     * 
+ * * .littlehorse.VariableAssignment source_variable = 4; * @return Whether the sourceVariable field is set. */ @@ -1595,6 +1814,11 @@ public boolean hasSourceVariable() { return rhsValueCase_ == 4; } /** + *
+     * Set the source_variable as the RHS to use another variable from the workflow to
+     * as the RHS/
+     * 
+ * * .littlehorse.VariableAssignment source_variable = 4; * @return The sourceVariable. */ @@ -1613,6 +1837,11 @@ public io.littlehorse.sdk.common.proto.VariableAssignment getSourceVariable() { } } /** + *
+     * Set the source_variable as the RHS to use another variable from the workflow to
+     * as the RHS/
+     * 
+ * * .littlehorse.VariableAssignment source_variable = 4; */ public Builder setSourceVariable(io.littlehorse.sdk.common.proto.VariableAssignment value) { @@ -1629,6 +1858,11 @@ public Builder setSourceVariable(io.littlehorse.sdk.common.proto.VariableAssignm return this; } /** + *
+     * Set the source_variable as the RHS to use another variable from the workflow to
+     * as the RHS/
+     * 
+ * * .littlehorse.VariableAssignment source_variable = 4; */ public Builder setSourceVariable( @@ -1643,6 +1877,11 @@ public Builder setSourceVariable( return this; } /** + *
+     * Set the source_variable as the RHS to use another variable from the workflow to
+     * as the RHS/
+     * 
+ * * .littlehorse.VariableAssignment source_variable = 4; */ public Builder mergeSourceVariable(io.littlehorse.sdk.common.proto.VariableAssignment value) { @@ -1666,6 +1905,11 @@ public Builder mergeSourceVariable(io.littlehorse.sdk.common.proto.VariableAssig return this; } /** + *
+     * Set the source_variable as the RHS to use another variable from the workflow to
+     * as the RHS/
+     * 
+ * * .littlehorse.VariableAssignment source_variable = 4; */ public Builder clearSourceVariable() { @@ -1685,12 +1929,22 @@ public Builder clearSourceVariable() { return this; } /** + *
+     * Set the source_variable as the RHS to use another variable from the workflow to
+     * as the RHS/
+     * 
+ * * .littlehorse.VariableAssignment source_variable = 4; */ public io.littlehorse.sdk.common.proto.VariableAssignment.Builder getSourceVariableBuilder() { return getSourceVariableFieldBuilder().getBuilder(); } /** + *
+     * Set the source_variable as the RHS to use another variable from the workflow to
+     * as the RHS/
+     * 
+ * * .littlehorse.VariableAssignment source_variable = 4; */ @java.lang.Override @@ -1705,6 +1959,11 @@ public io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getSourceVari } } /** + *
+     * Set the source_variable as the RHS to use another variable from the workflow to
+     * as the RHS/
+     * 
+ * * .littlehorse.VariableAssignment source_variable = 4; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1729,6 +1988,10 @@ public io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getSourceVari private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.VariableValue, io.littlehorse.sdk.common.proto.VariableValue.Builder, io.littlehorse.sdk.common.proto.VariableValueOrBuilder> literalValueBuilder_; /** + *
+     * Use a literal value as the RHS.
+     * 
+ * * .littlehorse.VariableValue literal_value = 5; * @return Whether the literalValue field is set. */ @@ -1737,6 +2000,10 @@ public boolean hasLiteralValue() { return rhsValueCase_ == 5; } /** + *
+     * Use a literal value as the RHS.
+     * 
+ * * .littlehorse.VariableValue literal_value = 5; * @return The literalValue. */ @@ -1755,6 +2022,10 @@ public io.littlehorse.sdk.common.proto.VariableValue getLiteralValue() { } } /** + *
+     * Use a literal value as the RHS.
+     * 
+ * * .littlehorse.VariableValue literal_value = 5; */ public Builder setLiteralValue(io.littlehorse.sdk.common.proto.VariableValue value) { @@ -1771,6 +2042,10 @@ public Builder setLiteralValue(io.littlehorse.sdk.common.proto.VariableValue val return this; } /** + *
+     * Use a literal value as the RHS.
+     * 
+ * * .littlehorse.VariableValue literal_value = 5; */ public Builder setLiteralValue( @@ -1785,6 +2060,10 @@ public Builder setLiteralValue( return this; } /** + *
+     * Use a literal value as the RHS.
+     * 
+ * * .littlehorse.VariableValue literal_value = 5; */ public Builder mergeLiteralValue(io.littlehorse.sdk.common.proto.VariableValue value) { @@ -1808,6 +2087,10 @@ public Builder mergeLiteralValue(io.littlehorse.sdk.common.proto.VariableValue v return this; } /** + *
+     * Use a literal value as the RHS.
+     * 
+ * * .littlehorse.VariableValue literal_value = 5; */ public Builder clearLiteralValue() { @@ -1827,12 +2110,20 @@ public Builder clearLiteralValue() { return this; } /** + *
+     * Use a literal value as the RHS.
+     * 
+ * * .littlehorse.VariableValue literal_value = 5; */ public io.littlehorse.sdk.common.proto.VariableValue.Builder getLiteralValueBuilder() { return getLiteralValueFieldBuilder().getBuilder(); } /** + *
+     * Use a literal value as the RHS.
+     * 
+ * * .littlehorse.VariableValue literal_value = 5; */ @java.lang.Override @@ -1847,6 +2138,10 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getLiteralValueOrB } } /** + *
+     * Use a literal value as the RHS.
+     * 
+ * * .littlehorse.VariableValue literal_value = 5; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1871,6 +2166,10 @@ public io.littlehorse.sdk.common.proto.VariableValueOrBuilder getLiteralValueOrB private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.VariableMutation.NodeOutputSource, io.littlehorse.sdk.common.proto.VariableMutation.NodeOutputSource.Builder, io.littlehorse.sdk.common.proto.VariableMutation.NodeOutputSourceOrBuilder> nodeOutputBuilder_; /** + *
+     * Use the output of the current node as the RHS.
+     * 
+ * * .littlehorse.VariableMutation.NodeOutputSource node_output = 6; * @return Whether the nodeOutput field is set. */ @@ -1879,6 +2178,10 @@ public boolean hasNodeOutput() { return rhsValueCase_ == 6; } /** + *
+     * Use the output of the current node as the RHS.
+     * 
+ * * .littlehorse.VariableMutation.NodeOutputSource node_output = 6; * @return The nodeOutput. */ @@ -1897,6 +2200,10 @@ public io.littlehorse.sdk.common.proto.VariableMutation.NodeOutputSource getNode } } /** + *
+     * Use the output of the current node as the RHS.
+     * 
+ * * .littlehorse.VariableMutation.NodeOutputSource node_output = 6; */ public Builder setNodeOutput(io.littlehorse.sdk.common.proto.VariableMutation.NodeOutputSource value) { @@ -1913,6 +2220,10 @@ public Builder setNodeOutput(io.littlehorse.sdk.common.proto.VariableMutation.No return this; } /** + *
+     * Use the output of the current node as the RHS.
+     * 
+ * * .littlehorse.VariableMutation.NodeOutputSource node_output = 6; */ public Builder setNodeOutput( @@ -1927,6 +2238,10 @@ public Builder setNodeOutput( return this; } /** + *
+     * Use the output of the current node as the RHS.
+     * 
+ * * .littlehorse.VariableMutation.NodeOutputSource node_output = 6; */ public Builder mergeNodeOutput(io.littlehorse.sdk.common.proto.VariableMutation.NodeOutputSource value) { @@ -1950,6 +2265,10 @@ public Builder mergeNodeOutput(io.littlehorse.sdk.common.proto.VariableMutation. return this; } /** + *
+     * Use the output of the current node as the RHS.
+     * 
+ * * .littlehorse.VariableMutation.NodeOutputSource node_output = 6; */ public Builder clearNodeOutput() { @@ -1969,12 +2288,20 @@ public Builder clearNodeOutput() { return this; } /** + *
+     * Use the output of the current node as the RHS.
+     * 
+ * * .littlehorse.VariableMutation.NodeOutputSource node_output = 6; */ public io.littlehorse.sdk.common.proto.VariableMutation.NodeOutputSource.Builder getNodeOutputBuilder() { return getNodeOutputFieldBuilder().getBuilder(); } /** + *
+     * Use the output of the current node as the RHS.
+     * 
+ * * .littlehorse.VariableMutation.NodeOutputSource node_output = 6; */ @java.lang.Override @@ -1989,6 +2316,10 @@ public io.littlehorse.sdk.common.proto.VariableMutation.NodeOutputSourceOrBuilde } } /** + *
+     * Use the output of the current node as the RHS.
+     * 
+ * * .littlehorse.VariableMutation.NodeOutputSource node_output = 6; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableMutationOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableMutationOrBuilder.java index 397a41287..0a2b90cbb 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableMutationOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableMutationOrBuilder.java @@ -8,11 +8,19 @@ public interface VariableMutationOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The name of the variable to mutate
+   * 
+ * * string lhs_name = 1; * @return The lhsName. */ java.lang.String getLhsName(); /** + *
+   * The name of the variable to mutate
+   * 
+ * * string lhs_name = 1; * @return The bytes for lhsName. */ @@ -20,16 +28,31 @@ public interface VariableMutationOrBuilder extends getLhsNameBytes(); /** + *
+   * For JSON_ARR and JSON_OBJ variables, this allows you to optionally mutate
+   * a specific sub-field of the variable.
+   * 
+ * * optional string lhs_json_path = 2; * @return Whether the lhsJsonPath field is set. */ boolean hasLhsJsonPath(); /** + *
+   * For JSON_ARR and JSON_OBJ variables, this allows you to optionally mutate
+   * a specific sub-field of the variable.
+   * 
+ * * optional string lhs_json_path = 2; * @return The lhsJsonPath. */ java.lang.String getLhsJsonPath(); /** + *
+   * For JSON_ARR and JSON_OBJ variables, this allows you to optionally mutate
+   * a specific sub-field of the variable.
+   * 
+ * * optional string lhs_json_path = 2; * @return The bytes for lhsJsonPath. */ @@ -37,57 +60,104 @@ public interface VariableMutationOrBuilder extends getLhsJsonPathBytes(); /** + *
+   * Defines the operation that we are executing.
+   * 
+ * * .littlehorse.VariableMutationType operation = 3; * @return The enum numeric value on the wire for operation. */ int getOperationValue(); /** + *
+   * Defines the operation that we are executing.
+   * 
+ * * .littlehorse.VariableMutationType operation = 3; * @return The operation. */ io.littlehorse.sdk.common.proto.VariableMutationType getOperation(); /** + *
+   * Set the source_variable as the RHS to use another variable from the workflow to
+   * as the RHS/
+   * 
+ * * .littlehorse.VariableAssignment source_variable = 4; * @return Whether the sourceVariable field is set. */ boolean hasSourceVariable(); /** + *
+   * Set the source_variable as the RHS to use another variable from the workflow to
+   * as the RHS/
+   * 
+ * * .littlehorse.VariableAssignment source_variable = 4; * @return The sourceVariable. */ io.littlehorse.sdk.common.proto.VariableAssignment getSourceVariable(); /** + *
+   * Set the source_variable as the RHS to use another variable from the workflow to
+   * as the RHS/
+   * 
+ * * .littlehorse.VariableAssignment source_variable = 4; */ io.littlehorse.sdk.common.proto.VariableAssignmentOrBuilder getSourceVariableOrBuilder(); /** + *
+   * Use a literal value as the RHS.
+   * 
+ * * .littlehorse.VariableValue literal_value = 5; * @return Whether the literalValue field is set. */ boolean hasLiteralValue(); /** + *
+   * Use a literal value as the RHS.
+   * 
+ * * .littlehorse.VariableValue literal_value = 5; * @return The literalValue. */ io.littlehorse.sdk.common.proto.VariableValue getLiteralValue(); /** + *
+   * Use a literal value as the RHS.
+   * 
+ * * .littlehorse.VariableValue literal_value = 5; */ io.littlehorse.sdk.common.proto.VariableValueOrBuilder getLiteralValueOrBuilder(); /** + *
+   * Use the output of the current node as the RHS.
+   * 
+ * * .littlehorse.VariableMutation.NodeOutputSource node_output = 6; * @return Whether the nodeOutput field is set. */ boolean hasNodeOutput(); /** + *
+   * Use the output of the current node as the RHS.
+   * 
+ * * .littlehorse.VariableMutation.NodeOutputSource node_output = 6; * @return The nodeOutput. */ io.littlehorse.sdk.common.proto.VariableMutation.NodeOutputSource getNodeOutput(); /** + *
+   * Use the output of the current node as the RHS.
+   * 
+ * * .littlehorse.VariableMutation.NodeOutputSource node_output = 6; */ io.littlehorse.sdk.common.proto.VariableMutation.NodeOutputSourceOrBuilder getNodeOutputOrBuilder(); diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableOrBuilder.java index 799840b13..f37e3a4a5 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableOrBuilder.java @@ -8,61 +8,112 @@ public interface VariableOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * ID of this Variable. Note that the VariableId contains the relevant
+   * WfRunId inside it, the threadRunNumber, and the name of the Variabe.
+   * 
+ * * .littlehorse.VariableId id = 1; * @return Whether the id field is set. */ boolean hasId(); /** + *
+   * ID of this Variable. Note that the VariableId contains the relevant
+   * WfRunId inside it, the threadRunNumber, and the name of the Variabe.
+   * 
+ * * .littlehorse.VariableId id = 1; * @return The id. */ io.littlehorse.sdk.common.proto.VariableId getId(); /** + *
+   * ID of this Variable. Note that the VariableId contains the relevant
+   * WfRunId inside it, the threadRunNumber, and the name of the Variabe.
+   * 
+ * * .littlehorse.VariableId id = 1; */ io.littlehorse.sdk.common.proto.VariableIdOrBuilder getIdOrBuilder(); /** + *
+   * The value of this Variable.
+   * 
+ * * .littlehorse.VariableValue value = 2; * @return Whether the value field is set. */ boolean hasValue(); /** + *
+   * The value of this Variable.
+   * 
+ * * .littlehorse.VariableValue value = 2; * @return The value. */ io.littlehorse.sdk.common.proto.VariableValue getValue(); /** + *
+   * The value of this Variable.
+   * 
+ * * .littlehorse.VariableValue value = 2; */ io.littlehorse.sdk.common.proto.VariableValueOrBuilder getValueOrBuilder(); /** + *
+   * When the Variable was created.
+   * 
+ * * .google.protobuf.Timestamp created_at = 3; * @return Whether the createdAt field is set. */ boolean hasCreatedAt(); /** + *
+   * When the Variable was created.
+   * 
+ * * .google.protobuf.Timestamp created_at = 3; * @return The createdAt. */ com.google.protobuf.Timestamp getCreatedAt(); /** + *
+   * When the Variable was created.
+   * 
+ * * .google.protobuf.Timestamp created_at = 3; */ com.google.protobuf.TimestampOrBuilder getCreatedAtOrBuilder(); /** + *
+   * The ID of the WfSpec that this Variable belongs to.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; * @return Whether the wfSpecId field is set. */ boolean hasWfSpecId(); /** + *
+   * The ID of the WfSpec that this Variable belongs to.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; * @return The wfSpecId. */ io.littlehorse.sdk.common.proto.WfSpecId getWfSpecId(); /** + *
+   * The ID of the WfSpec that this Variable belongs to.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 4; */ io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder(); diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableValue.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableValue.java index 1c4809616..a98cfe87f 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableValue.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableValue.java @@ -4,6 +4,12 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * VariableValue is a structure containing a value in LittleHorse. It can be
+ * used to pass input variables into a WfRun/ThreadRun/TaskRun/etc, as output
+ * from a TaskRun, as the value of a WfRun's Variable, etc.
+ * 
+ * * Protobuf type {@code littlehorse.VariableValue} */ public final class VariableValue extends @@ -92,6 +98,10 @@ public int getNumber() { public static final int JSON_OBJ_FIELD_NUMBER = 2; /** + *
+   * A String representing a serialized json object.
+   * 
+ * * string json_obj = 2; * @return Whether the jsonObj field is set. */ @@ -99,6 +109,10 @@ public boolean hasJsonObj() { return valueCase_ == 2; } /** + *
+   * A String representing a serialized json object.
+   * 
+ * * string json_obj = 2; * @return The jsonObj. */ @@ -120,6 +134,10 @@ public java.lang.String getJsonObj() { } } /** + *
+   * A String representing a serialized json object.
+   * 
+ * * string json_obj = 2; * @return The bytes for jsonObj. */ @@ -144,6 +162,10 @@ public java.lang.String getJsonObj() { public static final int JSON_ARR_FIELD_NUMBER = 3; /** + *
+   * A String representing a serialized json list.
+   * 
+ * * string json_arr = 3; * @return Whether the jsonArr field is set. */ @@ -151,6 +173,10 @@ public boolean hasJsonArr() { return valueCase_ == 3; } /** + *
+   * A String representing a serialized json list.
+   * 
+ * * string json_arr = 3; * @return The jsonArr. */ @@ -172,6 +198,10 @@ public java.lang.String getJsonArr() { } } /** + *
+   * A String representing a serialized json list.
+   * 
+ * * string json_arr = 3; * @return The bytes for jsonArr. */ @@ -196,6 +226,10 @@ public java.lang.String getJsonArr() { public static final int DOUBLE_FIELD_NUMBER = 4; /** + *
+   * A 64-bit floating point number.
+   * 
+ * * double double = 4; * @return Whether the double field is set. */ @@ -204,6 +238,10 @@ public boolean hasDouble() { return valueCase_ == 4; } /** + *
+   * A 64-bit floating point number.
+   * 
+ * * double double = 4; * @return The double. */ @@ -217,6 +255,10 @@ public double getDouble() { public static final int BOOL_FIELD_NUMBER = 5; /** + *
+   * A boolean.
+   * 
+ * * bool bool = 5; * @return Whether the bool field is set. */ @@ -225,6 +267,10 @@ public boolean hasBool() { return valueCase_ == 5; } /** + *
+   * A boolean.
+   * 
+ * * bool bool = 5; * @return The bool. */ @@ -238,6 +284,10 @@ public boolean getBool() { public static final int STR_FIELD_NUMBER = 6; /** + *
+   * A string.
+   * 
+ * * string str = 6; * @return Whether the str field is set. */ @@ -245,6 +295,10 @@ public boolean hasStr() { return valueCase_ == 6; } /** + *
+   * A string.
+   * 
+ * * string str = 6; * @return The str. */ @@ -266,6 +320,10 @@ public java.lang.String getStr() { } } /** + *
+   * A string.
+   * 
+ * * string str = 6; * @return The bytes for str. */ @@ -290,6 +348,10 @@ public java.lang.String getStr() { public static final int INT_FIELD_NUMBER = 7; /** + *
+   * A 64-bit integer.
+   * 
+ * * int64 int = 7; * @return Whether the int field is set. */ @@ -298,6 +360,10 @@ public boolean hasInt() { return valueCase_ == 7; } /** + *
+   * A 64-bit integer.
+   * 
+ * * int64 int = 7; * @return The int. */ @@ -311,6 +377,10 @@ public long getInt() { public static final int BYTES_FIELD_NUMBER = 8; /** + *
+   * An arbitrary String of bytes.
+   * 
+ * * bytes bytes = 8; * @return Whether the bytes field is set. */ @@ -319,6 +389,10 @@ public boolean hasBytes() { return valueCase_ == 8; } /** + *
+   * An arbitrary String of bytes.
+   * 
+ * * bytes bytes = 8; * @return The bytes. */ @@ -600,6 +674,12 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * VariableValue is a structure containing a value in LittleHorse. It can be
+   * used to pass input variables into a WfRun/ThreadRun/TaskRun/etc, as output
+   * from a TaskRun, as the value of a WfRun's Variable, etc.
+   * 
+ * * Protobuf type {@code littlehorse.VariableValue} */ public static final class Builder extends @@ -856,6 +936,10 @@ public Builder clearValue() { private int bitField0_; /** + *
+     * A String representing a serialized json object.
+     * 
+ * * string json_obj = 2; * @return Whether the jsonObj field is set. */ @@ -864,6 +948,10 @@ public boolean hasJsonObj() { return valueCase_ == 2; } /** + *
+     * A String representing a serialized json object.
+     * 
+ * * string json_obj = 2; * @return The jsonObj. */ @@ -886,6 +974,10 @@ public java.lang.String getJsonObj() { } } /** + *
+     * A String representing a serialized json object.
+     * 
+ * * string json_obj = 2; * @return The bytes for jsonObj. */ @@ -909,6 +1001,10 @@ public java.lang.String getJsonObj() { } } /** + *
+     * A String representing a serialized json object.
+     * 
+ * * string json_obj = 2; * @param value The jsonObj to set. * @return This builder for chaining. @@ -922,6 +1018,10 @@ public Builder setJsonObj( return this; } /** + *
+     * A String representing a serialized json object.
+     * 
+ * * string json_obj = 2; * @return This builder for chaining. */ @@ -934,6 +1034,10 @@ public Builder clearJsonObj() { return this; } /** + *
+     * A String representing a serialized json object.
+     * 
+ * * string json_obj = 2; * @param value The bytes for jsonObj to set. * @return This builder for chaining. @@ -949,6 +1053,10 @@ public Builder setJsonObjBytes( } /** + *
+     * A String representing a serialized json list.
+     * 
+ * * string json_arr = 3; * @return Whether the jsonArr field is set. */ @@ -957,6 +1065,10 @@ public boolean hasJsonArr() { return valueCase_ == 3; } /** + *
+     * A String representing a serialized json list.
+     * 
+ * * string json_arr = 3; * @return The jsonArr. */ @@ -979,6 +1091,10 @@ public java.lang.String getJsonArr() { } } /** + *
+     * A String representing a serialized json list.
+     * 
+ * * string json_arr = 3; * @return The bytes for jsonArr. */ @@ -1002,6 +1118,10 @@ public java.lang.String getJsonArr() { } } /** + *
+     * A String representing a serialized json list.
+     * 
+ * * string json_arr = 3; * @param value The jsonArr to set. * @return This builder for chaining. @@ -1015,6 +1135,10 @@ public Builder setJsonArr( return this; } /** + *
+     * A String representing a serialized json list.
+     * 
+ * * string json_arr = 3; * @return This builder for chaining. */ @@ -1027,6 +1151,10 @@ public Builder clearJsonArr() { return this; } /** + *
+     * A String representing a serialized json list.
+     * 
+ * * string json_arr = 3; * @param value The bytes for jsonArr to set. * @return This builder for chaining. @@ -1042,6 +1170,10 @@ public Builder setJsonArrBytes( } /** + *
+     * A 64-bit floating point number.
+     * 
+ * * double double = 4; * @return Whether the double field is set. */ @@ -1049,6 +1181,10 @@ public boolean hasDouble() { return valueCase_ == 4; } /** + *
+     * A 64-bit floating point number.
+     * 
+ * * double double = 4; * @return The double. */ @@ -1059,6 +1195,10 @@ public double getDouble() { return 0D; } /** + *
+     * A 64-bit floating point number.
+     * 
+ * * double double = 4; * @param value The double to set. * @return This builder for chaining. @@ -1071,6 +1211,10 @@ public Builder setDouble(double value) { return this; } /** + *
+     * A 64-bit floating point number.
+     * 
+ * * double double = 4; * @return This builder for chaining. */ @@ -1084,6 +1228,10 @@ public Builder clearDouble() { } /** + *
+     * A boolean.
+     * 
+ * * bool bool = 5; * @return Whether the bool field is set. */ @@ -1091,6 +1239,10 @@ public boolean hasBool() { return valueCase_ == 5; } /** + *
+     * A boolean.
+     * 
+ * * bool bool = 5; * @return The bool. */ @@ -1101,6 +1253,10 @@ public boolean getBool() { return false; } /** + *
+     * A boolean.
+     * 
+ * * bool bool = 5; * @param value The bool to set. * @return This builder for chaining. @@ -1113,6 +1269,10 @@ public Builder setBool(boolean value) { return this; } /** + *
+     * A boolean.
+     * 
+ * * bool bool = 5; * @return This builder for chaining. */ @@ -1126,6 +1286,10 @@ public Builder clearBool() { } /** + *
+     * A string.
+     * 
+ * * string str = 6; * @return Whether the str field is set. */ @@ -1134,6 +1298,10 @@ public boolean hasStr() { return valueCase_ == 6; } /** + *
+     * A string.
+     * 
+ * * string str = 6; * @return The str. */ @@ -1156,6 +1324,10 @@ public java.lang.String getStr() { } } /** + *
+     * A string.
+     * 
+ * * string str = 6; * @return The bytes for str. */ @@ -1179,6 +1351,10 @@ public java.lang.String getStr() { } } /** + *
+     * A string.
+     * 
+ * * string str = 6; * @param value The str to set. * @return This builder for chaining. @@ -1192,6 +1368,10 @@ public Builder setStr( return this; } /** + *
+     * A string.
+     * 
+ * * string str = 6; * @return This builder for chaining. */ @@ -1204,6 +1384,10 @@ public Builder clearStr() { return this; } /** + *
+     * A string.
+     * 
+ * * string str = 6; * @param value The bytes for str to set. * @return This builder for chaining. @@ -1219,6 +1403,10 @@ public Builder setStrBytes( } /** + *
+     * A 64-bit integer.
+     * 
+ * * int64 int = 7; * @return Whether the int field is set. */ @@ -1226,6 +1414,10 @@ public boolean hasInt() { return valueCase_ == 7; } /** + *
+     * A 64-bit integer.
+     * 
+ * * int64 int = 7; * @return The int. */ @@ -1236,6 +1428,10 @@ public long getInt() { return 0L; } /** + *
+     * A 64-bit integer.
+     * 
+ * * int64 int = 7; * @param value The int to set. * @return This builder for chaining. @@ -1248,6 +1444,10 @@ public Builder setInt(long value) { return this; } /** + *
+     * A 64-bit integer.
+     * 
+ * * int64 int = 7; * @return This builder for chaining. */ @@ -1261,6 +1461,10 @@ public Builder clearInt() { } /** + *
+     * An arbitrary String of bytes.
+     * 
+ * * bytes bytes = 8; * @return Whether the bytes field is set. */ @@ -1268,6 +1472,10 @@ public boolean hasBytes() { return valueCase_ == 8; } /** + *
+     * An arbitrary String of bytes.
+     * 
+ * * bytes bytes = 8; * @return The bytes. */ @@ -1278,6 +1486,10 @@ public com.google.protobuf.ByteString getBytes() { return com.google.protobuf.ByteString.EMPTY; } /** + *
+     * An arbitrary String of bytes.
+     * 
+ * * bytes bytes = 8; * @param value The bytes to set. * @return This builder for chaining. @@ -1290,6 +1502,10 @@ public Builder setBytes(com.google.protobuf.ByteString value) { return this; } /** + *
+     * An arbitrary String of bytes.
+     * 
+ * * bytes bytes = 8; * @return This builder for chaining. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableValueOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableValueOrBuilder.java index 3b55b2cdd..36847720e 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableValueOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/VariableValueOrBuilder.java @@ -8,16 +8,28 @@ public interface VariableValueOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * A String representing a serialized json object.
+   * 
+ * * string json_obj = 2; * @return Whether the jsonObj field is set. */ boolean hasJsonObj(); /** + *
+   * A String representing a serialized json object.
+   * 
+ * * string json_obj = 2; * @return The jsonObj. */ java.lang.String getJsonObj(); /** + *
+   * A String representing a serialized json object.
+   * 
+ * * string json_obj = 2; * @return The bytes for jsonObj. */ @@ -25,16 +37,28 @@ public interface VariableValueOrBuilder extends getJsonObjBytes(); /** + *
+   * A String representing a serialized json list.
+   * 
+ * * string json_arr = 3; * @return Whether the jsonArr field is set. */ boolean hasJsonArr(); /** + *
+   * A String representing a serialized json list.
+   * 
+ * * string json_arr = 3; * @return The jsonArr. */ java.lang.String getJsonArr(); /** + *
+   * A String representing a serialized json list.
+   * 
+ * * string json_arr = 3; * @return The bytes for jsonArr. */ @@ -42,38 +66,66 @@ public interface VariableValueOrBuilder extends getJsonArrBytes(); /** + *
+   * A 64-bit floating point number.
+   * 
+ * * double double = 4; * @return Whether the double field is set. */ boolean hasDouble(); /** + *
+   * A 64-bit floating point number.
+   * 
+ * * double double = 4; * @return The double. */ double getDouble(); /** + *
+   * A boolean.
+   * 
+ * * bool bool = 5; * @return Whether the bool field is set. */ boolean hasBool(); /** + *
+   * A boolean.
+   * 
+ * * bool bool = 5; * @return The bool. */ boolean getBool(); /** + *
+   * A string.
+   * 
+ * * string str = 6; * @return Whether the str field is set. */ boolean hasStr(); /** + *
+   * A string.
+   * 
+ * * string str = 6; * @return The str. */ java.lang.String getStr(); /** + *
+   * A string.
+   * 
+ * * string str = 6; * @return The bytes for str. */ @@ -81,22 +133,38 @@ public interface VariableValueOrBuilder extends getStrBytes(); /** + *
+   * A 64-bit integer.
+   * 
+ * * int64 int = 7; * @return Whether the int field is set. */ boolean hasInt(); /** + *
+   * A 64-bit integer.
+   * 
+ * * int64 int = 7; * @return The int. */ long getInt(); /** + *
+   * An arbitrary String of bytes.
+   * 
+ * * bytes bytes = 8; * @return Whether the bytes field is set. */ boolean hasBytes(); /** + *
+   * An arbitrary String of bytes.
+   * 
+ * * bytes bytes = 8; * @return The bytes. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WaitForThreadsRun.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WaitForThreadsRun.java index 498caa2c9..0aec797ab 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WaitForThreadsRun.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WaitForThreadsRun.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * The sub-node structure for a WAIT_FOR_THREADS NodeRun.
+ * 
+ * * Protobuf type {@code littlehorse.WaitForThreadsRun} */ public final class WaitForThreadsRun extends @@ -45,44 +49,79 @@ public interface WaitForThreadOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+     * The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun
+     * is still RUNNING, HALTED, or HALTING.
+     * 
+ * * optional .google.protobuf.Timestamp thread_end_time = 1; * @return Whether the threadEndTime field is set. */ boolean hasThreadEndTime(); /** + *
+     * The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun
+     * is still RUNNING, HALTED, or HALTING.
+     * 
+ * * optional .google.protobuf.Timestamp thread_end_time = 1; * @return The threadEndTime. */ com.google.protobuf.Timestamp getThreadEndTime(); /** + *
+     * The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun
+     * is still RUNNING, HALTED, or HALTING.
+     * 
+ * * optional .google.protobuf.Timestamp thread_end_time = 1; */ com.google.protobuf.TimestampOrBuilder getThreadEndTimeOrBuilder(); /** + *
+     * The current status of the ThreadRun being waited for.
+     * 
+ * * .littlehorse.LHStatus thread_status = 2; * @return The enum numeric value on the wire for threadStatus. */ int getThreadStatusValue(); /** + *
+     * The current status of the ThreadRun being waited for.
+     * 
+ * * .littlehorse.LHStatus thread_status = 2; * @return The threadStatus. */ io.littlehorse.sdk.common.proto.LHStatus getThreadStatus(); /** + *
+     * The number of the ThreadRun being waited for.
+     * 
+ * * int32 thread_run_number = 3; * @return The threadRunNumber. */ int getThreadRunNumber(); /** + *
+     * INTERNAL: flag used by scheduler internally.
+     * 
+ * * bool already_handled = 5; * @return The alreadyHandled. */ boolean getAlreadyHandled(); } /** + *
+   * A 'WaitForThread' structure defines a thread that is being waited for.
+   * 
+ * * Protobuf type {@code littlehorse.WaitForThreadsRun.WaitForThread} */ public static final class WaitForThread extends @@ -122,6 +161,11 @@ protected java.lang.Object newInstance( public static final int THREAD_END_TIME_FIELD_NUMBER = 1; private com.google.protobuf.Timestamp threadEndTime_; /** + *
+     * The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun
+     * is still RUNNING, HALTED, or HALTING.
+     * 
+ * * optional .google.protobuf.Timestamp thread_end_time = 1; * @return Whether the threadEndTime field is set. */ @@ -130,6 +174,11 @@ public boolean hasThreadEndTime() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun
+     * is still RUNNING, HALTED, or HALTING.
+     * 
+ * * optional .google.protobuf.Timestamp thread_end_time = 1; * @return The threadEndTime. */ @@ -138,6 +187,11 @@ public com.google.protobuf.Timestamp getThreadEndTime() { return threadEndTime_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : threadEndTime_; } /** + *
+     * The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun
+     * is still RUNNING, HALTED, or HALTING.
+     * 
+ * * optional .google.protobuf.Timestamp thread_end_time = 1; */ @java.lang.Override @@ -148,6 +202,10 @@ public com.google.protobuf.TimestampOrBuilder getThreadEndTimeOrBuilder() { public static final int THREAD_STATUS_FIELD_NUMBER = 2; private int threadStatus_ = 0; /** + *
+     * The current status of the ThreadRun being waited for.
+     * 
+ * * .littlehorse.LHStatus thread_status = 2; * @return The enum numeric value on the wire for threadStatus. */ @@ -155,6 +213,10 @@ public com.google.protobuf.TimestampOrBuilder getThreadEndTimeOrBuilder() { return threadStatus_; } /** + *
+     * The current status of the ThreadRun being waited for.
+     * 
+ * * .littlehorse.LHStatus thread_status = 2; * @return The threadStatus. */ @@ -166,6 +228,10 @@ public com.google.protobuf.TimestampOrBuilder getThreadEndTimeOrBuilder() { public static final int THREAD_RUN_NUMBER_FIELD_NUMBER = 3; private int threadRunNumber_ = 0; /** + *
+     * The number of the ThreadRun being waited for.
+     * 
+ * * int32 thread_run_number = 3; * @return The threadRunNumber. */ @@ -177,6 +243,10 @@ public int getThreadRunNumber() { public static final int ALREADY_HANDLED_FIELD_NUMBER = 5; private boolean alreadyHandled_ = false; /** + *
+     * INTERNAL: flag used by scheduler internally.
+     * 
+ * * bool already_handled = 5; * @return The alreadyHandled. */ @@ -381,6 +451,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+     * A 'WaitForThread' structure defines a thread that is being waited for.
+     * 
+ * * Protobuf type {@code littlehorse.WaitForThreadsRun.WaitForThread} */ public static final class Builder extends @@ -605,6 +679,11 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> threadEndTimeBuilder_; /** + *
+       * The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun
+       * is still RUNNING, HALTED, or HALTING.
+       * 
+ * * optional .google.protobuf.Timestamp thread_end_time = 1; * @return Whether the threadEndTime field is set. */ @@ -612,6 +691,11 @@ public boolean hasThreadEndTime() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+       * The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun
+       * is still RUNNING, HALTED, or HALTING.
+       * 
+ * * optional .google.protobuf.Timestamp thread_end_time = 1; * @return The threadEndTime. */ @@ -623,6 +707,11 @@ public com.google.protobuf.Timestamp getThreadEndTime() { } } /** + *
+       * The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun
+       * is still RUNNING, HALTED, or HALTING.
+       * 
+ * * optional .google.protobuf.Timestamp thread_end_time = 1; */ public Builder setThreadEndTime(com.google.protobuf.Timestamp value) { @@ -639,6 +728,11 @@ public Builder setThreadEndTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+       * The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun
+       * is still RUNNING, HALTED, or HALTING.
+       * 
+ * * optional .google.protobuf.Timestamp thread_end_time = 1; */ public Builder setThreadEndTime( @@ -653,6 +747,11 @@ public Builder setThreadEndTime( return this; } /** + *
+       * The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun
+       * is still RUNNING, HALTED, or HALTING.
+       * 
+ * * optional .google.protobuf.Timestamp thread_end_time = 1; */ public Builder mergeThreadEndTime(com.google.protobuf.Timestamp value) { @@ -672,6 +771,11 @@ public Builder mergeThreadEndTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+       * The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun
+       * is still RUNNING, HALTED, or HALTING.
+       * 
+ * * optional .google.protobuf.Timestamp thread_end_time = 1; */ public Builder clearThreadEndTime() { @@ -685,6 +789,11 @@ public Builder clearThreadEndTime() { return this; } /** + *
+       * The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun
+       * is still RUNNING, HALTED, or HALTING.
+       * 
+ * * optional .google.protobuf.Timestamp thread_end_time = 1; */ public com.google.protobuf.Timestamp.Builder getThreadEndTimeBuilder() { @@ -693,6 +802,11 @@ public com.google.protobuf.Timestamp.Builder getThreadEndTimeBuilder() { return getThreadEndTimeFieldBuilder().getBuilder(); } /** + *
+       * The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun
+       * is still RUNNING, HALTED, or HALTING.
+       * 
+ * * optional .google.protobuf.Timestamp thread_end_time = 1; */ public com.google.protobuf.TimestampOrBuilder getThreadEndTimeOrBuilder() { @@ -704,6 +818,11 @@ public com.google.protobuf.TimestampOrBuilder getThreadEndTimeOrBuilder() { } } /** + *
+       * The time at which the ThreadRun ended (successfully or not). Not set if the ThreadRun
+       * is still RUNNING, HALTED, or HALTING.
+       * 
+ * * optional .google.protobuf.Timestamp thread_end_time = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -722,6 +841,10 @@ public com.google.protobuf.TimestampOrBuilder getThreadEndTimeOrBuilder() { private int threadStatus_ = 0; /** + *
+       * The current status of the ThreadRun being waited for.
+       * 
+ * * .littlehorse.LHStatus thread_status = 2; * @return The enum numeric value on the wire for threadStatus. */ @@ -729,6 +852,10 @@ public com.google.protobuf.TimestampOrBuilder getThreadEndTimeOrBuilder() { return threadStatus_; } /** + *
+       * The current status of the ThreadRun being waited for.
+       * 
+ * * .littlehorse.LHStatus thread_status = 2; * @param value The enum numeric value on the wire for threadStatus to set. * @return This builder for chaining. @@ -740,6 +867,10 @@ public Builder setThreadStatusValue(int value) { return this; } /** + *
+       * The current status of the ThreadRun being waited for.
+       * 
+ * * .littlehorse.LHStatus thread_status = 2; * @return The threadStatus. */ @@ -749,6 +880,10 @@ public io.littlehorse.sdk.common.proto.LHStatus getThreadStatus() { return result == null ? io.littlehorse.sdk.common.proto.LHStatus.UNRECOGNIZED : result; } /** + *
+       * The current status of the ThreadRun being waited for.
+       * 
+ * * .littlehorse.LHStatus thread_status = 2; * @param value The threadStatus to set. * @return This builder for chaining. @@ -763,6 +898,10 @@ public Builder setThreadStatus(io.littlehorse.sdk.common.proto.LHStatus value) { return this; } /** + *
+       * The current status of the ThreadRun being waited for.
+       * 
+ * * .littlehorse.LHStatus thread_status = 2; * @return This builder for chaining. */ @@ -775,6 +914,10 @@ public Builder clearThreadStatus() { private int threadRunNumber_ ; /** + *
+       * The number of the ThreadRun being waited for.
+       * 
+ * * int32 thread_run_number = 3; * @return The threadRunNumber. */ @@ -783,6 +926,10 @@ public int getThreadRunNumber() { return threadRunNumber_; } /** + *
+       * The number of the ThreadRun being waited for.
+       * 
+ * * int32 thread_run_number = 3; * @param value The threadRunNumber to set. * @return This builder for chaining. @@ -795,6 +942,10 @@ public Builder setThreadRunNumber(int value) { return this; } /** + *
+       * The number of the ThreadRun being waited for.
+       * 
+ * * int32 thread_run_number = 3; * @return This builder for chaining. */ @@ -807,6 +958,10 @@ public Builder clearThreadRunNumber() { private boolean alreadyHandled_ ; /** + *
+       * INTERNAL: flag used by scheduler internally.
+       * 
+ * * bool already_handled = 5; * @return The alreadyHandled. */ @@ -815,6 +970,10 @@ public boolean getAlreadyHandled() { return alreadyHandled_; } /** + *
+       * INTERNAL: flag used by scheduler internally.
+       * 
+ * * bool already_handled = 5; * @param value The alreadyHandled to set. * @return This builder for chaining. @@ -827,6 +986,10 @@ public Builder setAlreadyHandled(boolean value) { return this; } /** + *
+       * INTERNAL: flag used by scheduler internally.
+       * 
+ * * bool already_handled = 5; * @return This builder for chaining. */ @@ -904,6 +1067,10 @@ public io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThread getDefaul @SuppressWarnings("serial") private java.util.List threads_; /** + *
+   * The threads that are being waited for.
+   * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ @java.lang.Override @@ -911,6 +1078,10 @@ public java.util.List + * The threads that are being waited for. + * + * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ @java.lang.Override @@ -919,6 +1090,10 @@ public java.util.List + * The threads that are being waited for. + * + * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ @java.lang.Override @@ -926,6 +1101,10 @@ public int getThreadsCount() { return threads_.size(); } /** + *
+   * The threads that are being waited for.
+   * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ @java.lang.Override @@ -933,6 +1112,10 @@ public io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThread getThread return threads_.get(index); } /** + *
+   * The threads that are being waited for.
+   * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ @java.lang.Override @@ -944,6 +1127,11 @@ public io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThreadOrBuilder public static final int POLICY_FIELD_NUMBER = 2; private int policy_ = 0; /** + *
+   * The policy to use when handling failures for Threads. Currently, only
+   * one policy exists.
+   * 
+ * * .littlehorse.WaitForThreadsPolicy policy = 2; * @return The enum numeric value on the wire for policy. */ @@ -951,6 +1139,11 @@ public io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThreadOrBuilder return policy_; } /** + *
+   * The policy to use when handling failures for Threads. Currently, only
+   * one policy exists.
+   * 
+ * * .littlehorse.WaitForThreadsPolicy policy = 2; * @return The policy. */ @@ -1129,6 +1322,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * The sub-node structure for a WAIT_FOR_THREADS NodeRun.
+   * 
+ * * Protobuf type {@code littlehorse.WaitForThreadsRun} */ public static final class Builder extends @@ -1368,6 +1565,10 @@ private void ensureThreadsIsMutable() { io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThread, io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThread.Builder, io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThreadOrBuilder> threadsBuilder_; /** + *
+     * The threads that are being waited for.
+     * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ public java.util.List getThreadsList() { @@ -1378,6 +1579,10 @@ public java.util.List + * The threads that are being waited for. + * + * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ public int getThreadsCount() { @@ -1388,6 +1593,10 @@ public int getThreadsCount() { } } /** + *
+     * The threads that are being waited for.
+     * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ public io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThread getThreads(int index) { @@ -1398,6 +1607,10 @@ public io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThread getThread } } /** + *
+     * The threads that are being waited for.
+     * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ public Builder setThreads( @@ -1415,6 +1628,10 @@ public Builder setThreads( return this; } /** + *
+     * The threads that are being waited for.
+     * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ public Builder setThreads( @@ -1429,6 +1646,10 @@ public Builder setThreads( return this; } /** + *
+     * The threads that are being waited for.
+     * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ public Builder addThreads(io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThread value) { @@ -1445,6 +1666,10 @@ public Builder addThreads(io.littlehorse.sdk.common.proto.WaitForThreadsRun.Wait return this; } /** + *
+     * The threads that are being waited for.
+     * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ public Builder addThreads( @@ -1462,6 +1687,10 @@ public Builder addThreads( return this; } /** + *
+     * The threads that are being waited for.
+     * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ public Builder addThreads( @@ -1476,6 +1705,10 @@ public Builder addThreads( return this; } /** + *
+     * The threads that are being waited for.
+     * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ public Builder addThreads( @@ -1490,6 +1723,10 @@ public Builder addThreads( return this; } /** + *
+     * The threads that are being waited for.
+     * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ public Builder addAllThreads( @@ -1505,6 +1742,10 @@ public Builder addAllThreads( return this; } /** + *
+     * The threads that are being waited for.
+     * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ public Builder clearThreads() { @@ -1518,6 +1759,10 @@ public Builder clearThreads() { return this; } /** + *
+     * The threads that are being waited for.
+     * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ public Builder removeThreads(int index) { @@ -1531,6 +1776,10 @@ public Builder removeThreads(int index) { return this; } /** + *
+     * The threads that are being waited for.
+     * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ public io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThread.Builder getThreadsBuilder( @@ -1538,6 +1787,10 @@ public io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThread.Builder g return getThreadsFieldBuilder().getBuilder(index); } /** + *
+     * The threads that are being waited for.
+     * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ public io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThreadOrBuilder getThreadsOrBuilder( @@ -1548,6 +1801,10 @@ public io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThreadOrBuilder } } /** + *
+     * The threads that are being waited for.
+     * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ public java.util.List @@ -1559,6 +1816,10 @@ public io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThreadOrBuilder } } /** + *
+     * The threads that are being waited for.
+     * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ public io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThread.Builder addThreadsBuilder() { @@ -1566,6 +1827,10 @@ public io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThread.Builder a io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThread.getDefaultInstance()); } /** + *
+     * The threads that are being waited for.
+     * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ public io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThread.Builder addThreadsBuilder( @@ -1574,6 +1839,10 @@ public io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThread.Builder a index, io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThread.getDefaultInstance()); } /** + *
+     * The threads that are being waited for.
+     * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ public java.util.List @@ -1597,6 +1866,11 @@ public io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThread.Builder a private int policy_ = 0; /** + *
+     * The policy to use when handling failures for Threads. Currently, only
+     * one policy exists.
+     * 
+ * * .littlehorse.WaitForThreadsPolicy policy = 2; * @return The enum numeric value on the wire for policy. */ @@ -1604,6 +1878,11 @@ public io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThread.Builder a return policy_; } /** + *
+     * The policy to use when handling failures for Threads. Currently, only
+     * one policy exists.
+     * 
+ * * .littlehorse.WaitForThreadsPolicy policy = 2; * @param value The enum numeric value on the wire for policy to set. * @return This builder for chaining. @@ -1615,6 +1894,11 @@ public Builder setPolicyValue(int value) { return this; } /** + *
+     * The policy to use when handling failures for Threads. Currently, only
+     * one policy exists.
+     * 
+ * * .littlehorse.WaitForThreadsPolicy policy = 2; * @return The policy. */ @@ -1624,6 +1908,11 @@ public io.littlehorse.sdk.common.proto.WaitForThreadsPolicy getPolicy() { return result == null ? io.littlehorse.sdk.common.proto.WaitForThreadsPolicy.UNRECOGNIZED : result; } /** + *
+     * The policy to use when handling failures for Threads. Currently, only
+     * one policy exists.
+     * 
+ * * .littlehorse.WaitForThreadsPolicy policy = 2; * @param value The policy to set. * @return This builder for chaining. @@ -1638,6 +1927,11 @@ public Builder setPolicy(io.littlehorse.sdk.common.proto.WaitForThreadsPolicy va return this; } /** + *
+     * The policy to use when handling failures for Threads. Currently, only
+     * one policy exists.
+     * 
+ * * .littlehorse.WaitForThreadsPolicy policy = 2; * @return This builder for chaining. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WaitForThreadsRunOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WaitForThreadsRunOrBuilder.java index c934937c1..ebed4c143 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WaitForThreadsRunOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WaitForThreadsRunOrBuilder.java @@ -8,35 +8,65 @@ public interface WaitForThreadsRunOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The threads that are being waited for.
+   * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ java.util.List getThreadsList(); /** + *
+   * The threads that are being waited for.
+   * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThread getThreads(int index); /** + *
+   * The threads that are being waited for.
+   * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ int getThreadsCount(); /** + *
+   * The threads that are being waited for.
+   * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ java.util.List getThreadsOrBuilderList(); /** + *
+   * The threads that are being waited for.
+   * 
+ * * repeated .littlehorse.WaitForThreadsRun.WaitForThread threads = 1; */ io.littlehorse.sdk.common.proto.WaitForThreadsRun.WaitForThreadOrBuilder getThreadsOrBuilder( int index); /** + *
+   * The policy to use when handling failures for Threads. Currently, only
+   * one policy exists.
+   * 
+ * * .littlehorse.WaitForThreadsPolicy policy = 2; * @return The enum numeric value on the wire for policy. */ int getPolicyValue(); /** + *
+   * The policy to use when handling failures for Threads. Currently, only
+   * one policy exists.
+   * 
+ * * .littlehorse.WaitForThreadsPolicy policy = 2; * @return The policy. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfRun.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfRun.java index 6ef4cdf71..e421a5ce2 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfRun.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfRun.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * A WfRun is a running instance of a WfSpec.
+ * 
+ * * Protobuf type {@code littlehorse.WfRun} */ public final class WfRun extends @@ -47,6 +51,10 @@ protected java.lang.Object newInstance( public static final int ID_FIELD_NUMBER = 1; private io.littlehorse.sdk.common.proto.WfRunId id_; /** + *
+   * The ID of the WfRun.
+   * 
+ * * .littlehorse.WfRunId id = 1; * @return Whether the id field is set. */ @@ -55,6 +63,10 @@ public boolean hasId() { return id_ != null; } /** + *
+   * The ID of the WfRun.
+   * 
+ * * .littlehorse.WfRunId id = 1; * @return The id. */ @@ -63,6 +75,10 @@ public io.littlehorse.sdk.common.proto.WfRunId getId() { return id_ == null ? io.littlehorse.sdk.common.proto.WfRunId.getDefaultInstance() : id_; } /** + *
+   * The ID of the WfRun.
+   * 
+ * * .littlehorse.WfRunId id = 1; */ @java.lang.Override @@ -73,6 +89,10 @@ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getIdOrBuilder() { public static final int WF_SPEC_ID_FIELD_NUMBER = 2; private io.littlehorse.sdk.common.proto.WfSpecId wfSpecId_; /** + *
+   * The ID of the WfSpec that this WfRun belongs to.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 2; * @return Whether the wfSpecId field is set. */ @@ -81,6 +101,10 @@ public boolean hasWfSpecId() { return wfSpecId_ != null; } /** + *
+   * The ID of the WfSpec that this WfRun belongs to.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 2; * @return The wfSpecId. */ @@ -89,6 +113,10 @@ public io.littlehorse.sdk.common.proto.WfSpecId getWfSpecId() { return wfSpecId_ == null ? io.littlehorse.sdk.common.proto.WfSpecId.getDefaultInstance() : wfSpecId_; } /** + *
+   * The ID of the WfSpec that this WfRun belongs to.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 2; */ @java.lang.Override @@ -100,6 +128,11 @@ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder() @SuppressWarnings("serial") private java.util.List oldWfSpecVersions_; /** + *
+   * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+   * old WfSpecId to this list for historical auditing and debugging purposes.
+   * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ @java.lang.Override @@ -107,6 +140,11 @@ public java.util.List getOldWfSpecVers return oldWfSpecVersions_; } /** + *
+   * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+   * old WfSpecId to this list for historical auditing and debugging purposes.
+   * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ @java.lang.Override @@ -115,6 +153,11 @@ public java.util.List getOldWfSpecVers return oldWfSpecVersions_; } /** + *
+   * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+   * old WfSpecId to this list for historical auditing and debugging purposes.
+   * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ @java.lang.Override @@ -122,6 +165,11 @@ public int getOldWfSpecVersionsCount() { return oldWfSpecVersions_.size(); } /** + *
+   * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+   * old WfSpecId to this list for historical auditing and debugging purposes.
+   * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ @java.lang.Override @@ -129,6 +177,11 @@ public io.littlehorse.sdk.common.proto.WfSpecId getOldWfSpecVersions(int index) return oldWfSpecVersions_.get(index); } /** + *
+   * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+   * old WfSpecId to this list for historical auditing and debugging purposes.
+   * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ @java.lang.Override @@ -140,6 +193,10 @@ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getOldWfSpecVersionsOrB public static final int STATUS_FIELD_NUMBER = 4; private int status_ = 0; /** + *
+   * The status of this WfRun.
+   * 
+ * * .littlehorse.LHStatus status = 4; * @return The enum numeric value on the wire for status. */ @@ -147,6 +204,10 @@ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getOldWfSpecVersionsOrB return status_; } /** + *
+   * The status of this WfRun.
+   * 
+ * * .littlehorse.LHStatus status = 4; * @return The status. */ @@ -159,8 +220,12 @@ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getOldWfSpecVersionsOrB private int greatestThreadrunNumber_ = 0; /** *
+   * The ID number of the greatest ThreadRUn in this WfRun. The total number of ThreadRuns
+   * is given by greatest_thread_run_number + 1.
+   *
    * Introduced now since with ThreadRun-level retention, we can't rely upon
-   * thread_runs.size() to determine the number of ThreadRuns.
+   * thread_runs.size() to determine the number of ThreadRuns, as a ThreadRun is removed
+   * from the thread_runs list once its retention period expires.
    * 
* * int32 greatest_threadrun_number = 5; @@ -174,6 +239,10 @@ public int getGreatestThreadrunNumber() { public static final int START_TIME_FIELD_NUMBER = 6; private com.google.protobuf.Timestamp startTime_; /** + *
+   * The time the WfRun was started.
+   * 
+ * * .google.protobuf.Timestamp start_time = 6; * @return Whether the startTime field is set. */ @@ -182,6 +251,10 @@ public boolean hasStartTime() { return startTime_ != null; } /** + *
+   * The time the WfRun was started.
+   * 
+ * * .google.protobuf.Timestamp start_time = 6; * @return The startTime. */ @@ -190,6 +263,10 @@ public com.google.protobuf.Timestamp getStartTime() { return startTime_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : startTime_; } /** + *
+   * The time the WfRun was started.
+   * 
+ * * .google.protobuf.Timestamp start_time = 6; */ @java.lang.Override @@ -200,6 +277,10 @@ public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder() { public static final int END_TIME_FIELD_NUMBER = 7; private com.google.protobuf.Timestamp endTime_; /** + *
+   * The time the WfRun failed or completed.
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 7; * @return Whether the endTime field is set. */ @@ -208,6 +289,10 @@ public boolean hasEndTime() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+   * The time the WfRun failed or completed.
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 7; * @return The endTime. */ @@ -216,6 +301,10 @@ public com.google.protobuf.Timestamp getEndTime() { return endTime_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : endTime_; } /** + *
+   * The time the WfRun failed or completed.
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 7; */ @java.lang.Override @@ -227,6 +316,11 @@ public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder() { @SuppressWarnings("serial") private java.util.List threadRuns_; /** + *
+   * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+   * have not yet expired.
+   * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ @java.lang.Override @@ -234,6 +328,11 @@ public java.util.List getThreadRunsLi return threadRuns_; } /** + *
+   * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+   * have not yet expired.
+   * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ @java.lang.Override @@ -242,6 +341,11 @@ public java.util.List getThreadRunsLi return threadRuns_; } /** + *
+   * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+   * have not yet expired.
+   * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ @java.lang.Override @@ -249,6 +353,11 @@ public int getThreadRunsCount() { return threadRuns_.size(); } /** + *
+   * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+   * have not yet expired.
+   * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ @java.lang.Override @@ -256,6 +365,11 @@ public io.littlehorse.sdk.common.proto.ThreadRun getThreadRuns(int index) { return threadRuns_.get(index); } /** + *
+   * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+   * have not yet expired.
+   * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ @java.lang.Override @@ -268,6 +382,11 @@ public io.littlehorse.sdk.common.proto.ThreadRunOrBuilder getThreadRunsOrBuilder @SuppressWarnings("serial") private java.util.List pendingInterrupts_; /** + *
+   * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+   * halting.
+   * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ @java.lang.Override @@ -275,6 +394,11 @@ public java.util.List getPendi return pendingInterrupts_; } /** + *
+   * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+   * halting.
+   * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ @java.lang.Override @@ -283,6 +407,11 @@ public java.util.List getPendi return pendingInterrupts_; } /** + *
+   * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+   * halting.
+   * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ @java.lang.Override @@ -290,6 +419,11 @@ public int getPendingInterruptsCount() { return pendingInterrupts_.size(); } /** + *
+   * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+   * halting.
+   * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ @java.lang.Override @@ -297,6 +431,11 @@ public io.littlehorse.sdk.common.proto.PendingInterrupt getPendingInterrupts(int return pendingInterrupts_.get(index); } /** + *
+   * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+   * halting.
+   * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ @java.lang.Override @@ -309,6 +448,11 @@ public io.littlehorse.sdk.common.proto.PendingInterruptOrBuilder getPendingInter @SuppressWarnings("serial") private java.util.List pendingFailures_; /** + *
+   * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+   * finish halting.
+   * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ @java.lang.Override @@ -316,6 +460,11 @@ public java.util.List get return pendingFailures_; } /** + *
+   * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+   * finish halting.
+   * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ @java.lang.Override @@ -324,6 +473,11 @@ public java.util.List get return pendingFailures_; } /** + *
+   * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+   * finish halting.
+   * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ @java.lang.Override @@ -331,6 +485,11 @@ public int getPendingFailuresCount() { return pendingFailures_.size(); } /** + *
+   * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+   * finish halting.
+   * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ @java.lang.Override @@ -338,6 +497,11 @@ public io.littlehorse.sdk.common.proto.PendingFailureHandler getPendingFailures( return pendingFailures_.get(index); } /** + *
+   * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+   * finish halting.
+   * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ @java.lang.Override @@ -630,6 +794,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * A WfRun is a running instance of a WfSpec.
+   * 
+ * * Protobuf type {@code littlehorse.WfRun} */ public static final class Builder extends @@ -1133,6 +1301,10 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.WfRunId, io.littlehorse.sdk.common.proto.WfRunId.Builder, io.littlehorse.sdk.common.proto.WfRunIdOrBuilder> idBuilder_; /** + *
+     * The ID of the WfRun.
+     * 
+ * * .littlehorse.WfRunId id = 1; * @return Whether the id field is set. */ @@ -1140,6 +1312,10 @@ public boolean hasId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * The ID of the WfRun.
+     * 
+ * * .littlehorse.WfRunId id = 1; * @return The id. */ @@ -1151,6 +1327,10 @@ public io.littlehorse.sdk.common.proto.WfRunId getId() { } } /** + *
+     * The ID of the WfRun.
+     * 
+ * * .littlehorse.WfRunId id = 1; */ public Builder setId(io.littlehorse.sdk.common.proto.WfRunId value) { @@ -1167,6 +1347,10 @@ public Builder setId(io.littlehorse.sdk.common.proto.WfRunId value) { return this; } /** + *
+     * The ID of the WfRun.
+     * 
+ * * .littlehorse.WfRunId id = 1; */ public Builder setId( @@ -1181,6 +1365,10 @@ public Builder setId( return this; } /** + *
+     * The ID of the WfRun.
+     * 
+ * * .littlehorse.WfRunId id = 1; */ public Builder mergeId(io.littlehorse.sdk.common.proto.WfRunId value) { @@ -1200,6 +1388,10 @@ public Builder mergeId(io.littlehorse.sdk.common.proto.WfRunId value) { return this; } /** + *
+     * The ID of the WfRun.
+     * 
+ * * .littlehorse.WfRunId id = 1; */ public Builder clearId() { @@ -1213,6 +1405,10 @@ public Builder clearId() { return this; } /** + *
+     * The ID of the WfRun.
+     * 
+ * * .littlehorse.WfRunId id = 1; */ public io.littlehorse.sdk.common.proto.WfRunId.Builder getIdBuilder() { @@ -1221,6 +1417,10 @@ public io.littlehorse.sdk.common.proto.WfRunId.Builder getIdBuilder() { return getIdFieldBuilder().getBuilder(); } /** + *
+     * The ID of the WfRun.
+     * 
+ * * .littlehorse.WfRunId id = 1; */ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getIdOrBuilder() { @@ -1232,6 +1432,10 @@ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getIdOrBuilder() { } } /** + *
+     * The ID of the WfRun.
+     * 
+ * * .littlehorse.WfRunId id = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1252,6 +1456,10 @@ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getIdOrBuilder() { private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.WfSpecId, io.littlehorse.sdk.common.proto.WfSpecId.Builder, io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder> wfSpecIdBuilder_; /** + *
+     * The ID of the WfSpec that this WfRun belongs to.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 2; * @return Whether the wfSpecId field is set. */ @@ -1259,6 +1467,10 @@ public boolean hasWfSpecId() { return ((bitField0_ & 0x00000002) != 0); } /** + *
+     * The ID of the WfSpec that this WfRun belongs to.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 2; * @return The wfSpecId. */ @@ -1270,6 +1482,10 @@ public io.littlehorse.sdk.common.proto.WfSpecId getWfSpecId() { } } /** + *
+     * The ID of the WfSpec that this WfRun belongs to.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 2; */ public Builder setWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { @@ -1286,6 +1502,10 @@ public Builder setWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { return this; } /** + *
+     * The ID of the WfSpec that this WfRun belongs to.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 2; */ public Builder setWfSpecId( @@ -1300,6 +1520,10 @@ public Builder setWfSpecId( return this; } /** + *
+     * The ID of the WfSpec that this WfRun belongs to.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 2; */ public Builder mergeWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { @@ -1319,6 +1543,10 @@ public Builder mergeWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { return this; } /** + *
+     * The ID of the WfSpec that this WfRun belongs to.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 2; */ public Builder clearWfSpecId() { @@ -1332,6 +1560,10 @@ public Builder clearWfSpecId() { return this; } /** + *
+     * The ID of the WfSpec that this WfRun belongs to.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 2; */ public io.littlehorse.sdk.common.proto.WfSpecId.Builder getWfSpecIdBuilder() { @@ -1340,6 +1572,10 @@ public io.littlehorse.sdk.common.proto.WfSpecId.Builder getWfSpecIdBuilder() { return getWfSpecIdFieldBuilder().getBuilder(); } /** + *
+     * The ID of the WfSpec that this WfRun belongs to.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 2; */ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder() { @@ -1351,6 +1587,10 @@ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder() } } /** + *
+     * The ID of the WfSpec that this WfRun belongs to.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 2; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1380,6 +1620,11 @@ private void ensureOldWfSpecVersionsIsMutable() { io.littlehorse.sdk.common.proto.WfSpecId, io.littlehorse.sdk.common.proto.WfSpecId.Builder, io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder> oldWfSpecVersionsBuilder_; /** + *
+     * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+     * old WfSpecId to this list for historical auditing and debugging purposes.
+     * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ public java.util.List getOldWfSpecVersionsList() { @@ -1390,6 +1635,11 @@ public java.util.List getOldWfSpecVers } } /** + *
+     * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+     * old WfSpecId to this list for historical auditing and debugging purposes.
+     * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ public int getOldWfSpecVersionsCount() { @@ -1400,6 +1650,11 @@ public int getOldWfSpecVersionsCount() { } } /** + *
+     * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+     * old WfSpecId to this list for historical auditing and debugging purposes.
+     * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ public io.littlehorse.sdk.common.proto.WfSpecId getOldWfSpecVersions(int index) { @@ -1410,6 +1665,11 @@ public io.littlehorse.sdk.common.proto.WfSpecId getOldWfSpecVersions(int index) } } /** + *
+     * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+     * old WfSpecId to this list for historical auditing and debugging purposes.
+     * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ public Builder setOldWfSpecVersions( @@ -1427,6 +1687,11 @@ public Builder setOldWfSpecVersions( return this; } /** + *
+     * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+     * old WfSpecId to this list for historical auditing and debugging purposes.
+     * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ public Builder setOldWfSpecVersions( @@ -1441,6 +1706,11 @@ public Builder setOldWfSpecVersions( return this; } /** + *
+     * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+     * old WfSpecId to this list for historical auditing and debugging purposes.
+     * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ public Builder addOldWfSpecVersions(io.littlehorse.sdk.common.proto.WfSpecId value) { @@ -1457,6 +1727,11 @@ public Builder addOldWfSpecVersions(io.littlehorse.sdk.common.proto.WfSpecId val return this; } /** + *
+     * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+     * old WfSpecId to this list for historical auditing and debugging purposes.
+     * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ public Builder addOldWfSpecVersions( @@ -1474,6 +1749,11 @@ public Builder addOldWfSpecVersions( return this; } /** + *
+     * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+     * old WfSpecId to this list for historical auditing and debugging purposes.
+     * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ public Builder addOldWfSpecVersions( @@ -1488,6 +1768,11 @@ public Builder addOldWfSpecVersions( return this; } /** + *
+     * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+     * old WfSpecId to this list for historical auditing and debugging purposes.
+     * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ public Builder addOldWfSpecVersions( @@ -1502,6 +1787,11 @@ public Builder addOldWfSpecVersions( return this; } /** + *
+     * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+     * old WfSpecId to this list for historical auditing and debugging purposes.
+     * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ public Builder addAllOldWfSpecVersions( @@ -1517,6 +1807,11 @@ public Builder addAllOldWfSpecVersions( return this; } /** + *
+     * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+     * old WfSpecId to this list for historical auditing and debugging purposes.
+     * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ public Builder clearOldWfSpecVersions() { @@ -1530,6 +1825,11 @@ public Builder clearOldWfSpecVersions() { return this; } /** + *
+     * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+     * old WfSpecId to this list for historical auditing and debugging purposes.
+     * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ public Builder removeOldWfSpecVersions(int index) { @@ -1543,6 +1843,11 @@ public Builder removeOldWfSpecVersions(int index) { return this; } /** + *
+     * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+     * old WfSpecId to this list for historical auditing and debugging purposes.
+     * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ public io.littlehorse.sdk.common.proto.WfSpecId.Builder getOldWfSpecVersionsBuilder( @@ -1550,6 +1855,11 @@ public io.littlehorse.sdk.common.proto.WfSpecId.Builder getOldWfSpecVersionsBuil return getOldWfSpecVersionsFieldBuilder().getBuilder(index); } /** + *
+     * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+     * old WfSpecId to this list for historical auditing and debugging purposes.
+     * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getOldWfSpecVersionsOrBuilder( @@ -1560,6 +1870,11 @@ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getOldWfSpecVersionsOrB } } /** + *
+     * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+     * old WfSpecId to this list for historical auditing and debugging purposes.
+     * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ public java.util.List @@ -1571,6 +1886,11 @@ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getOldWfSpecVersionsOrB } } /** + *
+     * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+     * old WfSpecId to this list for historical auditing and debugging purposes.
+     * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ public io.littlehorse.sdk.common.proto.WfSpecId.Builder addOldWfSpecVersionsBuilder() { @@ -1578,6 +1898,11 @@ public io.littlehorse.sdk.common.proto.WfSpecId.Builder addOldWfSpecVersionsBuil io.littlehorse.sdk.common.proto.WfSpecId.getDefaultInstance()); } /** + *
+     * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+     * old WfSpecId to this list for historical auditing and debugging purposes.
+     * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ public io.littlehorse.sdk.common.proto.WfSpecId.Builder addOldWfSpecVersionsBuilder( @@ -1586,6 +1911,11 @@ public io.littlehorse.sdk.common.proto.WfSpecId.Builder addOldWfSpecVersionsBuil index, io.littlehorse.sdk.common.proto.WfSpecId.getDefaultInstance()); } /** + *
+     * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+     * old WfSpecId to this list for historical auditing and debugging purposes.
+     * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ public java.util.List @@ -1609,6 +1939,10 @@ public io.littlehorse.sdk.common.proto.WfSpecId.Builder addOldWfSpecVersionsBuil private int status_ = 0; /** + *
+     * The status of this WfRun.
+     * 
+ * * .littlehorse.LHStatus status = 4; * @return The enum numeric value on the wire for status. */ @@ -1616,6 +1950,10 @@ public io.littlehorse.sdk.common.proto.WfSpecId.Builder addOldWfSpecVersionsBuil return status_; } /** + *
+     * The status of this WfRun.
+     * 
+ * * .littlehorse.LHStatus status = 4; * @param value The enum numeric value on the wire for status to set. * @return This builder for chaining. @@ -1627,6 +1965,10 @@ public Builder setStatusValue(int value) { return this; } /** + *
+     * The status of this WfRun.
+     * 
+ * * .littlehorse.LHStatus status = 4; * @return The status. */ @@ -1636,6 +1978,10 @@ public io.littlehorse.sdk.common.proto.LHStatus getStatus() { return result == null ? io.littlehorse.sdk.common.proto.LHStatus.UNRECOGNIZED : result; } /** + *
+     * The status of this WfRun.
+     * 
+ * * .littlehorse.LHStatus status = 4; * @param value The status to set. * @return This builder for chaining. @@ -1650,6 +1996,10 @@ public Builder setStatus(io.littlehorse.sdk.common.proto.LHStatus value) { return this; } /** + *
+     * The status of this WfRun.
+     * 
+ * * .littlehorse.LHStatus status = 4; * @return This builder for chaining. */ @@ -1663,8 +2013,12 @@ public Builder clearStatus() { private int greatestThreadrunNumber_ ; /** *
+     * The ID number of the greatest ThreadRUn in this WfRun. The total number of ThreadRuns
+     * is given by greatest_thread_run_number + 1.
+     *
      * Introduced now since with ThreadRun-level retention, we can't rely upon
-     * thread_runs.size() to determine the number of ThreadRuns.
+     * thread_runs.size() to determine the number of ThreadRuns, as a ThreadRun is removed
+     * from the thread_runs list once its retention period expires.
      * 
* * int32 greatest_threadrun_number = 5; @@ -1676,8 +2030,12 @@ public int getGreatestThreadrunNumber() { } /** *
+     * The ID number of the greatest ThreadRUn in this WfRun. The total number of ThreadRuns
+     * is given by greatest_thread_run_number + 1.
+     *
      * Introduced now since with ThreadRun-level retention, we can't rely upon
-     * thread_runs.size() to determine the number of ThreadRuns.
+     * thread_runs.size() to determine the number of ThreadRuns, as a ThreadRun is removed
+     * from the thread_runs list once its retention period expires.
      * 
* * int32 greatest_threadrun_number = 5; @@ -1693,8 +2051,12 @@ public Builder setGreatestThreadrunNumber(int value) { } /** *
+     * The ID number of the greatest ThreadRUn in this WfRun. The total number of ThreadRuns
+     * is given by greatest_thread_run_number + 1.
+     *
      * Introduced now since with ThreadRun-level retention, we can't rely upon
-     * thread_runs.size() to determine the number of ThreadRuns.
+     * thread_runs.size() to determine the number of ThreadRuns, as a ThreadRun is removed
+     * from the thread_runs list once its retention period expires.
      * 
* * int32 greatest_threadrun_number = 5; @@ -1711,6 +2073,10 @@ public Builder clearGreatestThreadrunNumber() { private com.google.protobuf.SingleFieldBuilderV3< com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> startTimeBuilder_; /** + *
+     * The time the WfRun was started.
+     * 
+ * * .google.protobuf.Timestamp start_time = 6; * @return Whether the startTime field is set. */ @@ -1718,6 +2084,10 @@ public boolean hasStartTime() { return ((bitField0_ & 0x00000020) != 0); } /** + *
+     * The time the WfRun was started.
+     * 
+ * * .google.protobuf.Timestamp start_time = 6; * @return The startTime. */ @@ -1729,6 +2099,10 @@ public com.google.protobuf.Timestamp getStartTime() { } } /** + *
+     * The time the WfRun was started.
+     * 
+ * * .google.protobuf.Timestamp start_time = 6; */ public Builder setStartTime(com.google.protobuf.Timestamp value) { @@ -1745,6 +2119,10 @@ public Builder setStartTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the WfRun was started.
+     * 
+ * * .google.protobuf.Timestamp start_time = 6; */ public Builder setStartTime( @@ -1759,6 +2137,10 @@ public Builder setStartTime( return this; } /** + *
+     * The time the WfRun was started.
+     * 
+ * * .google.protobuf.Timestamp start_time = 6; */ public Builder mergeStartTime(com.google.protobuf.Timestamp value) { @@ -1778,6 +2160,10 @@ public Builder mergeStartTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the WfRun was started.
+     * 
+ * * .google.protobuf.Timestamp start_time = 6; */ public Builder clearStartTime() { @@ -1791,6 +2177,10 @@ public Builder clearStartTime() { return this; } /** + *
+     * The time the WfRun was started.
+     * 
+ * * .google.protobuf.Timestamp start_time = 6; */ public com.google.protobuf.Timestamp.Builder getStartTimeBuilder() { @@ -1799,6 +2189,10 @@ public com.google.protobuf.Timestamp.Builder getStartTimeBuilder() { return getStartTimeFieldBuilder().getBuilder(); } /** + *
+     * The time the WfRun was started.
+     * 
+ * * .google.protobuf.Timestamp start_time = 6; */ public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder() { @@ -1810,6 +2204,10 @@ public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder() { } } /** + *
+     * The time the WfRun was started.
+     * 
+ * * .google.protobuf.Timestamp start_time = 6; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1830,6 +2228,10 @@ public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder() { private com.google.protobuf.SingleFieldBuilderV3< com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> endTimeBuilder_; /** + *
+     * The time the WfRun failed or completed.
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 7; * @return Whether the endTime field is set. */ @@ -1837,6 +2239,10 @@ public boolean hasEndTime() { return ((bitField0_ & 0x00000040) != 0); } /** + *
+     * The time the WfRun failed or completed.
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 7; * @return The endTime. */ @@ -1848,6 +2254,10 @@ public com.google.protobuf.Timestamp getEndTime() { } } /** + *
+     * The time the WfRun failed or completed.
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 7; */ public Builder setEndTime(com.google.protobuf.Timestamp value) { @@ -1864,6 +2274,10 @@ public Builder setEndTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the WfRun failed or completed.
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 7; */ public Builder setEndTime( @@ -1878,6 +2292,10 @@ public Builder setEndTime( return this; } /** + *
+     * The time the WfRun failed or completed.
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 7; */ public Builder mergeEndTime(com.google.protobuf.Timestamp value) { @@ -1897,6 +2315,10 @@ public Builder mergeEndTime(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The time the WfRun failed or completed.
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 7; */ public Builder clearEndTime() { @@ -1910,6 +2332,10 @@ public Builder clearEndTime() { return this; } /** + *
+     * The time the WfRun failed or completed.
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 7; */ public com.google.protobuf.Timestamp.Builder getEndTimeBuilder() { @@ -1918,6 +2344,10 @@ public com.google.protobuf.Timestamp.Builder getEndTimeBuilder() { return getEndTimeFieldBuilder().getBuilder(); } /** + *
+     * The time the WfRun failed or completed.
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 7; */ public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder() { @@ -1929,6 +2359,10 @@ public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder() { } } /** + *
+     * The time the WfRun failed or completed.
+     * 
+ * * optional .google.protobuf.Timestamp end_time = 7; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -1958,6 +2392,11 @@ private void ensureThreadRunsIsMutable() { io.littlehorse.sdk.common.proto.ThreadRun, io.littlehorse.sdk.common.proto.ThreadRun.Builder, io.littlehorse.sdk.common.proto.ThreadRunOrBuilder> threadRunsBuilder_; /** + *
+     * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+     * have not yet expired.
+     * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ public java.util.List getThreadRunsList() { @@ -1968,6 +2407,11 @@ public java.util.List getThreadRunsLi } } /** + *
+     * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+     * have not yet expired.
+     * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ public int getThreadRunsCount() { @@ -1978,6 +2422,11 @@ public int getThreadRunsCount() { } } /** + *
+     * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+     * have not yet expired.
+     * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ public io.littlehorse.sdk.common.proto.ThreadRun getThreadRuns(int index) { @@ -1988,6 +2437,11 @@ public io.littlehorse.sdk.common.proto.ThreadRun getThreadRuns(int index) { } } /** + *
+     * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+     * have not yet expired.
+     * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ public Builder setThreadRuns( @@ -2005,6 +2459,11 @@ public Builder setThreadRuns( return this; } /** + *
+     * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+     * have not yet expired.
+     * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ public Builder setThreadRuns( @@ -2019,6 +2478,11 @@ public Builder setThreadRuns( return this; } /** + *
+     * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+     * have not yet expired.
+     * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ public Builder addThreadRuns(io.littlehorse.sdk.common.proto.ThreadRun value) { @@ -2035,6 +2499,11 @@ public Builder addThreadRuns(io.littlehorse.sdk.common.proto.ThreadRun value) { return this; } /** + *
+     * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+     * have not yet expired.
+     * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ public Builder addThreadRuns( @@ -2052,6 +2521,11 @@ public Builder addThreadRuns( return this; } /** + *
+     * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+     * have not yet expired.
+     * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ public Builder addThreadRuns( @@ -2066,6 +2540,11 @@ public Builder addThreadRuns( return this; } /** + *
+     * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+     * have not yet expired.
+     * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ public Builder addThreadRuns( @@ -2080,6 +2559,11 @@ public Builder addThreadRuns( return this; } /** + *
+     * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+     * have not yet expired.
+     * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ public Builder addAllThreadRuns( @@ -2095,6 +2579,11 @@ public Builder addAllThreadRuns( return this; } /** + *
+     * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+     * have not yet expired.
+     * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ public Builder clearThreadRuns() { @@ -2108,6 +2597,11 @@ public Builder clearThreadRuns() { return this; } /** + *
+     * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+     * have not yet expired.
+     * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ public Builder removeThreadRuns(int index) { @@ -2121,6 +2615,11 @@ public Builder removeThreadRuns(int index) { return this; } /** + *
+     * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+     * have not yet expired.
+     * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ public io.littlehorse.sdk.common.proto.ThreadRun.Builder getThreadRunsBuilder( @@ -2128,6 +2627,11 @@ public io.littlehorse.sdk.common.proto.ThreadRun.Builder getThreadRunsBuilder( return getThreadRunsFieldBuilder().getBuilder(index); } /** + *
+     * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+     * have not yet expired.
+     * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ public io.littlehorse.sdk.common.proto.ThreadRunOrBuilder getThreadRunsOrBuilder( @@ -2138,6 +2642,11 @@ public io.littlehorse.sdk.common.proto.ThreadRunOrBuilder getThreadRunsOrBuilder } } /** + *
+     * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+     * have not yet expired.
+     * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ public java.util.List @@ -2149,6 +2658,11 @@ public io.littlehorse.sdk.common.proto.ThreadRunOrBuilder getThreadRunsOrBuilder } } /** + *
+     * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+     * have not yet expired.
+     * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ public io.littlehorse.sdk.common.proto.ThreadRun.Builder addThreadRunsBuilder() { @@ -2156,6 +2670,11 @@ public io.littlehorse.sdk.common.proto.ThreadRun.Builder addThreadRunsBuilder() io.littlehorse.sdk.common.proto.ThreadRun.getDefaultInstance()); } /** + *
+     * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+     * have not yet expired.
+     * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ public io.littlehorse.sdk.common.proto.ThreadRun.Builder addThreadRunsBuilder( @@ -2164,6 +2683,11 @@ public io.littlehorse.sdk.common.proto.ThreadRun.Builder addThreadRunsBuilder( index, io.littlehorse.sdk.common.proto.ThreadRun.getDefaultInstance()); } /** + *
+     * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+     * have not yet expired.
+     * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ public java.util.List @@ -2198,6 +2722,11 @@ private void ensurePendingInterruptsIsMutable() { io.littlehorse.sdk.common.proto.PendingInterrupt, io.littlehorse.sdk.common.proto.PendingInterrupt.Builder, io.littlehorse.sdk.common.proto.PendingInterruptOrBuilder> pendingInterruptsBuilder_; /** + *
+     * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+     * halting.
+     * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ public java.util.List getPendingInterruptsList() { @@ -2208,6 +2737,11 @@ public java.util.List getPendi } } /** + *
+     * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+     * halting.
+     * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ public int getPendingInterruptsCount() { @@ -2218,6 +2752,11 @@ public int getPendingInterruptsCount() { } } /** + *
+     * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+     * halting.
+     * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ public io.littlehorse.sdk.common.proto.PendingInterrupt getPendingInterrupts(int index) { @@ -2228,6 +2767,11 @@ public io.littlehorse.sdk.common.proto.PendingInterrupt getPendingInterrupts(int } } /** + *
+     * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+     * halting.
+     * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ public Builder setPendingInterrupts( @@ -2245,6 +2789,11 @@ public Builder setPendingInterrupts( return this; } /** + *
+     * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+     * halting.
+     * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ public Builder setPendingInterrupts( @@ -2259,6 +2808,11 @@ public Builder setPendingInterrupts( return this; } /** + *
+     * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+     * halting.
+     * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ public Builder addPendingInterrupts(io.littlehorse.sdk.common.proto.PendingInterrupt value) { @@ -2275,6 +2829,11 @@ public Builder addPendingInterrupts(io.littlehorse.sdk.common.proto.PendingInter return this; } /** + *
+     * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+     * halting.
+     * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ public Builder addPendingInterrupts( @@ -2292,6 +2851,11 @@ public Builder addPendingInterrupts( return this; } /** + *
+     * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+     * halting.
+     * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ public Builder addPendingInterrupts( @@ -2306,6 +2870,11 @@ public Builder addPendingInterrupts( return this; } /** + *
+     * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+     * halting.
+     * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ public Builder addPendingInterrupts( @@ -2320,6 +2889,11 @@ public Builder addPendingInterrupts( return this; } /** + *
+     * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+     * halting.
+     * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ public Builder addAllPendingInterrupts( @@ -2335,6 +2909,11 @@ public Builder addAllPendingInterrupts( return this; } /** + *
+     * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+     * halting.
+     * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ public Builder clearPendingInterrupts() { @@ -2348,6 +2927,11 @@ public Builder clearPendingInterrupts() { return this; } /** + *
+     * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+     * halting.
+     * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ public Builder removePendingInterrupts(int index) { @@ -2361,6 +2945,11 @@ public Builder removePendingInterrupts(int index) { return this; } /** + *
+     * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+     * halting.
+     * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ public io.littlehorse.sdk.common.proto.PendingInterrupt.Builder getPendingInterruptsBuilder( @@ -2368,6 +2957,11 @@ public io.littlehorse.sdk.common.proto.PendingInterrupt.Builder getPendingInterr return getPendingInterruptsFieldBuilder().getBuilder(index); } /** + *
+     * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+     * halting.
+     * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ public io.littlehorse.sdk.common.proto.PendingInterruptOrBuilder getPendingInterruptsOrBuilder( @@ -2378,6 +2972,11 @@ public io.littlehorse.sdk.common.proto.PendingInterruptOrBuilder getPendingInter } } /** + *
+     * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+     * halting.
+     * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ public java.util.List @@ -2389,6 +2988,11 @@ public io.littlehorse.sdk.common.proto.PendingInterruptOrBuilder getPendingInter } } /** + *
+     * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+     * halting.
+     * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ public io.littlehorse.sdk.common.proto.PendingInterrupt.Builder addPendingInterruptsBuilder() { @@ -2396,6 +3000,11 @@ public io.littlehorse.sdk.common.proto.PendingInterrupt.Builder addPendingInterr io.littlehorse.sdk.common.proto.PendingInterrupt.getDefaultInstance()); } /** + *
+     * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+     * halting.
+     * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ public io.littlehorse.sdk.common.proto.PendingInterrupt.Builder addPendingInterruptsBuilder( @@ -2404,6 +3013,11 @@ public io.littlehorse.sdk.common.proto.PendingInterrupt.Builder addPendingInterr index, io.littlehorse.sdk.common.proto.PendingInterrupt.getDefaultInstance()); } /** + *
+     * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+     * halting.
+     * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ public java.util.List @@ -2438,6 +3052,11 @@ private void ensurePendingFailuresIsMutable() { io.littlehorse.sdk.common.proto.PendingFailureHandler, io.littlehorse.sdk.common.proto.PendingFailureHandler.Builder, io.littlehorse.sdk.common.proto.PendingFailureHandlerOrBuilder> pendingFailuresBuilder_; /** + *
+     * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+     * finish halting.
+     * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ public java.util.List getPendingFailuresList() { @@ -2448,6 +3067,11 @@ public java.util.List get } } /** + *
+     * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+     * finish halting.
+     * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ public int getPendingFailuresCount() { @@ -2458,6 +3082,11 @@ public int getPendingFailuresCount() { } } /** + *
+     * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+     * finish halting.
+     * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ public io.littlehorse.sdk.common.proto.PendingFailureHandler getPendingFailures(int index) { @@ -2468,6 +3097,11 @@ public io.littlehorse.sdk.common.proto.PendingFailureHandler getPendingFailures( } } /** + *
+     * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+     * finish halting.
+     * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ public Builder setPendingFailures( @@ -2485,6 +3119,11 @@ public Builder setPendingFailures( return this; } /** + *
+     * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+     * finish halting.
+     * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ public Builder setPendingFailures( @@ -2499,6 +3138,11 @@ public Builder setPendingFailures( return this; } /** + *
+     * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+     * finish halting.
+     * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ public Builder addPendingFailures(io.littlehorse.sdk.common.proto.PendingFailureHandler value) { @@ -2515,6 +3159,11 @@ public Builder addPendingFailures(io.littlehorse.sdk.common.proto.PendingFailure return this; } /** + *
+     * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+     * finish halting.
+     * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ public Builder addPendingFailures( @@ -2532,6 +3181,11 @@ public Builder addPendingFailures( return this; } /** + *
+     * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+     * finish halting.
+     * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ public Builder addPendingFailures( @@ -2546,6 +3200,11 @@ public Builder addPendingFailures( return this; } /** + *
+     * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+     * finish halting.
+     * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ public Builder addPendingFailures( @@ -2560,6 +3219,11 @@ public Builder addPendingFailures( return this; } /** + *
+     * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+     * finish halting.
+     * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ public Builder addAllPendingFailures( @@ -2575,6 +3239,11 @@ public Builder addAllPendingFailures( return this; } /** + *
+     * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+     * finish halting.
+     * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ public Builder clearPendingFailures() { @@ -2588,6 +3257,11 @@ public Builder clearPendingFailures() { return this; } /** + *
+     * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+     * finish halting.
+     * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ public Builder removePendingFailures(int index) { @@ -2601,6 +3275,11 @@ public Builder removePendingFailures(int index) { return this; } /** + *
+     * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+     * finish halting.
+     * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ public io.littlehorse.sdk.common.proto.PendingFailureHandler.Builder getPendingFailuresBuilder( @@ -2608,6 +3287,11 @@ public io.littlehorse.sdk.common.proto.PendingFailureHandler.Builder getPendingF return getPendingFailuresFieldBuilder().getBuilder(index); } /** + *
+     * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+     * finish halting.
+     * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ public io.littlehorse.sdk.common.proto.PendingFailureHandlerOrBuilder getPendingFailuresOrBuilder( @@ -2618,6 +3302,11 @@ public io.littlehorse.sdk.common.proto.PendingFailureHandlerOrBuilder getPending } } /** + *
+     * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+     * finish halting.
+     * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ public java.util.List @@ -2629,6 +3318,11 @@ public io.littlehorse.sdk.common.proto.PendingFailureHandlerOrBuilder getPending } } /** + *
+     * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+     * finish halting.
+     * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ public io.littlehorse.sdk.common.proto.PendingFailureHandler.Builder addPendingFailuresBuilder() { @@ -2636,6 +3330,11 @@ public io.littlehorse.sdk.common.proto.PendingFailureHandler.Builder addPendingF io.littlehorse.sdk.common.proto.PendingFailureHandler.getDefaultInstance()); } /** + *
+     * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+     * finish halting.
+     * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ public io.littlehorse.sdk.common.proto.PendingFailureHandler.Builder addPendingFailuresBuilder( @@ -2644,6 +3343,11 @@ public io.littlehorse.sdk.common.proto.PendingFailureHandler.Builder addPendingF index, io.littlehorse.sdk.common.proto.PendingFailureHandler.getDefaultInstance()); } /** + *
+     * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+     * finish halting.
+     * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ public java.util.List diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfRunId.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfRunId.java index 71b6cf665..f094c4942 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfRunId.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfRunId.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * ID for a WfRun
+ * 
+ * * Protobuf type {@code littlehorse.WfRunId} */ public final class WfRunId extends @@ -44,6 +48,10 @@ protected java.lang.Object newInstance( @SuppressWarnings("serial") private volatile java.lang.Object id_ = ""; /** + *
+   * The ID for this WfRun instance.
+   * 
+ * * string id = 1; * @return The id. */ @@ -61,6 +69,10 @@ public java.lang.String getId() { } } /** + *
+   * The ID for this WfRun instance.
+   * 
+ * * string id = 1; * @return The bytes for id. */ @@ -82,6 +94,10 @@ public java.lang.String getId() { public static final int PARENT_WF_RUN_ID_FIELD_NUMBER = 2; private io.littlehorse.sdk.common.proto.WfRunId parentWfRunId_; /** + *
+   * A WfRun may have a parent WfRun. If so, this field is set to the parent's ID.
+   * 
+ * * optional .littlehorse.WfRunId parent_wf_run_id = 2; * @return Whether the parentWfRunId field is set. */ @@ -90,6 +106,10 @@ public boolean hasParentWfRunId() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+   * A WfRun may have a parent WfRun. If so, this field is set to the parent's ID.
+   * 
+ * * optional .littlehorse.WfRunId parent_wf_run_id = 2; * @return The parentWfRunId. */ @@ -98,6 +118,10 @@ public io.littlehorse.sdk.common.proto.WfRunId getParentWfRunId() { return parentWfRunId_ == null ? io.littlehorse.sdk.common.proto.WfRunId.getDefaultInstance() : parentWfRunId_; } /** + *
+   * A WfRun may have a parent WfRun. If so, this field is set to the parent's ID.
+   * 
+ * * optional .littlehorse.WfRunId parent_wf_run_id = 2; */ @java.lang.Override @@ -278,6 +302,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * ID for a WfRun
+   * 
+ * * Protobuf type {@code littlehorse.WfRunId} */ public static final class Builder extends @@ -478,6 +506,10 @@ public Builder mergeFrom( private java.lang.Object id_ = ""; /** + *
+     * The ID for this WfRun instance.
+     * 
+ * * string id = 1; * @return The id. */ @@ -494,6 +526,10 @@ public java.lang.String getId() { } } /** + *
+     * The ID for this WfRun instance.
+     * 
+ * * string id = 1; * @return The bytes for id. */ @@ -511,6 +547,10 @@ public java.lang.String getId() { } } /** + *
+     * The ID for this WfRun instance.
+     * 
+ * * string id = 1; * @param value The id to set. * @return This builder for chaining. @@ -524,6 +564,10 @@ public Builder setId( return this; } /** + *
+     * The ID for this WfRun instance.
+     * 
+ * * string id = 1; * @return This builder for chaining. */ @@ -534,6 +578,10 @@ public Builder clearId() { return this; } /** + *
+     * The ID for this WfRun instance.
+     * 
+ * * string id = 1; * @param value The bytes for id to set. * @return This builder for chaining. @@ -552,6 +600,10 @@ public Builder setIdBytes( private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.WfRunId, io.littlehorse.sdk.common.proto.WfRunId.Builder, io.littlehorse.sdk.common.proto.WfRunIdOrBuilder> parentWfRunIdBuilder_; /** + *
+     * A WfRun may have a parent WfRun. If so, this field is set to the parent's ID.
+     * 
+ * * optional .littlehorse.WfRunId parent_wf_run_id = 2; * @return Whether the parentWfRunId field is set. */ @@ -559,6 +611,10 @@ public boolean hasParentWfRunId() { return ((bitField0_ & 0x00000002) != 0); } /** + *
+     * A WfRun may have a parent WfRun. If so, this field is set to the parent's ID.
+     * 
+ * * optional .littlehorse.WfRunId parent_wf_run_id = 2; * @return The parentWfRunId. */ @@ -570,6 +626,10 @@ public io.littlehorse.sdk.common.proto.WfRunId getParentWfRunId() { } } /** + *
+     * A WfRun may have a parent WfRun. If so, this field is set to the parent's ID.
+     * 
+ * * optional .littlehorse.WfRunId parent_wf_run_id = 2; */ public Builder setParentWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { @@ -586,6 +646,10 @@ public Builder setParentWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { return this; } /** + *
+     * A WfRun may have a parent WfRun. If so, this field is set to the parent's ID.
+     * 
+ * * optional .littlehorse.WfRunId parent_wf_run_id = 2; */ public Builder setParentWfRunId( @@ -600,6 +664,10 @@ public Builder setParentWfRunId( return this; } /** + *
+     * A WfRun may have a parent WfRun. If so, this field is set to the parent's ID.
+     * 
+ * * optional .littlehorse.WfRunId parent_wf_run_id = 2; */ public Builder mergeParentWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) { @@ -619,6 +687,10 @@ public Builder mergeParentWfRunId(io.littlehorse.sdk.common.proto.WfRunId value) return this; } /** + *
+     * A WfRun may have a parent WfRun. If so, this field is set to the parent's ID.
+     * 
+ * * optional .littlehorse.WfRunId parent_wf_run_id = 2; */ public Builder clearParentWfRunId() { @@ -632,6 +704,10 @@ public Builder clearParentWfRunId() { return this; } /** + *
+     * A WfRun may have a parent WfRun. If so, this field is set to the parent's ID.
+     * 
+ * * optional .littlehorse.WfRunId parent_wf_run_id = 2; */ public io.littlehorse.sdk.common.proto.WfRunId.Builder getParentWfRunIdBuilder() { @@ -640,6 +716,10 @@ public io.littlehorse.sdk.common.proto.WfRunId.Builder getParentWfRunIdBuilder() return getParentWfRunIdFieldBuilder().getBuilder(); } /** + *
+     * A WfRun may have a parent WfRun. If so, this field is set to the parent's ID.
+     * 
+ * * optional .littlehorse.WfRunId parent_wf_run_id = 2; */ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getParentWfRunIdOrBuilder() { @@ -651,6 +731,10 @@ public io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getParentWfRunIdOrBuilde } } /** + *
+     * A WfRun may have a parent WfRun. If so, this field is set to the parent's ID.
+     * 
+ * * optional .littlehorse.WfRunId parent_wf_run_id = 2; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfRunIdOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfRunIdOrBuilder.java index 9b2da15df..ba0aee418 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfRunIdOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfRunIdOrBuilder.java @@ -8,11 +8,19 @@ public interface WfRunIdOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The ID for this WfRun instance.
+   * 
+ * * string id = 1; * @return The id. */ java.lang.String getId(); /** + *
+   * The ID for this WfRun instance.
+   * 
+ * * string id = 1; * @return The bytes for id. */ @@ -20,16 +28,28 @@ public interface WfRunIdOrBuilder extends getIdBytes(); /** + *
+   * A WfRun may have a parent WfRun. If so, this field is set to the parent's ID.
+   * 
+ * * optional .littlehorse.WfRunId parent_wf_run_id = 2; * @return Whether the parentWfRunId field is set. */ boolean hasParentWfRunId(); /** + *
+   * A WfRun may have a parent WfRun. If so, this field is set to the parent's ID.
+   * 
+ * * optional .littlehorse.WfRunId parent_wf_run_id = 2; * @return The parentWfRunId. */ io.littlehorse.sdk.common.proto.WfRunId getParentWfRunId(); /** + *
+   * A WfRun may have a parent WfRun. If so, this field is set to the parent's ID.
+   * 
+ * * optional .littlehorse.WfRunId parent_wf_run_id = 2; */ io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getParentWfRunIdOrBuilder(); diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfRunOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfRunOrBuilder.java index 5de6eedb5..d82506264 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfRunOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfRunOrBuilder.java @@ -8,65 +8,122 @@ public interface WfRunOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The ID of the WfRun.
+   * 
+ * * .littlehorse.WfRunId id = 1; * @return Whether the id field is set. */ boolean hasId(); /** + *
+   * The ID of the WfRun.
+   * 
+ * * .littlehorse.WfRunId id = 1; * @return The id. */ io.littlehorse.sdk.common.proto.WfRunId getId(); /** + *
+   * The ID of the WfRun.
+   * 
+ * * .littlehorse.WfRunId id = 1; */ io.littlehorse.sdk.common.proto.WfRunIdOrBuilder getIdOrBuilder(); /** + *
+   * The ID of the WfSpec that this WfRun belongs to.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 2; * @return Whether the wfSpecId field is set. */ boolean hasWfSpecId(); /** + *
+   * The ID of the WfSpec that this WfRun belongs to.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 2; * @return The wfSpecId. */ io.littlehorse.sdk.common.proto.WfSpecId getWfSpecId(); /** + *
+   * The ID of the WfSpec that this WfRun belongs to.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 2; */ io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder(); /** + *
+   * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+   * old WfSpecId to this list for historical auditing and debugging purposes.
+   * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ java.util.List getOldWfSpecVersionsList(); /** + *
+   * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+   * old WfSpecId to this list for historical auditing and debugging purposes.
+   * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ io.littlehorse.sdk.common.proto.WfSpecId getOldWfSpecVersions(int index); /** + *
+   * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+   * old WfSpecId to this list for historical auditing and debugging purposes.
+   * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ int getOldWfSpecVersionsCount(); /** + *
+   * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+   * old WfSpecId to this list for historical auditing and debugging purposes.
+   * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ java.util.List getOldWfSpecVersionsOrBuilderList(); /** + *
+   * When a WfRun is migrated from an old verison of a WfSpec to a newer one, we add the
+   * old WfSpecId to this list for historical auditing and debugging purposes.
+   * 
+ * * repeated .littlehorse.WfSpecId old_wf_spec_versions = 3; */ io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getOldWfSpecVersionsOrBuilder( int index); /** + *
+   * The status of this WfRun.
+   * 
+ * * .littlehorse.LHStatus status = 4; * @return The enum numeric value on the wire for status. */ int getStatusValue(); /** + *
+   * The status of this WfRun.
+   * 
+ * * .littlehorse.LHStatus status = 4; * @return The status. */ @@ -74,8 +131,12 @@ io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getOldWfSpecVersionsOrBuilder( /** *
+   * The ID number of the greatest ThreadRUn in this WfRun. The total number of ThreadRuns
+   * is given by greatest_thread_run_number + 1.
+   *
    * Introduced now since with ThreadRun-level retention, we can't rely upon
-   * thread_runs.size() to determine the number of ThreadRuns.
+   * thread_runs.size() to determine the number of ThreadRuns, as a ThreadRun is removed
+   * from the thread_runs list once its retention period expires.
    * 
* * int32 greatest_threadrun_number = 5; @@ -84,102 +145,201 @@ io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getOldWfSpecVersionsOrBuilder( int getGreatestThreadrunNumber(); /** + *
+   * The time the WfRun was started.
+   * 
+ * * .google.protobuf.Timestamp start_time = 6; * @return Whether the startTime field is set. */ boolean hasStartTime(); /** + *
+   * The time the WfRun was started.
+   * 
+ * * .google.protobuf.Timestamp start_time = 6; * @return The startTime. */ com.google.protobuf.Timestamp getStartTime(); /** + *
+   * The time the WfRun was started.
+   * 
+ * * .google.protobuf.Timestamp start_time = 6; */ com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder(); /** + *
+   * The time the WfRun failed or completed.
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 7; * @return Whether the endTime field is set. */ boolean hasEndTime(); /** + *
+   * The time the WfRun failed or completed.
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 7; * @return The endTime. */ com.google.protobuf.Timestamp getEndTime(); /** + *
+   * The time the WfRun failed or completed.
+   * 
+ * * optional .google.protobuf.Timestamp end_time = 7; */ com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder(); /** + *
+   * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+   * have not yet expired.
+   * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ java.util.List getThreadRunsList(); /** + *
+   * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+   * have not yet expired.
+   * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ io.littlehorse.sdk.common.proto.ThreadRun getThreadRuns(int index); /** + *
+   * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+   * have not yet expired.
+   * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ int getThreadRunsCount(); /** + *
+   * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+   * have not yet expired.
+   * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ java.util.List getThreadRunsOrBuilderList(); /** + *
+   * A list of all active ThreadRun's and terminated ThreadRun's whose retention periods
+   * have not yet expired.
+   * 
+ * * repeated .littlehorse.ThreadRun thread_runs = 8; */ io.littlehorse.sdk.common.proto.ThreadRunOrBuilder getThreadRunsOrBuilder( int index); /** + *
+   * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+   * halting.
+   * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ java.util.List getPendingInterruptsList(); /** + *
+   * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+   * halting.
+   * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ io.littlehorse.sdk.common.proto.PendingInterrupt getPendingInterrupts(int index); /** + *
+   * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+   * halting.
+   * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ int getPendingInterruptsCount(); /** + *
+   * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+   * halting.
+   * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ java.util.List getPendingInterruptsOrBuilderList(); /** + *
+   * A list of Interrupt events that will fire once their appropriate ThreadRun's finish
+   * halting.
+   * 
+ * * repeated .littlehorse.PendingInterrupt pending_interrupts = 9; */ io.littlehorse.sdk.common.proto.PendingInterruptOrBuilder getPendingInterruptsOrBuilder( int index); /** + *
+   * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+   * finish halting.
+   * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ java.util.List getPendingFailuresList(); /** + *
+   * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+   * finish halting.
+   * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ io.littlehorse.sdk.common.proto.PendingFailureHandler getPendingFailures(int index); /** + *
+   * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+   * finish halting.
+   * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ int getPendingFailuresCount(); /** + *
+   * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+   * finish halting.
+   * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ java.util.List getPendingFailuresOrBuilderList(); /** + *
+   * A list of pending failure handlers which will fire once their appropriate ThreadRun's
+   * finish halting.
+   * 
+ * * repeated .littlehorse.PendingFailureHandler pending_failures = 10; */ io.littlehorse.sdk.common.proto.PendingFailureHandlerOrBuilder getPendingFailuresOrBuilder( diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfSpecId.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfSpecId.java index 47be73c10..269d55058 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfSpecId.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfSpecId.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * The ID of a WfSpec.
+ * 
+ * * Protobuf type {@code littlehorse.WfSpecId} */ public final class WfSpecId extends @@ -43,6 +47,10 @@ protected java.lang.Object newInstance( @SuppressWarnings("serial") private volatile java.lang.Object name_ = ""; /** + *
+   * Name of the WfSpec.
+   * 
+ * * string name = 1; * @return The name. */ @@ -60,6 +68,10 @@ public java.lang.String getName() { } } /** + *
+   * Name of the WfSpec.
+   * 
+ * * string name = 1; * @return The bytes for name. */ @@ -81,6 +93,17 @@ public java.lang.String getName() { public static final int MAJOR_VERSION_FIELD_NUMBER = 2; private int majorVersion_ = 0; /** + *
+   * Major Version of a WfSpec.
+   *
+   * Note that WfSpec's are versioned. Creating a new WfSpec with the same name
+   * and no breaking changes to the public Variables API results in a new WfSpec
+   * being created with the same MajorVersion and a new revision. Creating a
+   * WfSpec with a breaking change to the public Variables API results in a
+   * new WfSpec being created with the same name, an incremented major_version,
+   * and revision = 0.
+   * 
+ * * int32 major_version = 2; * @return The majorVersion. */ @@ -92,6 +115,17 @@ public int getMajorVersion() { public static final int REVISION_FIELD_NUMBER = 3; private int revision_ = 0; /** + *
+   * Revision of a WfSpec.
+   *
+   * Note that WfSpec's are versioned. Creating a new WfSpec with the same name
+   * and no breaking changes to the public Variables API results in a new WfSpec
+   * being created with the same MajorVersion and a new revision. Creating a
+   * WfSpec with a breaking change to the public Variables API results in a
+   * new WfSpec being created with the same name, an incremented major_version,
+   * and revision = 0.
+   * 
+ * * int32 revision = 3; * @return The revision. */ @@ -279,6 +313,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * The ID of a WfSpec.
+   * 
+ * * Protobuf type {@code littlehorse.WfSpecId} */ public static final class Builder extends @@ -474,6 +512,10 @@ public Builder mergeFrom( private java.lang.Object name_ = ""; /** + *
+     * Name of the WfSpec.
+     * 
+ * * string name = 1; * @return The name. */ @@ -490,6 +532,10 @@ public java.lang.String getName() { } } /** + *
+     * Name of the WfSpec.
+     * 
+ * * string name = 1; * @return The bytes for name. */ @@ -507,6 +553,10 @@ public java.lang.String getName() { } } /** + *
+     * Name of the WfSpec.
+     * 
+ * * string name = 1; * @param value The name to set. * @return This builder for chaining. @@ -520,6 +570,10 @@ public Builder setName( return this; } /** + *
+     * Name of the WfSpec.
+     * 
+ * * string name = 1; * @return This builder for chaining. */ @@ -530,6 +584,10 @@ public Builder clearName() { return this; } /** + *
+     * Name of the WfSpec.
+     * 
+ * * string name = 1; * @param value The bytes for name to set. * @return This builder for chaining. @@ -546,6 +604,17 @@ public Builder setNameBytes( private int majorVersion_ ; /** + *
+     * Major Version of a WfSpec.
+     *
+     * Note that WfSpec's are versioned. Creating a new WfSpec with the same name
+     * and no breaking changes to the public Variables API results in a new WfSpec
+     * being created with the same MajorVersion and a new revision. Creating a
+     * WfSpec with a breaking change to the public Variables API results in a
+     * new WfSpec being created with the same name, an incremented major_version,
+     * and revision = 0.
+     * 
+ * * int32 major_version = 2; * @return The majorVersion. */ @@ -554,6 +623,17 @@ public int getMajorVersion() { return majorVersion_; } /** + *
+     * Major Version of a WfSpec.
+     *
+     * Note that WfSpec's are versioned. Creating a new WfSpec with the same name
+     * and no breaking changes to the public Variables API results in a new WfSpec
+     * being created with the same MajorVersion and a new revision. Creating a
+     * WfSpec with a breaking change to the public Variables API results in a
+     * new WfSpec being created with the same name, an incremented major_version,
+     * and revision = 0.
+     * 
+ * * int32 major_version = 2; * @param value The majorVersion to set. * @return This builder for chaining. @@ -566,6 +646,17 @@ public Builder setMajorVersion(int value) { return this; } /** + *
+     * Major Version of a WfSpec.
+     *
+     * Note that WfSpec's are versioned. Creating a new WfSpec with the same name
+     * and no breaking changes to the public Variables API results in a new WfSpec
+     * being created with the same MajorVersion and a new revision. Creating a
+     * WfSpec with a breaking change to the public Variables API results in a
+     * new WfSpec being created with the same name, an incremented major_version,
+     * and revision = 0.
+     * 
+ * * int32 major_version = 2; * @return This builder for chaining. */ @@ -578,6 +669,17 @@ public Builder clearMajorVersion() { private int revision_ ; /** + *
+     * Revision of a WfSpec.
+     *
+     * Note that WfSpec's are versioned. Creating a new WfSpec with the same name
+     * and no breaking changes to the public Variables API results in a new WfSpec
+     * being created with the same MajorVersion and a new revision. Creating a
+     * WfSpec with a breaking change to the public Variables API results in a
+     * new WfSpec being created with the same name, an incremented major_version,
+     * and revision = 0.
+     * 
+ * * int32 revision = 3; * @return The revision. */ @@ -586,6 +688,17 @@ public int getRevision() { return revision_; } /** + *
+     * Revision of a WfSpec.
+     *
+     * Note that WfSpec's are versioned. Creating a new WfSpec with the same name
+     * and no breaking changes to the public Variables API results in a new WfSpec
+     * being created with the same MajorVersion and a new revision. Creating a
+     * WfSpec with a breaking change to the public Variables API results in a
+     * new WfSpec being created with the same name, an incremented major_version,
+     * and revision = 0.
+     * 
+ * * int32 revision = 3; * @param value The revision to set. * @return This builder for chaining. @@ -598,6 +711,17 @@ public Builder setRevision(int value) { return this; } /** + *
+     * Revision of a WfSpec.
+     *
+     * Note that WfSpec's are versioned. Creating a new WfSpec with the same name
+     * and no breaking changes to the public Variables API results in a new WfSpec
+     * being created with the same MajorVersion and a new revision. Creating a
+     * WfSpec with a breaking change to the public Variables API results in a
+     * new WfSpec being created with the same name, an incremented major_version,
+     * and revision = 0.
+     * 
+ * * int32 revision = 3; * @return This builder for chaining. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfSpecIdOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfSpecIdOrBuilder.java index baaf976b7..662957d3e 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfSpecIdOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfSpecIdOrBuilder.java @@ -8,11 +8,19 @@ public interface WfSpecIdOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * Name of the WfSpec.
+   * 
+ * * string name = 1; * @return The name. */ java.lang.String getName(); /** + *
+   * Name of the WfSpec.
+   * 
+ * * string name = 1; * @return The bytes for name. */ @@ -20,12 +28,34 @@ public interface WfSpecIdOrBuilder extends getNameBytes(); /** + *
+   * Major Version of a WfSpec.
+   *
+   * Note that WfSpec's are versioned. Creating a new WfSpec with the same name
+   * and no breaking changes to the public Variables API results in a new WfSpec
+   * being created with the same MajorVersion and a new revision. Creating a
+   * WfSpec with a breaking change to the public Variables API results in a
+   * new WfSpec being created with the same name, an incremented major_version,
+   * and revision = 0.
+   * 
+ * * int32 major_version = 2; * @return The majorVersion. */ int getMajorVersion(); /** + *
+   * Revision of a WfSpec.
+   *
+   * Note that WfSpec's are versioned. Creating a new WfSpec with the same name
+   * and no breaking changes to the public Variables API results in a new WfSpec
+   * being created with the same MajorVersion and a new revision. Creating a
+   * WfSpec with a breaking change to the public Variables API results in a
+   * new WfSpec being created with the same name, an incremented major_version,
+   * and revision = 0.
+   * 
+ * * int32 revision = 3; * @return The revision. */ diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfSpecMetricsId.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfSpecMetricsId.java index 06a454bfd..a6a5abc3c 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfSpecMetricsId.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfSpecMetricsId.java @@ -4,6 +4,10 @@ package io.littlehorse.sdk.common.proto; /** + *
+ * ID for a specific window of WfSpec metrics.
+ * 
+ * * Protobuf type {@code littlehorse.WfSpecMetricsId} */ public final class WfSpecMetricsId extends @@ -42,6 +46,10 @@ protected java.lang.Object newInstance( public static final int WINDOW_START_FIELD_NUMBER = 1; private com.google.protobuf.Timestamp windowStart_; /** + *
+   * The timestamp at which this metrics window starts.
+   * 
+ * * .google.protobuf.Timestamp window_start = 1; * @return Whether the windowStart field is set. */ @@ -50,6 +58,10 @@ public boolean hasWindowStart() { return windowStart_ != null; } /** + *
+   * The timestamp at which this metrics window starts.
+   * 
+ * * .google.protobuf.Timestamp window_start = 1; * @return The windowStart. */ @@ -58,6 +70,10 @@ public com.google.protobuf.Timestamp getWindowStart() { return windowStart_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : windowStart_; } /** + *
+   * The timestamp at which this metrics window starts.
+   * 
+ * * .google.protobuf.Timestamp window_start = 1; */ @java.lang.Override @@ -68,6 +84,10 @@ public com.google.protobuf.TimestampOrBuilder getWindowStartOrBuilder() { public static final int WINDOW_TYPE_FIELD_NUMBER = 2; private int windowType_ = 0; /** + *
+   * The length of this window.
+   * 
+ * * .littlehorse.MetricsWindowLength window_type = 2; * @return The enum numeric value on the wire for windowType. */ @@ -75,6 +95,10 @@ public com.google.protobuf.TimestampOrBuilder getWindowStartOrBuilder() { return windowType_; } /** + *
+   * The length of this window.
+   * 
+ * * .littlehorse.MetricsWindowLength window_type = 2; * @return The windowType. */ @@ -86,6 +110,10 @@ public com.google.protobuf.TimestampOrBuilder getWindowStartOrBuilder() { public static final int WF_SPEC_ID_FIELD_NUMBER = 3; private io.littlehorse.sdk.common.proto.WfSpecId wfSpecId_; /** + *
+   * The WfSpecId that this metrics window reports on.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 3; * @return Whether the wfSpecId field is set. */ @@ -94,6 +122,10 @@ public boolean hasWfSpecId() { return wfSpecId_ != null; } /** + *
+   * The WfSpecId that this metrics window reports on.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 3; * @return The wfSpecId. */ @@ -102,6 +134,10 @@ public io.littlehorse.sdk.common.proto.WfSpecId getWfSpecId() { return wfSpecId_ == null ? io.littlehorse.sdk.common.proto.WfSpecId.getDefaultInstance() : wfSpecId_; } /** + *
+   * The WfSpecId that this metrics window reports on.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 3; */ @java.lang.Override @@ -298,6 +334,10 @@ protected Builder newBuilderForType( return builder; } /** + *
+   * ID for a specific window of WfSpec metrics.
+   * 
+ * * Protobuf type {@code littlehorse.WfSpecMetricsId} */ public static final class Builder extends @@ -509,6 +549,10 @@ public Builder mergeFrom( private com.google.protobuf.SingleFieldBuilderV3< com.google.protobuf.Timestamp, com.google.protobuf.Timestamp.Builder, com.google.protobuf.TimestampOrBuilder> windowStartBuilder_; /** + *
+     * The timestamp at which this metrics window starts.
+     * 
+ * * .google.protobuf.Timestamp window_start = 1; * @return Whether the windowStart field is set. */ @@ -516,6 +560,10 @@ public boolean hasWindowStart() { return ((bitField0_ & 0x00000001) != 0); } /** + *
+     * The timestamp at which this metrics window starts.
+     * 
+ * * .google.protobuf.Timestamp window_start = 1; * @return The windowStart. */ @@ -527,6 +575,10 @@ public com.google.protobuf.Timestamp getWindowStart() { } } /** + *
+     * The timestamp at which this metrics window starts.
+     * 
+ * * .google.protobuf.Timestamp window_start = 1; */ public Builder setWindowStart(com.google.protobuf.Timestamp value) { @@ -543,6 +595,10 @@ public Builder setWindowStart(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The timestamp at which this metrics window starts.
+     * 
+ * * .google.protobuf.Timestamp window_start = 1; */ public Builder setWindowStart( @@ -557,6 +613,10 @@ public Builder setWindowStart( return this; } /** + *
+     * The timestamp at which this metrics window starts.
+     * 
+ * * .google.protobuf.Timestamp window_start = 1; */ public Builder mergeWindowStart(com.google.protobuf.Timestamp value) { @@ -576,6 +636,10 @@ public Builder mergeWindowStart(com.google.protobuf.Timestamp value) { return this; } /** + *
+     * The timestamp at which this metrics window starts.
+     * 
+ * * .google.protobuf.Timestamp window_start = 1; */ public Builder clearWindowStart() { @@ -589,6 +653,10 @@ public Builder clearWindowStart() { return this; } /** + *
+     * The timestamp at which this metrics window starts.
+     * 
+ * * .google.protobuf.Timestamp window_start = 1; */ public com.google.protobuf.Timestamp.Builder getWindowStartBuilder() { @@ -597,6 +665,10 @@ public com.google.protobuf.Timestamp.Builder getWindowStartBuilder() { return getWindowStartFieldBuilder().getBuilder(); } /** + *
+     * The timestamp at which this metrics window starts.
+     * 
+ * * .google.protobuf.Timestamp window_start = 1; */ public com.google.protobuf.TimestampOrBuilder getWindowStartOrBuilder() { @@ -608,6 +680,10 @@ public com.google.protobuf.TimestampOrBuilder getWindowStartOrBuilder() { } } /** + *
+     * The timestamp at which this metrics window starts.
+     * 
+ * * .google.protobuf.Timestamp window_start = 1; */ private com.google.protobuf.SingleFieldBuilderV3< @@ -626,6 +702,10 @@ public com.google.protobuf.TimestampOrBuilder getWindowStartOrBuilder() { private int windowType_ = 0; /** + *
+     * The length of this window.
+     * 
+ * * .littlehorse.MetricsWindowLength window_type = 2; * @return The enum numeric value on the wire for windowType. */ @@ -633,6 +713,10 @@ public com.google.protobuf.TimestampOrBuilder getWindowStartOrBuilder() { return windowType_; } /** + *
+     * The length of this window.
+     * 
+ * * .littlehorse.MetricsWindowLength window_type = 2; * @param value The enum numeric value on the wire for windowType to set. * @return This builder for chaining. @@ -644,6 +728,10 @@ public Builder setWindowTypeValue(int value) { return this; } /** + *
+     * The length of this window.
+     * 
+ * * .littlehorse.MetricsWindowLength window_type = 2; * @return The windowType. */ @@ -653,6 +741,10 @@ public io.littlehorse.sdk.common.proto.MetricsWindowLength getWindowType() { return result == null ? io.littlehorse.sdk.common.proto.MetricsWindowLength.UNRECOGNIZED : result; } /** + *
+     * The length of this window.
+     * 
+ * * .littlehorse.MetricsWindowLength window_type = 2; * @param value The windowType to set. * @return This builder for chaining. @@ -667,6 +759,10 @@ public Builder setWindowType(io.littlehorse.sdk.common.proto.MetricsWindowLength return this; } /** + *
+     * The length of this window.
+     * 
+ * * .littlehorse.MetricsWindowLength window_type = 2; * @return This builder for chaining. */ @@ -681,6 +777,10 @@ public Builder clearWindowType() { private com.google.protobuf.SingleFieldBuilderV3< io.littlehorse.sdk.common.proto.WfSpecId, io.littlehorse.sdk.common.proto.WfSpecId.Builder, io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder> wfSpecIdBuilder_; /** + *
+     * The WfSpecId that this metrics window reports on.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 3; * @return Whether the wfSpecId field is set. */ @@ -688,6 +788,10 @@ public boolean hasWfSpecId() { return ((bitField0_ & 0x00000004) != 0); } /** + *
+     * The WfSpecId that this metrics window reports on.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 3; * @return The wfSpecId. */ @@ -699,6 +803,10 @@ public io.littlehorse.sdk.common.proto.WfSpecId getWfSpecId() { } } /** + *
+     * The WfSpecId that this metrics window reports on.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 3; */ public Builder setWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { @@ -715,6 +823,10 @@ public Builder setWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { return this; } /** + *
+     * The WfSpecId that this metrics window reports on.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 3; */ public Builder setWfSpecId( @@ -729,6 +841,10 @@ public Builder setWfSpecId( return this; } /** + *
+     * The WfSpecId that this metrics window reports on.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 3; */ public Builder mergeWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { @@ -748,6 +864,10 @@ public Builder mergeWfSpecId(io.littlehorse.sdk.common.proto.WfSpecId value) { return this; } /** + *
+     * The WfSpecId that this metrics window reports on.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 3; */ public Builder clearWfSpecId() { @@ -761,6 +881,10 @@ public Builder clearWfSpecId() { return this; } /** + *
+     * The WfSpecId that this metrics window reports on.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 3; */ public io.littlehorse.sdk.common.proto.WfSpecId.Builder getWfSpecIdBuilder() { @@ -769,6 +893,10 @@ public io.littlehorse.sdk.common.proto.WfSpecId.Builder getWfSpecIdBuilder() { return getWfSpecIdFieldBuilder().getBuilder(); } /** + *
+     * The WfSpecId that this metrics window reports on.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 3; */ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder() { @@ -780,6 +908,10 @@ public io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder() } } /** + *
+     * The WfSpecId that this metrics window reports on.
+     * 
+ * * .littlehorse.WfSpecId wf_spec_id = 3; */ private com.google.protobuf.SingleFieldBuilderV3< diff --git a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfSpecMetricsIdOrBuilder.java b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfSpecMetricsIdOrBuilder.java index 911087536..c4ad88e3d 100644 --- a/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfSpecMetricsIdOrBuilder.java +++ b/sdk-java/src/main/java/io/littlehorse/sdk/common/proto/WfSpecMetricsIdOrBuilder.java @@ -8,42 +8,74 @@ public interface WfSpecMetricsIdOrBuilder extends com.google.protobuf.MessageOrBuilder { /** + *
+   * The timestamp at which this metrics window starts.
+   * 
+ * * .google.protobuf.Timestamp window_start = 1; * @return Whether the windowStart field is set. */ boolean hasWindowStart(); /** + *
+   * The timestamp at which this metrics window starts.
+   * 
+ * * .google.protobuf.Timestamp window_start = 1; * @return The windowStart. */ com.google.protobuf.Timestamp getWindowStart(); /** + *
+   * The timestamp at which this metrics window starts.
+   * 
+ * * .google.protobuf.Timestamp window_start = 1; */ com.google.protobuf.TimestampOrBuilder getWindowStartOrBuilder(); /** + *
+   * The length of this window.
+   * 
+ * * .littlehorse.MetricsWindowLength window_type = 2; * @return The enum numeric value on the wire for windowType. */ int getWindowTypeValue(); /** + *
+   * The length of this window.
+   * 
+ * * .littlehorse.MetricsWindowLength window_type = 2; * @return The windowType. */ io.littlehorse.sdk.common.proto.MetricsWindowLength getWindowType(); /** + *
+   * The WfSpecId that this metrics window reports on.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 3; * @return Whether the wfSpecId field is set. */ boolean hasWfSpecId(); /** + *
+   * The WfSpecId that this metrics window reports on.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 3; * @return The wfSpecId. */ io.littlehorse.sdk.common.proto.WfSpecId getWfSpecId(); /** + *
+   * The WfSpecId that this metrics window reports on.
+   * 
+ * * .littlehorse.WfSpecId wf_spec_id = 3; */ io.littlehorse.sdk.common.proto.WfSpecIdOrBuilder getWfSpecIdOrBuilder();