SkipDirective Class

Summary

Directive used to exclude objects from a sync operation, or it lets you use a skip rule to exclude actions from an operation.
Assembly
Cake.MsDeploy.dll
Namespace
Cake.MsDeploy.Directives
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IMsDeployArgument"] click Interface0 "/api/Cake.MsDeploy/IMsDeployArgument" Type["SkipDirective"] class Type type-node

Syntax

public class SkipDirective : IMsDeployArgument

Constructors

Name Summary
SkipDirective()

Properties

Name Value Summary
AbsolutePath string
Regular expression that will be used to match the absolute path of the object
KeyAttribute string
Regular expression that will be used to match the value of the key attribute of the object.
ObjectName string
Regular expression that will be used to match the object name
SkipAction Nullable<SkipAction>
Which action to skip
XPath string
XPath expression that identifies the object.

Methods

Name Value Summary
AppendCommandLineArgument(StringBuilder) void
Converts the object into its MSDeploy command line equivalent and Appends it to the stringbuilder
ToCommandLineArgument() string
Converts the SkipDirective into its commmand line argument

Extension Methods

Name Value Summary
Dump<SkipDirective>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<SkipDirective>(SkipDirective[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<SkipDirective>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<SkipDirective>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<SkipDirective>(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<SkipDirective>(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