NamedArgument Class

Summary

Represents a named argument and its value.
Assembly
Cake.Powershell.dll
Namespace
Cake.Powershell
Interfaces
  • IProcessArgument
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IProcessArgument"] Type["NamedArgument"] class Type type-node

Syntax

public sealed class NamedArgument : IProcessArgument

Constructors

Name Summary
NamedArgument(string, IProcessArgument) Initializes a new instance of the NamedArgument class.
NamedArgument(string, IProcessArgument, string) Initializes a new instance of the NamedArgument class.

Properties

Name Value Summary
Format string
Gets or sets the format of the argument

Methods

Name Value Summary
Render() string
Render the arguments as a string.
RenderSafe() string
Renders the argument as a string. Sensitive information will be redacted.
ToString() string
Returns a string that represents this instance.

Extension Methods

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