io.smallrye.graphql.client.typesafe.api

Annotation Type Header

@Retention(value=RUNTIME)
 @Target(value={TYPE,METHOD,PARAMETER})
 @Repeatable(value=Headers.class)
public @interface Header

Adds a custom header to the http requests sent out by the GraphQL Client. Annotate your method or the API interface.

The `name` is always fixed, but the value can be either a `constant` or the name of a `method` for dynamic values. It can't be both or neither. The method is always a static method, either on the interface itself (or one of the classes it's nested in) or any other class, when the method name is prefixed by the fully qualified class name plus . and is accessible, e.g. `java.lang.System.lineSeparator`.

In rare cases, you may want to pass the value of a header as a parameter; neither `constant` nor `method` will be allowed then.

@Header annotations can be defined via @Steretypes.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	constant
String	method

Element Detail

name

public abstract String name

constant

public abstract String constant

Default:

""

method

public abstract String method

Default:

""