Message

```
public class Message
extends JSONBase
```
A structured message object. Used to return errors from requests.

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Message`	`create(Integer id, String format)`
`boolean`	`equals(Object obj)`
`String`	`getFormat()` A format string for the message.
`int`	`getId()` Unique identifier for the message.
`Boolean`	`getSendTelemetry()` If true send to telemetry.
`Boolean`	`getShowUser()` If true show user.
`String`	`getUrl()` An optional url where additional information about this message can be found.
`String`	`getUrlLabel()` An optional label that is presented to the user as the UI for opening the url.
`Map<String,String>`	`getVariables()` An object used as a dictionary for looking up the variables in the format string.
`int`	`hashCode()`
`Message`	`setFormat(String format)`
`Message`	`setId(int id)`
`Message`	`setSendTelemetry(Boolean sendTelemetry)`
`Message`	`setShowUser(Boolean showUser)`
`Message`	`setUrl(String url)`
`Message`	`setUrlLabel(String urlLabel)`
`Message`	`setVariables(Map<String,String> variables)`

getFormat
```
public String getFormat()
```
A format string for the message. Embedded variables have the form '{name}'. If variable name starts with an underscore character, the variable does not contain user data (PII) and can be safely used for telemetry purposes.

public Message setFormat(String format)

getVariables
```
public Map<String,String> getVariables()
```
An object used as a dictionary for looking up the variables in the format string.

public Message setVariables(Map<String,String> variables)

getSendTelemetry
```
public Boolean getSendTelemetry()
```
If true send to telemetry.

public Message setSendTelemetry(Boolean sendTelemetry)

public Message setShowUser(Boolean showUser)

getUrl
```
public String getUrl()
```
An optional url where additional information about this message can be found.

getUrlLabel
```
public String getUrlLabel()
```
An optional label that is presented to the user as the UI for opening the url.

public Message setUrlLabel(String urlLabel)

public static Message create(Integer id,
                             String format)

Class Message