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

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

```
public class Result
extends Object
```
A result produced by an analysis tool.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Result.BaselineState` The state of a result relative to a baseline of a previous run.
`static class`	`Result.Kind` A value that categorizes results by evaluation state.
`static class`	`Result.Level` A value specifying the severity level of the result.

Constructor Summary

Constructors
Constructor and Description

Result()

Constructors
Constructor and Description
`Result()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`ArtifactLocation`	`getAnalysisTarget()` Specifies the location of an artifact.
`Set<Attachment>`	`getAttachments()` A set of artifacts relevant to the result.
`Result.BaselineState`	`getBaselineState()` The state of a result relative to a baseline of a previous run.
`List<CodeFlow>`	`getCodeFlows()` An array of 'codeFlow' objects relevant to the result.
`String`	`getCorrelationGuid()` A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.
`Fingerprints`	`getFingerprints()` A set of strings each of which individually defines a stable, unique identity for the result.
`Set<Fix>`	`getFixes()` An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.
`Set<Graph>`	`getGraphs()` An array of zero or more unique graph objects associated with the result.
`Set<GraphTraversal>`	`getGraphTraversals()` An array of one or more unique 'graphTraversal' objects.
`String`	`getGuid()` A stable, unique identifer for the result in the form of a GUID.
`URI`	`getHostedViewerUri()` An absolute URI at which the result can be viewed.
`Result.Kind`	`getKind()` A value that categorizes results by evaluation state.
`Result.Level`	`getLevel()` A value specifying the severity level of the result.
`List<Location>`	`getLocations()` The set of locations where the result was detected.
`Message`	`getMessage()` Encapsulates a message intended to be read by the end user.
`Integer`	`getOccurrenceCount()` A positive integer specifying the number of times this logically unique result was observed in this run.
`PartialFingerprints`	`getPartialFingerprints()` A set of strings that contribute to the stable, unique identity of the result.
`PropertyBag`	`getProperties()` Key/value pairs that provide additional information about the object.
`ResultProvenance`	`getProvenance()` Contains information about how and when a result was detected.
`Double`	`getRank()` A number representing the priority or importance of the result.
`Set<Location>`	`getRelatedLocations()` A set of locations relevant to this result.
`ReportingDescriptorReference`	`getRule()` Information about how to locate a relevant reporting descriptor.
`String`	`getRuleId()` The stable, unique identifier of the rule, if any, to which this result is relevant.
`Integer`	`getRuleIndex()` The index within the tool component rules array of the rule object associated with this result.
`Set<Stack>`	`getStacks()` An array of 'stack' objects relevant to the result.
`Set<Suppression>`	`getSuppressions()` A set of suppressions relevant to this result.
`Set<ReportingDescriptorReference>`	`getTaxa()` An array of references to taxonomy reporting descriptors that are applicable to the result.
`WebRequest`	`getWebRequest()` Describes an HTTP request.
`WebResponse`	`getWebResponse()` Describes the response to an HTTP request.
`Set<URI>`	`getWorkItemUris()` The URIs of the work items associated with this result.
`int`	`hashCode()`
`void`	`setAnalysisTarget(ArtifactLocation analysisTarget)` Specifies the location of an artifact.
`void`	`setAttachments(Set<Attachment> attachments)` A set of artifacts relevant to the result.
`void`	`setBaselineState(Result.BaselineState baselineState)` The state of a result relative to a baseline of a previous run.
`void`	`setCodeFlows(List<CodeFlow> codeFlows)` An array of 'codeFlow' objects relevant to the result.
`void`	`setCorrelationGuid(String correlationGuid)` A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.
`void`	`setFingerprints(Fingerprints fingerprints)` A set of strings each of which individually defines a stable, unique identity for the result.
`void`	`setFixes(Set<Fix> fixes)` An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.
`void`	`setGraphs(Set<Graph> graphs)` An array of zero or more unique graph objects associated with the result.
`void`	`setGraphTraversals(Set<GraphTraversal> graphTraversals)` An array of one or more unique 'graphTraversal' objects.
`void`	`setGuid(String guid)` A stable, unique identifer for the result in the form of a GUID.
`void`	`setHostedViewerUri(URI hostedViewerUri)` An absolute URI at which the result can be viewed.
`void`	`setKind(Result.Kind kind)` A value that categorizes results by evaluation state.
`void`	`setLevel(Result.Level level)` A value specifying the severity level of the result.
`void`	`setLocations(List<Location> locations)` The set of locations where the result was detected.
`void`	`setMessage(Message message)` Encapsulates a message intended to be read by the end user.
`void`	`setOccurrenceCount(Integer occurrenceCount)` A positive integer specifying the number of times this logically unique result was observed in this run.
`void`	`setPartialFingerprints(PartialFingerprints partialFingerprints)` A set of strings that contribute to the stable, unique identity of the result.
`void`	`setProperties(PropertyBag properties)` Key/value pairs that provide additional information about the object.
`void`	`setProvenance(ResultProvenance provenance)` Contains information about how and when a result was detected.
`void`	`setRank(Double rank)` A number representing the priority or importance of the result.
`void`	`setRelatedLocations(Set<Location> relatedLocations)` A set of locations relevant to this result.
`void`	`setRule(ReportingDescriptorReference rule)` Information about how to locate a relevant reporting descriptor.
`void`	`setRuleId(String ruleId)` The stable, unique identifier of the rule, if any, to which this result is relevant.
`void`	`setRuleIndex(Integer ruleIndex)` The index within the tool component rules array of the rule object associated with this result.
`void`	`setStacks(Set<Stack> stacks)` An array of 'stack' objects relevant to the result.
`void`	`setSuppressions(Set<Suppression> suppressions)` A set of suppressions relevant to this result.
`void`	`setTaxa(Set<ReportingDescriptorReference> taxa)` An array of references to taxonomy reporting descriptors that are applicable to the result.
`void`	`setWebRequest(WebRequest webRequest)` Describes an HTTP request.
`void`	`setWebResponse(WebResponse webResponse)` Describes the response to an HTTP request.
`void`	`setWorkItemUris(Set<URI> workItemUris)` The URIs of the work items associated with this result.
`String`	`toString()`
`Result`	`withAnalysisTarget(ArtifactLocation analysisTarget)`
`Result`	`withAttachments(Set<Attachment> attachments)`
`Result`	`withBaselineState(Result.BaselineState baselineState)`
`Result`	`withCodeFlows(List<CodeFlow> codeFlows)`
`Result`	`withCorrelationGuid(String correlationGuid)`
`Result`	`withFingerprints(Fingerprints fingerprints)`
`Result`	`withFixes(Set<Fix> fixes)`
`Result`	`withGraphs(Set<Graph> graphs)`
`Result`	`withGraphTraversals(Set<GraphTraversal> graphTraversals)`
`Result`	`withGuid(String guid)`
`Result`	`withHostedViewerUri(URI hostedViewerUri)`
`Result`	`withKind(Result.Kind kind)`
`Result`	`withLevel(Result.Level level)`
`Result`	`withLocations(List<Location> locations)`
`Result`	`withMessage(Message message)`
`Result`	`withOccurrenceCount(Integer occurrenceCount)`
`Result`	`withPartialFingerprints(PartialFingerprints partialFingerprints)`
`Result`	`withProperties(PropertyBag properties)`
`Result`	`withProvenance(ResultProvenance provenance)`
`Result`	`withRank(Double rank)`
`Result`	`withRelatedLocations(Set<Location> relatedLocations)`
`Result`	`withRule(ReportingDescriptorReference rule)`
`Result`	`withRuleId(String ruleId)`
`Result`	`withRuleIndex(Integer ruleIndex)`
`Result`	`withStacks(Set<Stack> stacks)`
`Result`	`withSuppressions(Set<Suppression> suppressions)`
`Result`	`withTaxa(Set<ReportingDescriptorReference> taxa)`
`Result`	`withWebRequest(WebRequest webRequest)`
`Result`	`withWebResponse(WebResponse webResponse)`
`Result`	`withWorkItemUris(Set<URI> workItemUris)`

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

