IHasIssueFiltering Interface

Summary

Interface for settings that support issue filtering.
graph BT Type["IHasIssueFiltering"] class Type type-node Implementing0["IReportIssuesToBuildServerSettings"]-.->Type click Implementing0 "/api/Cake.Issues.BuildServer/IReportIssuesToBuildServerSettings" Implementing1["IReportIssuesToBuildServerFromIssueProviderSettings"]-.->Type click Implementing1 "/api/Cake.Issues.BuildServer/IReportIssuesToBuildServerFromIssueProviderSettings" Implementing2["ReportIssuesToBuildServerFromIssueProviderSettings"]-.->Type click Implementing2 "/api/Cake.Issues.BuildServer/ReportIssuesToBuildServerFromIssueProviderSettings" Implementing3["ReportIssuesToBuildServerSettings"]-.->Type click Implementing3 "/api/Cake.Issues.BuildServer/ReportIssuesToBuildServerSettings"

Syntax

public interface IHasIssueFiltering

Properties

Name Value Summary
IssueFilters IList<Func<IEnumerable<IIssue>, IEnumerable<IIssue>>>
Gets list of filter functions which should be applied before posting issues.
MaxIssuesToPost Nullable<int>
Gets or sets the global number of issues which should be posted at maximum over all IIssueProvider. Issues are filtered by Priority and issues with an AffectedFileRelativePath are prioritized. Default is null which won't set a global limit.
MaxIssuesToPostForEachIssueProvider Nullable<int>
Gets or sets the number of issues which should be posted at maximum for each IIssueProvider. Issues are filtered by Priority and issues with an AffectedFileRelativePath are prioritized. null won't limit issues per issue provider. Default is to filter to 100 issues for each issue provider.

Extension Methods

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