View Source

Interface IIndexDiagnostics

Exposes diagnostic information about an index

Namespace: Umbraco.Cms.Infrastructure.Examine

Assembly: Umbraco.Infrastructure.dll

Syntax

public interface IIndexDiagnostics

Properties

Metadata

A key/value collection of diagnostic properties for the index

Declaration

IReadOnlyDictionary<string, object> Metadata { get; }

Property Value

Type	Description
IReadOnlyDictionary<System.String, System.Object>

Remarks

Used to display in the UI

Methods

IsHealthy()

If the index can be open/read

Declaration

Attempt<string> IsHealthy()

Returns

Type	Description
Attempt<System.String>	A successful attempt if it is healthy, else a failed attempt with a message if unhealthy