- Constructor Detail
  - Result
```
public Result()
```
- Method Detail
  - getRuleId
```
public String getRuleId()
```
    The stable, unique identifier of the rule, if any, to which this result is relevant.
  - setRuleId
```
public void setRuleId(String ruleId)
```
    The stable, unique identifier of the rule, if any, to which this result is relevant.
  - withRuleId
```
public Result withRuleId(String ruleId)
```
  - getRuleIndex
```
public Integer getRuleIndex()
```
    The index within the tool component rules array of the rule object associated with this result.
  - setRuleIndex
```
public void setRuleIndex(Integer ruleIndex)
```
    The index within the tool component rules array of the rule object associated with this result.
  - withRuleIndex
```
public Result withRuleIndex(Integer ruleIndex)
```
  - getRule
```
public ReportingDescriptorReference getRule()
```
    Information about how to locate a relevant reporting descriptor.
  - setRule
```
public void setRule(ReportingDescriptorReference rule)
```
    Information about how to locate a relevant reporting descriptor.
  - withRule
```
public Result withRule(ReportingDescriptorReference rule)
```
  - getKind
```
public Result.Kind getKind()
```
    A value that categorizes results by evaluation state.
  - setKind
```
public void setKind(Result.Kind kind)
```
    A value that categorizes results by evaluation state.
  - withKind
```
public Result withKind(Result.Kind kind)
```
  - getLevel
```
public Result.Level getLevel()
```
    A value specifying the severity level of the result.
  - setLevel
