View Source

Class ExamineIndexModel

Represents the data model used for an Examine index in Umbraco.

Inheritance

object

Namespace: Umbraco.Cms.Infrastructure.Examine

Assembly: Umbraco.Infrastructure.dll

Syntax

[DataContract(Name = "indexer", Namespace = "")]
public class ExamineIndexModel

Constructors

ExamineIndexModel()

Declaration

public ExamineIndexModel()

Properties

CanRebuild

Gets or sets a value indicating whether this index is allowed to be rebuilt.

Declaration

[DataMember(Name = "canRebuild")]
public bool CanRebuild { get; set; }

Property Value

Type	Description
bool

HealthStatus

The health status of the examine index.

Declaration

[DataMember(Name = "healthStatus")]
public string? HealthStatus { get; set; }

Property Value

Type	Description
string

IsHealthy

Gets a value indicating whether the index is considered healthy, meaning its HealthStatus property equals "Healthy".

Declaration

[DataMember(Name = "isHealthy")]
public bool IsHealthy { get; }

Property Value

Type	Description
bool

Name

Gets or sets the name of the index.

Declaration

[DataMember(Name = "name")]
public string? Name { get; set; }

Property Value

Type	Description
string

ProviderProperties

Gets or sets a collection of provider-specific properties for the examine index. The dictionary contains key-value pairs representing additional metadata or configuration for the index provider.

Declaration

[DataMember(Name = "providerProperties")]
public IReadOnlyDictionary<string, object?>? ProviderProperties { get; set; }

Property Value

Type	Description
IReadOnlyDictionary<string, object>