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

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

```
public class Notification
extends Object
```
Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Notification.Level
A value specifying the severity level of the notification.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Notification.Level` A value specifying the severity level of the notification.

Constructor Summary

Constructors
Constructor and Description

Notification()

Constructors
Constructor and Description
`Notification()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`ReportingDescriptorReference`	`getAssociatedRule()` Information about how to locate a relevant reporting descriptor.
`ReportingDescriptorReference`	`getDescriptor()` Information about how to locate a relevant reporting descriptor.
`Exception`	`getException()` Describes a runtime exception encountered during the execution of an analysis tool.
`Notification.Level`	`getLevel()` A value specifying the severity level of the notification.
`Set<Location>`	`getLocations()` The locations relevant to this notification.
`Message`	`getMessage()` Encapsulates a message intended to be read by the end user.
`PropertyBag`	`getProperties()` Key/value pairs that provide additional information about the object.
`Integer`	`getThreadId()` The thread identifier of the code that generated the notification.
`Date`	`getTimeUtc()` The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.
`int`	`hashCode()`
`void`	`setAssociatedRule(ReportingDescriptorReference associatedRule)` Information about how to locate a relevant reporting descriptor.
`void`	`setDescriptor(ReportingDescriptorReference descriptor)` Information about how to locate a relevant reporting descriptor.
`void`	`setException(Exception exception)` Describes a runtime exception encountered during the execution of an analysis tool.
`void`	`setLevel(Notification.Level level)` A value specifying the severity level of the notification.
`void`	`setLocations(Set<Location> locations)` The locations relevant to this notification.
`void`	`setMessage(Message message)` Encapsulates a message intended to be read by the end user.
`void`	`setProperties(PropertyBag properties)` Key/value pairs that provide additional information about the object.
`void`	`setThreadId(Integer threadId)` The thread identifier of the code that generated the notification.
`void`	`setTimeUtc(Date timeUtc)` The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.
`String`	`toString()`
`Notification`	`withAssociatedRule(ReportingDescriptorReference associatedRule)`
`Notification`	`withDescriptor(ReportingDescriptorReference descriptor)`
`Notification`	`withException(Exception exception)`
`Notification`	`withLevel(Notification.Level level)`
`Notification`	`withLocations(Set<Location> locations)`
`Notification`	`withMessage(Message message)`
`Notification`	`withProperties(PropertyBag properties)`
`Notification`	`withThreadId(Integer threadId)`
`Notification`	`withTimeUtc(Date timeUtc)`

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

- Constructor Detail
  - Notification
```
public Notification()
```
- Method Detail
  - getLocations
```
public Set<Location> getLocations()
```
    The locations relevant to this notification.
  - setLocations
```
public void setLocations(Set<Location> locations)
```
    The locations relevant to this notification.
  - withLocations
```
public Notification withLocations(Set<Location> locations)
```
  - 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 Notification withMessage(Message message)
```
  - getLevel
```
public Notification.Level getLevel()
```
    A value specifying the severity level of the notification.
  - setLevel
```
public void setLevel(Notification.Level level)
```
    A value specifying the severity level of the notification.
  - withLevel
```
public Notification withLevel(Notification.Level level)
```
  - getThreadId
```
public Integer getThreadId()
```
    The thread identifier of the code that generated the notification.
  - setThreadId
```
public void setThreadId(Integer threadId)
```
    The thread identifier of the code that generated the notification.
  - withThreadId
```
public Notification withThreadId(Integer threadId)
```
  - getTimeUtc
```
public Date getTimeUtc()
```
    The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.
  - setTimeUtc
```
public void setTimeUtc(Date timeUtc)
```
    The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.
  - withTimeUtc
```
public Notification withTimeUtc(Date timeUtc)
```
  - getException
```
public Exception getException()
```
    Describes a runtime exception encountered during the execution of an analysis tool.
  - setException
```
public void setException(Exception exception)
```
    Describes a runtime exception encountered during the execution of an analysis tool.
  - withException
```
public Notification withException(Exception exception)
```
  - getDescriptor
```
public ReportingDescriptorReference getDescriptor()
```
    Information about how to locate a relevant reporting descriptor.
  - setDescriptor
```
public void setDescriptor(ReportingDescriptorReference descriptor)
```
    Information about how to locate a relevant reporting descriptor.
  - withDescriptor
```
public Notification withDescriptor(ReportingDescriptorReference descriptor)
```
  - getAssociatedRule
```
public ReportingDescriptorReference getAssociatedRule()
```
    Information about how to locate a relevant reporting descriptor.
  - setAssociatedRule
```
public void setAssociatedRule(ReportingDescriptorReference associatedRule)
```
    Information about how to locate a relevant reporting descriptor.
  - withAssociatedRule
```
public Notification withAssociatedRule(ReportingDescriptorReference associatedRule)
```
  - 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 Notification 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 Notification

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Notification

Method Detail

getLocations

setLocations

withLocations

getMessage

setMessage

withMessage

getLevel

setLevel

withLevel

getThreadId

setThreadId

withThreadId

getTimeUtc

setTimeUtc

withTimeUtc

getException

setException

withException

getDescriptor

setDescriptor

withDescriptor

getAssociatedRule

setAssociatedRule

withAssociatedRule

getProperties

setProperties

withProperties

toString

hashCode

equals