All Downloads are FREE. Search and download functionalities are using the official Maven repository.

smithy4s.smithy.rules.package.scala Maven / Gradle / Ivy

The newest version!
package smithy

package object rules {

  /** 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.
    * @param key
    *   The rule-set parameter name.
    * @param value
    *   The client parameter definition.
    */
  type ClientContextParams = smithy.rules.ClientContextParams.Type
  /** A list of transport header values.
    * @param member
    *   A transport header value.
    */
  type EndpointHeaderValue = smithy.rules.EndpointHeaderValue.Type
  /** A map of header names to list of values.
    * @param key
    *   The transport header name.
    * @param value
    *   The transport header values.
    */
  type EndpointHeaders = smithy.rules.EndpointHeaders.Type
  /** Defines an endpoint rule-set used to resolve the client's transport endpoint. */
  type EndpointRuleSet = smithy.rules.EndpointRuleSet.Type
  /** A list of endpoint rule-set tests.
    * @param member
    *   Describes an endpoint test case for validation of an endpoint rule-set.
    */
  type EndpointTestList = smithy.rules.EndpointTestList.Type
  /** Binds one or more named rule-set parameters to elements contained in the operation's input structure.
    * The type of the shapes targeted by the trait MUST match the parameter types defined in the rule-set.
    * @param key
    *   The rule-set parameter name.
    * @param value
    *   The static parameter definition.
    */
  type OperationContextParams = smithy.rules.OperationContextParams.Type
  /** A list of operation input descriptions for an endpoint rule-set test case.
    * @param member
    *   The service operation configuration to be used for testing the rules-engine.
    */
  type OperationInputs = smithy.rules.OperationInputs.Type
  /** A map of strings to document values.
    * @param key
    *   The property name.
    * @param value
    *   The property value.
    */
  type Properties = smithy.rules.Properties.Type
  /** 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.
    * @param key
    *   The rule-set parameter name.
    * @param value
    *   The static parameter definition.
    */
  type StaticContextParams = smithy.rules.StaticContextParams.Type

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy