Sessions: Probes

This page mirrors the Probes section from Sessions.

AddProbe

Source file, signature, and docstring

Member SessionBuilder.AddProbe(ProbeBuilder probeBuilder)

Kind function

Declaring Type SessionBuilder

Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs

Signature

public SessionBuilder AddProbe(ProbeBuilder probeBuilder)

Docstring

Adds the supplied probe to the current Runner session builder instance.

Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.

CreateProbe

Source file, signature, and docstring

Member SessionBuilder.CreateProbe(ProbeBuilder probeBuilder)

Kind function

Declaring Type SessionBuilder

Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs

Signature

public SessionBuilder CreateProbe(ProbeBuilder probeBuilder)

Docstring

Creates or adds the configured probe entry on the current Runner session builder instance.

Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.

ReadProbes

Source file, signature, and docstring

Member SessionBuilder.ReadProbes()

Kind function

Declaring Type SessionBuilder

Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs

Signature

public IReadOnlyList<ProbeBuilder> ReadProbes()

Docstring

Returns the configured probes currently stored on the Runner session builder instance.

Use this method when working with the documented Runner session builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.

ReadProbe

Source file, signature, and docstring

Member SessionBuilder.ReadProbe(string name)

Kind function

Declaring Type SessionBuilder

Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs

Signature

public ProbeBuilder? ReadProbe(string name)

Docstring

Returns the configured probe currently stored on the Runner session builder instance.

Use this method when working with the documented Runner session builder API surface in code. Use it to inspect the current configured state without rebuilding the surrounding collection or runtime object graph.

UpdateProbe

Source file, signature, and docstring

Member SessionBuilder.UpdateProbe(string name, ProbeBuilder probeBuilder)

Kind function

Declaring Type SessionBuilder

Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs

Signature

public SessionBuilder UpdateProbe(string name, ProbeBuilder probeBuilder)

Docstring

Updates the configured probe stored on the current Runner session builder instance.

Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.

UpdateProbe

Source file, signature, and docstring

Member SessionBuilder.UpdateProbe(string name, Func<ProbeBuilder, ProbeBuilder> update)

Kind function

Declaring Type SessionBuilder

Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs

Signature

public SessionBuilder UpdateProbe(string name, Func<ProbeBuilder, ProbeBuilder> update)

Docstring

Updates the configured probe stored on the current Runner session builder instance.

Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.

DeleteProbe

Source file, signature, and docstring

Member SessionBuilder.DeleteProbe(string name)

Kind function

Declaring Type SessionBuilder

Source File QaaS.Runner.Sessions/Session/Builders/SessionBuilderLogic.cs

Signature

public SessionBuilder DeleteProbe(string name)

Docstring

Removes the configured probe from the current Runner session builder instance.

Use this method when working with the documented Runner session builder API surface in code. The change is stored on the current builder instance and is consumed by later build, validation, or execution steps.