Package com.commercetools.api.models.error

Interface GraphQLInsufficientScopeError

All Superinterfaces:

GraphQLErrorObject

public interface GraphQLInsufficientScopeError
extends GraphQLErrorObject

This error occurs when your API Client does not have the OAuth scope required for the endpoint. Use an API Client with the required permissions for this endpoint instead.

Example to create an instance using the builder pattern

     GraphQLInsufficientScopeError graphQLInsufficientScopeError = GraphQLInsufficientScopeError.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INSUFFICIENT_SCOPE	discriminator value for GraphQLInsufficientScopeError

Method Summary

Modifier and Type	Method	Description
static GraphQLInsufficientScopeErrorBuilder	builder()	builder factory method for GraphQLInsufficientScopeError
static GraphQLInsufficientScopeErrorBuilder	builder(GraphQLInsufficientScopeError template)	create builder for GraphQLInsufficientScopeError instance
static GraphQLInsufficientScopeError	deepCopy(GraphQLInsufficientScopeError template)	factory method to create a deep copy of GraphQLInsufficientScopeError
@NotNull String	getCode()	One of the error codes that is listed on the Errors page.
static GraphQLInsufficientScopeError	of()	factory method
static GraphQLInsufficientScopeError	of(GraphQLInsufficientScopeError template)	factory method to create a shallow copy GraphQLInsufficientScopeError
static com.fasterxml.jackson.core.type.TypeReference<GraphQLInsufficientScopeError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withGraphQLInsufficientScopeError(Function<GraphQLInsufficientScopeError,T> helper)	accessor map function

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

setValue, values, withGraphQLErrorObject

Field Details

INSUFFICIENT_SCOPE

static final String INSUFFICIENT_SCOPE

discriminator value for GraphQLInsufficientScopeError

See Also:

• Constant Field Values

Method Details

getCode

@NotNull
@NotNull String getCode()

Description copied from interface: GraphQLErrorObject

One of the error codes that is listed on the Errors page.

Specified by:

getCode in interface GraphQLErrorObject

Returns:

code

of

static GraphQLInsufficientScopeError of()

factory method

Returns:

instance of GraphQLInsufficientScopeError

of

static GraphQLInsufficientScopeError of(GraphQLInsufficientScopeError template)

factory method to create a shallow copy GraphQLInsufficientScopeError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static GraphQLInsufficientScopeError deepCopy(@Nullable
 GraphQLInsufficientScopeError template)

factory method to create a deep copy of GraphQLInsufficientScopeError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static GraphQLInsufficientScopeErrorBuilder builder()

builder factory method for GraphQLInsufficientScopeError

Returns:

builder

builder

static GraphQLInsufficientScopeErrorBuilder builder(GraphQLInsufficientScopeError template)

create builder for GraphQLInsufficientScopeError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withGraphQLInsufficientScopeError

default <T> T withGraphQLInsufficientScopeError(Function<GraphQLInsufficientScopeError,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<GraphQLInsufficientScopeError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference