VagrantPluginInstallSettings Class

Summary

Additional settings for the vagrant plugin install command.
Assembly
Cake.Vagrant.dll
Namespace
Cake.Vagrant.Settings
Interfaces
  • IVagrantCommandSettings
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IVagrantCommandSettings"] Type["VagrantPluginInstallSettings"] class Type type-node

Syntax

public class VagrantPluginInstallSettings : IVagrantCommandSettings

Constructors

Properties

Name Value Summary
CleanSources Nullable<bool>
Clears all sources that have been defined so far.
EntryPoint string
If the plugin you are installing has another entrypoint, this flag can be used to specify it.
Source string
Adds a source from which to fetch a plugin.
Version string
The version of the plugin to install. By default, this command will install the latest version.

Methods

Name Value Summary
GetToolArguments() Action<ProcessArgumentBuilder>
Gets the command arguments corresponding to the specified IVagrantCommandSettings

Extension Methods

Name Value Summary
CleanFirst(bool) VagrantPluginInstallSettings
Clears all sources that have been defined so far.
Requires the Cake.Vagrant addin
ConstrainVersion(string) VagrantPluginInstallSettings
The version of the plugin to install.
Requires the Cake.Vagrant addin
Dump<VagrantPluginInstallSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
FromSource(string) VagrantPluginInstallSettings
Adds a source from which to fetch a plugin.
Requires the Cake.Vagrant addin
IsIn<VagrantPluginInstallSettings>(VagrantPluginInstallSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<VagrantPluginInstallSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<VagrantPluginInstallSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
SetEntryPoint(string) VagrantPluginInstallSettings
Sets the EntryPoint for a plugin.
Requires the Cake.Vagrant addin
ThrowIfNull<VagrantPluginInstallSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<VagrantPluginInstallSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin