Invocation (com.contrastsecurity:java-sarif 1.0 API)

java.lang.Object
- com.contrastsecurity.sarif.Invocation

```
public class Invocation
extends Object
```
The runtime environment of the analysis tool run.

Constructor Summary

Constructors
Constructor and Description

Invocation()

Constructors
Constructor and Description
`Invocation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`String`	`getAccount()` The account under which the invocation occurred.
`List<String>`	`getArguments()` An array of strings, containing in order the command line arguments passed to the tool from the operating system.
`String`	`getCommandLine()` The command line used to invoke the tool.
`Date`	`getEndTimeUtc()` The Coordinated Universal Time (UTC) date and time at which the invocation ended.
`EnvironmentVariables`	`getEnvironmentVariables()` The environment variables associated with the analysis tool process, expressed as key/value pairs.
`ArtifactLocation`	`getExecutableLocation()` Specifies the location of an artifact.
`Boolean`	`getExecutionSuccessful()` Specifies whether the tool's execution completed successfully.
`Integer`	`getExitCode()` The process exit code.
`String`	`getExitCodeDescription()` The reason for the process exit.
`String`	`getExitSignalName()` The name of the signal that caused the process to exit.
`Integer`	`getExitSignalNumber()` The numeric value of the signal that caused the process to exit.
`String`	`getMachine()` The machine on which the invocation occurred.
`Set<ConfigurationOverride>`	`getNotificationConfigurationOverrides()` An array of configurationOverride objects that describe notifications related runtime overrides.
`Integer`	`getProcessId()` The id of the process in which the invocation occurred.
`String`	`getProcessStartFailureMessage()` The reason given by the operating system that the process failed to start.
`PropertyBag`	`getProperties()` Key/value pairs that provide additional information about the object.
`Set<ArtifactLocation>`	`getResponseFiles()` The locations of any response files specified on the tool's command line.
`Set<ConfigurationOverride>`	`getRuleConfigurationOverrides()` An array of configurationOverride objects that describe rules related runtime overrides.
`Date`	`getStartTimeUtc()` The Coordinated Universal Time (UTC) date and time at which the invocation started.
`ArtifactLocation`	`getStderr()` Specifies the location of an artifact.
`ArtifactLocation`	`getStdin()` Specifies the location of an artifact.
`ArtifactLocation`	`getStdout()` Specifies the location of an artifact.
`ArtifactLocation`	`getStdoutStderr()` Specifies the location of an artifact.
`List<Notification>`	`getToolConfigurationNotifications()` A list of conditions detected by the tool that are relevant to the tool's configuration.
`List<Notification>`	`getToolExecutionNotifications()` A list of runtime conditions detected by the tool during the analysis.
`ArtifactLocation`	`getWorkingDirectory()` Specifies the location of an artifact.
`int`	`hashCode()`
`void`	`setAccount(String account)` The account under which the invocation occurred.
`void`	`setArguments(List<String> arguments)` An array of strings, containing in order the command line arguments passed to the tool from the operating system.
`void`	`setCommandLine(String commandLine)` The command line used to invoke the tool.
`void`	`setEndTimeUtc(Date endTimeUtc)` The Coordinated Universal Time (UTC) date and time at which the invocation ended.
`void`	`setEnvironmentVariables(EnvironmentVariables environmentVariables)` The environment variables associated with the analysis tool process, expressed as key/value pairs.
`void`	`setExecutableLocation(ArtifactLocation executableLocation)` Specifies the location of an artifact.
`void`	`setExecutionSuccessful(Boolean executionSuccessful)` Specifies whether the tool's execution completed successfully.
`void`	`setExitCode(Integer exitCode)` The process exit code.
`void`	`setExitCodeDescription(String exitCodeDescription)` The reason for the process exit.
`void`	`setExitSignalName(String exitSignalName)` The name of the signal that caused the process to exit.
`void`	`setExitSignalNumber(Integer exitSignalNumber)` The numeric value of the signal that caused the process to exit.
`void`	`setMachine(String machine)` The machine on which the invocation occurred.
`void`	`setNotificationConfigurationOverrides(Set<ConfigurationOverride> notificationConfigurationOverrides)` An array of configurationOverride objects that describe notifications related runtime overrides.
`void`	`setProcessId(Integer processId)` The id of the process in which the invocation occurred.
`void`	`setProcessStartFailureMessage(String processStartFailureMessage)` The reason given by the operating system that the process failed to start.
`void`	`setProperties(PropertyBag properties)` Key/value pairs that provide additional information about the object.
`void`	`setResponseFiles(Set<ArtifactLocation> responseFiles)` The locations of any response files specified on the tool's command line.
`void`	`setRuleConfigurationOverrides(Set<ConfigurationOverride> ruleConfigurationOverrides)` An array of configurationOverride objects that describe rules related runtime overrides.
`void`	`setStartTimeUtc(Date startTimeUtc)` The Coordinated Universal Time (UTC) date and time at which the invocation started.
`void`	`setStderr(ArtifactLocation stderr)` Specifies the location of an artifact.
`void`	`setStdin(ArtifactLocation stdin)` Specifies the location of an artifact.
`void`	`setStdout(ArtifactLocation stdout)` Specifies the location of an artifact.
`void`	`setStdoutStderr(ArtifactLocation stdoutStderr)` Specifies the location of an artifact.
`void`	`setToolConfigurationNotifications(List<Notification> toolConfigurationNotifications)` A list of conditions detected by the tool that are relevant to the tool's configuration.
`void`	`setToolExecutionNotifications(List<Notification> toolExecutionNotifications)` A list of runtime conditions detected by the tool during the analysis.
`void`	`setWorkingDirectory(ArtifactLocation workingDirectory)` Specifies the location of an artifact.
`String`	`toString()`
`Invocation`	`withAccount(String account)`
`Invocation`	`withArguments(List<String> arguments)`
`Invocation`	`withCommandLine(String commandLine)`
`Invocation`	`withEndTimeUtc(Date endTimeUtc)`
`Invocation`	`withEnvironmentVariables(EnvironmentVariables environmentVariables)`
`Invocation`	`withExecutableLocation(ArtifactLocation executableLocation)`
`Invocation`	`withExecutionSuccessful(Boolean executionSuccessful)`
`Invocation`	`withExitCode(Integer exitCode)`
`Invocation`	`withExitCodeDescription(String exitCodeDescription)`
`Invocation`	`withExitSignalName(String exitSignalName)`
`Invocation`	`withExitSignalNumber(Integer exitSignalNumber)`
`Invocation`	`withMachine(String machine)`
`Invocation`	`withNotificationConfigurationOverrides(Set<ConfigurationOverride> notificationConfigurationOverrides)`
`Invocation`	`withProcessId(Integer processId)`
`Invocation`	`withProcessStartFailureMessage(String processStartFailureMessage)`
`Invocation`	`withProperties(PropertyBag properties)`
`Invocation`	`withResponseFiles(Set<ArtifactLocation> responseFiles)`
`Invocation`	`withRuleConfigurationOverrides(Set<ConfigurationOverride> ruleConfigurationOverrides)`
`Invocation`	`withStartTimeUtc(Date startTimeUtc)`
`Invocation`	`withStderr(ArtifactLocation stderr)`
`Invocation`	`withStdin(ArtifactLocation stdin)`
`Invocation`	`withStdout(ArtifactLocation stdout)`
`Invocation`	`withStdoutStderr(ArtifactLocation stdoutStderr)`
`Invocation`	`withToolConfigurationNotifications(List<Notification> toolConfigurationNotifications)`
`Invocation`	`withToolExecutionNotifications(List<Notification> toolExecutionNotifications)`
`Invocation`	`withWorkingDirectory(ArtifactLocation workingDirectory)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Invocation
```
public Invocation()
```
- Method Detail
  - getCommandLine
