smithy.api.EnumDefinition
See theEnumDefinition companion object
final case class EnumDefinition(value: NonEmptyString, name: Option[EnumConstantBodyName], documentation: Option[String], tags: Option[List[NonEmptyString]], deprecated: Option[Boolean])
An enum definition for the enum trait.
Value parameters
- deprecated
-
Whether the enum value should be considered deprecated.
- documentation
-
Provides optional documentation about the enum constant value.
- name
-
Defines the name that is used in code to represent this variant.
- tags
-
Applies a list of tags to the enum constant.
- value
-
Defines the enum value that is sent over the wire.
Attributes
- Companion
- object
- Graph
-
- Supertypes
Members list
In this article