Version:
RaftRepository2 Class
Provides the implementation for the underlying storage mechanism of a raft.
Inheritance Hierarchy
- object
- Inedo.Extensibility.RaftRepositories.RaftRepository2
Syntax
public
class
RaftRepository2 : System.IDisposable, System.IAsyncDisposable
Properties
|
Name |
Description |
|
|
DefaultName
|
Gets the name of the default raft.
|
|
|
IsReadOnly
|
Gets a value indicating whether the items in the raft are read only.
|
|
|
MaxItemSize
|
Gets or sets the maximum size in bytes of an individual raft item.
|
|
|
RaftId
|
Gets or sets the product-specific identifier for the raft.
|
|
|
RaftName
|
Gets or sets the product-specific name for the raft.
|
|
|
SupportsVersioning
|
Gets a value indicating whether items are versioned by this raft.
|
|
|
WarnItemSize
|
Gets or sets the minimum size that generates a warning when saving a raft item.
|
Methods
|
Name |
Description |
|
|
Commit(Inedo.Extensibility.UserDirectories.IUserDirectoryUser user)
|
|
|
|
CommitAsync(Inedo.Extensibility.UserDirectories.IUserDirectoryUser user, System.Threading.CancellationToken cancellationToken)
|
|
|
|
DeleteRaftItem(RaftItemType type, string name)
|
|
|
|
DeleteRaftItemAsync(RaftItemType type, string name, System.Threading.CancellationToken cancellationToken)
|
|
|
|
DeleteVariable(Inedo.ExecutionEngine.RuntimeVariableName name)
|
|
|
|
DeleteVariableAsync(Inedo.ExecutionEngine.RuntimeVariableName name, System.Threading.CancellationToken cancellationToken)
|
|
|
|
Dispose(bool disposing)
|
Releases resources used by the raft repository.
|
|
|
DisposeAsync
|
Releases resources used by the raft repository.
|
|
|
EnsureRelativePath(string path)
|
|
|
|
GetDescription
|
Gets a description of the raft's configuration.
|
|
|
GetProjects(bool recursive)
|
|
|
|
GetProjectsAsync(bool recursive, System.Threading.CancellationToken cancellationToken)
|
|
|
|
GetProjectScopedRaftRepository(string project)
|
|
|
|
GetProjectScopedRaftRepositoryAsync(string project, System.Threading.CancellationToken cancellationToken)
|
|
|
|
GetRaftItem(RaftItemType type, string name, string version)
|
|
|
|
GetRaftItemAsync(RaftItemType type, string name, string version, System.Threading.CancellationToken cancellationToken)
|
|
|
|
GetRaftItems(RaftItemType type)
|
Returns all of the items contained in the raft.
|
|
|
GetRaftItemsAsync(RaftItemType type, System.Threading.CancellationToken cancellationToken)
|
|
|
|
GetRaftItemVersions(RaftItemType type, string name)
|
|
|
|
GetRaftItemVersionsAsync(RaftItemType type, string name, System.Threading.CancellationToken cancellationToken)
|
|
|
|
GetVariables
|
Returns a dictionary containing all of the variables and their values in the raft.
|
|
|
GetVariablesAsync(System.Threading.CancellationToken cancellationToken)
|
|
|
|
SaveToZipAsync(System.IO.Stream stream, System.Threading.CancellationToken cancellationToken)
|
|
|
|
SetVariable(Inedo.ExecutionEngine.RuntimeVariableName name, string value)
|
|
|
|
SetVariableAsync(Inedo.ExecutionEngine.RuntimeVariableName name, string value, System.Threading.CancellationToken cancellationToken)
|
|
|
|
TestConfiguration
|
Validates the configuration of the raft based on its property values.
|
|
|
TestConfigurationAsync(System.Threading.CancellationToken cancellationToken)
|
|
|
|
WriteRaftItem(RaftItemType type, string name, string content, System.DateTimeOffset? timestamp, string userName)
|
|
|
|
WriteRaftItemAsync(RaftItemType type, string name, string content, System.DateTimeOffset? timestamp, string userName, System.Threading.CancellationToken cancellationToken)
|
|
|
|
WriteStandardVariableData(System.Collections.Generic.IReadOnlyDictionary<Inedo.ExecutionEngine.RuntimeVariableName, string> variables, System.IO.TextWriter textWriter)
|
|
