Interface IIndexInstanceBuildRecordService

Namespace

Dynamicweb.Indexing.BuildStates

Assembly

Dynamicweb.Core.dll

Provides durable storage and state transitions for index instance build records.

public interface IIndexInstanceBuildRecordService

Methods

Get(string, string, string)

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

[SuppressMessage("Naming", "CA1716:Identifiers should not match keywords", Justification = "The requested API intentionally uses the domain term 'Get'.")]
IndexInstanceBuildRecord Get(string repository, string indexName, string instanceName)

Parameters

repository string

indexName string

instanceName string

Returns

IndexInstanceBuildRecord

GetAll()

Gets all persisted build records.

IEnumerable<IndexInstanceBuildRecord> GetAll()

Returns

IEnumerable<IndexInstanceBuildRecord>

GetAll(string, string)

Gets all persisted build records for the specified index.

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.

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.

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.

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.

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.

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.

void Save(IndexInstanceBuildRecord record)

Parameters

record IndexInstanceBuildRecord

UpdateHeartbeat(string, string, string, string?)

Updates the running heartbeat for an instance.

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

Parameters

repository string

indexName string

instanceName string

resumeCursor string

Returns

IndexInstanceBuildRecord