Class ProtoDiagnosticCaptureOptions

Namespace

ProtoTest.Json

Assembly

ProtoTest.Json.dll

Capture and redaction options every protocol's attachment configuration shares: whether request bodies, responses and expected shapes are captured, plus the redaction settings from JsonDiagnosticOptions. A protocol adds only what is genuinely its own, such as HTTP's sensitive headers and query parameters.

public class ProtoDiagnosticCaptureOptions : JsonDiagnosticOptions, IProtoConfigurableOptions

Inheritance

object

JsonDiagnosticOptions

ProtoDiagnosticCaptureOptions

Implements

IProtoConfigurableOptions

Derived

GrpcAttachmentOptions

ProtoHttpAttachmentOptions

Inherited Members

JsonDiagnosticOptions.RedactSensitiveData

JsonDiagnosticOptions.MaxDiagnosticBodyLength

JsonDiagnosticOptions.SensitiveJsonProperties

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ProtoConfigurableOptionsExtensions.BindFromConfiguration(IProtoConfigurableOptions, IConfiguration)

SheetModelAssertions.ShouldMatchShape<TRow>(TRow, object, bool, JsonSerializerOptions?)

SheetModelAssertions.ShouldMatchShape<TRow>(TRow, object, JsonSerializerOptions?)

Constructors

ProtoDiagnosticCaptureOptions(string)

Creates options bound to a known configuration section, e.g. ProtoTest:Rest:Attachments.

public ProtoDiagnosticCaptureOptions(string configurationSectionName)

Parameters

configurationSectionName string

Properties

CaptureExpectedShapes

Captures the expected shape used by shape assertions. Defaults to true.

public bool CaptureExpectedShapes { get; set; }

Property Value

bool

CaptureRequestBodies

Captures outgoing request bodies as attachments. Defaults to true.

public bool CaptureRequestBodies { get; set; }

Property Value

bool

CaptureResponses

Captures response bodies as attachments. Defaults to true.

public bool CaptureResponses { get; set; }

Property Value

bool

ConfigurationSectionName

The configuration section this instance binds from, e.g. "ProtoTest:Rest:Attachments".

public string ConfigurationSectionName { get; }

Property Value

string