org.springframework.graphql.data.method.annotation

Annotation Type Argument

@Target(value=PARAMETER)
 @Retention(value=RUNTIME)
 @Documented
public @interface Argument

Annotation to bind a method parameter to a GraphQL input argument.

If the method parameter is Map<String, Object> or and a parameter name is not specified, then the map parameter is populated via DataFetchingEnvironment.getArguments().

Since:

1.0.0

Author:

Rossen Stoyanchev

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	defaultValue The default value to use as a fallback when an input argument is not present or has an empty value.
String	name The name of the input argument to bind to.
boolean	required Whether the input argument is required.
String	value Alias for name().

Element Detail

value

@AliasFor(value="name")
public abstract String value

Alias for name().

Default:

""

name

@AliasFor(value="value")
public abstract String name

The name of the input argument to bind to.

Default:

""

required

public abstract boolean required

Whether the input argument is required.

Defaults to true, leading to an exception being thrown if the argument is missing. Switch this to false if you prefer a null value when the parameter is not present.

Alternatively, provide a defaultValue(), which implicitly sets this flag to false.

Default:

true

defaultValue

public abstract String defaultValue

The default value to use as a fallback when an input argument is not present or has an empty value.

Supplying a default value implicitly sets required() to false.

Default:

"\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n"