GrypeSettings Class

Summary

Contains the settings shared by all Grype commands (Grype's global flags).
graph BT Type-->Base0["ToolSettings"] Type["GrypeSettings"] class Type type-node Derived0["GrypeDbUpdateSettings"]-->Type click Derived0 "/api/Cake.Grype.Db/GrypeDbUpdateSettings" Derived1["GrypeDbImportSettings"]-->Type click Derived1 "/api/Cake.Grype.Db/GrypeDbImportSettings" Derived2["GrypeDbStatusSettings"]-->Type click Derived2 "/api/Cake.Grype.Db/GrypeDbStatusSettings" Derived3["GrypeDbCheckSettings"]-->Type click Derived3 "/api/Cake.Grype.Db/GrypeDbCheckSettings" Derived4["GrypeDbDeleteSettings"]-->Type click Derived4 "/api/Cake.Grype.Db/GrypeDbDeleteSettings" Derived5["GrypeVersionSettings"]-->Type click Derived5 "/api/Cake.Grype/GrypeVersionSettings" Derived6["GrypeScanSettings"]-->Type click Derived6 "/api/Cake.Grype.Scan/GrypeScanSettings"

Syntax

public class GrypeSettings : ToolSettings

Remarks

Grype settings that have no command-line flag, such as GRYPE_DB_AUTO_UPDATE, GRYPE_DB_CACHE_DIR or GRYPE_CHECK_FOR_APP_UPDATE, can be set through EnvironmentVariables.

Constructors

Name Summary
GrypeSettings()

Properties

Name Value Summary
ConfigFiles ICollection<FilePath>
Gets or sets the Grype configuration files to use (-c, repeatable). Relative paths are resolved against the working directory.
Profiles ICollection<string>
Gets or sets the configuration profiles to use (--profile, repeatable).
Quiet bool
Gets or sets a value indicating whether all logging output is suppressed (-q).
Verbosity GrypeVerbosity
Gets or sets the log verbosity (-v or -vv).

Extension Methods

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