VagrantBoxRemoveSettings Class

This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Vagrant.

Summary

Additional settings for the vagrant box remove command

Assembly

Cake.Vagrant.dll

Namespace

Cake.Vagrant.Settings

Interfaces

IVagrantCommandSettings

Base Types

Object

graph BT Type-->Base0["Object"] Type-.->Interface0["IVagrantCommandSettings"] Type["VagrantBoxRemoveSettings"] class Type type-node

Syntax

public class VagrantBoxRemoveSettings : IVagrantCommandSettings

Constructors

Name	Summary
VagrantBoxRemoveSettings()

Properties

Name	Value	Summary
BoxVersion	string	Version of version constraints of the boxes to remove. See `Version` for more details.
Force	Nullable<bool>	Forces removing the box even if an active Vagrant environment is using it.
Provider	string	The provider-specific box to remove with the given name.
RemoveAll	Nullable<bool>	Remove all available versions of a box.

Methods

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

Extension Methods

Name	Value	Summary
ConstrainVersion(string)	VagrantBoxRemoveSettings	Sets the version constraint for the box to remove From VagrantBoxRemoveSettingsExtensions Requires the Cake.Vagrant addin
Dump<VagrantBoxRemoveSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
Force(bool)	VagrantBoxRemoveSettings	Forces removing the box even if an active Vagrant environment is using it. From VagrantBoxRemoveSettingsExtensions Requires the Cake.Vagrant addin
IsIn<VagrantBoxRemoveSettings>(VagrantBoxRemoveSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<VagrantBoxRemoveSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<VagrantBoxRemoveSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
RemoveAll()	VagrantBoxRemoveSettings	Remove all available versions of a box. From VagrantBoxRemoveSettingsExtensions Requires the Cake.Vagrant addin
ThrowIfNull<VagrantBoxRemoveSettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<VagrantBoxRemoveSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin
UseProvider(string)	VagrantBoxRemoveSettings	The provider-specific box to remove with the given name. From VagrantBoxRemoveSettingsExtensions Requires the Cake.Vagrant addin