public class AuthnErrorDetail extends Object
Modifier and Type | Class and Description |
---|---|
static class |
AuthnErrorDetail.Builder
A fluent builder for
AuthnErrorDetail instances. |
Constructor and Description |
---|
AuthnErrorDetail()
Create an instance.
|
AuthnErrorDetail(String code,
String message,
String target)
Create an instance with the specified parameters.
|
Modifier and Type | Method and Description |
---|---|
String |
getCode()
Get the error code.
|
String |
getMessage()
Get the developer-facing error message.
|
String |
getTarget()
If the error applies to a specific field in an incoming API request, this identifies the name of the JSON field.
|
String |
getUserMessage()
Get the user-facing error message.
|
void |
setCode(String code)
Set the error code.
|
void |
setMessage(String message)
Set the error message.
|
void |
setTarget(String target)
Set the target JSON field for the error.
|
void |
setUserMessage(String userMessage)
Directly set the localized user-facing error message.
|
void |
setUserMessageKey(String userMessageKey)
Set the user-facing error message key.
|
public AuthnErrorDetail()
public AuthnErrorDetail(String code, String message, String target)
code
- The error code.message
- The error message.target
- If the error applies to a specific field in an incoming API request, this contains the name of the JSON field.public String getCode()
public void setCode(String code)
public String getMessage()
public void setMessage(String message)
public String getUserMessage()
setUserMessageKey()
or the localized error message can be directly set with setUserMessage()
.public void setUserMessageKey(String userMessageKey)
public void setUserMessage(String userMessage)
public String getTarget()
public void setTarget(String target)
Copyright 2019 Ping Identity Corp. All rights reserved.