Otter SDK Reference

Version:

EnsureOperation Class

An operation that will collect information and configure a server based on a template configuration.

Inheritance Hierarchy

object
- Inedo.Otter.Extensibility.Operations.Operation
  - Inedo.Otter.Extensibility.Operations.EnsureOperation
    - Inedo.Otter.Extensibility.Operations.EnsureOperation<TConfig>
    - Inedo.Otter.Extensibility.Operations.RemoteEnsureOperation

Syntax

public class EnsureOperation : Operation, Inedo.Diagnostics.ILogger, IComparingOperation, ICollectingOperation, IExecutingOperation

Constructors

	Name	Description
	EnsureOperation	Initializes a new instance of the EnsureOperation class.

Methods

	Name	Description
	AddCustomInputStateValues(Inedo.ExecutionEngine.Mapping.OperationInputState state)	When implemented in a derived class, adds additional values to the unique input state key for the operation.
	CollectAsync(IOperationExecutionContext context)	Collects configuration from a server.
	Compare(Inedo.Otter.Extensibility.Configurations.PersistedConfiguration other)	Compares collected configuration from a server against the operation's current configuration.
	Complete	Returns a System.Threading.Tasks.Task that can be returned from the ConfigureAsync(IOperationExecutionContext context) method to indicate that the operation completed synchronously.
	Complete(Inedo.Otter.Extensibility.Configurations.PersistedConfiguration config)	Returns a System.Threading.Tasks.Task`1 that can be returned from the CollectAsync(IOperationExecutionContext context) method to indicate that the operation completed synchronously.
	ConfigureAsync(IOperationExecutionContext context)	Configures a server.
	GetConfigurationTemplate	Gets the desired state of a configuration.
	Store(Inedo.Otter.Extensibility.Configurations.PersistedConfiguration config, Inedo.Otter.Extensibility.Configurations.ConfigurationPersistenceContext context)	Stores the specified configuration.
	StoreConfigurationStatus(Inedo.Otter.Extensibility.Configurations.PersistedConfiguration actual, Inedo.Otter.Extensibility.Configurations.ComparisonResult results, Inedo.Otter.Extensibility.Configurations.ConfigurationPersistenceContext context)	Stores the configuration status based on a comparison of the operation's template configuration.