ShapeExt extension

on

Properties

hasDefaultValue → bool

Available on Shape, provided by the ShapeExt extension

Whether the same has a default value.
no setter
isBoxed → bool

Available on Shape, provided by the ShapeExt extension

Whether this is boxed. This means the shape is optionally present and has no default value.
no setter
isEnum → bool

Available on Shape, provided by the ShapeExt extension

Whether this is an enum.
no setter
isError → bool

Available on Shape, provided by the ShapeExt extension

Whether this has the @error trait.
no setter
isHttpError → bool

Available on Shape, provided by the ShapeExt extension

Whether this has the @httpError trait.
no setter
isIdempotencyToken → bool

Available on Shape, provided by the ShapeExt extension

Whether this is an idempotency token.
no setter
isNotBoxed → bool

Available on Shape, provided by the ShapeExt extension

Whether this is not boxed. This means the shape is required to be present with a value.
no setter
isNotRequired → bool

Available on Shape, provided by the ShapeExt extension

Whether this does not have the @required trait.
no setter
isRequired → bool

Available on Shape, provided by the ShapeExt extension

Whether this has the @required trait.
no setter
isSparse → bool

Available on Shape, provided by the ShapeExt extension

Whether this has the @sparse trait.
no setter
isStreaming → bool

Available on Shape, provided by the ShapeExt extension

Whether this has the @streaming trait.
no setter
isUnstable → bool

Available on Shape, provided by the ShapeExt extension

Whether this has the @unstable trait.
no setter
timestampFormat → TimestampFormat?

Available on Shape, provided by the ShapeExt extension

The custom timestamp format specified by this shape, if any.
no setter

Methods

expectTrait<T extends Trait<Object>>() → T

Available on Shape, provided by the ShapeExt extension

Gets the trait of type T from the shape or throws if not found.
getTrait<T extends Trait<Object>>() → T?

Available on Shape, provided by the ShapeExt extension

Returns the trait of type T, if it exists on the shape.
hasTrait<T extends Trait<Object>>() → bool

Available on Shape, provided by the ShapeExt extension

Whether the shape has a trait of type T.