```
public String getCommandLine()
```
    The command line used to invoke the tool.
  - setCommandLine
```
public void setCommandLine(String commandLine)
```
    The command line used to invoke the tool.
  - withCommandLine
```
public Invocation withCommandLine(String commandLine)
```
  - getArguments
```
public List<String> getArguments()
```
    An array of strings, containing in order the command line arguments passed to the tool from the operating system.
  - setArguments
```
public void setArguments(List<String> arguments)
```
    An array of strings, containing in order the command line arguments passed to the tool from the operating system.
  - withArguments
```
public Invocation withArguments(List<String> arguments)
```
  - getResponseFiles
```
public Set<ArtifactLocation> getResponseFiles()
```
    The locations of any response files specified on the tool's command line.
  - setResponseFiles
```
public void setResponseFiles(Set<ArtifactLocation> responseFiles)
```
    The locations of any response files specified on the tool's command line.
  - withResponseFiles
```
public Invocation withResponseFiles(Set<ArtifactLocation> responseFiles)
```
  - getStartTimeUtc
```
public Date getStartTimeUtc()
```
    The Coordinated Universal Time (UTC) date and time at which the invocation started. See "Date/time properties" in the SARIF spec for the required format.
  - setStartTimeUtc
```
public void setStartTimeUtc(Date startTimeUtc)
```
    The Coordinated Universal Time (UTC) date and time at which the invocation started. See "Date/time properties" in the SARIF spec for the required format.
  - withStartTimeUtc
