IdRef

smithy.api.IdRef
See theIdRef companion object
case class IdRef(selector: String, failWhenMissing: Option[Boolean], errorMessage: Option[String])

Indicates that a string value MUST contain a valid shape ID.

The provided shape ID MAY be absolute or relative to the shape to which the trait is applied. A relative shape ID that does not resolve to a shape defined in the same namespace resolves to a shape defined in the prelude if the prelude shape is not marked with the private trait.

Attributes

errorMessage

Defines a custom error message to use when the shape ID cannot be found or does not match the selector. A default message is generated when errorMessage is not defined.

failWhenMissing

When set to true, the shape ID MUST target a shape that can be found in the model.

selector

Defines the selector that the resolved shape, if found, MUST match.

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