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

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

```
public class Run
extends Object
```
Describes a single run of an analysis tool, and contains the reported output of that run.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Run.ColumnKind
Specifies the unit in which the tool measures columns.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Run.ColumnKind` Specifies the unit in which the tool measures columns.

Constructor Summary

Constructors
Constructor and Description

Run()

Constructors
Constructor and Description
`Run()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`List<Address>`	`getAddresses()` Addresses associated with this run instance, if any.
`Set<Artifact>`	`getArtifacts()` An array of artifact objects relevant to the run.
`RunAutomationDetails`	`getAutomationDetails()` Information that describes a run's identity and role within an engineering system process.
`String`	`getBaselineGuid()` The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.
`Run.ColumnKind`	`getColumnKind()` Specifies the unit in which the tool measures columns.
`Conversion`	`getConversion()` Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.
`String`	`getDefaultEncoding()` Specifies the default encoding for any artifact object that refers to a text file.
`String`	`getDefaultSourceLanguage()` Specifies the default source language for any artifact object that refers to a text file that contains source code.
`ExternalPropertyFileReferences`	`getExternalPropertyFileReferences()` References to external property files that should be inlined with the content of a root log file.
`Set<Graph>`	`getGraphs()` An array of zero or more unique graph objects associated with the run.
`List<Invocation>`	`getInvocations()` Describes the invocation of the analysis tool.
`String`	`getLanguage()` The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region).
`Set<LogicalLocation>`	`getLogicalLocations()` An array of logical locations such as namespaces, types or functions.
`Set<String>`	`getNewlineSequences()` An ordered list of character sequences that were treated as line breaks when computing region information for the run.
`OriginalUriBaseIds`	`getOriginalUriBaseIds()` The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.
`Set<ToolComponent>`	`getPolicies()` Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).
`PropertyBag`	`getProperties()` Key/value pairs that provide additional information about the object.
`Set<String>`	`getRedactionTokens()` An array of strings used to replace sensitive information in a redaction-aware property.
`List<Result>`	`getResults()` The set of results contained in an SARIF log.
`Set<RunAutomationDetails>`	`getRunAggregates()` Automation details that describe the aggregate of runs to which this run belongs.
`SpecialLocations`	`getSpecialLocations()` Defines locations of special significance to SARIF consumers.
`Set<ToolComponent>`	`getTaxonomies()` An array of toolComponent objects relevant to a taxonomy in which results are categorized.
`Set<ThreadFlowLocation>`	`getThreadFlowLocations()` An array of threadFlowLocation objects cached at run level.
`Tool`	`getTool()` The analysis tool that was run.
`Set<ToolComponent>`	`getTranslations()` The set of available translations of the localized data provided by the tool.
`Set<VersionControlDetails>`	`getVersionControlProvenance()` Specifies the revision in version control of the artifacts that were scanned.
`Set<WebRequest>`	`getWebRequests()` An array of request objects cached at run level.
`Set<WebResponse>`	`getWebResponses()` An array of response objects cached at run level.
`int`	`hashCode()`
`void`	`setAddresses(List<Address> addresses)` Addresses associated with this run instance, if any.
`void`	`setArtifacts(Set<Artifact> artifacts)` An array of artifact objects relevant to the run.
`void`	`setAutomationDetails(RunAutomationDetails automationDetails)` Information that describes a run's identity and role within an engineering system process.
`void`	`setBaselineGuid(String baselineGuid)` The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.
`void`	`setColumnKind(Run.ColumnKind columnKind)` Specifies the unit in which the tool measures columns.
`void`	`setConversion(Conversion conversion)` Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.
`void`	`setDefaultEncoding(String defaultEncoding)` Specifies the default encoding for any artifact object that refers to a text file.
`void`	`setDefaultSourceLanguage(String defaultSourceLanguage)` Specifies the default source language for any artifact object that refers to a text file that contains source code.
`void`	`setExternalPropertyFileReferences(ExternalPropertyFileReferences externalPropertyFileReferences)` References to external property files that should be inlined with the content of a root log file.
`void`	`setGraphs(Set<Graph> graphs)` An array of zero or more unique graph objects associated with the run.
`void`	`setInvocations(List<Invocation> invocations)` Describes the invocation of the analysis tool.
`void`	`setLanguage(String language)` The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region).
`void`	`setLogicalLocations(Set<LogicalLocation> logicalLocations)` An array of logical locations such as namespaces, types or functions.
`void`	`setNewlineSequences(Set<String> newlineSequences)` An ordered list of character sequences that were treated as line breaks when computing region information for the run.
`void`	`setOriginalUriBaseIds(OriginalUriBaseIds originalUriBaseIds)` The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.
`void`	`setPolicies(Set<ToolComponent> policies)` Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).
`void`	`setProperties(PropertyBag properties)` Key/value pairs that provide additional information about the object.
`void`	`setRedactionTokens(Set<String> redactionTokens)` An array of strings used to replace sensitive information in a redaction-aware property.
`void`	`setResults(List<Result> results)` The set of results contained in an SARIF log.
`void`	`setRunAggregates(Set<RunAutomationDetails> runAggregates)` Automation details that describe the aggregate of runs to which this run belongs.
`void`	`setSpecialLocations(SpecialLocations specialLocations)` Defines locations of special significance to SARIF consumers.
`void`	`setTaxonomies(Set<ToolComponent> taxonomies)` An array of toolComponent objects relevant to a taxonomy in which results are categorized.
`void`	`setThreadFlowLocations(Set<ThreadFlowLocation> threadFlowLocations)` An array of threadFlowLocation objects cached at run level.
`void`	`setTool(Tool tool)` The analysis tool that was run.
`void`	`setTranslations(Set<ToolComponent> translations)` The set of available translations of the localized data provided by the tool.
`void`	`setVersionControlProvenance(Set<VersionControlDetails> versionControlProvenance)` Specifies the revision in version control of the artifacts that were scanned.
`void`	`setWebRequests(Set<WebRequest> webRequests)` An array of request objects cached at run level.
`void`	`setWebResponses(Set<WebResponse> webResponses)` An array of response objects cached at run level.
`String`	`toString()`
`Run`	`withAddresses(List<Address> addresses)`
`Run`	`withArtifacts(Set<Artifact> artifacts)`
`Run`	`withAutomationDetails(RunAutomationDetails automationDetails)`
`Run`	`withBaselineGuid(String baselineGuid)`
`Run`	`withColumnKind(Run.ColumnKind columnKind)`
`Run`	`withConversion(Conversion conversion)`
`Run`	`withDefaultEncoding(String defaultEncoding)`
`Run`	`withDefaultSourceLanguage(String defaultSourceLanguage)`
`Run`	`withExternalPropertyFileReferences(ExternalPropertyFileReferences externalPropertyFileReferences)`
`Run`	`withGraphs(Set<Graph> graphs)`
`Run`	`withInvocations(List<Invocation> invocations)`
`Run`	`withLanguage(String language)`
`Run`	`withLogicalLocations(Set<LogicalLocation> logicalLocations)`
`Run`	`withNewlineSequences(Set<String> newlineSequences)`
`Run`	`withOriginalUriBaseIds(OriginalUriBaseIds originalUriBaseIds)`
`Run`	`withPolicies(Set<ToolComponent> policies)`
`Run`	`withProperties(PropertyBag properties)`
`Run`	`withRedactionTokens(Set<String> redactionTokens)`
`Run`	`withResults(List<Result> results)`
`Run`	`withRunAggregates(Set<RunAutomationDetails> runAggregates)`
`Run`	`withSpecialLocations(SpecialLocations specialLocations)`
`Run`	`withTaxonomies(Set<ToolComponent> taxonomies)`
`Run`	`withThreadFlowLocations(Set<ThreadFlowLocation> threadFlowLocations)`
`Run`	`withTool(Tool tool)`
`Run`	`withTranslations(Set<ToolComponent> translations)`
`Run`	`withVersionControlProvenance(Set<VersionControlDetails> versionControlProvenance)`
`Run`	`withWebRequests(Set<WebRequest> webRequests)`
`Run`	`withWebResponses(Set<WebResponse> webResponses)`

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

