Class IndexInstanceBuildRecordService

Namespace

Dynamicweb.Indexing.BuildStates

Assembly

Dynamicweb.Core.dll

Persists durable index instance build state to the diagnostics folder.

public sealed class IndexInstanceBuildRecordService : IIndexInstanceBuildRecordService

Inheritance

object

IndexInstanceBuildRecordService

Implements

IIndexInstanceBuildRecordService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Get(string, string, string)

Gets the durable record for the specified instance, returning a synthesized never-built record when no persisted state exists.

public IndexInstanceBuildRecord Get(string repository, string indexName, string instanceName)

Parameters

repository string

indexName string

instanceName string

Returns

IndexInstanceBuildRecord

GetAll()

Gets all persisted build records.

public IEnumerable<IndexInstanceBuildRecord> GetAll()

Returns

IEnumerable<IndexInstanceBuildRecord>

GetAll(string, string)

Gets all persisted build records for the specified index.

public IEnumerable<IndexInstanceBuildRecord> GetAll(string repository, string indexName)

Parameters

repository string

indexName string

Returns

IEnumerable<IndexInstanceBuildRecord>

MarkCompleted(string, string, string, bool)

Marks an instance as completed successfully.

public IndexInstanceBuildRecord MarkCompleted(string repository, string indexName, string instanceName, bool isOnlineInstance)

Parameters

repository string

indexName string

instanceName string

isOnlineInstance bool

Returns

IndexInstanceBuildRecord

MarkFailed(string, string, string, string, string, string?)

Marks an instance as failed.

public IndexInstanceBuildRecord MarkFailed(string repository, string indexName, string instanceName, string errorSummary, string errorDetails, string? resumeCursor = null)

Parameters

repository string

indexName string

instanceName string

errorSummary string

errorDetails string

resumeCursor string

Returns

IndexInstanceBuildRecord

MarkInterrupted(string, string, string, string, string)

Marks an instance as interrupted and awaiting recovery.

public IndexInstanceBuildRecord MarkInterrupted(string repository, string indexName, string instanceName, string errorSummary, string errorDetails)

Parameters

repository string

indexName string

instanceName string

errorSummary string

errorDetails string

Returns

IndexInstanceBuildRecord

MarkRunning(string, string, string, string?)

Marks an instance as actively running and refreshes its heartbeat.

public IndexInstanceBuildRecord MarkRunning(string repository, string indexName, string instanceName, string? resumeCursor = null)

Parameters

repository string

indexName string

instanceName string

resumeCursor string

Returns

IndexInstanceBuildRecord

MarkStarting(string, string, string, string, string, bool, string, bool)

Marks the beginning of a build attempt.

public IndexInstanceBuildRecord MarkStarting(string repository, string indexName, string instanceName, string buildName, string operationId, bool resumeSupported, string resumeCursor, bool isOnlineInstance)

Parameters

repository string

indexName string

instanceName string

buildName string

operationId string

resumeSupported bool

resumeCursor string

isOnlineInstance bool

Returns

IndexInstanceBuildRecord

Save(IndexInstanceBuildRecord)

Saves the supplied build record.

public void Save(IndexInstanceBuildRecord record)

Parameters

record IndexInstanceBuildRecord

UpdateHeartbeat(string, string, string, string?)

Updates the running heartbeat for an instance.

public IndexInstanceBuildRecord UpdateHeartbeat(string repository, string indexName, string instanceName, string? resumeCursor = null)

Parameters

repository string

indexName string

instanceName string

resumeCursor string

Returns

IndexInstanceBuildRecord