CodeQLSecurityReportToolSettings Class

Summary

Tool for generating report
Assembly
Cake.CodeQL.Cli.dll
Namespace
Cake.CodeQL.Cli.Report
Base Types
  • ToolSettings
graph BT Type-->Base0["ToolSettings"] Type["CodeQLSecurityReportToolSettings"] class Type type-node

Syntax

public class CodeQLSecurityReportToolSettings : ToolSettings

Constructors

Name Summary
CodeQLSecurityReportToolSettings()

Properties

Name Value Summary
GitHubApiUrl string
GitHub API URL. Defaults to "https://api.github.com"
GitHubToken string
The GitHub Personal Access Token that has the necessary access for security and dependency API endpoints.
OutputDirectory DirectoryPath
The directory to output the PDF report to. This will be created if it does not exist. Defaults to "./".
RedirectStandardError bool
Gets or sets the process option to redirect standard error
RedirectStandardOutput bool
Gets or sets the process option to redirect standard output
Repository string
The repository that contains the source code, in <owner>/<repository_name><owner>/<repository_name> form, e.g. peter-murray/node-hue-api
SarifReportDirectory DirectoryPath
The directory containing the SARIF report files. Defaults to "../results";
Template Nullable<Template>
The report template type used to render the report.

Extension Methods

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