Package com.pingidentity.sdk.api.authn.model

Class AuthnErrorDetail.Builder

java.lang.Object

com.pingidentity.sdk.api.authn.model.AuthnErrorDetail.Builder

Enclosing class:

AuthnErrorDetail

public static class AuthnErrorDetail.Builder
extends Object

A fluent builder for AuthnErrorDetail instances.

Since:

9.3

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AuthnErrorDetail	build()	Build the instance.
AuthnErrorDetail.Builder	code(String code)	Set the error code.
AuthnErrorDetail.Builder	message(String message)	Set the developer-facing error message.
AuthnErrorDetail.Builder	target(String target)	Set the JSON target field.
AuthnErrorDetail.Builder	userMessage(String userMessage)	Directly set the localized user-facing error message.
AuthnErrorDetail.Builder	userMessageKey(String messageKey)	Set the user-facing error message key.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

build

public AuthnErrorDetail build()

Build the instance.

code

public AuthnErrorDetail.Builder code(String code)

Set the error code.

message

public AuthnErrorDetail.Builder message(String message)

Set the developer-facing error message.

userMessageKey

public AuthnErrorDetail.Builder userMessageKey(String messageKey)

Set the user-facing error message key. In the JSON serialization this key will automatically be converted to a localized string if a corresponding message is defined in the authn-api-messages properties file for the user's locale.

userMessage

public AuthnErrorDetail.Builder userMessage(String userMessage)

Directly set the localized user-facing error message.

target

public AuthnErrorDetail.Builder target(String target)

Set the JSON target field.