Invocation

@JsonClass(generateAdapter = true)
data class Invocation(@Json(name = "account") val account: String? = null, @Json(name = "arguments") val arguments: List<String>? = null, @Json(name = "commandLine") val commandLine: String? = null, @Json(name = "endTimeUtc") val endTimeUTC: String? = null, @Json(name = "environmentVariables") val environmentVariables: Map<String, String>? = null, @Json(name = "executableLocation") val executableLocation: ArtifactLocation? = null, @Json(name = "executionSuccessful") val executionSuccessful: Boolean, @Json(name = "exitCode") val exitCode: Int? = null, @Json(name = "exitCodeDescription") val exitCodeDescription: String? = null, @Json(name = "exitSignalName") val exitSignalName: String? = null, @Json(name = "exitSignalNumber") val exitSignalNumber: Int? = null, @Json(name = "machine") val machine: String? = null, @Json(name = "notificationConfigurationOverrides") val notificationConfigurationOverrides: List<ConfigurationOverride>? = null, @Json(name = "processId") val processID: Int? = null, @Json(name = "processStartFailureMessage") val processStartFailureMessage: String? = null, @Json(name = "properties") val properties: PropertyBag? = null, @Json(name = "responseFiles") val responseFiles: List<ArtifactLocation>? = null, @Json(name = "ruleConfigurationOverrides") val ruleConfigurationOverrides: List<ConfigurationOverride>? = null, @Json(name = "startTimeUtc") val startTimeUTC: String? = null, @Json(name = "stderr") val stderr: ArtifactLocation? = null, @Json(name = "stdin") val stdin: ArtifactLocation? = null, @Json(name = "stdout") val stdout: ArtifactLocation? = null, @Json(name = "stdoutStderr") val stdoutStderr: ArtifactLocation? = null, @Json(name = "toolConfigurationNotifications") val toolConfigurationNotifications: List<Notification>? = null, @Json(name = "toolExecutionNotifications") val toolExecutionNotifications: List<Notification>? = null, @Json(name = "workingDirectory") val workingDirectory: ArtifactLocation? = null)(source)

An invocation object that describes the invocation of the converter.

The runtime environment of the analysis tool run.

Since

0.12.0

Constructors

Link copied to clipboard
constructor(@Json(name = "account") account: String? = null, @Json(name = "arguments") arguments: List<String>? = null, @Json(name = "commandLine") commandLine: String? = null, @Json(name = "endTimeUtc") endTimeUTC: String? = null, @Json(name = "environmentVariables") environmentVariables: Map<String, String>? = null, @Json(name = "executableLocation") executableLocation: ArtifactLocation? = null, @Json(name = "executionSuccessful") executionSuccessful: Boolean, @Json(name = "exitCode") exitCode: Int? = null, @Json(name = "exitCodeDescription") exitCodeDescription: String? = null, @Json(name = "exitSignalName") exitSignalName: String? = null, @Json(name = "exitSignalNumber") exitSignalNumber: Int? = null, @Json(name = "machine") machine: String? = null, @Json(name = "notificationConfigurationOverrides") notificationConfigurationOverrides: List<ConfigurationOverride>? = null, @Json(name = "processId") processID: Int? = null, @Json(name = "processStartFailureMessage") processStartFailureMessage: String? = null, @Json(name = "properties") properties: PropertyBag? = null, @Json(name = "responseFiles") responseFiles: List<ArtifactLocation>? = null, @Json(name = "ruleConfigurationOverrides") ruleConfigurationOverrides: List<ConfigurationOverride>? = null, @Json(name = "startTimeUtc") startTimeUTC: String? = null, @Json(name = "stderr") stderr: ArtifactLocation? = null, @Json(name = "stdin") stdin: ArtifactLocation? = null, @Json(name = "stdout") stdout: ArtifactLocation? = null, @Json(name = "stdoutStderr") stdoutStderr: ArtifactLocation? = null, @Json(name = "toolConfigurationNotifications") toolConfigurationNotifications: List<Notification>? = null, @Json(name = "toolExecutionNotifications") toolExecutionNotifications: List<Notification>? = null, @Json(name = "workingDirectory") workingDirectory: ArtifactLocation? = null)

Properties

Link copied to clipboard
val account: String? = null

The account that ran the analysis tool.

Link copied to clipboard
val arguments: List<String>? = null

An array of strings, containing in order the command line arguments passed to the tool from the operating system.

Link copied to clipboard
val commandLine: String? = null

The command line used to invoke the tool.

Link copied to clipboard
val endTimeUTC: String? = null

The Coordinated Universal Time (UTC) date and time at which the run ended. See "Date/time properties" in the SARIF spec for the required format.

Link copied to clipboard

The environment variables associated with the analysis tool process, expressed as key/value pairs.

Link copied to clipboard

An absolute URI specifying the location of the analysis tool's executable.

Link copied to clipboard

Specifies whether the tool's execution completed successfully.

Link copied to clipboard
val exitCode: Int? = null

The process exit code.

Link copied to clipboard

The reason for the process exit.

Link copied to clipboard
val exitSignalName: String? = null

The name of the signal that caused the process to exit.

Link copied to clipboard
val exitSignalNumber: Int? = null

The numeric value of the signal that caused the process to exit.

Link copied to clipboard
val machine: String? = null

The machine that hosted the analysis tool run.

Link copied to clipboard

An array of configurationOverride objects that describe notifications related runtime overrides.

Link copied to clipboard
val processID: Int? = null

The process id for the analysis tool run.

Link copied to clipboard

The reason given by the operating system that the process failed to start.

Link copied to clipboard
val properties: PropertyBag? = null

Key/value pairs that provide additional information about the invocation.

Link copied to clipboard

The locations of any response files specified on the tool's command line.

Link copied to clipboard

An array of configurationOverride objects that describe rules related runtime overrides.

Link copied to clipboard
val startTimeUTC: String? = null

The Coordinated Universal Time (UTC) date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.

Link copied to clipboard

A file containing the standard error stream from the process that was invoked.

Link copied to clipboard
val stdin: ArtifactLocation? = null

A file containing the standard input stream to the process that was invoked.

Link copied to clipboard

A file containing the standard output stream from the process that was invoked.

Link copied to clipboard

A file containing the interleaved standard output and standard error stream from the process that was invoked.

Link copied to clipboard

A list of conditions detected by the tool that are relevant to the tool's configuration.

Link copied to clipboard

A list of runtime conditions detected by the tool during the analysis.

Link copied to clipboard

The working directory for the analysis tool run.