Class Parameter

java.lang.Object

software.amazon.awssdk.services.iotsitewise.endpoints.internal.Parameter

All Implemented Interfaces:

ToParameterReference

@SdkInternalApi
public final class Parameter
extends Object
implements ToParameterReference

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Parameter.Builder
static final class	Parameter.Deprecated

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT
static final String	DEPRECATED
static final String	DOCUMENTATION
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
Parameter(Parameter.Builder builder)

Method Summary

Modifier and Type	Method	Description
static Parameter.Builder	builder()
BooleanEqualsFn	eq(boolean b)
BooleanEqualsFn	eq(Expr e)
boolean	equals(Object o)
Expr	expr()
static Parameter	fromNode(String name, JsonNode node)
Optional<String>	getBuiltIn()
Optional<Value>	getDefault()	The default value for this Parameter
Optional<Value>	getDefaultValue()
Optional<Parameter.Deprecated>	getDeprecated()
Optional<String>	getDocumentation()
Identifier	getName()
ParameterType	getType()
Optional<Value>	getValue()
int	hashCode()
boolean	isBuiltIn()
boolean	isRequired()
String	template()
ParameterReference	toParameterReference()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

DEPRECATED

public static final String DEPRECATED

See Also:

• Constant Field Values

DOCUMENTATION

public static final String DOCUMENTATION

See Also:

• Constant Field Values

DEFAULT

public static final String DEFAULT

See Also:

• Constant Field Values

Constructor Details

Parameter

public Parameter(Parameter.Builder builder)

Method Details

getBuiltIn

public Optional<String> getBuiltIn()

getDefaultValue

public Optional<Value> getDefaultValue()

isRequired

public boolean isRequired()

getDeprecated

public Optional<Parameter.Deprecated> getDeprecated()

fromNode

public static Parameter fromNode(String name,
 JsonNode node)
                          throws RuleError

Throws:

RuleError

getType

public ParameterType getType()

getName

public Identifier getName()

isBuiltIn

public boolean isBuiltIn()

getValue

public Optional<Value> getValue()

builder

public static Parameter.Builder builder()

toString

public String toString()

Overrides:

toString in class Object

toParameterReference

public ParameterReference toParameterReference()

Specified by:

toParameterReference in interface ToParameterReference

template

public String template()

expr

public Expr expr()

eq

public BooleanEqualsFn eq(boolean b)

eq

public BooleanEqualsFn eq(Expr e)

getDocumentation

public Optional<String> getDocumentation()

getDefault

public Optional<Value> getDefault()

The default value for this Parameter

Returns:

The value. This value must match the type of this parameter.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object