IntelligenceX

API Reference

Interface

IGitHubRepositorySnapshotStore

Namespace IntelligenceX.Telemetry.GitHub
Assembly IntelligenceX
Modifiers abstract

Contract for persisted GitHub repository snapshots.

Methods

public abstract IReadOnlyList<GitHubRepositorySnapshotRecord> GetAll() #
Returns: IReadOnlyList<GitHubRepositorySnapshotRecord>

Returns all known snapshots ordered by repository and capture time.

Returns

All repository snapshots.

public abstract IReadOnlyList<GitHubRepositorySnapshotRecord> GetByWatch(String watchId) #
Returns: IReadOnlyList<GitHubRepositorySnapshotRecord>

Returns all snapshots for a single watch ordered by capture time.

Parameters

watchId System.String requiredposition: 0
Stable watch identifier.

Returns

Ordered snapshots for the watch.

public abstract Boolean TryGet(String id, out GitHubRepositorySnapshotRecord snapshot) #
Returns: Boolean

Looks up a snapshot by its stable identifier.

Parameters

id System.String requiredposition: 0
Stable snapshot identifier.
snapshot IntelligenceX.Telemetry.GitHub.GitHubRepositorySnapshotRecord@ requiredposition: 1
Resolved snapshot when one exists.

Returns

true when the snapshot exists.

public abstract Boolean TryGetLatest(String watchId, out GitHubRepositorySnapshotRecord snapshot) #
Returns: Boolean

Returns the newest snapshot for a watch when one exists.

Parameters

watchId System.String requiredposition: 0
Stable watch identifier.
snapshot IntelligenceX.Telemetry.GitHub.GitHubRepositorySnapshotRecord@ requiredposition: 1
Newest snapshot when one exists.

Returns

true when at least one snapshot exists.

public abstract Void Upsert(GitHubRepositorySnapshotRecord snapshot) #
Returns: Void

Inserts or replaces a repository snapshot.

Parameters

snapshot IntelligenceX.Telemetry.GitHub.GitHubRepositorySnapshotRecord requiredposition: 0
Snapshot to persist.