ProtocolDefinition

smithy.api.ProtocolDefinition
See theProtocolDefinition companion object
case class ProtocolDefinition(traits: Option[List[TraitShapeId]], noInlineDocumentSupport: Option[Boolean])

Marks a trait as a protocol defining trait.

The targeted trait must only be applied to service shapes, must be a structure, and must have the trait trait.

Attributes

noInlineDocumentSupport

Set to true if inline documents are not supported by this protocol.

traits

Defines a list of traits that protocol implementations must understand in order to successfully use the protocol.

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product