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

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

```
public class ExternalProperties
extends Object
```
The top-level element of an external property file.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ExternalProperties.Version
The SARIF format version of this external properties object.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ExternalProperties.Version` The SARIF format version of this external properties object.

Constructor Summary

Constructors
Constructor and Description

ExternalProperties()

Constructors
Constructor and Description
`ExternalProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`List<Address>`	`getAddresses()` Addresses that will be merged with a separate run.
`Set<Artifact>`	`getArtifacts()` An array of artifact objects that will be merged with a separate run.
`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.
`ToolComponent`	`getDriver()` A component, such as a plug-in or the driver, of the analysis tool that was run.
`Set<ToolComponent>`	`getExtensions()` Tool extensions that will be merged with a separate run.
`PropertyBag`	`getExternalizedProperties()` Key/value pairs that provide additional information about the object.
`Set<Graph>`	`getGraphs()` An array of graph objects that will be merged with a separate run.
`String`	`getGuid()` A stable, unique identifer for this external properties object, in the form of a GUID.
`List<Invocation>`	`getInvocations()` Describes the invocation of the analysis tool that will be merged with a separate run.
`Set<LogicalLocation>`	`getLogicalLocations()` An array of logical locations such as namespaces, types or functions that will be merged with a separate run.
`Set<ToolComponent>`	`getPolicies()` Tool policies that will be merged with a separate run.
`PropertyBag`	`getProperties()` Key/value pairs that provide additional information about the object.
`List<Result>`	`getResults()` An array of result objects that will be merged with a separate run.
`String`	`getRunGuid()` A stable, unique identifer for the run associated with this external properties object, in the form of a GUID.
`URI`	`getSchema()` The URI of the JSON schema corresponding to the version of the external property file format.
`Set<ToolComponent>`	`getTaxonomies()` Tool taxonomies that will be merged with a separate run.
`Set<ThreadFlowLocation>`	`getThreadFlowLocations()` An array of threadFlowLocation objects that will be merged with a separate run.
`Set<ToolComponent>`	`getTranslations()` Tool translations that will be merged with a separate run.
`ExternalProperties.Version`	`getVersion()` The SARIF format version of this external properties object.
`Set<WebRequest>`	`getWebRequests()` Requests that will be merged with a separate run.
`Set<WebResponse>`	`getWebResponses()` Responses that will be merged with a separate run.
`int`	`hashCode()`
`void`	`setAddresses(List<Address> addresses)` Addresses that will be merged with a separate run.
`void`	`setArtifacts(Set<Artifact> artifacts)` An array of artifact objects that will be merged with a separate run.
`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`	`setDriver(ToolComponent driver)` A component, such as a plug-in or the driver, of the analysis tool that was run.
`void`	`setExtensions(Set<ToolComponent> extensions)` Tool extensions that will be merged with a separate run.
`void`	`setExternalizedProperties(PropertyBag externalizedProperties)` Key/value pairs that provide additional information about the object.
`void`	`setGraphs(Set<Graph> graphs)` An array of graph objects that will be merged with a separate run.
`void`	`setGuid(String guid)` A stable, unique identifer for this external properties object, in the form of a GUID.
`void`	`setInvocations(List<Invocation> invocations)` Describes the invocation of the analysis tool that will be merged with a separate run.
`void`	`setLogicalLocations(Set<LogicalLocation> logicalLocations)` An array of logical locations such as namespaces, types or functions that will be merged with a separate run.
`void`	`setPolicies(Set<ToolComponent> policies)` Tool policies that will be merged with a separate run.
`void`	`setProperties(PropertyBag properties)` Key/value pairs that provide additional information about the object.
`void`	`setResults(List<Result> results)` An array of result objects that will be merged with a separate run.
`void`	`setRunGuid(String runGuid)` A stable, unique identifer for the run associated with this external properties object, in the form of a GUID.
`void`	`setSchema(URI schema)` The URI of the JSON schema corresponding to the version of the external property file format.
`void`	`setTaxonomies(Set<ToolComponent> taxonomies)` Tool taxonomies that will be merged with a separate run.
`void`	`setThreadFlowLocations(Set<ThreadFlowLocation> threadFlowLocations)` An array of threadFlowLocation objects that will be merged with a separate run.
`void`	`setTranslations(Set<ToolComponent> translations)` Tool translations that will be merged with a separate run.
`void`	`setVersion(ExternalProperties.Version version)` The SARIF format version of this external properties object.
`void`	`setWebRequests(Set<WebRequest> webRequests)` Requests that will be merged with a separate run.
`void`	`setWebResponses(Set<WebResponse> webResponses)` Responses that will be merged with a separate run.
`String`	`toString()`
`ExternalProperties`	`withAddresses(List<Address> addresses)`
`ExternalProperties`	`withArtifacts(Set<Artifact> artifacts)`
`ExternalProperties`	`withConversion(Conversion conversion)`
`ExternalProperties`	`withDriver(ToolComponent driver)`
`ExternalProperties`	`withExtensions(Set<ToolComponent> extensions)`
`ExternalProperties`	`withExternalizedProperties(PropertyBag externalizedProperties)`
`ExternalProperties`	`withGraphs(Set<Graph> graphs)`
`ExternalProperties`	`withGuid(String guid)`
`ExternalProperties`	`withInvocations(List<Invocation> invocations)`
`ExternalProperties`	`withLogicalLocations(Set<LogicalLocation> logicalLocations)`
`ExternalProperties`	`withPolicies(Set<ToolComponent> policies)`
`ExternalProperties`	`withProperties(PropertyBag properties)`
`ExternalProperties`	`withResults(List<Result> results)`
`ExternalProperties`	`withRunGuid(String runGuid)`
`ExternalProperties`	`withSchema(URI schema)`
`ExternalProperties`	`withTaxonomies(Set<ToolComponent> taxonomies)`
`ExternalProperties`	`withThreadFlowLocations(Set<ThreadFlowLocation> threadFlowLocations)`
`ExternalProperties`	`withTranslations(Set<ToolComponent> translations)`
`ExternalProperties`	`withVersion(ExternalProperties.Version version)`
`ExternalProperties`	`withWebRequests(Set<WebRequest> webRequests)`
`ExternalProperties`	`withWebResponses(Set<WebResponse> webResponses)`

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

- Constructor Detail
  - ExternalProperties
```
public ExternalProperties()
```
- Method Detail
  - getSchema
```
public URI getSchema()
```
    The URI of the JSON schema corresponding to the version of the external property file format.
  - setSchema
```
public void setSchema(URI schema)
```
    The URI of the JSON schema corresponding to the version of the external property file format.
  - withSchema
```
public ExternalProperties withSchema(URI schema)
```
  - getVersion
```
public ExternalProperties.Version getVersion()
```
    The SARIF format version of this external properties object.
  - setVersion
```
public void setVersion(ExternalProperties.Version version)
```
    The SARIF format version of this external properties object.
  - withVersion
```
public ExternalProperties withVersion(ExternalProperties.Version version)
```
  - getGuid
```
public String getGuid()
```
    A stable, unique identifer for this external properties object, in the form of a GUID.
  - setGuid
```
public void setGuid(String guid)
```
    A stable, unique identifer for this external properties object, in the form of a GUID.
  - withGuid
```
public ExternalProperties withGuid(String guid)
```
  - getRunGuid
```
public String getRunGuid()
```
    A stable, unique identifer for the run associated with this external properties object, in the form of a GUID.
  - setRunGuid
```
public void setRunGuid(String runGuid)
```
    A stable, unique identifer for the run associated with this external properties object, in the form of a GUID.
  - withRunGuid
```
public ExternalProperties withRunGuid(String runGuid)
```
  - 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 ExternalProperties withConversion(Conversion conversion)
```
  - getGraphs
