IssueProviderSettings Class

Summary

Base settings for an BaseConfigurableIssueProvider<T>.
graph BT Type-->Base0["Object"] Type["IssueProviderSettings"] class Type type-node Derived0["DocFxIssuesSettings"]-->Type click Derived0 "/api/Cake.Issues.DocFx/DocFxIssuesSettings" Derived1["BaseMultiFormatIssueProviderSettings<TIssueProvider, TSettings>"]-->Type click Derived1 "/api/Cake.Issues/BaseMultiFormatIssueProviderSettings_2" Derived2["SarifIssuesSettings"]-->Type click Derived2 "/api/Cake.Issues.Sarif/SarifIssuesSettings" Derived3["InspectCodeIssuesSettings"]-->Type click Derived3 "/api/Cake.Issues.InspectCode/InspectCodeIssuesSettings" Derived4["TerraformIssuesSettings"]-->Type click Derived4 "/api/Cake.Issues.Terraform/TerraformIssuesSettings" Derived5["DupFinderIssuesSettings"]-->Type click Derived5 "/api/Cake.Issues.DupFinder/DupFinderIssuesSettings"

Syntax

public class IssueProviderSettings

Constructors

Name Summary
IssueProviderSettings(byte[]) Initializes a new instance of the IssueProviderSettings class for a log file content in memory.
IssueProviderSettings(FilePath) Initializes a new instance of the IssueProviderSettings class for reading a log file on disk.

Properties

Name Value Summary
LogFileContent byte[]
Gets the content of the log file.

Extension Methods

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