CodeQLToolSettings Class

Summary

Base class for all CodeQL cli tools.
graph BT Type-->Base0["ToolSettings"] Type["CodeQLToolSettings"] class Type type-node Derived0["CodeQLUploadResultsToolSettings"]-->Type click Derived0 "/api/Cake.CodeQL.Cli.Upload/CodeQLUploadResultsToolSettings" Derived1["CodeQLAnalyzeDatabaseToolSettings"]-->Type click Derived1 "/api/Cake.CodeQL.Cli.Database/CodeQLAnalyzeDatabaseToolSettings" Derived2["CodeQLCreateDatabaseToolSettings"]-->Type click Derived2 "/api/Cake.CodeQL.Cli.Database/CodeQLCreateDatabaseToolSettings"

Syntax

public abstract class CodeQLToolSettings : ToolSettings

Constructors

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

Properties

Name Value Summary
Command string
Gets the command which should be run.
RedirectStandardError bool
Gets or sets the process option to redirect standard error
RedirectStandardOutput bool
Gets or sets the process option to redirect standard output

Methods

Name Value Summary
EvaluateCore(ProcessArgumentBuilder) void
Evaluates the settings and writes them to args.

Extension Methods

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