```
public Set<Graph> getGraphs()
```
    An array of graph objects that will be merged with a separate run.
  - setGraphs
```
public void setGraphs(Set<Graph> graphs)
```
    An array of graph objects that will be merged with a separate run.
  - withGraphs
```
public ExternalProperties withGraphs(Set<Graph> graphs)
```
  - getExternalizedProperties
```
public PropertyBag getExternalizedProperties()
```
    Key/value pairs that provide additional information about the object.
  - setExternalizedProperties
```
public void setExternalizedProperties(PropertyBag externalizedProperties)
```
    Key/value pairs that provide additional information about the object.
  - withExternalizedProperties
```
public ExternalProperties withExternalizedProperties(PropertyBag externalizedProperties)
```
  - getArtifacts
```
public Set<Artifact> getArtifacts()
```
    An array of artifact objects that will be merged with a separate run.
  - setArtifacts
```
public void setArtifacts(Set<Artifact> artifacts)
```
    An array of artifact objects that will be merged with a separate run.
  - withArtifacts
```
public ExternalProperties withArtifacts(Set<Artifact> artifacts)
```
  - getInvocations
```
public List<Invocation> getInvocations()
```
    Describes the invocation of the analysis tool that will be merged with a separate run.
  - setInvocations
```
public void setInvocations(List<Invocation> invocations)
```
    Describes the invocation of the analysis tool that will be merged with a separate run.
  - withInvocations
```
public ExternalProperties withInvocations(List<Invocation> invocations)
```
  - getLogicalLocations
```
public Set<LogicalLocation> getLogicalLocations()
```
    An array of logical locations such as namespaces, types or functions that will be merged with a separate run.
  - setLogicalLocations
```
public void setLogicalLocations(Set<LogicalLocation> logicalLocations)
```
    An array of logical locations such as namespaces, types or functions that will be merged with a separate run.
  - withLogicalLocations
