DeriveUnionAttributeType

PackageReified.Schema
Marks a discriminated union for generated Schema support. The parameterless form uses the recommended internal type discriminator; named properties select explicit adjacent or external compatibility representations. General-union fields must be named.

Specification

Kind
Type
Members
8
Examples
0
``.ctor``Signature
DeriveUnionAttribute()
``.ctor``Signature
DeriveUnionAttribute(discriminator)
DiscriminatorSignature
this.Discriminator
PayloadFieldSignature
this.PayloadField
FullyQualifiedSignature
this.FullyQualified

Summary

NameSignatureSynopsis
Operations
``.ctor``DeriveUnionAttribute()No description available.
``.ctor``DeriveUnionAttribute(discriminator)No description available.
Discriminatorthis.DiscriminatorNo description available.
PayloadFieldthis.PayloadFieldNo description available.
FullyQualifiedthis.FullyQualifiedBy default, generated case construction and pattern-matching use the union's case tags unqualified where schemagen can prove that is safe.
Representationthis.RepresentationNo description available.
PayloadStylethis.PayloadStyleNo description available.
UnwrapFieldlessthis.UnwrapFieldlessNo description available.

Operations

kind:member

``.ctor``

DeriveUnionAttribute()
Member

Returns

DeriveUnionAttribute
kind:member

``.ctor``

DeriveUnionAttribute(discriminator)
Member

Parameters

NameTypeDescription
discriminatorstring

Returns

DeriveUnionAttribute
kind:member

Discriminator

this.Discriminator
Member

Returns

string
kind:member

PayloadField

this.PayloadField
Member

Returns

string
kind:member

FullyQualified

this.FullyQualified
Member
By default, generated case construction and pattern-matching use the union's case tags unqualified where schemagen can prove that is safe. Set this to opt a union out of that and always fully qualify its raw type and cases instead - reach for it if you attach hand-written members to this union type elsewhere that schemagen cannot see and that might collide.

Returns

bool
kind:member

Representation

this.Representation
Member

Returns

UnionRepresentationKind
kind:member

PayloadStyle

this.PayloadStyle
Member

Returns

UnionPayloadStyleKind
kind:member

UnwrapFieldless

this.UnwrapFieldless
Member

Returns

bool