KeyValueArgument 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.Powershell.

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["KeyValueArgument"] class Type type-node

Syntax

public sealed class KeyValueArgument : IProcessArgument

Constructors

Name	Summary
KeyValueArgument(string, TextArgument, string)	Initializes a new instance of the `KeyValueArgument` class.
KeyValueArgument(string, TextArgument)	Initializes a new instance of the `KeyValueArgument` 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<KeyValueArgument>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<KeyValueArgument>(KeyValueArgument[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<KeyValueArgument>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<KeyValueArgument>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<KeyValueArgument>(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<KeyValueArgument>(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