```
public ExternalProperties withLogicalLocations(Set<LogicalLocation> logicalLocations)
```
  - getThreadFlowLocations
```
public Set<ThreadFlowLocation> getThreadFlowLocations()
```
    An array of threadFlowLocation objects that will be merged with a separate run.
  - setThreadFlowLocations
```
public void setThreadFlowLocations(Set<ThreadFlowLocation> threadFlowLocations)
```
    An array of threadFlowLocation objects that will be merged with a separate run.
  - withThreadFlowLocations
```
public ExternalProperties withThreadFlowLocations(Set<ThreadFlowLocation> threadFlowLocations)
```
  - getResults
```
public List<Result> getResults()
```
    An array of result objects that will be merged with a separate run.
  - setResults
```
public void setResults(List<Result> results)
```
    An array of result objects that will be merged with a separate run.
  - withResults
```
public ExternalProperties withResults(List<Result> results)
```
  - getTaxonomies
```
public Set<ToolComponent> getTaxonomies()
```
    Tool taxonomies that will be merged with a separate run.
  - setTaxonomies
```
public void setTaxonomies(Set<ToolComponent> taxonomies)
```
    Tool taxonomies that will be merged with a separate run.
  - withTaxonomies
```
public ExternalProperties withTaxonomies(Set<ToolComponent> taxonomies)
```
  - getDriver
```
public ToolComponent getDriver()
```
    A component, such as a plug-in or the driver, of the analysis tool that was run.
  - setDriver
```
public void setDriver(ToolComponent driver)
```
    A component, such as a plug-in or the driver, of the analysis tool that was run.
  - withDriver
```
public ExternalProperties withDriver(ToolComponent driver)
```
  - getExtensions
```
public Set<ToolComponent> getExtensions()
```
    Tool extensions that will be merged with a separate run.
  - setExtensions
```
public void setExtensions(Set<ToolComponent> extensions)
```
    Tool extensions that will be merged with a separate run.
  - withExtensions
```
public ExternalProperties withExtensions(Set<ToolComponent> extensions)
```
  - getPolicies
```
public Set<ToolComponent> getPolicies()
```
    Tool policies that will be merged with a separate run.
  - setPolicies
```
public void setPolicies(Set<ToolComponent> policies)
```
    Tool policies that will be merged with a separate run.
  - withPolicies
```
public ExternalProperties withPolicies(Set<ToolComponent> policies)
```
  - getTranslations
```
public Set<ToolComponent> getTranslations()
```
    Tool translations that will be merged with a separate run.
  - setTranslations
```
public void setTranslations(Set<ToolComponent> translations)
```
    Tool translations that will be merged with a separate run.
  - withTranslations
```
public ExternalProperties withTranslations(Set<ToolComponent> translations)
```
  - getAddresses
```
public List<Address> getAddresses()
```
    Addresses that will be merged with a separate run.
  - setAddresses
```
public void setAddresses(List<Address> addresses)
```
    Addresses that will be merged with a separate run.
  - withAddresses
```
public ExternalProperties withAddresses(List<Address> addresses)
```
  - getWebRequests
```
public Set<WebRequest> getWebRequests()
```
    Requests that will be merged with a separate run.
  - setWebRequests
```
public void setWebRequests(Set<WebRequest> webRequests)
```
    Requests that will be merged with a separate run.
  - withWebRequests
```
public ExternalProperties withWebRequests(Set<WebRequest> webRequests)
```
  - getWebResponses
```
public Set<WebResponse> getWebResponses()
```
    Responses that will be merged with a separate run.
  - setWebResponses
```
public void setWebResponses(Set<WebResponse> webResponses)
```
    Responses that will be merged with a separate run.
  - withWebResponses
```
public ExternalProperties withWebResponses(Set<WebResponse> webResponses)
```
  - 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 ExternalProperties 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 ExternalProperties

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExternalProperties

Method Detail

getSchema

setSchema

withSchema

getVersion

setVersion

withVersion

getGuid

setGuid

withGuid

getRunGuid

setRunGuid

withRunGuid

getConversion

setConversion

withConversion

getGraphs

setGraphs

withGraphs

getExternalizedProperties

setExternalizedProperties

withExternalizedProperties

getArtifacts

setArtifacts

withArtifacts

getInvocations

setInvocations

withInvocations

getLogicalLocations

setLogicalLocations

withLogicalLocations

getThreadFlowLocations

setThreadFlowLocations

withThreadFlowLocations

getResults

setResults

withResults

getTaxonomies

setTaxonomies

withTaxonomies

getDriver

setDriver

withDriver

getExtensions

setExtensions

withExtensions

getPolicies

setPolicies

withPolicies

getTranslations

setTranslations

withTranslations

getAddresses

setAddresses

withAddresses

getWebRequests

setWebRequests

withWebRequests

getWebResponses

setWebResponses

withWebResponses

getProperties

setProperties

withProperties

toString

hashCode

equals