Package ai.extend.types

Class StepRunOutputRulesItem.Builder

java.lang.Object

ai.extend.types.StepRunOutputRulesItem.Builder

All Implemented Interfaces:

StepRunOutputRulesItem._FinalStage, StepRunOutputRulesItem.NameStage, StepRunOutputRulesItem.ValidStage

Enclosing class:

StepRunOutputRulesItem

public static final class StepRunOutputRulesItem.Builder
extends java.lang.Object
implements StepRunOutputRulesItem.NameStage, StepRunOutputRulesItem.ValidStage, StepRunOutputRulesItem._FinalStage

Method Summary

Modifier and Type	Method	Description
StepRunOutputRulesItem	build()
StepRunOutputRulesItem._FinalStage	error(java.lang.String error)	If the failureReason is PARSE_ERROR or VALUE_ERROR, then this field contains the error's details.
StepRunOutputRulesItem._FinalStage	error(java.util.Optional<java.lang.String> error)	If the failureReason is PARSE_ERROR or VALUE_ERROR, then this field contains the error's details.
StepRunOutputRulesItem._FinalStage	failureReason(StepRunOutputRulesItemFailureReason failureReason)	If the validation rule is not valid, then this describes why the rule failed.
StepRunOutputRulesItem._FinalStage	failureReason(java.util.Optional<StepRunOutputRulesItemFailureReason> failureReason)	If the validation rule is not valid, then this describes why the rule failed.
StepRunOutputRulesItem.Builder	from(StepRunOutputRulesItem other)
StepRunOutputRulesItem.ValidStage	name(java.lang.String name)	The name of the validation rule.
StepRunOutputRulesItem._FinalStage	valid(boolean valid)	Indicates whether this validation rule passed or not.
StepRunOutputRulesItem._FinalStage	validArray(java.util.List<java.lang.String> validArray)	Only present if the validation rule's formula is array valued.
StepRunOutputRulesItem._FinalStage	validArray(java.util.Optional<java.util.List<java.lang.String>> validArray)	Only present if the validation rule's formula is array valued.

Methods inherited from class java.lang.Object

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

Method Detail

from

public StepRunOutputRulesItem.Builder from(StepRunOutputRulesItem other)

Specified by:

from in interface StepRunOutputRulesItem.NameStage

name

public StepRunOutputRulesItem.ValidStage name(@NotNull
                                              java.lang.String name)

The name of the validation rule.

The name of the validation rule.

Specified by:

name in interface StepRunOutputRulesItem.NameStage

Returns:

Reference to this so that method calls can be chained together.

valid

public StepRunOutputRulesItem._FinalStage valid(boolean valid)

Indicates whether this validation rule passed or not. This field will be true only if the formula evaluates to true. If the rule's formula is array valued, then this field will only be true if the formula evaluates to true for every item in the array.

Indicates whether this validation rule passed or not. This field will be true only if the formula evaluates to true. If the rule's formula is array valued, then this field will only be true if the formula evaluates to true for every item in the array.

Specified by:

valid in interface StepRunOutputRulesItem.ValidStage

Returns:

Reference to this so that method calls can be chained together.

error

public StepRunOutputRulesItem._FinalStage error(java.lang.String error)

If the failureReason is PARSE_ERROR or VALUE_ERROR, then this field contains the error's details.

Specified by:

error in interface StepRunOutputRulesItem._FinalStage

Returns:

Reference to this so that method calls can be chained together.

error

public StepRunOutputRulesItem._FinalStage error(java.util.Optional<java.lang.String> error)

If the failureReason is PARSE_ERROR or VALUE_ERROR, then this field contains the error's details.

Specified by:

error in interface StepRunOutputRulesItem._FinalStage

failureReason

public StepRunOutputRulesItem._FinalStage failureReason(StepRunOutputRulesItemFailureReason failureReason)

If the validation rule is not valid, then this describes why the rule failed.

• "RULE_FAILED" - The formula evaluated to false or null
• "PARSE_ERROR" - The formula could not be parsed
• "VALUE_ERROR" - An error occurred while evaluating the formula

Specified by:

failureReason in interface StepRunOutputRulesItem._FinalStage

Returns:

Reference to this so that method calls can be chained together.

failureReason

public StepRunOutputRulesItem._FinalStage failureReason(java.util.Optional<StepRunOutputRulesItemFailureReason> failureReason)

If the validation rule is not valid, then this describes why the rule failed.

• "RULE_FAILED" - The formula evaluated to false or null
• "PARSE_ERROR" - The formula could not be parsed
• "VALUE_ERROR" - An error occurred while evaluating the formula

Specified by:

failureReason in interface StepRunOutputRulesItem._FinalStage

validArray

public StepRunOutputRulesItem._FinalStage validArray(java.util.List<java.lang.String> validArray)

Only present if the validation rule's formula is array valued. This field contains the formula's evaluated result for every item in the array.

Specified by:

validArray in interface StepRunOutputRulesItem._FinalStage

Returns:

Reference to this so that method calls can be chained together.

validArray

public StepRunOutputRulesItem._FinalStage validArray(java.util.Optional<java.util.List<java.lang.String>> validArray)

Only present if the validation rule's formula is array valued. This field contains the formula's evaluated result for every item in the array.

Specified by:

validArray in interface StepRunOutputRulesItem._FinalStage

build

public StepRunOutputRulesItem build()

Specified by:

build in interface StepRunOutputRulesItem._FinalStage