- Constructor Detail
  - Run
```
public Run()
```
- Method Detail
  - getTool
```
public Tool getTool()
```
    The analysis tool that was run. (Required)
  - setTool
```
public void setTool(Tool tool)
```
    The analysis tool that was run. (Required)
  - withTool
```
public Run withTool(Tool tool)
```
  - getInvocations
```
public List<Invocation> getInvocations()
```
    Describes the invocation of the analysis tool.
  - setInvocations
```
public void setInvocations(List<Invocation> invocations)
```
    Describes the invocation of the analysis tool.
  - withInvocations
```
public Run withInvocations(List<Invocation> invocations)
```
  - getConversion
```
public Conversion getConversion()
```
    Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.
  - setConversion
```
public void setConversion(Conversion conversion)
```
    Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.
  - withConversion
```
public Run withConversion(Conversion conversion)
```
  - getLanguage
```
public String getLanguage()
```
    The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).
  - setLanguage
```
public void setLanguage(String language)
```
    The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).
  - withLanguage
```
public Run withLanguage(String language)
```
  - getVersionControlProvenance
```
public Set<VersionControlDetails> getVersionControlProvenance()
```
    Specifies the revision in version control of the artifacts that were scanned.
  - setVersionControlProvenance
```
public void setVersionControlProvenance(Set<VersionControlDetails> versionControlProvenance)
```
    Specifies the revision in version control of the artifacts that were scanned.
  - withVersionControlProvenance
