Package com.flowable.agent.api.guardrail

Class ExternalGuardrailInvocationResult

java.lang.Object

com.flowable.agent.api.guardrail.ExternalGuardrailInvocationResult

public class ExternalGuardrailInvocationResult
extends Object

Result from an external guardrail invocation.

Use the builder to construct results:

 // Content is safe
 ExternalGuardrailInvocationResult.pass().build();

 // Content is blocked
 ExternalGuardrailInvocationResult.fail("PII detected").build();

 // Content was sanitized and should continue with rewritten text
 ExternalGuardrailInvocationResult.pass().sanitizedContent("Hello [PERSON]").build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExternalGuardrailInvocationResult.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	passed
protected final String	reason
protected final String	sanitizedContent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ExternalGuardrailInvocationResult(ExternalGuardrailInvocationResult.Builder builder)

Method Summary

Modifier and Type	Method	Description
static ExternalGuardrailInvocationResult.Builder	fail(String reason)
String	getReason()
String	getSanitizedContent()	Returns the sanitized/rewritten content, or null if the content was not modified.
boolean	isPassed()
static ExternalGuardrailInvocationResult.Builder	pass()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

passed

protected final boolean passed

reason

protected final String reason

sanitizedContent

protected final String sanitizedContent

Constructor Details

ExternalGuardrailInvocationResult

protected ExternalGuardrailInvocationResult(ExternalGuardrailInvocationResult.Builder builder)

Method Details

pass

public static ExternalGuardrailInvocationResult.Builder pass()

fail

public static ExternalGuardrailInvocationResult.Builder fail(String reason)

isPassed

public boolean isPassed()

getReason

public String getReason()

getSanitizedContent

public String getSanitizedContent()

Returns the sanitized/rewritten content, or null if the content was not modified. When non-null, this content replaces the original in the pipeline (e.g., PII redacted before LLM call).