JsonPropertyInfo.IsRequired Property

Definition

Namespace:

System.Text.Json.Serialization.Metadata

Assembly:

System.Text.Json.dll

Package:

System.Text.Json v9.0.0-rc.2.24473.5

Source:

JsonPropertyInfo.cs

Gets or sets a value that indicates whether the current property is required for deserialization to be successful.

public:
 property bool IsRequired { bool get(); void set(bool value); };

public bool IsRequired { get; set; }

member this.IsRequired : bool with get, set

Public Property IsRequired As Boolean

Property Value

Boolean

Exceptions

InvalidOperationException

The JsonPropertyInfo instance has been locked for further modification.

Remarks

For contracts that originate from DefaultJsonTypeInfoResolver or JsonSerializerContext, the value of this property is mapped from JsonRequiredAttribute annotations.

For contracts that use DefaultJsonTypeInfoResolver, the value of this property is also mapped from properties that have the required modifier, unless deserialization uses a constructor that populates all required properties and has SetsRequiredMembersAttribute.

The required keyword is currently not supported in JsonSerializerContext contracts.

See also

• Required properties