Package com.commercetools.api.models.error

Interface ExternalOAuthFailedError

All Superinterfaces:

ErrorObject

All Known Implementing Classes:

ExternalOAuthFailedErrorImpl

public interface ExternalOAuthFailedError
extends ErrorObject

Returned when an external OAuth Introspection endpoint does not return a response within the time limit, or the response isn't compliant with RFC 7662 (for example, an HTTP status code like 500).

Example to create an instance using the builder pattern

     ExternalOAuthFailedError externalOAuthFailedError = ExternalOAuthFailedError.builder()
             .message("{message}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXTERNAL_O_AUTH_FAILED	discriminator value for ExternalOAuthFailedError

Method Summary

Modifier and Type	Method	Description
static ExternalOAuthFailedErrorBuilder	builder()	builder factory method for ExternalOAuthFailedError
static ExternalOAuthFailedErrorBuilder	builder(ExternalOAuthFailedError template)	create builder for ExternalOAuthFailedError instance
static ExternalOAuthFailedError	deepCopy(ExternalOAuthFailedError template)	factory method to create a deep copy of ExternalOAuthFailedError
@NotNull String	getCode()	Error identifier.
@NotNull String	getMessage()	Plain text description detailing the external OAuth error.
static ExternalOAuthFailedError	of()	factory method
static ExternalOAuthFailedError	of(ExternalOAuthFailedError template)	factory method to create a shallow copy ExternalOAuthFailedError
void	setMessage(String message)	Plain text description detailing the external OAuth error.
static com.fasterxml.jackson.core.type.TypeReference<ExternalOAuthFailedError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withExternalOAuthFailedError(Function<ExternalOAuthFailedError,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.error.ErrorObject

setValue, values, withErrorObject

Field Details

EXTERNAL_O_AUTH_FAILED

static final String EXTERNAL_O_AUTH_FAILED

discriminator value for ExternalOAuthFailedError

See Also:

• Constant Field Values

Method Details

getCode

@NotNull
@NotNull String getCode()

Description copied from interface: ErrorObject

Error identifier.

Specified by:

getCode in interface ErrorObject

Returns:

code

getMessage

@NotNull
@NotNull String getMessage()

Plain text description detailing the external OAuth error. For example, "External OAuth did not respond in time.".

Specified by:

getMessage in interface ErrorObject

Returns:

message

setMessage

void setMessage(String message)

Plain text description detailing the external OAuth error. For example, "External OAuth did not respond in time.".

Specified by:

setMessage in interface ErrorObject

Parameters:

message - value to be set

of

static ExternalOAuthFailedError of()

factory method

Returns:

instance of ExternalOAuthFailedError

of

static ExternalOAuthFailedError of(ExternalOAuthFailedError template)

factory method to create a shallow copy ExternalOAuthFailedError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ExternalOAuthFailedError deepCopy(@Nullable
 ExternalOAuthFailedError template)

factory method to create a deep copy of ExternalOAuthFailedError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ExternalOAuthFailedErrorBuilder builder()

builder factory method for ExternalOAuthFailedError

Returns:

builder

builder

static ExternalOAuthFailedErrorBuilder builder(ExternalOAuthFailedError template)

create builder for ExternalOAuthFailedError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withExternalOAuthFailedError

default <T> T withExternalOAuthFailedError(Function<ExternalOAuthFailedError,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<ExternalOAuthFailedError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference