Package org.apache.tika.pipes.api
Enum Class PipesResult.RESULT_STATUS
- All Implemented Interfaces:
Serializable,Comparable<PipesResult.RESULT_STATUS>,Constable
- Enclosing class:
PipesResult
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe task's total timeout was exhausted mid-parse: the worker is healthy (no restart), content extracted up to that point was emitted, but one or more embedded documents were skipped rather than attempted. -
Method Summary
Modifier and TypeMethodDescriptionbytegetByte()Gets the high-level category for this result status.booleanisFatal()Checks if this status represents a fatal error.booleanChecks if this status represents an initialization failure.booleanChecks if this status represents a process crash (OOM, timeout, etc.).booleanChecks if this status represents successful processing.booleanChecks if this status represents a task-level exception.static PipesResult.RESULT_STATUSlookup(int b) static PipesResult.RESULT_STATUSReturns the enum constant of this class with the specified name.static PipesResult.RESULT_STATUS[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
FAILED_TO_INITIALIZE
-
FETCHER_INITIALIZATION_EXCEPTION
-
EMITTER_INITIALIZATION_EXCEPTION
-
CLIENT_UNAVAILABLE_WITHIN_MS
-
FETCH_EXCEPTION
-
EMIT_EXCEPTION
-
FETCHER_NOT_FOUND
-
EMITTER_NOT_FOUND
-
PRESET_NOT_FOUND
-
PAYLOAD_LIMIT_EXCEEDED
-
OOM
-
TIMEOUT
-
UNSPECIFIED_CRASH
-
EMPTY_OUTPUT
-
PARSE_SUCCESS
-
PARSE_SUCCESS_WITH_EXCEPTION
-
PARSE_EXCEPTION_NO_EMIT
-
EMIT_SUCCESS
-
EMIT_SUCCESS_PARSE_EXCEPTION
-
EMIT_SUCCESS_PASSBACK
-
PARTIAL_TIMEOUT
The task's total timeout was exhausted mid-parse: the worker is healthy (no restart), content extracted up to that point was emitted, but one or more embedded documents were skipped rather than attempted. Distinct fromTIMEOUT(worker lost, content lost, restart) -- here the parse completed and a retry would truncate at the same place, so the fix is a biggertotalTaskTimeoutMillisor accepting the truncation, not a retry. SeeTikaCoreProperties#TASK_DEADLINE_REACHED.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-
getCategory
Gets the high-level category for this result status.- Returns:
- the category (FATAL, INITIALIZATION_FAILURE, TASK_EXCEPTION, PROCESS_CRASH, or SUCCESS)
-
isFatal
public boolean isFatal()Checks if this status represents a fatal error.Fatal errors mean the system cannot continue and must be fixed and restarted.
- Returns:
- true if this is a fatal error
-
isInitializationFailure
public boolean isInitializationFailure()Checks if this status represents an initialization failure.Initialization failures occur when a component (fetcher, emitter, client) fails to start. These might be transient (e.g., network issues) or require configuration fixes.
- Returns:
- true if a component failed to initialize
-
isTaskException
public boolean isTaskException()Checks if this status represents a task-level exception.Task exceptions indicate this specific task failed, but other tasks may succeed. Processing can continue with the next task.
- Returns:
- true if this task failed
-
isProcessCrash
public boolean isProcessCrash()Checks if this status represents a process crash (OOM, timeout, etc.).Process crashes are system-level failures where the forked process terminated abnormally. The process will be auto-restarted and processing can continue.
- Returns:
- true if the forked process crashed
-
isSuccess
public boolean isSuccess()Checks if this status represents successful processing.Success includes normal completion as well as cases where processing completed with warnings (e.g., PARSE_SUCCESS_WITH_EXCEPTION).
- Returns:
- true if processing completed successfully (possibly with warnings)
-
lookup
-
getByte
public byte getByte()
-