```
public void setLevel(Result.Level level)
```
    A value specifying the severity level of the result.
  - withLevel
```
public Result withLevel(Result.Level level)
```
  - getMessage
```
public Message getMessage()
```
    Encapsulates a message intended to be read by the end user. (Required)
  - setMessage
```
public void setMessage(Message message)
```
    Encapsulates a message intended to be read by the end user. (Required)
  - withMessage
```
public Result withMessage(Message message)
```
  - getAnalysisTarget
```
public ArtifactLocation getAnalysisTarget()
```
    Specifies the location of an artifact.
  - setAnalysisTarget
```
public void setAnalysisTarget(ArtifactLocation analysisTarget)
```
    Specifies the location of an artifact.
  - withAnalysisTarget
```
public Result withAnalysisTarget(ArtifactLocation analysisTarget)
```
  - getLocations
```
public List<Location> getLocations()
```
    The set of locations where the result was detected. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.
  - setLocations
```
public void setLocations(List<Location> locations)
```
    The set of locations where the result was detected. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.
  - withLocations
```
public Result withLocations(List<Location> locations)
```
  - getGuid
```
public String getGuid()
```
    A stable, unique identifer for the result in the form of a GUID.
  - setGuid
```
public void setGuid(String guid)
```
    A stable, unique identifer for the result in the form of a GUID.
  - withGuid
```
public Result withGuid(String guid)
```
  - getCorrelationGuid
```
public String getCorrelationGuid()
```
    A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.
  - setCorrelationGuid
```
public void setCorrelationGuid(String correlationGuid)
```
    A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.
  - withCorrelationGuid
```
public Result withCorrelationGuid(String correlationGuid)
```
  - getOccurrenceCount
```
public Integer getOccurrenceCount()
```
    A positive integer specifying the number of times this logically unique result was observed in this run.
  - setOccurrenceCount
```
public void setOccurrenceCount(Integer occurrenceCount)
```
    A positive integer specifying the number of times this logically unique result was observed in this run.
  - withOccurrenceCount
```
public Result withOccurrenceCount(Integer occurrenceCount)
```
  - getPartialFingerprints
```
public PartialFingerprints getPartialFingerprints()
```
    A set of strings that contribute to the stable, unique identity of the result.
  - setPartialFingerprints
```
public void setPartialFingerprints(PartialFingerprints partialFingerprints)
```
    A set of strings that contribute to the stable, unique identity of the result.
  - withPartialFingerprints
```
public Result withPartialFingerprints(PartialFingerprints partialFingerprints)
```
  - getFingerprints
```
public Fingerprints getFingerprints()
```
    A set of strings each of which individually defines a stable, unique identity for the result.
  - setFingerprints
```
public void setFingerprints(Fingerprints fingerprints)
```
    A set of strings each of which individually defines a stable, unique identity for the result.
  - withFingerprints
```
public Result withFingerprints(Fingerprints fingerprints)
```
  - getStacks
```
public Set<Stack> getStacks()
```
    An array of 'stack' objects relevant to the result.
  - setStacks
```
public void setStacks(Set<Stack> stacks)
```
    An array of 'stack' objects relevant to the result.
  - withStacks
```
public Result withStacks(Set<Stack> stacks)
```
  - getCodeFlows
```
public List<CodeFlow> getCodeFlows()
```
    An array of 'codeFlow' objects relevant to the result.
  - setCodeFlows
```
public void setCodeFlows(List<CodeFlow> codeFlows)
```
    An array of 'codeFlow' objects relevant to the result.
  - withCodeFlows
```
public Result withCodeFlows(List<CodeFlow> codeFlows)
```
  - getGraphs
```
public Set<Graph> getGraphs()
```
    An array of zero or more unique graph objects associated with the result.
  - setGraphs
```
public void setGraphs(Set<Graph> graphs)
```
    An array of zero or more unique graph objects associated with the result.
  - withGraphs
```
public Result withGraphs(Set<Graph> graphs)
```
  - getGraphTraversals
```
public Set<GraphTraversal> getGraphTraversals()
```
    An array of one or more unique 'graphTraversal' objects.
  - setGraphTraversals
```
public void setGraphTraversals(Set<GraphTraversal> graphTraversals)
```
    An array of one or more unique 'graphTraversal' objects.
  - withGraphTraversals
```
public Result withGraphTraversals(Set<GraphTraversal> graphTraversals)
```
  - getRelatedLocations
```
public Set<Location> getRelatedLocations()
```
    A set of locations relevant to this result.
  - setRelatedLocations
```
public void setRelatedLocations(Set<Location> relatedLocations)
```
    A set of locations relevant to this result.
  - withRelatedLocations
```
public Result withRelatedLocations(Set<Location> relatedLocations)
```
  - getSuppressions
```
public Set<Suppression> getSuppressions()
```
    A set of suppressions relevant to this result.
  - setSuppressions