```
public Run withVersionControlProvenance(Set<VersionControlDetails> versionControlProvenance)
```
  - getOriginalUriBaseIds
```
public OriginalUriBaseIds getOriginalUriBaseIds()
```
    The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.
  - setOriginalUriBaseIds
```
public void setOriginalUriBaseIds(OriginalUriBaseIds originalUriBaseIds)
```
    The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.
  - withOriginalUriBaseIds
```
public Run withOriginalUriBaseIds(OriginalUriBaseIds originalUriBaseIds)
```
  - getArtifacts
```
public Set<Artifact> getArtifacts()
```
    An array of artifact objects relevant to the run.
  - setArtifacts
```
public void setArtifacts(Set<Artifact> artifacts)
```
    An array of artifact objects relevant to the run.
  - withArtifacts
```
public Run withArtifacts(Set<Artifact> artifacts)
```
  - getLogicalLocations
```
public Set<LogicalLocation> getLogicalLocations()
```
    An array of logical locations such as namespaces, types or functions.
  - setLogicalLocations
```
public void setLogicalLocations(Set<LogicalLocation> logicalLocations)
```
    An array of logical locations such as namespaces, types or functions.
  - withLogicalLocations
```
public Run withLogicalLocations(Set<LogicalLocation> logicalLocations)
```
  - getGraphs
```
public Set<Graph> getGraphs()
```
    An array of zero or more unique graph objects associated with the run.
  - setGraphs
```
public void setGraphs(Set<Graph> graphs)
```
    An array of zero or more unique graph objects associated with the run.
  - withGraphs
```
public Run withGraphs(Set<Graph> graphs)
```
  - getResults
```
public List<Result> getResults()
```
    The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) if a log file represents an actual scan.
  - setResults
```
public void setResults(List<Result> results)
```
    The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) if a log file represents an actual scan.
  - withResults
```
public Run withResults(List<Result> results)
```
  - getAutomationDetails
```
public RunAutomationDetails getAutomationDetails()
```
    Information that describes a run's identity and role within an engineering system process.
  - setAutomationDetails
```
public void setAutomationDetails(RunAutomationDetails automationDetails)
```
    Information that describes a run's identity and role within an engineering system process.
  - withAutomationDetails
