Package software.amazon.smithy.rulesengine.traits

Class ContextIndex

java.lang.Object

software.amazon.smithy.rulesengine.traits.ContextIndex

All Implemented Interfaces:

KnowledgeIndex

public final class ContextIndex
extends Object
implements KnowledgeIndex

Resolves an indexes the context parameters in the model.

Constructor Summary

Constructors

Constructor	Description
ContextIndex(Model model)

Method Summary

Modifier and Type	Method	Description
Optional<ClientContextParamsTrait>	getClientContextParams(Shape service)	Gets the mapping of context parameter names and corresponding ClientContextParamDefinition to be generated on the service client's configuration.
Map<MemberShape,ContextParamTrait>	getContextParams(Shape operation)	Gets the mapping of MemberShape to ContextParamTrait for the operation.
Optional<OperationContextParamsTrait>	getOperationContextParams(Shape operation)	Gets the operation context parameter names and their OperationContextParamDefinition for the given operation.
Optional<StaticContextParamsTrait>	getStaticContextParams(Shape operation)	Gets the static context parameter names and their StaticContextParamDefinition to be set for the given operation.
static ContextIndex	of(Model model)

Methods inherited from class java.lang.Object

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

Constructor Details

ContextIndex

public ContextIndex(Model model)

Method Details

of

public static ContextIndex of(Model model)

getClientContextParams

public Optional<ClientContextParamsTrait> getClientContextParams(Shape service)

Gets the mapping of context parameter names and corresponding ClientContextParamDefinition to be generated on the service client's configuration.

Parameters:

service - The service shape.

Returns:

The mapping of context parameter names to ClientContextParamDefinition.

getStaticContextParams

public Optional<StaticContextParamsTrait> getStaticContextParams(Shape operation)

Gets the static context parameter names and their StaticContextParamDefinition to be set for the given operation.

Parameters:

operation - The operation shape.

Returns:

The mapping of context parameter names to the static Node value to be set.

getOperationContextParams

public Optional<OperationContextParamsTrait> getOperationContextParams(Shape operation)

Gets the operation context parameter names and their OperationContextParamDefinition for the given operation.

Parameters:

operation - The operation shape.

Returns:

The mapping of context parameter names to the JMESPath expression to bind to input elements.

getContextParams

public Map<MemberShape,ContextParamTrait> getContextParams(Shape operation)

Gets the mapping of MemberShape to ContextParamTrait for the operation.

Parameters:

operation - The operation shape.

Returns:

The mapping of operation's MemberShape to ContextParamTrait.