Package com.commercetools.api.models.error

Interface GraphQLInvalidFieldError

All Superinterfaces:

GraphQLErrorObject

All Known Implementing Classes:

GraphQLInvalidFieldErrorImpl

public interface GraphQLInvalidFieldError
extends GraphQLErrorObject

Returned when a field has an invalid value.

Example to create an instance using the builder pattern

     GraphQLInvalidFieldError graphQLInvalidFieldError = GraphQLInvalidFieldError.builder()
             .field("{field}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INVALID_FIELD	discriminator value for GraphQLInvalidFieldError

Method Summary

Modifier and Type	Method	Description
static GraphQLInvalidFieldErrorBuilder	builder()	builder factory method for GraphQLInvalidFieldError
static GraphQLInvalidFieldErrorBuilder	builder(GraphQLInvalidFieldError template)	create builder for GraphQLInvalidFieldError instance
static GraphQLInvalidFieldError	deepCopy(GraphQLInvalidFieldError template)	factory method to create a deep copy of GraphQLInvalidFieldError
List<Object>	getAllowedValues()	Fixed set of allowed values for the field, if any.
@NotNull String	getCode()	Error identifier.
@NotNull String	getField()	Name of the field with the invalid value.
@NotNull Object	getInvalidValue()	Value invalid for the field.
static GraphQLInvalidFieldError	of()	factory method
static GraphQLInvalidFieldError	of(GraphQLInvalidFieldError template)	factory method to create a shallow copy GraphQLInvalidFieldError
void	setAllowedValues(Object... allowedValues)	Fixed set of allowed values for the field, if any.
void	setAllowedValues(List<Object> allowedValues)	Fixed set of allowed values for the field, if any.
void	setField(String field)	Name of the field with the invalid value.
void	setInvalidValue(Object invalidValue)	Value invalid for the field.
static com.fasterxml.jackson.core.type.TypeReference<GraphQLInvalidFieldError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withGraphQLInvalidFieldError(Function<GraphQLInvalidFieldError,T> helper)	accessor map function

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

setValue, values, withGraphQLErrorObject

Field Details

INVALID_FIELD

static final String INVALID_FIELD

discriminator value for GraphQLInvalidFieldError

See Also:

• Constant Field Values

Method Details

getCode

@NotNull
@NotNull String getCode()

Description copied from interface: GraphQLErrorObject

Error identifier.

Specified by:

getCode in interface GraphQLErrorObject

Returns:

code

getField

@NotNull
@NotNull String getField()

Name of the field with the invalid value.

Returns:

field

getInvalidValue

@NotNull
@NotNull Object getInvalidValue()

Value invalid for the field.

Returns:

invalidValue

getAllowedValues

List<Object> getAllowedValues()

Fixed set of allowed values for the field, if any.

Returns:

allowedValues

setField

void setField(String field)

Name of the field with the invalid value.

Parameters:

field - value to be set

setInvalidValue

void setInvalidValue(Object invalidValue)

Value invalid for the field.

Parameters:

invalidValue - value to be set

setAllowedValues

void setAllowedValues(Object... allowedValues)

Fixed set of allowed values for the field, if any.

Parameters:

allowedValues - values to be set

setAllowedValues

void setAllowedValues(List<Object> allowedValues)

Fixed set of allowed values for the field, if any.

Parameters:

allowedValues - values to be set

of

static GraphQLInvalidFieldError of()

factory method

Returns:

instance of GraphQLInvalidFieldError

of

static GraphQLInvalidFieldError of(GraphQLInvalidFieldError template)

factory method to create a shallow copy GraphQLInvalidFieldError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static GraphQLInvalidFieldError deepCopy(@Nullable
 GraphQLInvalidFieldError template)

factory method to create a deep copy of GraphQLInvalidFieldError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static GraphQLInvalidFieldErrorBuilder builder()

builder factory method for GraphQLInvalidFieldError

Returns:

builder

builder

static GraphQLInvalidFieldErrorBuilder builder(GraphQLInvalidFieldError template)

create builder for GraphQLInvalidFieldError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withGraphQLInvalidFieldError

default <T> T withGraphQLInvalidFieldError(Function<GraphQLInvalidFieldError,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<GraphQLInvalidFieldError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference