GrypeOutput Class

Summary

One Grype report output (-o format or -o format=file). Several outputs can be written by one scan, for example the table to the terminal and JSON to a file.
Assembly
Cake.Grype.dll
Namespace
Cake.Grype.Scan
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["GrypeOutput"] class Type type-node

Syntax

public sealed class GrypeOutput

Properties

Name Value Summary
File FilePath
Gets the file the report is written to, or null for standard output.
Format GrypeOutputFormat
Gets the report format.

Methods

Name Value Summary
CycloneDx(FilePath) GrypeOutput
The CycloneDX XML format.
static
CycloneDxJson(FilePath) GrypeOutput
The CycloneDX JSON format.
static
Json(FilePath) GrypeOutput
Grype's native JSON format.
static
Sarif(FilePath) GrypeOutput
The SARIF format.
static
Table(FilePath) GrypeOutput
The table format.
static
Template(FilePath) GrypeOutput
The Go template format; set Template too.
static

Extension Methods

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