step.functions

Class Function

java.lang.Object

step.core.accessors.AbstractIdentifiableObject

step.core.accessors.AbstractOrganizableObject

step.functions.Function

public class Function
extends AbstractOrganizableObject

This class encapsulates all the configuration parameters of functions (aka Keywords) which can also be defined on the configuration dialog of Keywords in the UI

Field Summary

Fields

Modifier and Type	Field and Description
protected DynamicValue<Integer>	callTimeout
static String	NAME
protected javax.json.JsonObject	schema
protected Map<String,String>	tokenSelectionCriteria

Fields inherited from class step.core.accessors.AbstractOrganizableObject

attributes

Fields inherited from class step.core.accessors.AbstractIdentifiableObject

_id

Constructor Summary

Constructors

Constructor and Description
Function()

Method Summary

Modifier and Type	Method and Description
DynamicValue<Integer>	getCallTimeout()
javax.json.JsonObject	getSchema()
Map<String,String>	getTokenSelectionCriteria()
boolean	requiresLocalExecution()
void	setCallTimeout(DynamicValue<Integer> callTimeout)
void	setSchema(javax.json.JsonObject schema) Sets the JSON schema to be used to validate the function's input at execution time
void	setTokenSelectionCriteria(Map<String,String> tokenSelectionCriteria) Defines additional selection criteria of agent token on which the function should be executed

Methods inherited from class step.core.accessors.AbstractOrganizableObject

getAttributes, setAttributes

Methods inherited from class step.core.accessors.AbstractIdentifiableObject

getId, setId

Methods inherited from class java.lang.Object

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

Field Detail

callTimeout

protected DynamicValue<Integer> callTimeout

schema

protected javax.json.JsonObject schema

tokenSelectionCriteria

protected Map<String,String> tokenSelectionCriteria

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

Function

public Function()

Method Detail

getTokenSelectionCriteria

public Map<String,String> getTokenSelectionCriteria()

setTokenSelectionCriteria

public void setTokenSelectionCriteria(Map<String,String> tokenSelectionCriteria)

Defines additional selection criteria of agent token on which the function should be executed

Parameters:

tokenSelectionCriteria - a map containing the additional selection criteria as key-value pairs

getCallTimeout

public DynamicValue<Integer> getCallTimeout()

setCallTimeout

public void setCallTimeout(DynamicValue<Integer> callTimeout)

Parameters:

callTimeout - the call timeout of the function in ms

getSchema

public javax.json.JsonObject getSchema()

setSchema

public void setSchema(javax.json.JsonObject schema)

Sets the JSON schema to be used to validate the function's input at execution time

Parameters:

schema - the JSON schema of the function. See https://json-schema.org/ for more details concerning JSON schema.

requiresLocalExecution

public boolean requiresLocalExecution()