Package com.commercetools.api.models.agent

Interface AgentResponsesAuthError

All Superinterfaces:

AuthErrorResponse, ErrorResponse

public interface AgentResponsesAuthError
extends AuthErrorResponse

Authentication or authorization failure from a /responses request. Uses the standard AuthErrorResponse shape (statusCode, message, errors, plus OAuth error / error_description) rather than the AgentResponsesErrorResponse envelope used for other errors from this endpoint.

Example to create an instance using the builder pattern

     AgentResponsesAuthError agentResponsesAuthError = AgentResponsesAuthError.builder()
             .statusCode(1)
             .message("{message}")
             .plusErrors(errorsBuilder -> errorsBuilder)
             .error("{error}")
             .build()
 

Method Summary

Modifier and Type	Method	Description
static AgentResponsesAuthErrorBuilder	builder()	builder factory method for AgentResponsesAuthError
static AgentResponsesAuthErrorBuilder	builder(AgentResponsesAuthError template)	create builder for AgentResponsesAuthError instance
AgentResponsesAuthError	copyDeep()
static AgentResponsesAuthError	deepCopy(AgentResponsesAuthError template)	factory method to create a deep copy of AgentResponsesAuthError
static AgentResponsesAuthError	of()	factory method
static AgentResponsesAuthError	of(AgentResponsesAuthError template)	factory method to create a shallow copy AgentResponsesAuthError
static tools.jackson.core.type.TypeReference<AgentResponsesAuthError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withAgentResponsesAuthError(Function<AgentResponsesAuthError,T> helper)	accessor map function

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

getError, getErrorDescription, getErrors, setError, setErrorDescription, setErrors, setErrors, withAuthErrorResponse

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

getMessage, getStatusCode, setMessage, setStatusCode, withErrorResponse

Method Details

of

static AgentResponsesAuthError of()

factory method

Returns:

instance of AgentResponsesAuthError

of

static AgentResponsesAuthError of(AgentResponsesAuthError template)

factory method to create a shallow copy AgentResponsesAuthError

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

AgentResponsesAuthError copyDeep()

Specified by:

copyDeep in interface AuthErrorResponse

Specified by:

copyDeep in interface ErrorResponse

deepCopy

@Nullable
static AgentResponsesAuthError deepCopy(@Nullable
 AgentResponsesAuthError template)

factory method to create a deep copy of AgentResponsesAuthError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AgentResponsesAuthErrorBuilder builder()

builder factory method for AgentResponsesAuthError

Returns:

builder

builder

static AgentResponsesAuthErrorBuilder builder(AgentResponsesAuthError template)

create builder for AgentResponsesAuthError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAgentResponsesAuthError

default <T> T withAgentResponsesAuthError(Function<AgentResponsesAuthError,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static tools.jackson.core.type.TypeReference<AgentResponsesAuthError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference