VagrantBoxUpdateSettings Class

Summary

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

Syntax

public class VagrantBoxUpdateSettings : IVagrantCommandSettings

Constructors

Properties

Name Value Summary
BoxName string
Name of a specific box to update.
Provider string
When BoxName is present, this controls what provider-specific box to update.

Methods

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

Extension Methods

Name Value Summary
Dump<VagrantBoxUpdateSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<VagrantBoxUpdateSettings>(VagrantBoxUpdateSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<VagrantBoxUpdateSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<VagrantBoxUpdateSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
OnlyUpdate(string) VagrantBoxUpdateSettings
Set the name of a specific box to update
Requires the Cake.Vagrant addin
ThrowIfNull<VagrantBoxUpdateSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<VagrantBoxUpdateSettings>(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
UseProvider(string) VagrantBoxUpdateSettings
Controls what provider-specific box to update
Requires the Cake.Vagrant addin