```
public Invocation withStartTimeUtc(Date startTimeUtc)
```
  - getEndTimeUtc
```
public Date getEndTimeUtc()
```
    The Coordinated Universal Time (UTC) date and time at which the invocation ended. See "Date/time properties" in the SARIF spec for the required format.
  - setEndTimeUtc
```
public void setEndTimeUtc(Date endTimeUtc)
```
    The Coordinated Universal Time (UTC) date and time at which the invocation ended. See "Date/time properties" in the SARIF spec for the required format.
  - withEndTimeUtc
```
public Invocation withEndTimeUtc(Date endTimeUtc)
```
  - getExitCode
```
public Integer getExitCode()
```
    The process exit code.
  - setExitCode
```
public void setExitCode(Integer exitCode)
```
    The process exit code.
  - withExitCode
```
public Invocation withExitCode(Integer exitCode)
```
  - getRuleConfigurationOverrides
```
public Set<ConfigurationOverride> getRuleConfigurationOverrides()
```
    An array of configurationOverride objects that describe rules related runtime overrides.
  - setRuleConfigurationOverrides
```
public void setRuleConfigurationOverrides(Set<ConfigurationOverride> ruleConfigurationOverrides)
```
    An array of configurationOverride objects that describe rules related runtime overrides.
  - withRuleConfigurationOverrides
```
public Invocation withRuleConfigurationOverrides(Set<ConfigurationOverride> ruleConfigurationOverrides)
```
  - getNotificationConfigurationOverrides
```
public Set<ConfigurationOverride> getNotificationConfigurationOverrides()
```
    An array of configurationOverride objects that describe notifications related runtime overrides.
  - setNotificationConfigurationOverrides
```
public void setNotificationConfigurationOverrides(Set<ConfigurationOverride> notificationConfigurationOverrides)
```
    An array of configurationOverride objects that describe notifications related runtime overrides.
  - withNotificationConfigurationOverrides
```
public Invocation withNotificationConfigurationOverrides(Set<ConfigurationOverride> notificationConfigurationOverrides)
```
  - getToolExecutionNotifications
```
public List<Notification> getToolExecutionNotifications()
```
    A list of runtime conditions detected by the tool during the analysis.
  - setToolExecutionNotifications
```
public void setToolExecutionNotifications(List<Notification> toolExecutionNotifications)
```
    A list of runtime conditions detected by the tool during the analysis.
  - withToolExecutionNotifications
