ServiceProbeResult

Definition

Assembly: Microsoft.OData.Mcp.Core.dll Namespace: Microsoft.OData.Mcp.Core.Diagnostics Inheritance: System.Object

Syntax

Microsoft.OData.Mcp.Core.Diagnostics.ServiceProbeResult

Summary

Everything a ServiceProbe learned about one service: the three steps, the parsed model when there was one, the entity set that was sampled, and the overall verdict.

Constructors

.ctor

Initializes a new instance of the ServiceProbeResult class.

Syntax

public ServiceProbeResult(System.Uri serviceRoot, Microsoft.OData.Mcp.Core.Diagnostics.ProbeStep metadata, Microsoft.OData.Mcp.Core.Diagnostics.ProbeStep data, Microsoft.OData.Mcp.Core.Diagnostics.ProbeStep results, Microsoft.OData.Mcp.Core.Models.EdmModel model, string entitySet, string entityType)

Parameters

Name	Type	Description
`serviceRoot`	`System.Uri`	-
`metadata`	`Microsoft.OData.Mcp.Core.Diagnostics.ProbeStep`	-
`data`	`Microsoft.OData.Mcp.Core.Diagnostics.ProbeStep`	-
`results`	`Microsoft.OData.Mcp.Core.Diagnostics.ProbeStep`	-
`model`	`Microsoft.OData.Mcp.Core.Models.EdmModel?`	-
`entitySet`	`string?`	-
`entityType`	`string?`	-

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Challenges

Every WWW-Authenticate value seen on a 401 or 403, metadata first.

Syntax

public System.Collections.Generic.IReadOnlyList<string> Challenges { get; }

Property Value

Type: System.Collections.Generic.IReadOnlyList<string>

Data

Step 2: GET {root}{EntitySet}?$top=1.

Syntax

public Microsoft.OData.Mcp.Core.Diagnostics.ProbeStep Data { get; }

Property Value

Type: Microsoft.OData.Mcp.Core.Diagnostics.ProbeStep

EntitySet

The entity set that was sampled, or null when the model declared none.

Syntax

public string EntitySet { get; }

Property Value

Type: string?

EntityType

The qualified name of the type behind ServiceProbeResult.EntitySet, or null.

Syntax

public string EntityType { get; }

Property Value

Type: string?

Metadata

Step 1: GET {root}$metadata and parse.

Syntax

public Microsoft.OData.Mcp.Core.Diagnostics.ProbeStep Metadata { get; }

Property Value

Type: Microsoft.OData.Mcp.Core.Diagnostics.ProbeStep

Model

The parsed model when step 1 passed, otherwise null.

Syntax

public Microsoft.OData.Mcp.Core.Models.EdmModel Model { get; }

Property Value

Type: Microsoft.OData.Mcp.Core.Models.EdmModel?

Results

Step 3: does the sampled row match the model?

Syntax

public Microsoft.OData.Mcp.Core.Diagnostics.ProbeStep Results { get; }

Property Value

Type: Microsoft.OData.Mcp.Core.Diagnostics.ProbeStep

SecuredStatusCode

The HTTP status of the step that refused access, when one did. Used to drive OAuth discovery.

Syntax

public System.Nullable<int> SecuredStatusCode { get; }

Property Value

Type: System.Nullable<int>

ServiceRoot

The normalized service root, always ending in /.

Syntax

public System.Uri ServiceRoot { get; }

Property Value

Type: System.Uri

Verdict

The overall conclusion.

Syntax

public Microsoft.OData.Mcp.Core.Diagnostics.ServiceVerdict Verdict { get; }

Property Value

Type: Microsoft.OData.Mcp.Core.Diagnostics.ServiceVerdict

Methods

Decide

Derives the verdict from the three steps.

Syntax

public static Microsoft.OData.Mcp.Core.Diagnostics.ServiceVerdict Decide(Microsoft.OData.Mcp.Core.Diagnostics.ProbeStep metadata, Microsoft.OData.Mcp.Core.Diagnostics.ProbeStep data, Microsoft.OData.Mcp.Core.Diagnostics.ProbeStep results)

Parameters

Name	Type	Description
`metadata`	`Microsoft.OData.Mcp.Core.Diagnostics.ProbeStep`	Step 1.
`data`	`Microsoft.OData.Mcp.Core.Diagnostics.ProbeStep`	Step 2.
`results`	`Microsoft.OData.Mcp.Core.Diagnostics.ProbeStep`	Step 3.

Returns

Type: Microsoft.OData.Mcp.Core.Diagnostics.ServiceVerdict The verdict. Security refusals win over reachability, which wins over readability.

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
`obj`	`object?`	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

ToString Override

Syntax

public override string ToString()

Returns

Type: string

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

​Definition

​Syntax

​Summary

​Constructors

​ .ctor

​Syntax

​Parameters

​ .ctor Inherited

​Syntax

​Properties

​ Challenges

​Syntax

​Property Value

​ Data

​Syntax

​Property Value

​ EntitySet

​Syntax

​Property Value

​ EntityType

​Syntax

​Property Value

​ Metadata

​Syntax

​Property Value

​ Model

​Syntax

​Property Value

​ Results

​Syntax

​Property Value

​ SecuredStatusCode

​Syntax

​Property Value

​ ServiceRoot

​Syntax

​Property Value

​ Verdict

​Syntax

​Property Value

​Methods

​ Decide

​Syntax

​Parameters

​Returns

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetType Inherited

​Syntax

​Returns

​ MemberwiseClone Inherited

​Syntax

​Returns

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ ToString Override

​Syntax

​Returns

​ ToString Inherited Virtual

​Syntax

​Returns

Definition

Syntax

Summary

Constructors

.ctor

Syntax

Parameters

.ctor Inherited

Syntax

Properties

Challenges

Syntax

Property Value

Data

Syntax

Property Value

EntitySet

Syntax

Property Value

EntityType

Syntax

Property Value

Metadata

Syntax

Property Value

Model

Syntax

Property Value

Results

Syntax

Property Value

SecuredStatusCode

Syntax

Property Value

ServiceRoot

Syntax

Property Value

Verdict

Syntax

Property Value

Methods

Decide

Syntax

Parameters

Returns

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetType Inherited

Syntax

Returns

MemberwiseClone Inherited

Syntax

Returns

ReferenceEquals Inherited

Syntax

Parameters

Returns

ToString Override

Syntax

Returns

ToString Inherited Virtual

Syntax

Returns