```
public void setSuppressions(Set<Suppression> suppressions)
```
    A set of suppressions relevant to this result.
  - withSuppressions
```
public Result withSuppressions(Set<Suppression> suppressions)
```
  - getBaselineState
```
public Result.BaselineState getBaselineState()
```
    The state of a result relative to a baseline of a previous run.
  - setBaselineState
```
public void setBaselineState(Result.BaselineState baselineState)
```
    The state of a result relative to a baseline of a previous run.
  - withBaselineState
```
public Result withBaselineState(Result.BaselineState baselineState)
```
  - getRank
```
public Double getRank()
```
    A number representing the priority or importance of the result.
  - setRank
```
public void setRank(Double rank)
```
    A number representing the priority or importance of the result.
  - withRank
```
public Result withRank(Double rank)
```
  - getAttachments
```
public Set<Attachment> getAttachments()
```
    A set of artifacts relevant to the result.
  - setAttachments
```
public void setAttachments(Set<Attachment> attachments)
```
    A set of artifacts relevant to the result.
  - withAttachments
```
public Result withAttachments(Set<Attachment> attachments)
```
  - getHostedViewerUri
```
public URI getHostedViewerUri()
```
    An absolute URI at which the result can be viewed.
  - setHostedViewerUri
```
public void setHostedViewerUri(URI hostedViewerUri)
```
    An absolute URI at which the result can be viewed.
  - withHostedViewerUri
```
public Result withHostedViewerUri(URI hostedViewerUri)
```
  - getWorkItemUris
```
public Set<URI> getWorkItemUris()
```
    The URIs of the work items associated with this result.
  - setWorkItemUris
```
public void setWorkItemUris(Set<URI> workItemUris)
```
    The URIs of the work items associated with this result.
  - withWorkItemUris
```
public Result withWorkItemUris(Set<URI> workItemUris)
```
  - getProvenance
```
public ResultProvenance getProvenance()
```
    Contains information about how and when a result was detected.
  - setProvenance
```
public void setProvenance(ResultProvenance provenance)
```
    Contains information about how and when a result was detected.
  - withProvenance
```
public Result withProvenance(ResultProvenance provenance)
```
  - getFixes
```
public Set<Fix> getFixes()
```
    An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.
  - setFixes
```
public void setFixes(Set<Fix> fixes)
```
    An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.
  - withFixes
```
public Result withFixes(Set<Fix> fixes)
```
  - getTaxa
```
public Set<ReportingDescriptorReference> getTaxa()
```
    An array of references to taxonomy reporting descriptors that are applicable to the result.
  - setTaxa
```
public void setTaxa(Set<ReportingDescriptorReference> taxa)
```
    An array of references to taxonomy reporting descriptors that are applicable to the result.
  - withTaxa
```
public Result withTaxa(Set<ReportingDescriptorReference> taxa)
```
  - getWebRequest
```
public WebRequest getWebRequest()
```
    Describes an HTTP request.
  - setWebRequest
```
public void setWebRequest(WebRequest webRequest)
```
    Describes an HTTP request.
  - withWebRequest
```
public Result withWebRequest(WebRequest webRequest)
```
  - getWebResponse
```
public WebResponse getWebResponse()
```
    Describes the response to an HTTP request.
  - setWebResponse
```
public void setWebResponse(WebResponse webResponse)
```
    Describes the response to an HTTP request.
  - withWebResponse
```
public Result withWebResponse(WebResponse webResponse)
```
  - 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 Result 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 Result

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Result

Method Detail

getRuleId

setRuleId

withRuleId

getRuleIndex

setRuleIndex

withRuleIndex

getRule

setRule

withRule

getKind

setKind

withKind

getLevel

setLevel

withLevel

getMessage

setMessage

withMessage

getAnalysisTarget

setAnalysisTarget

withAnalysisTarget

getLocations

setLocations

withLocations

getGuid

setGuid

withGuid

getCorrelationGuid

setCorrelationGuid

withCorrelationGuid

getOccurrenceCount

setOccurrenceCount

withOccurrenceCount

getPartialFingerprints

setPartialFingerprints

withPartialFingerprints

getFingerprints

setFingerprints

withFingerprints

getStacks

setStacks

withStacks

getCodeFlows

setCodeFlows

withCodeFlows

getGraphs

setGraphs

withGraphs

getGraphTraversals

setGraphTraversals

withGraphTraversals

getRelatedLocations

setRelatedLocations

withRelatedLocations

getSuppressions

setSuppressions

withSuppressions

getBaselineState

setBaselineState

withBaselineState

getRank

setRank

withRank

getAttachments

setAttachments

withAttachments

getHostedViewerUri

setHostedViewerUri

withHostedViewerUri

getWorkItemUris

setWorkItemUris

withWorkItemUris