Package com.netflix.spinnaker.kork.api.expressions

Class ExpressionFunctionProvider.FunctionDefinition

java.lang.Object

com.netflix.spinnaker.kork.api.expressions.ExpressionFunctionProvider.FunctionDefinition

Enclosing interface:

ExpressionFunctionProvider

public static class ExpressionFunctionProvider.FunctionDefinition
extends java.lang.Object

A single function definition. This defines the name and input parameter contract for interacting with the function.

Constructor Summary

Constructors

Constructor	Description
FunctionDefinition(java.lang.String name, ExpressionFunctionProvider.FunctionParameter... functionParameters)	Deprecated.
FunctionDefinition(java.lang.String name, java.lang.String description, ExpressionFunctionProvider.FunctionParameter... parameters)
FunctionDefinition(java.lang.String name, java.lang.String description, java.util.List<ExpressionFunctionProvider.FunctionParameter> parameters)
FunctionDefinition(java.lang.String name, java.lang.String description, java.util.List<ExpressionFunctionProvider.FunctionParameter> parameters, ExpressionFunctionProvider.FunctionDocumentation documentation)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()
ExpressionFunctionProvider.FunctionDocumentation	getDocumentation()
java.lang.String	getName()
java.util.List<ExpressionFunctionProvider.FunctionParameter>	getParameters()

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionDefinition

@Deprecated
@DeprecationInfo(reason="Please use the overload with description",
                 since="1.18",
                 eol="1.25",
                 replaceWith="FunctionDefinition(name, \"\", functionParameters)")
public FunctionDefinition(java.lang.String name,
                          ExpressionFunctionProvider.FunctionParameter... functionParameters)

Deprecated.

FunctionDefinition

public FunctionDefinition(java.lang.String name,
                          java.lang.String description,
                          java.util.List<ExpressionFunctionProvider.FunctionParameter> parameters,
                          @Nullable
                          ExpressionFunctionProvider.FunctionDocumentation documentation)

FunctionDefinition

public FunctionDefinition(java.lang.String name,
                          java.lang.String description,
                          ExpressionFunctionProvider.FunctionParameter... parameters)

FunctionDefinition

public FunctionDefinition(java.lang.String name,
                          java.lang.String description,
                          java.util.List<ExpressionFunctionProvider.FunctionParameter> parameters)

Method Detail

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

getParameters

public java.util.List<ExpressionFunctionProvider.FunctionParameter> getParameters()

getDocumentation

@Nullable
public ExpressionFunctionProvider.FunctionDocumentation getDocumentation()