```
public Invocation withToolExecutionNotifications(List<Notification> toolExecutionNotifications)
```
  - getToolConfigurationNotifications
```
public List<Notification> getToolConfigurationNotifications()
```
    A list of conditions detected by the tool that are relevant to the tool's configuration.
  - setToolConfigurationNotifications
```
public void setToolConfigurationNotifications(List<Notification> toolConfigurationNotifications)
```
    A list of conditions detected by the tool that are relevant to the tool's configuration.
  - withToolConfigurationNotifications
```
public Invocation withToolConfigurationNotifications(List<Notification> toolConfigurationNotifications)
```
  - getExitCodeDescription
```
public String getExitCodeDescription()
```
    The reason for the process exit.
  - setExitCodeDescription
```
public void setExitCodeDescription(String exitCodeDescription)
```
    The reason for the process exit.
  - withExitCodeDescription
```
public Invocation withExitCodeDescription(String exitCodeDescription)
```
  - getExitSignalName
```
public String getExitSignalName()
```
    The name of the signal that caused the process to exit.
  - setExitSignalName
```
public void setExitSignalName(String exitSignalName)
```
    The name of the signal that caused the process to exit.
  - withExitSignalName
```
public Invocation withExitSignalName(String exitSignalName)
```
  - getExitSignalNumber
```
public Integer getExitSignalNumber()
```
    The numeric value of the signal that caused the process to exit.
  - setExitSignalNumber
```
public void setExitSignalNumber(Integer exitSignalNumber)
```
    The numeric value of the signal that caused the process to exit.
  - withExitSignalNumber
```
public Invocation withExitSignalNumber(Integer exitSignalNumber)
```
  - getProcessStartFailureMessage
```
public String getProcessStartFailureMessage()
```
    The reason given by the operating system that the process failed to start.
  - setProcessStartFailureMessage
```
public void setProcessStartFailureMessage(String processStartFailureMessage)
```
    The reason given by the operating system that the process failed to start.
  - withProcessStartFailureMessage
```
public Invocation withProcessStartFailureMessage(String processStartFailureMessage)
```
  - getExecutionSuccessful
```
public Boolean getExecutionSuccessful()
```
    Specifies whether the tool's execution completed successfully. (Required)
  - setExecutionSuccessful
```
public void setExecutionSuccessful(Boolean executionSuccessful)
```
    Specifies whether the tool's execution completed successfully. (Required)
  - withExecutionSuccessful
```
public Invocation withExecutionSuccessful(Boolean executionSuccessful)
```
  - getMachine
```
public String getMachine()
```
    The machine on which the invocation occurred.
  - setMachine
```
public void setMachine(String machine)
```
    The machine on which the invocation occurred.
  - withMachine
```
public Invocation withMachine(String machine)
```
  - getAccount
```
public String getAccount()
```
    The account under which the invocation occurred.
  - setAccount
```
public void setAccount(String account)
```
    The account under which the invocation occurred.
  - withAccount
```
public Invocation withAccount(String account)
```
  - getProcessId
```
public Integer getProcessId()
```
    The id of the process in which the invocation occurred.
  - setProcessId
```
public void setProcessId(Integer processId)
```
    The id of the process in which the invocation occurred.
  - withProcessId
```
public Invocation withProcessId(Integer processId)
```
  - getExecutableLocation
```
public ArtifactLocation getExecutableLocation()
```
    Specifies the location of an artifact.
  - setExecutableLocation
```
public void setExecutableLocation(ArtifactLocation executableLocation)
```
    Specifies the location of an artifact.
  - withExecutableLocation
```
public Invocation withExecutableLocation(ArtifactLocation executableLocation)
```
  - getWorkingDirectory
```
public ArtifactLocation getWorkingDirectory()
```
    Specifies the location of an artifact.
  - setWorkingDirectory