```
public Run withAutomationDetails(RunAutomationDetails automationDetails)
```
  - getRunAggregates
```
public Set<RunAutomationDetails> getRunAggregates()
```
    Automation details that describe the aggregate of runs to which this run belongs.
  - setRunAggregates
```
public void setRunAggregates(Set<RunAutomationDetails> runAggregates)
```
    Automation details that describe the aggregate of runs to which this run belongs.
  - withRunAggregates
```
public Run withRunAggregates(Set<RunAutomationDetails> runAggregates)
```
  - getBaselineGuid
```
public String getBaselineGuid()
```
    The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.
  - setBaselineGuid
```
public void setBaselineGuid(String baselineGuid)
```
    The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.
  - withBaselineGuid
```
public Run withBaselineGuid(String baselineGuid)
```
  - getRedactionTokens
```
public Set<String> getRedactionTokens()
```
    An array of strings used to replace sensitive information in a redaction-aware property.
  - setRedactionTokens
```
public void setRedactionTokens(Set<String> redactionTokens)
```
    An array of strings used to replace sensitive information in a redaction-aware property.
  - withRedactionTokens
```
public Run withRedactionTokens(Set<String> redactionTokens)
```
  - getDefaultEncoding
```
public String getDefaultEncoding()
```
    Specifies the default encoding for any artifact object that refers to a text file.
  - setDefaultEncoding
```
public void setDefaultEncoding(String defaultEncoding)
```
    Specifies the default encoding for any artifact object that refers to a text file.
  - withDefaultEncoding
```
public Run withDefaultEncoding(String defaultEncoding)
```
  - getDefaultSourceLanguage
```
public String getDefaultSourceLanguage()
```
    Specifies the default source language for any artifact object that refers to a text file that contains source code.
  - setDefaultSourceLanguage
```
public void setDefaultSourceLanguage(String defaultSourceLanguage)
```
    Specifies the default source language for any artifact object that refers to a text file that contains source code.
  - withDefaultSourceLanguage
```
public Run withDefaultSourceLanguage(String defaultSourceLanguage)
```
  - getNewlineSequences
```
public Set<String> getNewlineSequences()
```
    An ordered list of character sequences that were treated as line breaks when computing region information for the run.
  - setNewlineSequences
```
public void setNewlineSequences(Set<String> newlineSequences)
```
    An ordered list of character sequences that were treated as line breaks when computing region information for the run.
  - withNewlineSequences
```
public Run withNewlineSequences(Set<String> newlineSequences)
```
  - getColumnKind
```
public Run.ColumnKind getColumnKind()
```
    Specifies the unit in which the tool measures columns.
  - setColumnKind
```
public void setColumnKind(Run.ColumnKind columnKind)
```
    Specifies the unit in which the tool measures columns.
  - withColumnKind
```
public Run withColumnKind(Run.ColumnKind columnKind)
```
  - getExternalPropertyFileReferences
```
public ExternalPropertyFileReferences getExternalPropertyFileReferences()
```
    References to external property files that should be inlined with the content of a root log file.
  - setExternalPropertyFileReferences
```
public void setExternalPropertyFileReferences(ExternalPropertyFileReferences externalPropertyFileReferences)
```
    References to external property files that should be inlined with the content of a root log file.
  - withExternalPropertyFileReferences
```
public Run withExternalPropertyFileReferences(ExternalPropertyFileReferences externalPropertyFileReferences)
```
  - getThreadFlowLocations
```
public Set<ThreadFlowLocation> getThreadFlowLocations()
```
    An array of threadFlowLocation objects cached at run level.
  - setThreadFlowLocations
```
public void setThreadFlowLocations(Set<ThreadFlowLocation> threadFlowLocations)
```
    An array of threadFlowLocation objects cached at run level.
  - withThreadFlowLocations
```
public Run withThreadFlowLocations(Set<ThreadFlowLocation> threadFlowLocations)
```
  - getTaxonomies
