package rules
- Source
- package.scala
- Alphabetic
- By Inheritance
- rules
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- case class ClientContextParamDefinition(_type: ShapeType, documentation: Option[String] = None) extends Product with Serializable
A client context parameter definition.
A client context parameter definition.
- documentation
Documentation string to be generated with the client parameter.
- type ClientContextParams = rules.ClientContextParams.Type
Defines one or more named rule-set parameters to be generated as configurable client parameters.
Defines one or more named rule-set parameters to be generated as configurable client parameters. The type specified for the client parameter MUST match the parameter type defined in the rule-set.
- case class ContextParam(name: String) extends Product with Serializable
Binds the targeted member of an operation's input structure to the named rule-set parameter.
Binds the targeted member of an operation's input structure to the named rule-set parameter. The type of the shape targeted by the trait MUST match the parameter type defined in the rule-set.
- name
The rule-set parameter name.
- case class EndpointExpectation(url: Option[String] = None, headers: Option[Map[String, List[String]]] = None, properties: Option[Map[String, Document]] = None) extends Product with Serializable
A description of an expected endpoint to be resolved for an endpoint rule-set test case.
A description of an expected endpoint to be resolved for an endpoint rule-set test case.
- url
The expected endpoint URL to be resolved for this test case.
- headers
The transport headers to be set for this test case.
- properties
The properties for the endpoint for this test case.
- type EndpointHeaderValue = rules.EndpointHeaderValue.Type
A list of transport header values.
- type EndpointHeaders = rules.EndpointHeaders.Type
A map of header names to list of values.
- type EndpointRuleSet = rules.EndpointRuleSet.Type
Defines an endpoint rule-set used to resolve the client's transport endpoint.
- case class EndpointTest(expect: EndpointTestExpectation, documentation: Option[String] = None, params: Option[Document] = None, operationInputs: Option[List[OperationInput]] = None) extends Product with Serializable
Describes an endpoint test case for validation of an endpoint rule-set.
Describes an endpoint test case for validation of an endpoint rule-set.
- expect
The expected outcome of the test case.
- documentation
Documentation describing the test case.
- params
Defines rule-set parameters and values to use for testing rules-engine.
- operationInputs
Defines a set of service operation configurations used for testing the rules-engine.
- sealed trait EndpointTestExpectation extends Product with Serializable
An endpoint rule-set test expectation describing an expected endpoint or error.
- type EndpointTestList = rules.EndpointTestList.Type
A list of endpoint rule-set tests.
- case class EndpointTests(version: String, testCases: Option[List[EndpointTest]] = None) extends Product with Serializable
Defines endpoint test-cases for validating a client's endpoint rule-set.
Defines endpoint test-cases for validating a client's endpoint rule-set.
- version
The endpoint tests schema version.
- testCases
List of endpoint test cases.
- case class OperationInput(operationName: String, operationParams: Option[Document] = None, builtInParams: Option[Document] = None, clientParams: Option[Document] = None) extends Product with Serializable
A description of a service operation and input used to verify an endpoint rule-set test case.
A description of a service operation and input used to verify an endpoint rule-set test case.
- operationName
The name of the service operation targeted by the test.
- operationParams
Defines the input parameters used to generate the operation request. These parameters MUST be compatible with the input of the operation.
- builtInParams
Defines the set of rule-set built-ins and their corresponding values to be set.
- clientParams
Defines the set of client configuration parameters to be set.
- type OperationInputs = rules.OperationInputs.Type
A list of operation input descriptions for an endpoint rule-set test case.
- type Properties = rules.Properties.Type
A map of strings to document values.
- sealed abstract class ShapeType extends Value
An enum representing supported Smithy shape types.
- case class StaticContextParamDefinition(value: Document) extends Product with Serializable
A static context parameter definition.
A static context parameter definition.
- value
The value to set the associated rule-set parameter to.
- type StaticContextParams = rules.StaticContextParams.Type
Binds one or more named rule-set parameters to the defined static value for the targeted operation.
Binds one or more named rule-set parameters to the defined static value for the targeted operation. The type of the targeted shape targeted by the trait MUST match the parameter type defined in the rule-set.
Value Members
- object ClientContextParamDefinition extends Companion[ClientContextParamDefinition] with Serializable
- object ClientContextParams extends Newtype[Map[String, ClientContextParamDefinition]]
Defines one or more named rule-set parameters to be generated as configurable client parameters.
Defines one or more named rule-set parameters to be generated as configurable client parameters. The type specified for the client parameter MUST match the parameter type defined in the rule-set.
- object ContextParam extends Companion[ContextParam] with Serializable
- object EndpointExpectation extends Companion[EndpointExpectation] with Serializable
- object EndpointHeaderValue extends Newtype[List[String]]
A list of transport header values.
- object EndpointHeaders extends Newtype[Map[String, List[String]]]
A map of header names to list of values.
- object EndpointRuleSet extends Newtype[Document]
Defines an endpoint rule-set used to resolve the client's transport endpoint.
- object EndpointTest extends Companion[EndpointTest] with Serializable
- object EndpointTestExpectation extends Companion[EndpointTestExpectation] with Serializable
- object EndpointTestList extends Newtype[List[EndpointTest]]
A list of endpoint rule-set tests.
- object EndpointTests extends Companion[EndpointTests] with Serializable
- object OperationInput extends Companion[OperationInput] with Serializable
- object OperationInputs extends Newtype[List[OperationInput]]
A list of operation input descriptions for an endpoint rule-set test case.
- object Properties extends Newtype[Map[String, Document]]
A map of strings to document values.
- object ShapeType extends Enumeration[ShapeType] with Companion[ShapeType] with Serializable
- object StaticContextParamDefinition extends Companion[StaticContextParamDefinition] with Serializable
- object StaticContextParams extends Newtype[Map[String, StaticContextParamDefinition]]
Binds one or more named rule-set parameters to the defined static value for the targeted operation.
Binds one or more named rule-set parameters to the defined static value for the targeted operation. The type of the targeted shape targeted by the trait MUST match the parameter type defined in the rule-set.