```
public void setWorkingDirectory(ArtifactLocation workingDirectory)
```
    Specifies the location of an artifact.
  - withWorkingDirectory
```
public Invocation withWorkingDirectory(ArtifactLocation workingDirectory)
```
  - getEnvironmentVariables
```
public EnvironmentVariables getEnvironmentVariables()
```
    The environment variables associated with the analysis tool process, expressed as key/value pairs.
  - setEnvironmentVariables
```
public void setEnvironmentVariables(EnvironmentVariables environmentVariables)
```
    The environment variables associated with the analysis tool process, expressed as key/value pairs.
  - withEnvironmentVariables
```
public Invocation withEnvironmentVariables(EnvironmentVariables environmentVariables)
```
  - getStdin
```
public ArtifactLocation getStdin()
```
    Specifies the location of an artifact.
  - setStdin
```
public void setStdin(ArtifactLocation stdin)
```
    Specifies the location of an artifact.
  - withStdin
```
public Invocation withStdin(ArtifactLocation stdin)
```
  - getStdout
```
public ArtifactLocation getStdout()
```
    Specifies the location of an artifact.
  - setStdout
```
public void setStdout(ArtifactLocation stdout)
```
    Specifies the location of an artifact.
  - withStdout
```
public Invocation withStdout(ArtifactLocation stdout)
```
  - getStderr
```
public ArtifactLocation getStderr()
```
    Specifies the location of an artifact.
  - setStderr
```
public void setStderr(ArtifactLocation stderr)
```
    Specifies the location of an artifact.
  - withStderr
```
public Invocation withStderr(ArtifactLocation stderr)
```
  - getStdoutStderr
```
public ArtifactLocation getStdoutStderr()
```
    Specifies the location of an artifact.
  - setStdoutStderr
```
public void setStdoutStderr(ArtifactLocation stdoutStderr)
```
    Specifies the location of an artifact.
  - withStdoutStderr
```
public Invocation withStdoutStderr(ArtifactLocation stdoutStderr)
```
  - getProperties
```
public PropertyBag getProperties()
```
    Key/value pairs that provide additional information about the object.
  - setProperties
```
public void setProperties(PropertyBag properties)
```
    Key/value pairs that provide additional information about the object.
  - withProperties
```
public Invocation withProperties(PropertyBag properties)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object

Class Invocation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Invocation

Method Detail

getCommandLine

setCommandLine

withCommandLine

getArguments

setArguments

withArguments

getResponseFiles

setResponseFiles

withResponseFiles

getStartTimeUtc

setStartTimeUtc

withStartTimeUtc

getEndTimeUtc

setEndTimeUtc

withEndTimeUtc

getExitCode

setExitCode

withExitCode

getRuleConfigurationOverrides

setRuleConfigurationOverrides

withRuleConfigurationOverrides

getNotificationConfigurationOverrides

setNotificationConfigurationOverrides

withNotificationConfigurationOverrides

getToolExecutionNotifications

setToolExecutionNotifications

withToolExecutionNotifications

getToolConfigurationNotifications

setToolConfigurationNotifications

withToolConfigurationNotifications

getExitCodeDescription

setExitCodeDescription

withExitCodeDescription

getExitSignalName

setExitSignalName

withExitSignalName

getExitSignalNumber

setExitSignalNumber

withExitSignalNumber

getProcessStartFailureMessage

setProcessStartFailureMessage

withProcessStartFailureMessage

getExecutionSuccessful

setExecutionSuccessful

withExecutionSuccessful

getMachine

setMachine

withMachine

getAccount

setAccount

withAccount

getProcessId

setProcessId

withProcessId

getExecutableLocation

setExecutableLocation

withExecutableLocation

getWorkingDirectory

setWorkingDirectory

withWorkingDirectory

getEnvironmentVariables

setEnvironmentVariables

withEnvironmentVariables

getStdin

setStdin

withStdin

getStdout

setStdout

withStdout

getStderr

setStderr

withStderr

getStdoutStderr