```
public Set<ToolComponent> getTaxonomies()
```
    An array of toolComponent objects relevant to a taxonomy in which results are categorized.
  - setTaxonomies
```
public void setTaxonomies(Set<ToolComponent> taxonomies)
```
    An array of toolComponent objects relevant to a taxonomy in which results are categorized.
  - withTaxonomies
```
public Run withTaxonomies(Set<ToolComponent> taxonomies)
```
  - getAddresses
```
public List<Address> getAddresses()
```
    Addresses associated with this run instance, if any.
  - setAddresses
```
public void setAddresses(List<Address> addresses)
```
    Addresses associated with this run instance, if any.
  - withAddresses
```
public Run withAddresses(List<Address> addresses)
```
  - getTranslations
```
public Set<ToolComponent> getTranslations()
```
    The set of available translations of the localized data provided by the tool.
  - setTranslations
```
public void setTranslations(Set<ToolComponent> translations)
```
    The set of available translations of the localized data provided by the tool.
  - withTranslations
```
public Run withTranslations(Set<ToolComponent> translations)
```
  - getPolicies
```
public Set<ToolComponent> getPolicies()
```
    Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).
  - setPolicies
```
public void setPolicies(Set<ToolComponent> policies)
```
    Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).
  - withPolicies
```
public Run withPolicies(Set<ToolComponent> policies)
```
  - getWebRequests
```
public Set<WebRequest> getWebRequests()
```
    An array of request objects cached at run level.
  - setWebRequests
```
public void setWebRequests(Set<WebRequest> webRequests)
```
    An array of request objects cached at run level.
  - withWebRequests
```
public Run withWebRequests(Set<WebRequest> webRequests)
```
  - getWebResponses
```
public Set<WebResponse> getWebResponses()
```
    An array of response objects cached at run level.
  - setWebResponses
```
public void setWebResponses(Set<WebResponse> webResponses)
```
    An array of response objects cached at run level.
  - withWebResponses
```
public Run withWebResponses(Set<WebResponse> webResponses)
```
  - getSpecialLocations
```
public SpecialLocations getSpecialLocations()
```
    Defines locations of special significance to SARIF consumers.
  - setSpecialLocations
```
public void setSpecialLocations(SpecialLocations specialLocations)
```
    Defines locations of special significance to SARIF consumers.
  - withSpecialLocations
```
public Run withSpecialLocations(SpecialLocations specialLocations)
```
  - 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 Run 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 Run

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Run

Method Detail

getTool

setTool

withTool

getInvocations

setInvocations

withInvocations

getConversion

setConversion

withConversion

getLanguage

setLanguage

withLanguage

getVersionControlProvenance

setVersionControlProvenance

withVersionControlProvenance

getOriginalUriBaseIds

setOriginalUriBaseIds

withOriginalUriBaseIds

getArtifacts

setArtifacts

withArtifacts

getLogicalLocations

setLogicalLocations

withLogicalLocations

getGraphs

setGraphs

withGraphs

getResults

setResults

withResults

getAutomationDetails

setAutomationDetails

withAutomationDetails

getRunAggregates

setRunAggregates

withRunAggregates

getBaselineGuid

setBaselineGuid

withBaselineGuid

getRedactionTokens

setRedactionTokens

withRedactionTokens

getDefaultEncoding

setDefaultEncoding

withDefaultEncoding

getDefaultSourceLanguage

setDefaultSourceLanguage

withDefaultSourceLanguage

getNewlineSequences

setNewlineSequences

withNewlineSequences

getColumnKind

setColumnKind

withColumnKind

getExternalPropertyFileReferences

setExternalPropertyFileReferences

withExternalPropertyFileReferences

getThreadFlowLocations

setThreadFlowLocations

withThreadFlowLocations

getTaxonomies

setTaxonomies

withTaxonomies

getAddresses

setAddresses

withAddresses

getTranslations

setTranslations

withTranslations

getPolicies

setPolicies

withPolicies