ExecutionSettings Class

Summary

Contains settings related to execution of the script.
Namespace
Cake.Core
Base Types
  • object
graph BT Type-->Base0["object"] Type["ExecutionSettings"] class Type type-node

Syntax

public sealed class ExecutionSettings

Constructors

Name Summary
ExecutionSettings() Initializes a new instance of the ExecutionSettings class.

Properties

Name Value Summary
Exclusive bool
Gets a value indicating whether or not to use the target exclusively.
Targets IEnumerable<string>
Gets the targets to be executed.

Methods

Name Value Summary
SetTarget(string) ExecutionSettings
Sets the target to be executed.
SetTargets(IEnumerable<string>) ExecutionSettings
Sets the targets to be executed.
UseExclusiveTarget() ExecutionSettings
Whether or not to use the target exclusively.

Extension Methods

Name Value Summary
Dump<ExecutionSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ExecutionSettings>(ExecutionSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<ExecutionSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<ExecutionSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<ExecutionSettings>(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
ThrowIfNull<ExecutionSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin